silverwind / save-csv

Download an array of objects as a CSV file in the browser

save-csv

Download an array of objects as a CSV file in the browser

save-csv is a tiny library (892 bytes gzipped) that creates an CSV file from a array of objects with matching keys and triggers a download in the browser. Features:

• Automatically detects the value separator (usually ,) based on the user's regional settings.
• Saves UTF8 by default and helps Excel to recognize this by adding a byte order mark.
• Fully configurable. Every output character can be modified via options.

Example

<script src="save-csv.min.js"></script>

saveCsv([
  {a:1, b:2},
  {a:3, b:4},
]);

Output

a,b
1,2
3,4

API

save-csv(array, [options])

• array Array: An array containing objects with matching keys.
• options Object
  • filename string: The filename to save to. Default: export.csv.
  • sep string: The value separator (usually ,). Recognizes the special value auto with which automatic detection based on the user's regional settings is attempted (See #1). Default: auto.
  • eol string: The line separator. Default: \r\n.
  • quote string: The quote character to use. Default: ".
  • bom boolean: Whether to include a byte order mark in the output. Default: true.
  • mime string: The mime type for the file. Default: text/csv;charset=utf-8.
  • formatter Function: A custom formatter function for values. The default function handles sep in values and uses JSON.stringify for complex values. Receives value.

© silverwind, distributed under BSD licence

save-csv's Issues

Support nested objects

saveCsv([{a:{c:1},b:2},{a:{c:3},b:4}]);

should output

a.c,b
1,2
3,4

Browser bugs regarding autodetection

Firefox: https://bugzilla.mozilla.org/show_bug.cgi?id=1388777
Chrome: https://bugs.chromium.org/p/chromium/issues/detail?id=753841

Option "sep" doesn't work for body-data

The "sep" option dosn't work, because it is misspelled in the body data routine.

It would be nice to set custom headers

Now items is an objects, and all key added as first row in csv with keys as values.
e.x. first_name.
sometimes these headings are not suitable for exporting. Especially when you need to make a multilingual application.

I can add the headers I need as the first line of data myself. But at the same time I can not disable the output of the first line with the keys.
It would be nice to add this feature to the options.
or if such an opportunity already exists, tell me how can i do it) Thanks!

Reserved keyword (like __proto__) and duplicated value for header is not supported

• Because of Object.keys({ __proto__: 1 }) === [], cannot pass in __proto__ as header value.
• Duplicated header value is not supported.

They are both since object key is used for specifying header value.
Because we pass in user name as header value, they can be problematic.