@bahmutov/csv

1.2.0 • Public • Published

csv

Transforms list of objects into CSV text

NPM

Build status semantic-release manpm standard style

Install

npm install --save @bahmutov/csv

Use

var csv = require('@bahmutov/csv')
// csv is object with 2 methods

Creating CSV from lists

var titles = ['Name', 'Age']
var values = [
    'Joe', 21,
    'Mary', 20
] 
csv.fromLists(titles, values);
/*
Name,Age
Joe,21
Mary,20
*/

You can pass maximum number of items as the last argument, returning a list of CSV texts

var titles = ['Name', 'Age']
var values = [
    'Joe', 21,
    'Mary', 20
]
var maxLines = 1
csv.fromLists(titles, values, maxLines);
/*
['Name,Age
Joe,21',
'Name,Age
Mary,20']
*/

Creating CSV from objects

You can select a subset of properties from an object.

var titles = ['Name', 'Age']
var properties = ['name', 'age']
var values = [
    {name: 'Joe', age: 21, sex: 'male' },
    {name: 'Mary', age: 20, sex: 'female' }
] 
csv.fromObjects(titles, properties, values);
/*
Name,Age
Joe,21
Mary,20
*/

This method also accepts max number of items in a single CSV, returning a list of strings in this case

csv.fromObjects(titles, properties, values, 1);
/*
[`Name,Age
Joe,21`,
`Name,Age
Mary,20`]
*/

Small print

Author: Gleb Bahmutov © 2015

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2015 Gleb Bahmutov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme

Keywords

Package Sidebar

Install

npm i @bahmutov/csv

Weekly Downloads

2

Version

1.2.0

License

MIT

Last publish

Collaborators

  • bahmutov