Interface CsvToJsonStreamOptions

interface CsvToJsonStreamOptions {
    delimiter?: string;
    autoDetect?: boolean;
    candidates?: string[];
    hasHeaders?: boolean;
    renameMap?: Record<string, string>;
    trim?: boolean;
    parseNumbers?: boolean;
    parseBooleans?: boolean;
    maxRows?: number;
    useFastPath?: boolean;
    fastPathMode?: "objects" | "compact" | "stream";
    useCache?: boolean;
    cache?: any;
    hooks?: {
        beforeConvert?: (csv: string, options: CsvToJsonOptions) => string;
        perRow?: (
            row: Record<string, any>,
            index: number,
            context?: { options: CsvToJsonOptions },
        ) => Record<string, any>;
        afterConvert?: (result: any[], options: CsvToJsonOptions) => any[];
        transformHooks?: TransformHooks;
        onError?: (error: Error, csv: string, options: CsvToJsonOptions) => void;
    };
    preventCsvInjection?: boolean;
    rfc4180Compliant?: boolean;
    warnExtraFields?: boolean;
    onError?: "skip"
    | "warn"
    | "throw";
    errorHandler?: (error: Error, line: string, lineNumber: number) => void;
    memoryWarningThreshold?: number;
    memoryLimit?: number;
    repairRowShifts?: boolean;
    normalizeQuotes?: boolean;
    transform?: (row: Record<string, any>) => Record<string, any>;
    schema?: Record<string, any>;
}

Hierarchy (View Summary)

Properties

delimiter? autoDetect? candidates? hasHeaders? renameMap? trim? parseNumbers? parseBooleans? maxRows? useFastPath? fastPathMode? useCache? cache? hooks? preventCsvInjection? rfc4180Compliant? warnExtraFields? onError? errorHandler? memoryWarningThreshold? memoryLimit? repairRowShifts? normalizeQuotes? transform? schema?

Properties

Optionaldelimiter

delimiter?: string

CSV delimiter (default: auto-detected)

OptionalautoDetect

autoDetect?: boolean

Auto-detect delimiter if not specified (default: true)

Optionalcandidates

candidates?: string[]

Candidate delimiters for auto-detection (default: [';', ',', '\t', '|'])

OptionalhasHeaders

hasHeaders?: boolean

Whether CSV has headers row (default: true)

OptionalrenameMap

renameMap?: Record<string, string>

Map for renaming column headers { newKey: oldKey }

Optionaltrim

trim?: boolean

Trim whitespace from values (default: true)

OptionalparseNumbers

parseNumbers?: boolean

Parse numeric values (default: false)

OptionalparseBooleans

parseBooleans?: boolean

Parse boolean values (default: false)

OptionalmaxRows

maxRows?: number

Maximum number of rows to process (optional, no limit by default)

OptionaluseFastPath

useFastPath?: boolean

Enable fast-path parsing (default: true)

OptionalfastPathMode

fastPathMode?: "objects" | "compact" | "stream"

Fast-path output mode (default: 'objects')

OptionaluseCache

useCache?: boolean

Use delimiter cache for auto-detection (default: true)

Optionalcache

cache?: any

Custom delimiter cache instance

Optionalhooks

hooks?: {
    beforeConvert?: (csv: string, options: CsvToJsonOptions) => string;
    perRow?: (
        row: Record<string, any>,
        index: number,
        context?: { options: CsvToJsonOptions },
    ) => Record<string, any>;
    afterConvert?: (result: any[], options: CsvToJsonOptions) => any[];
    transformHooks?: TransformHooks;
    onError?: (error: Error, csv: string, options: CsvToJsonOptions) => void;
}

Hooks for custom processing

OptionalpreventCsvInjection

preventCsvInjection?: boolean

Prevent CSV injection attacks by escaping formulas (default: true)

Optionalrfc4180Compliant

rfc4180Compliant?: boolean

Ensure RFC 4180 compliance (proper quoting, line endings) (default: true)

OptionalwarnExtraFields

warnExtraFields?: boolean

Warn about extra fields not in headers (default: false)

OptionalonError

onError?: "skip" | "warn" | "throw"

Error recovery strategy for row-level errors (default: 'throw')

OptionalerrorHandler

errorHandler?: (error: Error, line: string, lineNumber: number) => void

Custom error handler for row-level errors

OptionalmemoryWarningThreshold

memoryWarningThreshold?: number

Warn when row count exceeds this threshold (default: 1000000)

OptionalmemoryLimit

memoryLimit?: number

Safety limit for in-memory conversion (default: 5000000). Set to Infinity to disable.

OptionalrepairRowShifts

repairRowShifts?: boolean

Attempt to repair shifted rows with trailing empty fields (default: true)

OptionalnormalizeQuotes

normalizeQuotes?: boolean

Normalize excessive quotes in parsed fields (default: true)

Optionaltransform

transform?: (row: Record<string, any>) => Record<string, any>

Custom transform function for each row

Optionalschema

schema?: Record<string, any>

JSON schema for validation and formatting

Settings

Member Visibility

On This Page

Properties