Type Alias StringifyOptions

StringifyOptions: {
    bom?: boolean;
    columns?: readonly Column[];
    headers?: boolean;
    separator?: string;
}

Options for stringify.

Type declaration

  • Optionalbom?: boolean

    Whether to add a byte-order mark to the beginning of the file content. Required by software such as MS Excel to properly display Unicode text.

    {false}
    
  • Optionalcolumns?: readonly Column[]

    A list of instructions for how to target and transform the data for each column of output. This is also where you can provide an explicit header name for the column.

    {[]}
    
  • Optionalheaders?: boolean

    Whether to include the row of headers or not.

    {true}
    
  • Optionalseparator?: string

    Delimiter used to separate values. Examples:

    • "," comma
    • "\t" tab
    • "|" pipe
    • etc.
    {","}