UNPKG

csv/README.md

Version:

2.76 kBMarkdownView Raw

1
2<pre>
3     _   _           _        _____  _______      __
4    | \ | |         | |      / ____|/ ____\ \    / /
5    |  \| | ___   __| | ___ | |    | (___  \ \  / /
6    | . ` |/ _ \ / _` |/ _ \| |     \___ \  \ \/ /
7    | |\  | (_) | (_| |  __/| |____ ____) |  \  /
8    |_| \_|\___/ \__,_|\___| \_____|_____/    \/     New BSD License
9
10</pre>
11
12This project provides CSV generation, parsing, transformation and serialization
13for Node.js.
14
15It has been tested and used by a large community over the years and should be
16considered reliable. It provides every option you would expect from an advanced
17CSV parser and stringifier.
18
19[![NPM](https://nodei.co/npm/csv.png?stars&downloads)](https://nodei.co/npm/csv/) [![NPM](https://nodei.co/npm-dl/csv.png)](https://nodei.co/npm/csv/)
20
21The `csv` package is itself split into 4 packages:
22
23*   [`csv-generate`](https://csv.js.org/generate/),
24    a flexible generator of CSV string and Javascript objects. 
25    [![Build Status](https://secure.travis-ci.org/adaltas/node-csv-generate.svg?branch=master)][travis-csv-generate]
26*   [`csv-parse`](https://csv.js.org/parse/),
27    a parser converting CSV text into arrays or objects. 
28    [![Build Status](https://secure.travis-ci.org/adaltas/node-csv-parse.svg?branch=master)][travis-csv-parse]
29*   [`stream-transform`](https://csv.js.org/transform/),
30    a transformation framework.
31    [![Build Status](https://secure.travis-ci.org/adaltas/node-stream-transform.svg?branch=master)][travis-stream-transform]
32*   [`csv-stringify`](https://csv.js.org/stringify/), 
33    a stringifier converting records into a CSV text. 
34    [![Build Status](https://secure.travis-ci.org/adaltas/node-csv-stringify.svg?branch=master)][travis-csv-stringify]
35
36## Documentation
37
38The full documentation for the current version is available [here](https://csv.js.org).
39
40## Usage
41
42Installation command is `npm install csv`.
43
44Each package is fully compatible with the stream 2 and 3 specifications.
45Also, a simple callback-based API is always provided for convenience.
46
47## Development
48
49This parent project doesn't have tests itself but instead delegates the
50tests to its child projects.
51
52Read the documentation of the child projects for additional information.
53
54## Related projects
55
56*   Pavel Kolesnikov "ya-csv": <http://github.com/koles/ya-csv>
57*   Chris Williams "node-csv": <http://github.com/voodootikigod/node-csv>
58*   Mat Holt "PapaParse": <https://github.com/mholt/PapaParse>
59
60[travis]: https://travis-ci.org/
61[travis-csv-generate]: http://travis-ci.org/adaltas/node-csv-generate
62[travis-csv-parse]: http://travis-ci.org/adaltas/node-csv-parse
63[travis-stream-transform]: http://travis-ci.org/adaltas/node-stream-transform
64[travis-csv-stringify]: http://travis-ci.org/adaltas/node-csv-stringify

1
2	`<pre>`
3	`_ _ _ _____ _______ __`
4	`\| \ \| \| \| \| / ____\|/ ____\ \ / /`
5	`\| \\| \| ___ __\| \| ___ \| \| \| (___ \ \ / /`
6	\| . ` \|/ _ \ / _` \|/ _ \\| \| \___ \ \ \/ /
7	`\| \|\ \| (_) \| (_\| \| __/\| \|____ ____) \| \ /`
8	`\|_\| \_\|\___/ \__,_\|\___\| \_____\|_____/ \/ New BSD License`
9
10	`</pre>`
11
12	`This project provides CSV generation, parsing, transformation and serialization`
13	`for Node.js.`
14
15	`It has been tested and used by a large community over the years and should be`
16	`considered reliable. It provides every option you would expect from an advanced`
17	`CSV parser and stringifier.`
18
19	`[![NPM](https://nodei.co/npm/csv.png?stars&downloads)](https://nodei.co/npm/csv/) [![NPM](https://nodei.co/npm-dl/csv.png)](https://nodei.co/npm/csv/)`
20
21	The `csv` package is itself split into 4 packages:
22
23	* [`csv-generate`](https://csv.js.org/generate/),
24	`a flexible generator of CSV string and Javascript objects.`
25	`[![Build Status](https://secure.travis-ci.org/adaltas/node-csv-generate.svg?branch=master)][travis-csv-generate]`
26	* [`csv-parse`](https://csv.js.org/parse/),
27	`a parser converting CSV text into arrays or objects.`
28	`[![Build Status](https://secure.travis-ci.org/adaltas/node-csv-parse.svg?branch=master)][travis-csv-parse]`
29	* [`stream-transform`](https://csv.js.org/transform/),
30	`a transformation framework.`
31	`[![Build Status](https://secure.travis-ci.org/adaltas/node-stream-transform.svg?branch=master)][travis-stream-transform]`
32	* [`csv-stringify`](https://csv.js.org/stringify/),
33	`a stringifier converting records into a CSV text.`
34	`[![Build Status](https://secure.travis-ci.org/adaltas/node-csv-stringify.svg?branch=master)][travis-csv-stringify]`
35
36	`## Documentation`
37
38	`The full documentation for the current version is available [here](https://csv.js.org).`
39
40	`## Usage`
41
42	Installation command is `npm install csv`.
43
44	`Each package is fully compatible with the stream 2 and 3 specifications.`
45	`Also, a simple callback-based API is always provided for convenience.`
46
47	`## Development`
48
49	`This parent project doesn't have tests itself but instead delegates the`
50	`tests to its child projects.`
51
52	`Read the documentation of the child projects for additional information.`
53
54	`## Related projects`
55
56	`* Pavel Kolesnikov "ya-csv": <http://github.com/koles/ya-csv>`
57	`* Chris Williams "node-csv": <http://github.com/voodootikigod/node-csv>`
58	`* Mat Holt "PapaParse": <https://github.com/mholt/PapaParse>`
59
60	`[travis]: https://travis-ci.org/`
61	`[travis-csv-generate]: http://travis-ci.org/adaltas/node-csv-generate`
62	`[travis-csv-parse]: http://travis-ci.org/adaltas/node-csv-parse`
63	`[travis-stream-transform]: http://travis-ci.org/adaltas/node-stream-transform`
64	`[travis-csv-stringify]: http://travis-ci.org/adaltas/node-csv-stringify`