Function parse

parse<const CSVSource extends CSVString>(
csv: CSVSource,
): AsyncIterableIterator<CSVObjectRecord<PickCSVHeader<CSVSource>>>

Parse CSV to records.

String, ReadableStream<string | Uint8Array>, Response, Request, Blob, and File are supported.

Type Parameters

const CSVSource extends CSVString

Parameters

csv: CSVSource
CSV string to parse.

Returns AsyncIterableIterator<CSVObjectRecord<PickCSVHeader<CSVSource>>>

Async iterable iterator of records.

If you want array of records, use parse.toArray function.

Remarks

parseString, parseBinary, parseBinaryStream, parseStringStream, parseResponse, parseRequest, and parseBlob are used internally.

If you known the type of the CSV, it performs better to use them directly.

If you want to parse a...	Use...	Options...
String	parseString	ParseOptions
ReadableStream<String>	parseStringStream	ParseOptions
Uint8Array \| ArrayBuffer	parseBinary	ParseBinaryOptions
ReadableStream<Uint8Array>	parseBinaryStream	ParseBinaryOptions
Response	parseResponse	ParseBinaryOptions
Request	parseRequest	ParseBinaryOptions
Blob \| File	parseBlob	ParseBinaryOptions

Performance Characteristics:

Memory usage: O(1) - constant per record (streaming approach)
Suitable for: Files of any size, browser and server environments
Recommended for: Large files (> 10MB) or memory-constrained environments

This function processes CSV data as an async iterable iterator, yielding one record at a time. Memory footprint remains constant regardless of file size, making it ideal for large datasets.

Example: Parsing CSV files from strings

import { parse } from 'web-csv-toolbox';

const csv = `name,age
Alice,42
Bob,69`;

