Interface JsonToCsvStreamOptions

interface JsonToCsvStreamOptions {
    delimiter?: string;
    includeHeaders?: boolean;
    renameMap?: Record<string, string>;
    template?: Record<string, any>;
    maxRecords?: number;
    preventCsvInjection?: boolean;
    rfc4180Compliant?: boolean;
    normalizeQuotes?: boolean;
    flatten?: boolean;
    flattenSeparator?: string;
    flattenMaxDepth?: number;
    arrayHandling?: "join" | "stringify" | "expand";
    memoryWarningThreshold?: number;
    memoryLimit?: number;
    transform?: (row: Record<string, any>) => Record<string, any>;
    schema?: Record<string, any>;
    addBOM?: boolean;
}

Hierarchy (View Summary)

Properties

delimiter? includeHeaders? renameMap? template? maxRecords? preventCsvInjection? rfc4180Compliant? normalizeQuotes? flatten? flattenSeparator? flattenMaxDepth? arrayHandling? memoryWarningThreshold? memoryLimit? transform? schema? addBOM?

Properties

Optionaldelimiter

delimiter?: string

CSV delimiter (default: ';')

OptionalincludeHeaders

includeHeaders?: boolean

Include headers row (default: true)

OptionalrenameMap

renameMap?: Record<string, string>

Rename column headers { oldKey: newKey }

Optionaltemplate

template?: Record<string, any>

Template for guaranteed column order

OptionalmaxRecords

maxRecords?: number

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

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)

OptionalnormalizeQuotes

normalizeQuotes?: boolean

Normalize excessive quotes in JSON string values before CSV export (default: true)

Optionalflatten

flatten?: boolean

Whether to flatten nested objects into dot notation keys

OptionalflattenSeparator

flattenSeparator?: string

Separator for flattened keys (e.g., 'user.name' with '.')

OptionalflattenMaxDepth

flattenMaxDepth?: number

Maximum depth for flattening nested objects

OptionalarrayHandling

arrayHandling?: "join" | "stringify" | "expand"

How to handle arrays ('stringify', 'join', 'expand')

OptionalmemoryWarningThreshold

memoryWarningThreshold?: number

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

OptionalmemoryLimit

memoryLimit?: number

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

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

OptionaladdBOM

addBOM?: boolean

Add UTF-8 BOM for Excel compatibility (default: true)

Settings

Member Visibility

On This Page

Properties