CSVGenerate for Node.js

IssuesGitHub

CSV and object generator

Table of Contents

Build Status

This package provides a flexible generator of CSV strings and Javascript objects implementing the Node.js stream.Readable API. It may be used to generate random or user-defined datasets.

Source code for this project is available on GitHub.

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, ...)
  • Work nicely with the csv-parse, csv-stringify and stream-transform packages
  • MIT License

Usage

The package is published on NPM and can be installed either with NPM or YARN.

You can install the package directly, for example using NPM with the command npm install csv-generate.

# Install the package dependency
npm install csv-generate
# Write a sample module
cat > generator.js <<JS
// Require the csv module
import generate from 'csv-generate'
// Print 10 records
generate({length: 10}).pipe(process.stdout)
JS
# Execute the module
node generator.js

Another option is to access it through its parent csv package, which main module exports a generate function. For example using the NPM with the command npm install csv.

# Install the package dependency
npm install csv
# Write a sample module
cat > generator.js <<JS
// Require the csv module
import csv from 'csv'
// Print 10 records
csv.generate({length: 10}).pipe(process.stdout)
JS
# Execute the module
node generator.js

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.

The source code uses modern JavaScript features and runs natively in Node greater or equal than version 8.

Additional help

For usage and examples, you may refer to example page, the "samples" folder and the "test" folder.

About

The Node.js CSV project is an open source product hosted on GitHub and developed by Adaltas.