csv-stream-lite - v1.0.4
    Preparing search index...

    Interface CsvStringifyOptions<T, O>

    interface CsvStringifyOptions<T extends object = object, O extends object = T> {
        alwaysWriteHeaders?: boolean;
        delimiter?: string;
        escapeChar?: string;
        headers?: string[] | CsvObjectShape<T>;
        newline?: string;
        quoteChar?: string;
        transform?: (row: T) => O;
        writeBom?: boolean;
    }

    Type Parameters

    • T extends object = object
    • O extends object = T
    Index

    Properties

    alwaysWriteHeaders? delimiter? escapeChar? headers? newline? quoteChar? transform? writeBom?

    Properties

    alwaysWriteHeaders?: boolean

    Whether to always write headers, even if there are no records (default: false)

    delimiter?: string

    Character to separate fields (default: ',')

    escapeChar?: string

    Character to escape special characters (default: '"')

    headers?: string[] | CsvObjectShape<T>

    Optional array of headers to use as the first row. Optionally, pass in a CsvObjectShape to be used as headers

    newline?: string

    Newline character (default: '\n')

    quoteChar?: string

    Character to quote fields (default: '"')

    transform?: (row: T) => O

    Optional transform function to modify each record before stringifying

    writeBom?: boolean

    Whether to write a UTF-8 BOM at the start of the output (default: false)

    Settings

    Member Visibility

    On This Page

    Properties