Function parse

Parse CSV to records.

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

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' }
Copy

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' }
Copy

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' }
Copy

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' }
Copy

Parse CSV binary to records.

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)) {
  // ...
}
Copy

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',
})) {
  // ...
}
Copy