Class Csv<T, I>

Main CSV parser class for parsing complete CSV documents. Supports reading headers, streaming rows, and converting rows to objects.

Type Param: O

The output type after optional transformation (defaults to T)

Example

// Parse CSV with headers
const csv = new Csv(fileStream)
for await (const row of csv.streamObjectsAsync()) {
  console.log(row)
}

Type Parameters

T extends object
The object type for each row when reading as objects
I = unknown

Hierarchy (View Summary)

CsvEntity<T[], CsvRow<T, I>>
- Csv

Constructors

constructor

new Csv<T extends object, I = unknown>(
    asyncIterable?: ByteBuffer | ByteStream<T>,
    options?: CsvEntityOptions & {
        headers?: string[];
        ignoreUtf8Bom?: boolean;
        includeExtraCells?: boolean;
        readHeaders?: boolean;
        shape?: CsvObjectShape<T>;
        strictColumns?: boolean;
        transform?: (row: I) => T;
    },
): Csv<T, I>
Creates a new CSV parser.
Type Parameters
- T extends object
  The object type for each row when reading as objects
- I = unknown
Parameters
- OptionalasyncIterable: ByteBuffer | ByteStream<T>
  Optional byte stream or buffer containing CSV data
- Optionaloptions: CsvEntityOptions & {
      headers?: string[];
      ignoreUtf8Bom?: boolean;
      includeExtraCells?: boolean;
      readHeaders?: boolean;
      shape?: CsvObjectShape<T>;
      strictColumns?: boolean;
      transform?: (row: I) => T;
  }
  Configuration options for CSV parsing
Returns Csv<T, I>
Throws
If both headers and shape options are specified
Overrides CsvEntity.constructor
- Defined in packages/csv-stream-lite/src/parser.ts:630

Properties

byteBuffer

byteBuffer: ByteBuffer

consumed

consumed: boolean = false

escapeChar

escapeChar: string = '"'

`Optional`headers

headers?: string[]

ignoreUtf8Bom

ignoreUtf8Bom: boolean = true

includeExtraCells

includeExtraCells: boolean = false

`Optional`newline

newline?: string

quoteChar

quoteChar: string = '"'

readHeaders

readHeaders: boolean = true

separator

separator: string = ','

`Optional`shape

shape?: CsvObjectShape<T>

strictColumns

strictColumns: boolean = false

`Optional`transform

transform?: (row: I) => T

trim

trim: boolean = false

Accessors

allowBufferToBeExceeded

