Skip to content

Update index.js #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
baanshabriri wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update index.js #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
feb2bc4
Update index.js
baanshabriri Jul 20, 2023
228ad7e
Update index.js
baanshabriri Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ class ObjectsToCsv {
* @param {boolean} [options.append] - Whether to append to file. Default is overwrite (false).
* @param {boolean} [options.bom] - Append the BOM mark so that Excel shows
* @param {boolean} [options.allColumns] - Whether to check all items for column names or only the first. Default is the first.
* @param {boolean} [options.sortColumns] - Whether to sort columns names alphabetically. If false, maintains
* the order of keys in the object
* Unicode correctly.
*/
async toDisk(filename, options) {
Expand All @@ -53,7 +55,9 @@ class ObjectsToCsv {
? options.allColumns
: false;

let data = await this.toString(addHeader, allColumns);
const sortColumns = options.sortColumns ? options.sortColumns : true;

let data = await this.toString(addHeader, allColumns, sortColumns);
// Append the BOM mark if requested at the beginning of the file, otherwise
// Excel won't show Unicode correctly. The actual BOM mark will be EF BB BF,
// see https://stackoverflow.com/a/27975629/6269864 for details.
Expand Down Expand Up @@ -91,9 +95,11 @@ class ObjectsToCsv {
* @param {boolean} allColumns - Whether to check all items for column names.
* Uses only the first item if false.
* @returns {Promise<string>}
* @param {boolean} sortColumns - Whether to sort columns names alphabetically. If false, maintains
* the order of keys in the object
*/
async toString(header = true, allColumns = false) {
return await convert(this.data, header, allColumns);
async toString(header = true, allColumns = false, sortColumns = true) {
return await convert(this.data, header, allColumns, sortColumns);
}
}

Expand All @@ -102,10 +108,12 @@ class ObjectsToCsv {
* @param {object[]} data
* @param {boolean} header - Whether the first line should contain column headers.
* @param {boolean} allColumns - Whether to check all items for column names.
* @param {boolean} [options.sortColumns] - Whether to sort columns names alphabetically. If false, maintains
* the order of keys in the object
* Uses only the first item if false.
* @returns {string}
*/
async function convert(data, header = true, allColumns = false) {
async function convert(data, header = true, allColumns = false, sortColumns = true) {
if (data.length === 0) {
return '';
}
Expand All @@ -119,7 +127,7 @@ async function convert(data, header = true, allColumns = false) {
}, new Set())]
: Object.keys(data[0]); // just figure out columns from the first item in array

if (allColumns) {
if (allColumns && sortColumns) {
columnNames.sort(); // for predictable order of columns
}

Expand Down