@types/objects-to-csv
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.1 • Public • Published

    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.

    index.d.ts

    // Type definitions for objects-to-csv 1.3
    // Project: https://github.com/anton-bot/objects-to-csv#readme
    // Definitions by: Tom Plant <https://github.com/pl4nty>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    
    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: Thu, 08 Jul 2021 18:51:44 GMT
    • Dependencies: none
    • Global values: none

    Credits

    These definitions were written by Tom Plant.

    Keywords

    none

    Install

    npm i @types/objects-to-csv

    DownloadsWeekly Downloads

    34,643

    Version

    1.3.1

    License

    MIT

    Unpacked Size

    6.59 kB

    Total Files

    4

    Last publish

    Collaborators

    • types