get allowBufferToBeExceeded(): boolean
Returns boolean
Inherited from CsvEntity.allowBufferToBeExceeded
- Defined in packages/csv-stream-lite/src/parser.ts:128
set allowBufferToBeExceeded(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from CsvEntity.allowBufferToBeExceeded
- Defined in packages/csv-stream-lite/src/parser.ts:124

maxBufferSize

get maxBufferSize(): number
Returns number
Inherited from CsvEntity.maxBufferSize
- Defined in packages/csv-stream-lite/src/parser.ts:120
set maxBufferSize(size: number): void
Parameters
- size: number
Returns void
Inherited from CsvEntity.maxBufferSize
- Defined in packages/csv-stream-lite/src/parser.ts:116

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<CsvRow<T, I>>
Makes this entity async iterable using the asynchronous stream.

Returns AsyncGenerator<CsvRow<T, I>>
An async generator that yields values of type S
Inherited from CsvEntity.[asyncIterator]
- Defined in packages/csv-stream-lite/src/parser.ts:234

[iterator]

"[iterator]"(): Generator<CsvRow<T, I>>
Makes this entity iterable using the synchronous stream.

Returns Generator<CsvRow<T, I>>
A generator that yields values of type S
Inherited from CsvEntity.[iterator]
- Defined in packages/csv-stream-lite/src/parser.ts:225

consume

consume(): void
Consumes the entity if it hasn't been consumed yet. This ensures the buffer advances to the end of this entity.

Returns void
Inherited from CsvEntity.consume
- Defined in packages/csv-stream-lite/src/parser.ts:202

consumeAsync

consumeAsync(): Promise<void>
Asynchronously consumes the entity if it hasn't been consumed yet. This ensures the buffer advances to the end of this entity.

Returns Promise<void>
A promise that resolves when consumption is complete
Inherited from CsvEntity.consumeAsync
- Defined in packages/csv-stream-lite/src/parser.ts:214

`Protected`parse

parse(): T[]
Returns T[]
Overrides CsvEntity.parse
- Defined in packages/csv-stream-lite/src/parser.ts:686

`Protected`parseAsync

parseAsync(): Promise<T[]>
Returns Promise<T[]>
Overrides CsvEntity.parseAsync
- Defined in packages/csv-stream-lite/src/parser.ts:690

read

read(): T[]
Reads and parses the entire entity synchronously. Marks the entity as consumed after reading.

Returns T[]
The parsed result of type T
Inherited from CsvEntity.read
- Defined in packages/csv-stream-lite/src/parser.ts:142

readAsync

readAsync(): Promise<T[]>
Reads and parses the entire entity asynchronously. Marks the entity as consumed after reading.

Returns Promise<T[]>
A promise that resolves to the parsed result of type T
Inherited from CsvEntity.readAsync
- Defined in packages/csv-stream-lite/src/parser.ts:154

stream

stream(): Generator<CsvRow<T, I>>
Returns a synchronous generator that yields chunks of type S. Marks the entity as consumed when iteration completes.

Returns Generator<CsvRow<T, I>>
A generator that yields values of type S
Inherited from CsvEntity.stream
- Defined in packages/csv-stream-lite/src/parser.ts:166

streamAsync

streamAsync(): AsyncGenerator<CsvRow<T, I>>
Returns an asynchronous generator that yields chunks of type S. Handles buffering and automatically reads more data as needed.

Returns AsyncGenerator<CsvRow<T, I>>
An async generator that yields values of type S
Inherited from CsvEntity.streamAsync
- Defined in packages/csv-stream-lite/src/parser.ts:178

`Protected`streamImpl

streamImpl(): Generator<CsvRow<T, unknown>>
Returns Generator<CsvRow<T, unknown>>
Overrides CsvEntity.streamImpl
- Defined in packages/csv-stream-lite/src/parser.ts:698

streamObjects

streamObjects(): Generator<T>
Synchronously streams CSV rows as objects. Reads headers from the first row if readHeaders is true.

Returns Generator<T>
A generator that yields parsed objects of type O
Example
```
const csv = new Csv(csvString)
for (const row of csv.streamObjects()) {
  console.log(row)
}
```
- Defined in packages/csv-stream-lite/src/parser.ts:725

streamObjectsAsync

streamObjectsAsync(): AsyncGenerator<T>
Asynchronously streams CSV rows as objects. Automatically handles buffer refills as needed.

Returns AsyncGenerator<T>
An async generator that yields parsed objects of type O
Example
```
const csv = new Csv(fileStream)
for await (const row of csv.streamObjectsAsync()) {
  console.log(row)
}
```
- Defined in packages/csv-stream-lite/src/parser.ts:775

`Static`stringifier

stringifier<T extends object, O extends object = T>(
values: T[],
options?: CsvStringifyOptions<T, T extends O ? T<T> : O>,
): CsvStringify<T, T extends O ? T<T> : O>
Static method to create a CsvStringify instance for advanced usage.
Type Parameters
- T extends object
  The input object type
- O extends object = T
  The output object type after optional transformation (defaults to T)
Parameters
- values: T[]
  Array of objects to convert to CSV
- Optionaloptions: CsvStringifyOptions<T, T extends O ? T<T> : O>
  Optional configuration for CSV stringification
Returns CsvStringify<T, T extends O ? T<T> : O>
A CsvStringify instance
- Defined in packages/csv-stream-lite/src/parser.ts:854

`Static`stringify

stringify<T extends object, O extends object = T>(
values: T[],
options?: CsvStringifyOptions<T, T extends O ? T<T> : O>,
): Generator<CsvString<T extends O ? T<T> : O>>
Static method to stringify an array of objects into CSV format. Returns a synchronous generator that yields CSV string chunks.
Type Parameters
- T extends object
  The input object type
- O extends object = T
  The output object type after optional transformation (defaults to T)
Parameters
- values: T[]
  Array of objects to convert to CSV
- Optionaloptions: CsvStringifyOptions<T, T extends O ? T<T> : O>
  Optional configuration for CSV stringification
Returns Generator<CsvString<T extends O ? T<T> : O>>
A generator that yields CSV string chunks
Example
```
const data = [{ name: 'Alice', age: 30 }, { name: 'Bob', age: 25 }]
for (const chunk of Csv.stringify(data, { headers: ['name', 'age'] })) {
  process.stdout.write(chunk)
}
```
- Defined in packages/csv-stream-lite/src/parser.ts:813

`Static`stringifyAsync

stringifyAsync<T extends object, O extends object = T>(
values: T[],
options?: CsvStringifyOptions<T, T extends O ? T<T> : O>,
): AsyncGenerator<CsvString<T extends O ? T<T> : O>>
Static method to stringify an array of objects into CSV format asynchronously. Returns an asynchronous generator that yields CSV string chunks.
Type Parameters
- T extends object
  The input object type
- O extends object = T
  The output object type after optional transformation (defaults to T)
Parameters
- values: T[]
  Array of objects to convert to CSV
- Optionaloptions: CsvStringifyOptions<T, T extends O ? T<T> : O>
  Optional configuration for CSV stringification
Returns AsyncGenerator<CsvString<T extends O ? T<T> : O>>
An async generator that yields CSV string chunks
Example
```
const data = [{ name: 'Alice', age: 30 }, { name: 'Bob', age: 25 }]
for await (const chunk of Csv.stringifyAsync(data)) {
  process.stdout.write(chunk)
}
```
- Defined in packages/csv-stream-lite/src/parser.ts:838

Class Csv<T, I>

Type Param: O

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Csv<T, I>

Throws

Properties

byteBuffer

consumed

escapeChar

Optionalheaders

ignoreUtf8Bom

includeExtraCells

Optionalnewline

quoteChar

readHeaders

separator

Optionalshape

strictColumns

Optionaltransform

trim

Accessors

allowBufferToBeExceeded

Returns boolean

Parameters

Returns void

maxBufferSize

Returns number

Parameters

Returns void

Methods

[asyncIterator]

Returns AsyncGenerator<CsvRow<T, I>>

[iterator]

Returns Generator<CsvRow<T, I>>

consume

Returns void

consumeAsync

Returns Promise<void>

Protectedparse

Returns T[]

ProtectedparseAsync

Returns Promise<T[]>

read

Returns T[]

readAsync

Returns Promise<T[]>

stream

Returns Generator<CsvRow<T, I>>

streamAsync

Returns AsyncGenerator<CsvRow<T, I>>

ProtectedstreamImpl

Returns Generator<CsvRow<T, unknown>>

streamObjects

Returns Generator<T>

Example

streamObjectsAsync

Returns AsyncGenerator<T>

Example

Staticstringifier

Type Parameters

Parameters

Returns CsvStringify<T, T extends O ? T<T> : O>

Staticstringify

Type Parameters

Parameters

Returns Generator<CsvString<T extends O ? T<T> : O>>

Example

StaticstringifyAsync

Type Parameters

`Optional`headers

`Optional`newline

`Optional`shape

`Optional`transform

`Protected`parse

`Protected`parseAsync

`Protected`streamImpl

`Static`stringifier

`Static`stringify

`Static`stringifyAsync