data-streams/README.md

Transforms the Dataset resources of a package.jsonld into streams

data-streams
============

Transforms the [Dataset](http://schema.org/Dataset) resources of a package.jsonld into streams.

[![NPM](https://nodei.co/npm/data-streams.png)](https://nodei.co/npm/data-streams/)


Usage
=====

    var Pkg = require('data-streams');
    var myPackage = require('package.jsonld');

    var pkg = new Pkg(myPackage, '.');
    var stream = pkg.createReadStream(name, options);


```name``` is the name of the [Dataset](http://www.schema.org/Dataset) resource.

For the resources in ```csv``` and ```ldjson``` format, an
```options``` object with the following properties can be specified:

- objectMode: (true/false) return a stream in objectMode where every chunk will be a row (as a JS object).
- coerce: (true/false) coerce the values according to the types specified in schema (implies objectMode)
- ldjsonify: (true/false) JSON.stringify + '\n' (implies objectMode)
- filter: an array of column to be kept (all the other will be filtered out)

Tests
=====

    npm test


Licence
=======

MIT