<commit_before>node-qvx
=========
Read and Write Qlik QVX data using Streams

## Status
[![Build Status](https://travis-ci.org/kmpm/node-qvx.svg?branch=master)](https://travis-ci.org/kmpm/node-qvx)

Documentation needs to be done but it's still in a quite unstable time
so please have a look at the tests.

Have a look at https://github.com/kmpm/node-qvxserver for a Hapi based webserver that will give you qvx data.

Installation
------------

    npm install

There is a dependency on a module called bignum that uses some native SSL libraries
for handling 64 bit integers. This dependency might be tricky to install in windows.
Go to https://slproweb.com/products/Win32OpenSSL.html and download the latest __full__
version of OpenSLL and install it to it's default location.

Examples
---------
### Outbound
Have a look at https://github.com/kmpm/node-qvxserver for a 
Hapi based webserver that will give you qvx data that for example
QlikView can read. Also look at tests/outbound.tests.js and test/schema.tests.js.

Since the process is quit simple but quite verbos it's not suitable for the readme 
but you basically do.

1. Create a field definition with datatypes
2. Create a resuable schema instance using these field definitions 
3. From a stream of objects that match the field definition, pipe through
   the schema instance.


### Inbound
This shows a use of Inbound, something that you would do if you needed<commit_msg>more readme<commit_after>node-qvx
=========
Read and Write Qlik QVX data using Streams

## Status
[![Build Status](https://travis-ci.org/kmpm/node-qvx.svg?branch=master)](https://travis-ci.org/kmpm/node-qvx)

Documentation needs to so please have a look at the tests.

Have a look at https://github.com/kmpm/node-qvxserver for a Hapi based webserver that will give you qvx data.

Installation
------------

    npm install

There is a dependency on a module called bignum that uses some native SSL libraries
for handling 64 bit integers. This dependency might be tricky to install in windows.
Go to https://slproweb.com/products/Win32OpenSSL.html and download the latest __full__
version of OpenSLL and install it to it's default location. That might help.

Examples
---------
### Outbound
Have a look at https://github.com/kmpm/node-qvxserver for a 
Hapi based webserver that will give you qvx data that for example
QlikView can read. Also look at tests/outbound.tests.js and test/schema.tests.js.

Since the process is quit simple but quite verbos it's not suitable for the readme 
but you basically do.

1. Create a field definition with datatypes
2. Create a resuable schema instance using these field definitions 
3. From a stream of objects that match the field definition, pipe through
   the schema instance.


### Inbound
This shows a use of Inbound, something that you would do if you needed
{'fraction_non_alphanumeric': 0.08042328042328042, 'fraction_numerical': 0.0049382716049382715, 'mean_word_length': 3.839590443686007, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1576956', 'n_tokens_mistral': 841, 'n_tokens_neox': 802, 'n_words': 385}