SheetXL - v0.3.20
    Preparing search index...

    Interface WriteCSVOptions

    Options for exporting to CSV file format.

    The default options mimic Excel 2024.

    interface WriteCSVOptions {
        excludeHidden?: boolean;
        formatType?: string;
        papaParseConfig?: UnparseConfig;
        sheetKey?: string | number;
        trimLeadingBlankColumn?: boolean;
        trimLeadingBlankRow?: boolean;
    }
    Index

    Properties

    excludeHidden? formatType? papaParseConfig? sheetKey? trimLeadingBlankColumn? trimLeadingBlankRow?

    Properties

    excludeHidden?: boolean

    Indicate whether hidden columns and rows are skipped in the CSV output.

    false
    formatType?: string

    Optional file type hint (extension, MIME type, or export key).

    Used for type detection when it cannot be inferred from the destination. Examples: 'xlsx', 'csv', 'application/json', 'Excel'

    papaParseConfig?: UnparseConfig

    configuration for csv export

    CSV parse delegates to the excellent Papa Parse library. All options are exposes via papParseConfig.

    https://www.papaparse.com/docs#unparse-config-default

    sheetKey?: string | number

    Specify the tab to export.

    CSV Will only export one tab. By default this is the active tab. To change this pass a SheetKey.

    'the current active tab'
    trimLeadingBlankColumn?: boolean

    Indicates whether the leading blank columns should be trimmed.

    true
    trimLeadingBlankRow?: boolean

    Indicates whether the leading blank rows should be trimmed.

    false

    Settings

    Member Visibility

    On This Page

    Properties