AbortController
to manually cancel operations as needed.AbortSignal.timeout
to automatically cancel operations that exceed a specified time limit.string
s, ReadableStream
s, or Response
objects.,
and "
respectively.This package can then be installed using a package manager.
# Install with npm
$ npm install web-csv-toolbox
# Or Yarn
$ yarn add web-csv-toolbox
# Or pnpm
$ pnpm add web-csv-toolbox
<script src="https://unpkg.com/web-csv-toolbox"></script>
<script>
const csv = `name,age
Alice,42
Bob,69`;
(async function () {
for await (const record of CSV.parse(csv)) {
console.log(record);
}
})();
</script>
<script type="module">
import { parse } from 'https://unpkg.com/web-csv-toolbox?module';
const csv = `name,age
Alice,42
Bob,69`;
for await (const record of parse(csv)) {
console.log(record);
}
</script>
You can install and use the package by specifying the following:
import { parse } from "npm:web-csv-toolbox";
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' }
ReadableStream
simport { 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' }
Response
objectsimport { parse } from 'web-csv-toolbox';
const response = await fetch('https://example.com/data.csv');
for await (const record of parse(response)) {
console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }
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' }
import { parse } from 'web-csv-toolbox';
const csv = `Alice,42
Bob,69`;
for await (const record of parse(csv, { headers: ['name', 'age'] })) {
console.log(record);
}
// Prints:
// { name: 'Alice', age: '42' }
// { name: 'Bob', age: '69' }
AbortSignal
/ AbortController
SupportSupport for AbortSignal
/ AbortController
, enabling you to cancel ongoing asynchronous CSV processing tasks.
This feature is useful for scenarios where processing needs to be halted, such as when a user navigates away from the page or other conditions that require stopping the task early.
import { parse } from 'web-csv-toolbox';
const controller = new AbortController();
const csv = "name,age\nAlice,30\nBob,25";
try {
// Parse the CSV data then pass the AbortSignal to the parse function
for await (const record of parse(csv, { signal: controller.signal })) {
console.log(record);
}
} catch (error) {
if (error instanceof DOMException && error.name === 'AbortError') {
// The CSV processing was aborted by the user
console.log('CSV processing was aborted by the user.');
} else {
// An error occurred during CSV processing
console.error('An error occurred:', error);
}
}
// Some abort logic, like a cancel button
document.getElementById('cancel-button')
.addEventListener('click', () => {
controller.abort();
});
import { parse } from 'web-csv-toolbox';
// Set up a timeout of 5 seconds (5000 milliseconds)
const signal = AbortSignal.timeout(5000);
const csv = "name,age\nAlice,30\nBob,25";
try {
// Pass the AbortSignal to the parse function
const result = await parse.toArray(csv, { signal });
console.log(result);
} catch (error) {
if (error instanceof DOMException && error.name === 'TimeoutError') {
// Handle the case where the processing was aborted due to timeout
console.log('CSV processing was aborted due to timeout.');
} else {
// Handle other errors
console.error('An error occurred during CSV processing:', error);
}
}
Versions | Status |
---|---|
20.x | โ |
18.x | โ |
OS | Chrome | FireFox | Default |
---|---|---|---|
Windows | โ | โ | โ (Edge) |
macos | โ | โ | โฌ (Safari *) |
Linux | โ | โ | - |
* To Be Tested: I couldn't launch Safari in headless mode on GitHub Actions, so I couldn't verify it, but it probably works.
These APIs are designed for Simplicity and Ease of Use, providing an intuitive and straightforward experience for users.
function parse(input[, options]): AsyncIterableIterator<CSVRecord>
: ๐
function parse.toArray(input[, options]): Promise<CSVRecord[]>
: ๐
The input
paramater can be a string
, a ReadableStream
of string
s or Uint8Arrays,
or a Uint8Array object,
or a ArrayBuffer object,
or a Response object.
These APIs are optimized for Enhanced Performance and Control, catering to users who need more detailed and fine-tuned functionality.
function parseString(string[, options])
: ๐
function parseBinary(buffer[, options])
: ๐
function parseResponse(response[, options])
: ๐
Response
objects.function parseStream(stream[, options])
: ๐
function parseStringStream(stream[, options])
: ๐
function parseUint8ArrayStream(stream[, options])
: ๐
These APIs are built for Advanced Customization and Pipeline Design, ideal for developers looking for in-depth control and flexibility.
class LexerTransformer
: ๐
class RecordAssemblerTransformer
: ๐
These APIs are experimental and may change in the future.
You can use WebAssembly to parse CSV data for high performance.
"
. (Double quotation mark)
import { loadWASM, parseStringWASM } from "web-csv-toolbox";
// load WebAssembly module
await loadWASM();
const csv = "a,b,c\n1,2,3";
// parse CSV string
const result = parseStringToArraySyncWASM(csv);
console.log(result);
// Prints:
// [{ a: "1", b: "2", c: "3" }]
function loadWASM(): Promise<void>
: ๐
function parseStringToArraySyncWASM(string[, options]): CSVRecord[]
: ๐
Option | Description | Default | Notes |
---|---|---|---|
delimiter |
Character to separate fields | , |
|
quotation |
Character used for quoting fields | " |
|
headers |
Custom headers for the parsed records | First row | If not provided, the first row is used as headers |
signal |
AbortSignal to cancel processing | undefined |
Allows aborting of long-running operations |
Option | Description | Default | Notes |
---|---|---|---|
charset |
Character encoding for binary CSV inputs | utf-8 |
See Encoding API Compatibility for the encoding formats that can be specified. |
decompression |
Decompression algorithm for compressed CSV inputs | See DecompressionStream Compatibility. | |
ignoreBOM |
Whether to ignore Byte Order Mark (BOM) | false |
See TextDecoderOptions.ignoreBOM for more information about the BOM. |
fatal |
Throw an error on invalid characters | false |
See TextDecoderOptions.fatal for more information. |
The easiest way to contribute is to use the library and star repository.
Feel free to ask questions on GitHub Discussions.
Please register at GitHub Issues.
Please support kamiazya.
Even just a dollar is enough motivation to develop ๐
This software is released under the MIT License, see LICENSE.