Function parse

parse<const CSVSource extends string | ReadableStream<string>>(
csv: CSVSource,
): AsyncIterableIterator<CSVRecord<PickCSVHeader<CSVSource>>>

Parse CSV to records.

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

Type Parameters

const CSVSource extends string | ReadableStream<string>

Parameters

csv: CSVSource
CSV string to parse.

Returns AsyncIterableIterator<CSVRecord<PickCSVHeader<CSVSource>>>

Async iterable iterator of records.

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

Remarks

parseString, parseBinary, parseUint8ArrayStream, parseStringStream and parseResponse 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>	parseUint8ArrayStream	ParseBinaryOptions
Response	parseResponse	ParseBinaryOptions

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: string | ReadableStream<string>,
): AsyncIterableIterator<CSVRecord<Header>>

Parse CSV to records.

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

Type Parameters

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

Parameters

csv: string | ReadableStream<string>
CSV string to parse.

Returns AsyncIterableIterator<CSVRecord<Header>>

Async iterable iterator of records.

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

Remarks

parseString, parseBinary, parseUint8ArrayStream, parseStringStream and parseResponse 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>	parseUint8ArrayStream	ParseBinaryOptions
Response	parseResponse	ParseBinaryOptions

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: string | ReadableStream<string>,
options: ParseOptions<Header>,
): AsyncIterableIterator<CSVRecord<Header>>

Parse CSV to records.

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

Type Parameters

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

Parameters

csv: string | ReadableStream<string>
CSV string to parse.
options: ParseOptions<Header>
Parsing options for CSV string parsing.

Returns AsyncIterableIterator<CSVRecord<Header>>

Async iterable iterator of records.

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

Remarks

parseString, parseBinary, parseUint8ArrayStream, parseStringStream and parseResponse 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>	parseUint8ArrayStream	ParseBinaryOptions
Response	parseResponse	ParseBinaryOptions

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 string
    | ReadableStream<string>,
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Header extends
        readonly string[] = PickCSVHeader<CSVSource, Delimiter, Quotation>,
>(
    csv: CSVSource,
    options: ParseOptions<Header, Delimiter, Quotation>,
): AsyncIterableIterator<CSVRecord<Header>>

Parse CSV to records.

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

Type Parameters

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

Parameters

csv: CSVSource
CSV string to parse.
options: ParseOptions<Header, Delimiter, Quotation>
Parsing options for CSV string parsing.

Returns AsyncIterableIterator<CSVRecord<Header>>

Async iterable iterator of records.

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

Remarks

parseString, parseBinary, parseUint8ArrayStream, parseStringStream and parseResponse 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>	parseUint8ArrayStream	ParseBinaryOptions
Response	parseResponse	ParseBinaryOptions

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: CSVBinary,
options?: ParseBinaryOptions<Header>,
): AsyncIterableIterator<CSVRecord<Header>>

Parse CSV binary to records.

Type Parameters

const Header extends readonly string[]

Parameters

csv: CSVBinary
CSV binary to parse.
Optionaloptions: ParseBinaryOptions<Header>
Parsing options for CSV binary parsing.

Returns AsyncIterableIterator<CSVRecord<Header>>

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,
  decomposition: 'gzip',
})) {
  // ...
}

Function parse

Type Parameters

Parameters

Returns AsyncIterableIterator<CSVRecord<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<CSVRecord<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<CSVRecord<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<CSVRecord<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<CSVRecord<Header>>

Example: Parsing CSV files from responses

Example: Parsing CSV files with options spcialized for binary

Settings