Installation
npm install --save @types/objects-to-csv
Summary
This package contains type definitions for objects-to-csv (https://github.com/anton-bot/objects-to-csv#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/objects-to-csv.
declare class ObjectsToCsv {
/**
* Creates a new instance of the object array to csv converter.
*/
constructor(data: object[]);
/**
* Holds data to be converted.
*/
data: object[];
/**
* Saves the CSV file to the specified file.
* @param filename The path and filename of the new CSV file.
* @param options The options for writing to disk.
* @param options.append Whether to append to file. Default is overwrite (false).
* @param options.bom Append the BOM mark so that Excel shows
* @param options.allColumns Whether to check all items for column names or only the first. Default is the first.
* @returns Data converted to a CSV string.
*/
toDisk(
filename: string,
options?: {
append?: boolean | undefined;
bom?: boolean | undefined;
allColumns?: boolean | undefined;
},
): Promise<string>;
/**
* Returns the CSV file as string.
* @param header - If false, omit the first row containing the
* column names.
* @param allColumns - Whether to check all items for column names.
* Uses only the first item if false.
*/
toString(header?: boolean, allColumns?: boolean): Promise<string>;
/**
* Private method to run the actual conversion of array of objects to CSV data.
* @param data Data to be converted.
* @param header Whether the first line should contain column headers.
* @param allColumns Whether to check all items for column names.
* Uses only the first item if false.
* @returns Data converted to a CSV string.
*/
convert(data: object[], header?: boolean, allColumns?: boolean): Promise<string>;
}
export = ObjectsToCsv;
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:39 GMT
- Dependencies: none
Credits
These definitions were written by Tom Plant.
