44 lines
1.9 KiB
Plaintext
44 lines
1.9 KiB
Plaintext
|
|
||
|
|
[](https://travis-ci.org/#!/adaltas/node-csv-generate) [](https://www.npmjs.com/package/csv-generate) [](https://www.npmjs.com/package/csv-generate)
|
||
|
|
|
||
|
|
# CSV and object generation
|
||
|
|
|
||
|
|
This package provides a flexible generator of CSV strings and Javascript objects
|
||
|
|
implementing the Node.js `stream.Readable` API.
|
||
|
|
|
||
|
|
[Documentation for the "csv-generate" package is available here](https://csv.js.org/generate/).
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
* [Project homepage](http://csv.js.org/generate/)
|
||
|
|
* [API](http://csv.js.org/generate/api/)
|
||
|
|
* [Options](http://csv.js.org/generate/options/)
|
||
|
|
* [Examples](http://csv.js.org/generate/examples/)
|
||
|
|
|
||
|
|
## Main features
|
||
|
|
|
||
|
|
* Scalable `stream.Readable` implementation
|
||
|
|
* random or pseudo-random seed based generation
|
||
|
|
* Idempotence with the "seed" option
|
||
|
|
* User-defined value generation
|
||
|
|
* Multiple types of values (integer, boolean, dates, ...)
|
||
|
|
* MIT License
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Run `npm install csv` to install the full csv module or run `npm install csv-generate` if you are only interested by the CSV generator.
|
||
|
|
|
||
|
|
Use the callback style API for simplicity or the stream based API for scalability.
|
||
|
|
|
||
|
|
## Development
|
||
|
|
|
||
|
|
Tests are executed with [Mocha](https://mochajs.org/). To install it, simple run `npm install` followed by `npm test`. It will install mocha and its dependencies in your project "node_modules" directory and run the test suite. The tests run against the CoffeeScript source files.
|
||
|
|
|
||
|
|
To generate the JavaScript files, run `npm run coffee`.
|
||
|
|
|
||
|
|
The test suite is run online with [Travis](https://travis-ci.org/#!/adaltas/node-csv-generate). See the [Travis definition file](https://github.com/adaltas/node-csv-generate/blob/master/.travis.yml) to view the tested Node.js version.
|
||
|
|
|
||
|
|
## Contributors
|
||
|
|
|
||
|
|
* David Worms: <https://github.com/wdavidw>
|