for await (const record of parse(csv)) {
  console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files from streams

import { parse } from 'web-csv-toolbox';

const csv = `name,age
Alice,42
Bob,69`;

const stream = new ReadableStream({
  start(controller) {
    controller.enqueue(csv);
    controller.close();
  }
});

for await (const record of parse(stream)) {
 console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files with headers

import { parse } from 'web-csv-toolbox';

// This CSV has no header.
const csv = `Alice,42
Bob,69`;

for await (const record of parse(csv, { header: ['name', 'age'] })) {
 console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files with different delimiters characters

import { parse } from 'web-csv-toolbox';

const csv = `name\tage
Alice\t42
Bob\t69`;

for await (const record of parse(csv, { delimiter: '\t' })) {
console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

parse<const Header extends readonly string[]>(
csv: CSVString,
): AsyncIterableIterator<CSVObjectRecord<Header>>

Parse CSV to records.

String, ReadableStream<string | Uint8Array>, Response, Request, Blob, and File are supported.

Type Parameters

const Header extends readonly string[]
Header type like ['name', 'age'].

Parameters

csv: CSVString
CSV string to parse.

Returns AsyncIterableIterator<CSVObjectRecord<Header>>

Async iterable iterator of records.

If you want array of records, use parse.toArray function.

Remarks

parseString, parseBinary, parseBinaryStream, parseStringStream, parseResponse, parseRequest, and parseBlob are used internally.

If you known the type of the CSV, it performs better to use them directly.

If you want to parse a...	Use...	Options...
String	parseString	ParseOptions
ReadableStream<String>	parseStringStream	ParseOptions
Uint8Array \| ArrayBuffer	parseBinary	ParseBinaryOptions
ReadableStream<Uint8Array>	parseBinaryStream	ParseBinaryOptions
Response	parseResponse	ParseBinaryOptions
Request	parseRequest	ParseBinaryOptions
Blob \| File	parseBlob	ParseBinaryOptions

Performance Characteristics:

Memory usage: O(1) - constant per record (streaming approach)
Suitable for: Files of any size, browser and server environments
Recommended for: Large files (> 10MB) or memory-constrained environments

This function processes CSV data as an async iterable iterator, yielding one record at a time. Memory footprint remains constant regardless of file size, making it ideal for large datasets.

Example: Parsing CSV files from strings

import { parse } from 'web-csv-toolbox';

const csv = `name,age
Alice,42
Bob,69`;

for await (const record of parse(csv)) {
  console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files from streams

import { parse } from 'web-csv-toolbox';

const csv = `name,age
Alice,42
Bob,69`;

const stream = new ReadableStream({
  start(controller) {
    controller.enqueue(csv);
    controller.close();
  }
});

for await (const record of parse(stream)) {
 console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files with headers

import { parse } from 'web-csv-toolbox';

// This CSV has no header.
const csv = `Alice,42
Bob,69`;

for await (const record of parse(csv, { header: ['name', 'age'] })) {
 console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files with different delimiters characters

import { parse } from 'web-csv-toolbox';

const csv = `name\tage
Alice\t42
Bob\t69`;

for await (const record of parse(csv, { delimiter: '\t' })) {
console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

parse<
    const CSVSource extends CSVString,
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Header extends
        readonly string[] = PickCSVHeader<CSVSource, Delimiter, Quotation>,
    const Options extends
        ParseOptions<Header, Delimiter, Quotation> = ParseOptions<
        Header,
        Delimiter,
        Quotation,
    >,
>(
    csv: CSVSource,
    options: Options,
): AsyncIterableIterator<InferCSVRecord<Header, Options>>

Parse CSV to records.

String, ReadableStream<string | Uint8Array>, Response, Request, Blob, and File are supported.

Type Parameters

const CSVSource extends CSVString
const Delimiter extends string = ","
const Quotation extends string = "\""
const Header extends readonly string[] = PickCSVHeader<CSVSource, Delimiter, Quotation>
Header type like ['name', 'age'].
const Options extends ParseOptions<Header, Delimiter, Quotation> = ParseOptions<Header, Delimiter, Quotation>

Parameters

csv: CSVSource
CSV string to parse.
options: Options
Parsing options for CSV string parsing.

Returns AsyncIterableIterator<InferCSVRecord<Header, Options>>

Async iterable iterator of records.

If you want array of records, use parse.toArray function.

Remarks

parseString, parseBinary, parseBinaryStream, parseStringStream, parseResponse, parseRequest, and parseBlob are used internally.

If you known the type of the CSV, it performs better to use them directly.

If you want to parse a...	Use...	Options...
String	parseString	ParseOptions
ReadableStream<String>	parseStringStream	ParseOptions
Uint8Array \| ArrayBuffer	parseBinary	ParseBinaryOptions
ReadableStream<Uint8Array>	parseBinaryStream	ParseBinaryOptions
Response	parseResponse	ParseBinaryOptions
Request	parseRequest	ParseBinaryOptions
Blob \| File	parseBlob	ParseBinaryOptions

Performance Characteristics:

Memory usage: O(1) - constant per record (streaming approach)
Suitable for: Files of any size, browser and server environments
Recommended for: Large files (> 10MB) or memory-constrained environments

This function processes CSV data as an async iterable iterator, yielding one record at a time. Memory footprint remains constant regardless of file size, making it ideal for large datasets.

Example: Parsing CSV files from strings

import { parse } from 'web-csv-toolbox';

const csv = `name,age
Alice,42
Bob,69`;

for await (const record of parse(csv)) {
  console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files from streams

import { parse } from 'web-csv-toolbox';

const csv = `name,age
Alice,42
Bob,69`;

const stream = new ReadableStream({
  start(controller) {
    controller.enqueue(csv);
    controller.close();
  }
});

for await (const record of parse(stream)) {
 console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files with headers

import { parse } from 'web-csv-toolbox';

// This CSV has no header.
const csv = `Alice,42
Bob,69`;

for await (const record of parse(csv, { header: ['name', 'age'] })) {
 console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files with different delimiters characters

import { parse } from 'web-csv-toolbox';

const csv = `name\tage
Alice\t42
Bob\t69`;

for await (const record of parse(csv, { delimiter: '\t' })) {
console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

parse<
    const Header extends readonly string[],
    const Options extends
        ParseOptions<Header, ",", "\""> = ParseOptions<Header, ",", "\"">,
>(
    csv: CSVString,
    options: Options,
): AsyncIterableIterator<InferCSVRecord<Header, Options>>

Parse CSV to records.

String, ReadableStream<string | Uint8Array>, Response, Request, Blob, and File are supported.

Type Parameters

const Header extends readonly string[]
Header type like ['name', 'age'].
const Options extends ParseOptions<Header, ",", "\""> = ParseOptions<Header, ",", "\"">

Parameters

csv: CSVString
CSV string to parse.
options: Options
Parsing options for CSV string parsing.

Returns AsyncIterableIterator<InferCSVRecord<Header, Options>>

Async iterable iterator of records.

If you want array of records, use parse.toArray function.

Remarks

parseString, parseBinary, parseBinaryStream, parseStringStream, parseResponse, parseRequest, and parseBlob are used internally.

If you known the type of the CSV, it performs better to use them directly.

If you want to parse a...	Use...	Options...
String	parseString	ParseOptions
ReadableStream<String>	parseStringStream	ParseOptions
Uint8Array \| ArrayBuffer	parseBinary	ParseBinaryOptions
ReadableStream<Uint8Array>	parseBinaryStream	ParseBinaryOptions
Response	parseResponse	ParseBinaryOptions
Request	parseRequest	ParseBinaryOptions
Blob \| File	parseBlob	ParseBinaryOptions

Performance Characteristics:

Memory usage: O(1) - constant per record (streaming approach)
Suitable for: Files of any size, browser and server environments
Recommended for: Large files (> 10MB) or memory-constrained environments

This function processes CSV data as an async iterable iterator, yielding one record at a time. Memory footprint remains constant regardless of file size, making it ideal for large datasets.

Example: Parsing CSV files from strings

import { parse } from 'web-csv-toolbox';

const csv = `name,age
Alice,42
Bob,69`;

for await (const record of parse(csv)) {
  console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files from streams

import { parse } from 'web-csv-toolbox';

const csv = `name,age
Alice,42
Bob,69`;

const stream = new ReadableStream({
  start(controller) {
    controller.enqueue(csv);
    controller.close();
  }
});

for await (const record of parse(stream)) {
 console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files with headers

import { parse } from 'web-csv-toolbox';

// This CSV has no header.
const csv = `Alice,42
Bob,69`;

for await (const record of parse(csv, { header: ['name', 'age'] })) {
 console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

Example: Parsing CSV files with different delimiters characters

import { parse } from 'web-csv-toolbox';

const csv = `name\tage
Alice\t42
Bob\t69`;

for await (const record of parse(csv, { delimiter: '\t' })) {
console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }

parse<
    const Header extends readonly string[],
    const Options extends
        ParseBinaryOptions<Header, ",", "\""> = ParseBinaryOptions<
        Header,
        ",",
        "\"",
    >,
>(
    csv: CSVBinary,
    options?: Options,
): AsyncIterableIterator<InferCSVRecord<Header, Options>>
Parse CSV binary to records.
Type Parameters
- const Header extends readonly string[]
- const Options extends ParseBinaryOptions<Header, ",", "\""> = ParseBinaryOptions<Header, ",", "\"">
Parameters
- csv: CSVBinary
  CSV binary to parse.
- Optionaloptions: Options
  Parsing options for CSV binary parsing.
Returns AsyncIterableIterator<InferCSVRecord<Header, Options>>
Example: Parsing CSV files from responses
```
import { parse } from 'web-csv-toolbox';

// This CSV data is not gzipped and encoded in utf-8.
const response = await fetch('https://example.com/data.csv');

for await (const record of parse(response)) {
  // ...
}
```
Example: Parsing CSV files with options spcialized for binary
```
import { parse } from 'web-csv-toolbox';

// This CSV data is gzipped and encoded in shift-jis and has BOM.
const response = await fetch('https://example.com/data.csv.gz');

for await (const record of parse(response, {
  charset: 'shift-jis',
  ignoreBOM: true,
  decompression: 'gzip',
})) {
  // ...
}
```
- Defined in src/parser/api/parse.ts:203

Function parse

Type Parameters

Parameters

Returns AsyncIterableIterator<CSVObjectRecord<PickCSVHeader<CSVSource>>>

Remarks

Example: Parsing CSV files from strings

Example: Parsing CSV files from streams

Example: Parsing CSV files with headers

Example: Parsing CSV files with different delimiters characters

Type Parameters

Parameters

Returns AsyncIterableIterator<CSVObjectRecord<Header>>

Remarks

Example: Parsing CSV files from strings

Example: Parsing CSV files from streams

Example: Parsing CSV files with headers

Example: Parsing CSV files with different delimiters characters

Type Parameters

Parameters

Returns AsyncIterableIterator<InferCSVRecord<Header, Options>>

Remarks

Example: Parsing CSV files from strings

Example: Parsing CSV files from streams

Example: Parsing CSV files with headers

Example: Parsing CSV files with different delimiters characters

Type Parameters

Parameters

Returns AsyncIterableIterator<InferCSVRecord<Header, Options>>

Remarks

Example: Parsing CSV files from strings

Example: Parsing CSV files from streams

Example: Parsing CSV files with headers

Example: Parsing CSV files with different delimiters characters

Type Parameters

Parameters

Returns AsyncIterableIterator<InferCSVRecord<Header, Options>>

Example: Parsing CSV files from responses

Example: Parsing CSV files with options spcialized for binary

Settings