columna API reference - v0.5.0
    Preparing search index...

    Type Alias ReadCsvOptions

    ReadCsvOptions: IoLoadOptions & {
        comment?: string;
        decimal?: string;
        delimiter?: string;
        dtypes?: Record<string, DType>;
        falseValues?: string | string[];
        hasHeader?: boolean;
        header?: boolean | number;
        names?: string[];
        nRows?: number;
        nullValues?: string | string[];
        quoteChar?: string;
        separator?: string;
        skipBlankLines?: boolean;
        skipInitialSpace?: boolean;
        skipRows?: number;
        thousands?: string;
        trueValues?: string | string[];
        usecols?: (string | number)[];
    }

    Type Declaration

    • Optionalcomment?: string

      Lines starting with this prefix are ignored.

    • Optionaldecimal?: string

      Decimal mark (default .).

    • Optionaldelimiter?: string

      Alias of separator (pandas-style).

    • Optionaldtypes?: Record<string, DType>

      Force column dtypes after parse.

    • OptionalfalseValues?: string | string[]

      Values treated as boolean false.

    • OptionalhasHeader?: boolean

      Polars alias for header !== false.

    • Optionalheader?: boolean | number

      First row is header (default true). Number = header row index after skipRows.

    • Optionalnames?: string[]

      Explicit column names (used when header is false, or to override).

    • OptionalnRows?: number

      Max data rows to read (after header).

    • OptionalnullValues?: string | string[]

      Values treated as null.

    • OptionalquoteChar?: string

      Quote character (default ").

    • Optionalseparator?: string

      Column separator (default ,). Alias of delimiter.

    • OptionalskipBlankLines?: boolean

      Skip empty lines (default true).

    • OptionalskipInitialSpace?: boolean

      Trim whitespace after delimiter (default false).

    • OptionalskipRows?: number

      Rows to skip at the start of the file (before header).

    • Optionalthousands?: string

      Thousands separator to strip before parsing numbers.

    • OptionaltrueValues?: string | string[]

      Values treated as boolean true.

    • Optionalusecols?: (string | number)[]

      Keep only these columns (names or 0-based indices).

    Settings
    Member Visibility