web-csv-toolbox 0.11.0-next-5d01c3998b1d65f9ecf06ae0cb3ec382001832c5 → 0.11.0-next-705a38880da3e4e52fe9a761222deadb93ff518f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Lexer.cjs +1 -1
- package/dist/cjs/Lexer.cjs.map +1 -1
- package/dist/cjs/LexerTransformer.cjs.map +1 -1
- package/dist/cjs/assertCommonOptions.cjs.map +1 -1
- package/dist/cjs/constants.cjs +1 -1
- package/dist/cjs/constants.cjs.map +1 -1
- package/dist/cjs/parse.cjs.map +1 -1
- package/dist/cjs/parseString.cjs.map +1 -1
- package/dist/cjs/parseStringStream.cjs.map +1 -1
- package/dist/cjs/parseStringStreamToStream.cjs.map +1 -1
- package/dist/cjs/parseStringToArraySync.cjs.map +1 -1
- package/dist/cjs/parseStringToArraySyncWASM.cjs +1 -1
- package/dist/cjs/parseStringToArraySyncWASM.cjs.map +1 -1
- package/dist/cjs/parseStringToIterableIterator.cjs.map +1 -1
- package/dist/cjs/parseStringToStream.cjs.map +1 -1
- package/dist/es/Lexer.js +7 -6
- package/dist/es/Lexer.js.map +1 -1
- package/dist/es/LexerTransformer.js.map +1 -1
- package/dist/es/assertCommonOptions.js.map +1 -1
- package/dist/es/constants.js +3 -1
- package/dist/es/constants.js.map +1 -1
- package/dist/es/parse.js.map +1 -1
- package/dist/es/parseString.js.map +1 -1
- package/dist/es/parseStringStream.js.map +1 -1
- package/dist/es/parseStringStreamToStream.js.map +1 -1
- package/dist/es/parseStringToArraySync.js.map +1 -1
- package/dist/es/parseStringToArraySyncWASM.js +2 -2
- package/dist/es/parseStringToArraySyncWASM.js.map +1 -1
- package/dist/es/parseStringToIterableIterator.js.map +1 -1
- package/dist/es/parseStringToStream.js.map +1 -1
- package/dist/types/Lexer.d.ts +3 -2
- package/dist/types/LexerTransformer.d.ts +4 -3
- package/dist/types/assertCommonOptions.d.ts +1 -1
- package/dist/types/common/types.d.ts +8 -6
- package/dist/types/constants.d.ts +8 -0
- package/dist/types/escapeField.d.ts +2 -2
- package/dist/types/parse.d.ts +7 -2
- package/dist/types/parse.test-d.d.ts +1 -0
- package/dist/types/parseString.d.ts +7 -1
- package/dist/types/parseString.test-d.d.ts +1 -0
- package/dist/types/parseStringStream.d.ts +5 -1
- package/dist/types/parseStringStream.test-d.d.ts +1 -0
- package/dist/types/parseStringStreamToStream.d.ts +5 -1
- package/dist/types/parseStringStreamToStream.test-d.d.ts +1 -0
- package/dist/types/parseStringToArraySync.d.ts +5 -1
- package/dist/types/parseStringToArraySync.test-d.d.ts +1 -0
- package/dist/types/parseStringToArraySyncWASM.d.ts +5 -1
- package/dist/types/parseStringToArraySyncWASM.test-d.d.ts +1 -0
- package/dist/types/parseStringToIterableIterator.d.ts +5 -1
- package/dist/types/parseStringToIterableIterator.test-d.d.ts +1 -0
- package/dist/types/parseStringToStream.d.ts +5 -1
- package/dist/types/parseStringToStream.test-d.d.ts +1 -0
- package/dist/types/utils/types.d.ts +115 -0
- package/dist/types/utils/types.test-d.d.ts +1 -0
- package/dist/web-csv-toolbox.umd.cjs +1 -1
- package/dist/web-csv-toolbox.umd.cjs.map +1 -1
- package/package.json +3 -3
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parseStringStream.js","sources":["../../src/parseStringStream.ts"],"sourcesContent":["import type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport { parseStringStreamToStream } from \"./parseStringStreamToStream.ts\";\nimport { convertStreamToAsyncIterableIterator } from \"./utils/convertStreamToAsyncIterableIterator.ts\";\nimport * as internal from \"./utils/convertThisAsyncIterableIteratorToArray.ts\";\n\n/**\n * Parse CSV string stream to records.\n *\n * @category Middle-level API\n * @param stream CSV string stream to parse\n * @param options Parsing options.\n * @returns Async iterable iterator of records.\n *\n * If you want array of records, use {@link parseStringStream.toArray} function.\n *\n * @example Parsing CSV files from strings\n *\n * ```ts\n * import { parseStringStream } from 'web-csv-toolbox';\n *\n * const csv = `name,age\n * Alice,42\n * Bob,69`;\n *\n * const stream = new ReadableStream({\n * start(controller) {\n * controller.enqueue(csv);\n * controller.close();\n * },\n * });\n *\n * for await (const record of parseStringStream(csv)) {\n * console.log(record);\n * }\n * // Prints:\n * // { name: 'Alice', age: '42' }\n * // { name: 'Bob', age: '69' }\n * ```\n */\nexport function parseStringStream<Header extends ReadonlyArray<string>>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n): AsyncIterableIterator<CSVRecord<Header>> {\n const recordStream = parseStringStreamToStream(stream, options);\n return convertStreamToAsyncIterableIterator(recordStream);\n}\n\nexport declare namespace parseStringStream {\n /**\n * Parse CSV string stream to records.\n *\n * @returns Array of records\n *\n * @example\n *\n * ```ts\n * import { parseStringStream } from 'web-csv-toolbox';\n *\n * const csv = `name,age\n * Alice,42\n * Bob,69`;\n *\n * const stream = new ReadableStream({\n * start(controller) {\n * controller.enqueue(csv);\n * controller.close();\n * },\n * });\n *\n * const records = await parseStringStream.toArray(stream);\n * console.log(records);\n * // Prints:\n * // [ { name: 'Alice', age: '42' }, { name: 'Bob', age: '69' } ]\n * ```\n */\n export function toArray<Header extends ReadonlyArray<string>>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n ): Promise<CSVRecord<Header>[]>;\n /**\n * Parse CSV string stream to records.\n *\n * @returns Array of records\n *\n * @example\n *\n * ```ts\n * import { parseStringStream } from 'web-csv-toolbox';\n *\n * const csv = `name,age\n * Alice,42\n * Bob,69`;\n *\n * const stream = new ReadableStream({\n * start(controller) {\n * controller.enqueue(csv);\n * controller.close();\n * },\n * });\n *\n * await parseStringStream.toStream(stream)\n * .pipeTo(\n * new WritableStream({\n * write(record) {\n * console.log(record);\n * },\n * }),\n * );\n * ```\n */\n export function toStream<Header extends ReadonlyArray<string>>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n ): ReadableStream<CSVRecord<Header>>;\n}\n\nObject.defineProperties(parseStringStream, {\n toArray: {\n enumerable: true,\n writable: false,\n value: internal.convertThisAsyncIterableIteratorToArray,\n },\n toStream: {\n enumerable: true,\n writable: false,\n value: parseStringStreamToStream,\n },\n});\n"],"names":["internal.convertThisAsyncIterableIteratorToArray"],"mappings":";;;;
|
|
1
|
+
{"version":3,"file":"parseStringStream.js","sources":["../../src/parseStringStream.ts"],"sourcesContent":["import type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport type { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from \"./constants.ts\";\nimport { parseStringStreamToStream } from \"./parseStringStreamToStream.ts\";\nimport { convertStreamToAsyncIterableIterator } from \"./utils/convertStreamToAsyncIterableIterator.ts\";\nimport * as internal from \"./utils/convertThisAsyncIterableIteratorToArray.ts\";\nimport type { PickCSVHeader } from \"./utils/types.ts\";\n\n/**\n * Parse CSV string stream to records.\n *\n * @category Middle-level API\n * @param stream CSV string stream to parse\n * @param options Parsing options.\n * @returns Async iterable iterator of records.\n *\n * If you want array of records, use {@link parseStringStream.toArray} function.\n *\n * @example Parsing CSV files from strings\n *\n * ```ts\n * import { parseStringStream } from 'web-csv-toolbox';\n *\n * const csv = `name,age\n * Alice,42\n * Bob,69`;\n *\n * const stream = new ReadableStream({\n * start(controller) {\n * controller.enqueue(csv);\n * controller.close();\n * },\n * });\n *\n * for await (const record of parseStringStream(csv)) {\n * console.log(record);\n * }\n * // Prints:\n * // { name: 'Alice', age: '42' }\n * // { name: 'Bob', age: '69' }\n * ```\n */\nexport function parseStringStream<\n const CSVSource extends ReadableStream<string>,\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n const Header extends ReadonlyArray<string> = PickCSVHeader<\n CSVSource,\n Delimiter,\n Quotation\n >,\n>(\n csv: CSVSource,\n options: ParseOptions<Header, Delimiter, Quotation>,\n): AsyncIterableIterator<CSVRecord<Header>>;\nexport function parseStringStream<\n const CSVSource extends ReadableStream<string>,\n const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>,\n>(\n csv: CSVSource,\n options?: ParseOptions<Header>,\n): AsyncIterableIterator<CSVRecord<Header>>;\nexport function parseStringStream<const Header extends ReadonlyArray<string>>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n): AsyncIterableIterator<CSVRecord<Header>>;\nexport function parseStringStream<Header extends ReadonlyArray<string>>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n): AsyncIterableIterator<CSVRecord<Header>> {\n const recordStream = parseStringStreamToStream(stream, options);\n return convertStreamToAsyncIterableIterator(recordStream);\n}\n\nexport declare namespace parseStringStream {\n /**\n * Parse CSV string stream to records.\n *\n * @returns Array of records\n *\n * @example\n *\n * ```ts\n * import { parseStringStream } from 'web-csv-toolbox';\n *\n * const csv = `name,age\n * Alice,42\n * Bob,69`;\n *\n * const stream = new ReadableStream({\n * start(controller) {\n * controller.enqueue(csv);\n * controller.close();\n * },\n * });\n *\n * const records = await parseStringStream.toArray(stream);\n * console.log(records);\n * // Prints:\n * // [ { name: 'Alice', age: '42' }, { name: 'Bob', age: '69' } ]\n * ```\n */\n export function toArray<Header extends ReadonlyArray<string>>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n ): Promise<CSVRecord<Header>[]>;\n /**\n * Parse CSV string stream to records.\n *\n * @returns Array of records\n *\n * @example\n *\n * ```ts\n * import { parseStringStream } from 'web-csv-toolbox';\n *\n * const csv = `name,age\n * Alice,42\n * Bob,69`;\n *\n * const stream = new ReadableStream({\n * start(controller) {\n * controller.enqueue(csv);\n * controller.close();\n * },\n * });\n *\n * await parseStringStream.toStream(stream)\n * .pipeTo(\n * new WritableStream({\n * write(record) {\n * console.log(record);\n * },\n * }),\n * );\n * ```\n */\n export function toStream<Header extends ReadonlyArray<string>>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n ): ReadableStream<CSVRecord<Header>>;\n}\n\nObject.defineProperties(parseStringStream, {\n toArray: {\n enumerable: true,\n writable: false,\n value: internal.convertThisAsyncIterableIteratorToArray,\n },\n toStream: {\n enumerable: true,\n writable: false,\n value: parseStringStreamToStream,\n },\n});\n"],"names":["internal.convertThisAsyncIterableIteratorToArray"],"mappings":";;;;AAiEgB,SAAA,iBAAA,CACd,QACA,OAC0C,EAAA;AAC1C,EAAM,MAAA,YAAA,GAAe,yBAA0B,CAAA,MAAA,EAAQ,OAAO,CAAA,CAAA;AAC9D,EAAA,OAAO,qCAAqC,YAAY,CAAA,CAAA;AAC1D,CAAA;AAuEA,MAAA,CAAO,iBAAiB,iBAAmB,EAAA;AAAA,EACzC,OAAS,EAAA;AAAA,IACP,UAAY,EAAA,IAAA;AAAA,IACZ,QAAU,EAAA,KAAA;AAAA,IACV,OAAOA,uCAAS;AAAA,GAClB;AAAA,EACA,QAAU,EAAA;AAAA,IACR,UAAY,EAAA,IAAA;AAAA,IACZ,QAAU,EAAA,KAAA;AAAA,IACV,KAAO,EAAA,yBAAA;AAAA,GACT;AACF,CAAC,CAAA;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parseStringStreamToStream.js","sources":["../../src/parseStringStreamToStream.ts"],"sourcesContent":["import { LexerTransformer } from \"./LexerTransformer.ts\";\nimport { RecordAssemblerTransformer } from \"./RecordAssemblerTransformer.ts\";\nimport type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport { pipeline } from \"./utils/pipeline.ts\";\n\nexport function parseStringStreamToStream<Header extends ReadonlyArray<string
|
|
1
|
+
{"version":3,"file":"parseStringStreamToStream.js","sources":["../../src/parseStringStreamToStream.ts"],"sourcesContent":["import { LexerTransformer } from \"./LexerTransformer.ts\";\nimport { RecordAssemblerTransformer } from \"./RecordAssemblerTransformer.ts\";\nimport type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport type { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from \"./constants.ts\";\nimport { pipeline } from \"./utils/pipeline.ts\";\nimport type { PickCSVHeader } from \"./utils/types.ts\";\n\nexport function parseStringStreamToStream<\n const CSVSource extends ReadableStream<string>,\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n const Header extends ReadonlyArray<string> = PickCSVHeader<\n CSVSource,\n Delimiter,\n Quotation\n >,\n>(\n stream: CSVSource,\n options: ParseOptions<Header, Delimiter, Quotation>,\n): ReadableStream<CSVRecord<Header>>;\nexport function parseStringStreamToStream<\n const CSVSource extends ReadableStream<string>,\n const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>,\n>(\n stream: CSVSource,\n options?: ParseOptions<Header>,\n): ReadableStream<CSVRecord<Header>>;\nexport function parseStringStreamToStream<\n const Header extends ReadonlyArray<string>,\n>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n): ReadableStream<CSVRecord<Header>>;\nexport function parseStringStreamToStream<\n const Header extends ReadonlyArray<string>,\n>(\n stream: ReadableStream<string>,\n options?: ParseOptions<Header>,\n): ReadableStream<CSVRecord<Header>> {\n return pipeline(\n stream,\n new LexerTransformer(options),\n new RecordAssemblerTransformer(options),\n );\n}\n"],"names":[],"mappings":";;;;AAiCgB,SAAA,yBAAA,CAGd,QACA,OACmC,EAAA;AACnC,EAAO,OAAA,QAAA;AAAA,IACL,MAAA;AAAA,IACA,IAAI,iBAAiB,OAAO,CAAA;AAAA,IAC5B,IAAI,2BAA2B,OAAO,CAAA;AAAA,GACxC,CAAA;AACF;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parseStringToArraySync.js","sources":["../../src/parseStringToArraySync.ts"],"sourcesContent":["import { Lexer } from \"./Lexer.ts\";\nimport { RecordAssembler } from \"./RecordAssembler.ts\";\nimport type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport { commonParseErrorHandling } from \"./commonParseErrorHandling.ts\";\n\nexport function parseStringToArraySync
|
|
1
|
+
{"version":3,"file":"parseStringToArraySync.js","sources":["../../src/parseStringToArraySync.ts"],"sourcesContent":["import { Lexer } from \"./Lexer.ts\";\nimport { RecordAssembler } from \"./RecordAssembler.ts\";\nimport type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport { commonParseErrorHandling } from \"./commonParseErrorHandling.ts\";\nimport type { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from \"./constants.ts\";\nimport type { PickCSVHeader } from \"./utils/types.ts\";\n\nexport function parseStringToArraySync<\n const CSVSource extends string,\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n const Header extends ReadonlyArray<string> = PickCSVHeader<\n CSVSource,\n Delimiter,\n Quotation\n >,\n>(\n csv: CSVSource,\n options: ParseOptions<Header, Delimiter, Quotation>,\n): CSVRecord<Header>[];\nexport function parseStringToArraySync<\n const CSVSource extends string,\n const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>,\n>(csv: CSVSource, options?: ParseOptions<Header>): CSVRecord<Header>[];\nexport function parseStringToArraySync<\n const Header extends ReadonlyArray<string>,\n>(csv: string, options?: ParseOptions<Header>): CSVRecord<Header>[];\nexport function parseStringToArraySync<\n const Header extends ReadonlyArray<string>,\n>(csv: string, options?: ParseOptions<Header>): CSVRecord<Header>[] {\n try {\n const lexer = new Lexer(options);\n const assembler = new RecordAssembler(options);\n const tokens = lexer.lex(csv);\n return [...assembler.assemble(tokens)];\n } catch (error) {\n commonParseErrorHandling(error);\n }\n}\n"],"names":[],"mappings":";;;;AA2BgB,SAAA,sBAAA,CAEd,KAAa,OAAqD,EAAA;AAClE,EAAI,IAAA;AACF,IAAM,MAAA,KAAA,GAAQ,IAAI,KAAA,CAAM,OAAO,CAAA,CAAA;AAC/B,IAAM,MAAA,SAAA,GAAY,IAAI,eAAA,CAAgB,OAAO,CAAA,CAAA;AAC7C,IAAM,MAAA,MAAA,GAAS,KAAM,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AAC5B,IAAA,OAAO,CAAC,GAAG,SAAU,CAAA,QAAA,CAAS,MAAM,CAAC,CAAA,CAAA;AAAA,WAC9B,KAAO,EAAA;AACd,IAAA,wBAAA,CAAyB,KAAK,CAAA,CAAA;AAAA,GAChC;AACF;;;;"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { parseStringToArraySync } from './_virtual/_web-csv-toolbox-wasm.js';
|
|
2
2
|
import { assertCommonOptions } from './assertCommonOptions.js';
|
|
3
|
-
import { DOUBLE_QUOTE,
|
|
3
|
+
import { DOUBLE_QUOTE, DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.js';
|
|
4
4
|
|
|
5
5
|
function parseStringToArraySyncWASM(csv, options = {}) {
|
|
6
|
-
const { delimiter =
|
|
6
|
+
const { delimiter = DEFAULT_DELIMITER, quotation = DEFAULT_QUOTATION } = options;
|
|
7
7
|
if (typeof delimiter !== "string" || delimiter.length !== 1) {
|
|
8
8
|
throw new RangeError(
|
|
9
9
|
"Invalid delimiter, must be a single character on WASM."
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parseStringToArraySyncWASM.js","sources":["../../src/parseStringToArraySyncWASM.ts"],"sourcesContent":["import { parseStringToArraySync } from \"web-csv-toolbox-wasm\";\nimport { assertCommonOptions } from \"./assertCommonOptions.ts\";\nimport type { CSVRecord, CommonOptions } from \"./common/types.ts\";\nimport {
|
|
1
|
+
{"version":3,"file":"parseStringToArraySyncWASM.js","sources":["../../src/parseStringToArraySyncWASM.ts"],"sourcesContent":["import { parseStringToArraySync } from \"web-csv-toolbox-wasm\";\nimport { assertCommonOptions } from \"./assertCommonOptions.ts\";\nimport type { CSVRecord, CommonOptions } from \"./common/types.ts\";\nimport {\n DEFAULT_DELIMITER,\n DEFAULT_QUOTATION,\n DOUBLE_QUOTE,\n} from \"./constants.ts\";\nimport type { loadWASM } from \"./loadWASM.ts\";\nimport type { PickCSVHeader } from \"./utils/types.ts\";\n\n/**\n * Parse CSV string to record of arrays.\n *\n * @param csv CSV string\n * @param options Parse options\n * @returns Record of arrays\n *\n * @remarks\n * This function uses WebAssembly to parse CSV string.\n * Before calling this function, you must call {@link loadWASM} function.\n *\n * This function only supports UTF-8 string.\n * If you pass a string that is not UTF-8, like UTF-16, it throws an error.\n * This function only supports double quote as quotation.\n * So, `options.quotation` must be `\"` (double quote). Otherwise, it throws an error.\n *\n * And this function only supports single character as delimiter.\n * So, `options.delimiter` must be a single character. Otherwise, it throws an error.\n *\n * @example\n *\n * ```ts\n * import { loadWASM, parseStringWASM } from \"web-csv-toolbox\";\n *\n * await loadWASM();\n *\n * const csv = \"a,b,c\\n1,2,3\";\n *\n * const result = parseStringToArraySyncWASM(csv);\n * console.log(result);\n * // Prints:\n * // [{ a: \"1\", b: \"2\", c: \"3\" }]\n * ```\n * @beta\n * @throws {RangeError | TypeError} - If provided options are invalid.\n */\nexport function parseStringToArraySyncWASM<\n const CSVSource extends string,\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n const Header extends ReadonlyArray<string> = PickCSVHeader<\n CSVSource,\n Delimiter,\n Quotation\n >,\n>(\n csv: CSVSource,\n options: CommonOptions<Delimiter, Quotation>,\n): CSVRecord<Header>[];\nexport function parseStringToArraySyncWASM<\n const CSVSource extends string,\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>,\n>(\n csv: CSVSource,\n options?: CommonOptions<Delimiter, Quotation>,\n): CSVRecord<Header>[];\nexport function parseStringToArraySyncWASM<\n const Header extends ReadonlyArray<string>,\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n>(\n csv: string,\n options?: CommonOptions<Delimiter, Quotation>,\n): CSVRecord<Header>[];\nexport function parseStringToArraySyncWASM<\n const Header extends readonly string[],\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n>(\n csv: string,\n options: CommonOptions<Delimiter, Quotation> = {},\n): CSVRecord<Header>[] {\n const { delimiter = DEFAULT_DELIMITER, quotation = DEFAULT_QUOTATION } =\n options;\n if (typeof delimiter !== \"string\" || delimiter.length !== 1) {\n throw new RangeError(\n \"Invalid delimiter, must be a single character on WASM.\",\n );\n }\n if (quotation !== DOUBLE_QUOTE) {\n throw new RangeError(\"Invalid quotation, must be double quote on WASM.\");\n }\n assertCommonOptions({ delimiter, quotation });\n const demiliterCode = delimiter.charCodeAt(0);\n return JSON.parse(parseStringToArraySync(csv, demiliterCode));\n}\n"],"names":[],"mappings":";;;;AA6EO,SAAS,0BAKd,CAAA,GAAA,EACA,OAA+C,GAAA,EAC1B,EAAA;AACrB,EAAA,MAAM,EAAE,SAAA,GAAY,iBAAmB,EAAA,SAAA,GAAY,mBACjD,GAAA,OAAA,CAAA;AACF,EAAA,IAAI,OAAO,SAAA,KAAc,QAAY,IAAA,SAAA,CAAU,WAAW,CAAG,EAAA;AAC3D,IAAA,MAAM,IAAI,UAAA;AAAA,MACR,wDAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAA,IAAI,cAAc,YAAc,EAAA;AAC9B,IAAM,MAAA,IAAI,WAAW,kDAAkD,CAAA,CAAA;AAAA,GACzE;AACA,EAAoB,mBAAA,CAAA,EAAE,SAAW,EAAA,SAAA,EAAW,CAAA,CAAA;AAC5C,EAAM,MAAA,aAAA,GAAgB,SAAU,CAAA,UAAA,CAAW,CAAC,CAAA,CAAA;AAC5C,EAAA,OAAO,IAAK,CAAA,KAAA,CAAM,sBAAuB,CAAA,GAAA,EAAK,aAAa,CAAC,CAAA,CAAA;AAC9D;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parseStringToIterableIterator.js","sources":["../../src/parseStringToIterableIterator.ts"],"sourcesContent":["import { Lexer } from \"./Lexer.ts\";\nimport { RecordAssembler } from \"./RecordAssembler.ts\";\nimport type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport { commonParseErrorHandling } from \"./commonParseErrorHandling.ts\";\n\nexport function parseStringToIterableIterator<\n Header extends ReadonlyArray<string>,\n>(\n csv: string,\n options?: ParseOptions<Header>,\n): IterableIterator<CSVRecord<Header>> {\n try {\n const lexer = new Lexer(options);\n const assembler = new RecordAssembler(options);\n const tokens = lexer.lex(csv);\n return assembler.assemble(tokens);\n } catch (error) {\n commonParseErrorHandling(error);\n }\n}\n"],"names":[],"mappings":";;;;
|
|
1
|
+
{"version":3,"file":"parseStringToIterableIterator.js","sources":["../../src/parseStringToIterableIterator.ts"],"sourcesContent":["import { Lexer } from \"./Lexer.ts\";\nimport { RecordAssembler } from \"./RecordAssembler.ts\";\nimport type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport { commonParseErrorHandling } from \"./commonParseErrorHandling.ts\";\nimport type { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from \"./constants.ts\";\nimport type { PickCSVHeader } from \"./utils/types.ts\";\n\nexport function parseStringToIterableIterator<\n const CSVSource extends string,\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n const Header extends ReadonlyArray<string> = PickCSVHeader<\n CSVSource,\n Delimiter,\n Quotation\n >,\n>(\n stream: CSVSource,\n options: ParseOptions<Header, Delimiter, Quotation>,\n): IterableIterator<CSVRecord<Header>>;\nexport function parseStringToIterableIterator<\n const CSVSource extends string,\n const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>,\n>(\n stream: CSVSource,\n options?: ParseOptions<Header>,\n): IterableIterator<CSVRecord<Header>>;\nexport function parseStringToIterableIterator<\n const Header extends ReadonlyArray<string>,\n>(\n stream: string,\n options?: ParseOptions<Header>,\n): IterableIterator<CSVRecord<Header>>;\nexport function parseStringToIterableIterator<\n const Header extends ReadonlyArray<string>,\n>(\n csv: string,\n options?: ParseOptions<Header>,\n): IterableIterator<CSVRecord<Header>> {\n try {\n const lexer = new Lexer(options);\n const assembler = new RecordAssembler(options);\n const tokens = lexer.lex(csv);\n return assembler.assemble(tokens);\n } catch (error) {\n commonParseErrorHandling(error);\n }\n}\n"],"names":[],"mappings":";;;;AAiCgB,SAAA,6BAAA,CAGd,KACA,OACqC,EAAA;AACrC,EAAI,IAAA;AACF,IAAM,MAAA,KAAA,GAAQ,IAAI,KAAA,CAAM,OAAO,CAAA,CAAA;AAC/B,IAAM,MAAA,SAAA,GAAY,IAAI,eAAA,CAAgB,OAAO,CAAA,CAAA;AAC7C,IAAM,MAAA,MAAA,GAAS,KAAM,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AAC5B,IAAO,OAAA,SAAA,CAAU,SAAS,MAAM,CAAA,CAAA;AAAA,WACzB,KAAO,EAAA;AACd,IAAA,wBAAA,CAAyB,KAAK,CAAA,CAAA;AAAA,GAChC;AACF;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parseStringToStream.js","sources":["../../src/parseStringToStream.ts"],"sourcesContent":["import { Lexer } from \"./Lexer.ts\";\nimport { RecordAssembler } from \"./RecordAssembler.ts\";\nimport type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport { commonParseErrorHandling } from \"./commonParseErrorHandling.ts\";\n\nexport function parseStringToStream<Header extends ReadonlyArray<string>>(\n csv: string,\n options?: ParseOptions<Header>,\n): ReadableStream<CSVRecord<Header>> {\n try {\n const lexer = new Lexer(options);\n const assembler = new RecordAssembler(options);\n return new ReadableStream({\n start(controller) {\n const tokens = lexer.lex(csv);\n for (const record of assembler.assemble(tokens)) {\n controller.enqueue(record);\n }\n controller.close();\n },\n });\n } catch (error) {\n commonParseErrorHandling(error);\n }\n}\n"],"names":[],"mappings":";;;;
|
|
1
|
+
{"version":3,"file":"parseStringToStream.js","sources":["../../src/parseStringToStream.ts"],"sourcesContent":["import { Lexer } from \"./Lexer.ts\";\nimport { RecordAssembler } from \"./RecordAssembler.ts\";\nimport type { CSVRecord, ParseOptions } from \"./common/types.ts\";\nimport { commonParseErrorHandling } from \"./commonParseErrorHandling.ts\";\nimport type { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from \"./constants.ts\";\nimport type { PickCSVHeader } from \"./utils/types.ts\";\n\nexport function parseStringToStream<\n const CSVSource extends string,\n const Delimiter extends string = DEFAULT_DELIMITER,\n const Quotation extends string = DEFAULT_QUOTATION,\n const Header extends ReadonlyArray<string> = PickCSVHeader<\n CSVSource,\n Delimiter,\n Quotation\n >,\n>(\n stream: CSVSource,\n options: ParseOptions<Header, Delimiter, Quotation>,\n): ReadableStream<CSVRecord<Header>>;\nexport function parseStringToStream<\n const CSVSource extends string,\n const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>,\n>(\n stream: CSVSource,\n options?: ParseOptions<Header>,\n): ReadableStream<CSVRecord<Header>>;\nexport function parseStringToStream<const Header extends ReadonlyArray<string>>(\n stream: string,\n options?: ParseOptions<Header>,\n): ReadableStream<CSVRecord<Header>>;\nexport function parseStringToStream<const Header extends ReadonlyArray<string>>(\n csv: string,\n options?: ParseOptions<Header>,\n): ReadableStream<CSVRecord<Header>> {\n try {\n const lexer = new Lexer(options);\n const assembler = new RecordAssembler(options);\n return new ReadableStream({\n start(controller) {\n const tokens = lexer.lex(csv);\n for (const record of assembler.assemble(tokens)) {\n controller.enqueue(record);\n }\n controller.close();\n },\n });\n } catch (error) {\n commonParseErrorHandling(error);\n }\n}\n"],"names":[],"mappings":";;;;AA+BgB,SAAA,mBAAA,CACd,KACA,OACmC,EAAA;AACnC,EAAI,IAAA;AACF,IAAM,MAAA,KAAA,GAAQ,IAAI,KAAA,CAAM,OAAO,CAAA,CAAA;AAC/B,IAAM,MAAA,SAAA,GAAY,IAAI,eAAA,CAAgB,OAAO,CAAA,CAAA;AAC7C,IAAA,OAAO,IAAI,cAAe,CAAA;AAAA,MACxB,MAAM,UAAY,EAAA;AAChB,QAAM,MAAA,MAAA,GAAS,KAAM,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AAC5B,QAAA,KAAA,MAAW,MAAU,IAAA,SAAA,CAAU,QAAS,CAAA,MAAM,CAAG,EAAA;AAC/C,UAAA,UAAA,CAAW,QAAQ,MAAM,CAAA,CAAA;AAAA,SAC3B;AACA,QAAA,UAAA,CAAW,KAAM,EAAA,CAAA;AAAA,OACnB;AAAA,KACD,CAAA,CAAA;AAAA,WACM,KAAO,EAAA;AACd,IAAA,wBAAA,CAAyB,KAAK,CAAA,CAAA;AAAA,GAChC;AACF;;;;"}
|
package/dist/types/Lexer.d.ts
CHANGED
|
@@ -1,17 +1,18 @@
|
|
|
1
1
|
import { AbortSignalOptions, CommonOptions, Token } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
2
3
|
|
|
3
4
|
/**
|
|
4
5
|
* CSV Lexer.
|
|
5
6
|
*
|
|
6
7
|
* Lexter tokenizes CSV data into fields and records.
|
|
7
8
|
*/
|
|
8
|
-
export declare class Lexer {
|
|
9
|
+
export declare class Lexer<Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION> {
|
|
9
10
|
#private;
|
|
10
11
|
/**
|
|
11
12
|
* Constructs a new Lexer instance.
|
|
12
13
|
* @param options - The common options for the lexer.
|
|
13
14
|
*/
|
|
14
|
-
constructor(
|
|
15
|
+
constructor(options?: CommonOptions<Delimiter, Quotation> & AbortSignalOptions);
|
|
15
16
|
/**
|
|
16
17
|
* Lexes the given chunk of CSV data.
|
|
17
18
|
* @param chunk - The chunk of CSV data to be lexed.
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Lexer } from './Lexer.ts';
|
|
2
2
|
import { CommonOptions, Token } from './common/types.ts';
|
|
3
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* A transform stream that converts a stream of tokens into a stream of rows.
|
|
@@ -31,7 +32,7 @@ import { CommonOptions, Token } from './common/types.ts';
|
|
|
31
32
|
* // { type: RecordDelimiter, value: "\r\n", location: {...} }
|
|
32
33
|
* ```
|
|
33
34
|
*/
|
|
34
|
-
export declare class LexerTransformer extends TransformStream<string, Token[]> {
|
|
35
|
-
readonly lexer: Lexer
|
|
36
|
-
constructor(options?: CommonOptions);
|
|
35
|
+
export declare class LexerTransformer<Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION> extends TransformStream<string, Token[]> {
|
|
36
|
+
readonly lexer: Lexer<Delimiter, Quotation>;
|
|
37
|
+
constructor(options?: CommonOptions<Delimiter, Quotation>);
|
|
37
38
|
}
|
|
@@ -19,4 +19,4 @@ import { CommonOptions } from './common/types.ts';
|
|
|
19
19
|
* @throws {RangeError} If any required property is missing or if the delimiter is the same as the quotation.
|
|
20
20
|
* @throws {TypeError} If any required property is not a string.
|
|
21
21
|
*/
|
|
22
|
-
export declare function assertCommonOptions(options: Required<CommonOptions
|
|
22
|
+
export declare function assertCommonOptions<Delimiter extends string, Quotation extends string>(options: Required<CommonOptions<Delimiter, Quotation>>): asserts options is Required<CommonOptions<Delimiter, Quotation>>;
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from '../constants.ts';
|
|
2
|
+
import { Join } from '../utils/types.ts';
|
|
1
3
|
import { Field, FieldDelimiter, RecordDelimiter } from './constants.ts';
|
|
2
4
|
|
|
3
5
|
/**
|
|
@@ -131,7 +133,7 @@ export interface AbortSignalOptions {
|
|
|
131
133
|
* CSV Common Options.
|
|
132
134
|
* @category Types
|
|
133
135
|
*/
|
|
134
|
-
export interface CommonOptions {
|
|
136
|
+
export interface CommonOptions<Delimiter extends string, Quotation extends string> {
|
|
135
137
|
/**
|
|
136
138
|
* CSV field delimiter.
|
|
137
139
|
* If you want to parse TSV, specify `'\t'`.
|
|
@@ -147,13 +149,13 @@ export interface CommonOptions {
|
|
|
147
149
|
*
|
|
148
150
|
* @default ','
|
|
149
151
|
*/
|
|
150
|
-
delimiter?:
|
|
152
|
+
delimiter?: Delimiter;
|
|
151
153
|
/**
|
|
152
154
|
* CSV field quotation.
|
|
153
155
|
*
|
|
154
156
|
* @default '"'
|
|
155
157
|
*/
|
|
156
|
-
quotation?:
|
|
158
|
+
quotation?: Quotation;
|
|
157
159
|
}
|
|
158
160
|
/**
|
|
159
161
|
* CSV Parsing Options for binary.
|
|
@@ -238,7 +240,7 @@ export interface RecordAssemblerOptions<Header extends ReadonlyArray<string>> ex
|
|
|
238
240
|
* Parse options for CSV string.
|
|
239
241
|
* @category Types
|
|
240
242
|
*/
|
|
241
|
-
export interface ParseOptions<Header extends ReadonlyArray<string
|
|
243
|
+
export interface ParseOptions<Header extends ReadonlyArray<string> = ReadonlyArray<string>, Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION> extends CommonOptions<Delimiter, Quotation>, RecordAssemblerOptions<Header>, AbortSignalOptions {
|
|
242
244
|
}
|
|
243
245
|
/**
|
|
244
246
|
* Parse options for CSV binary.
|
|
@@ -265,7 +267,7 @@ export type CSVRecord<Header extends ReadonlyArray<string>> = Record<Header[numb
|
|
|
265
267
|
*
|
|
266
268
|
* @category Types
|
|
267
269
|
*/
|
|
268
|
-
export type CSVString = string | ReadableStream<string>;
|
|
270
|
+
export type CSVString<Header extends ReadonlyArray<string> = [], Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION> = Header extends readonly [string, ...string[]] ? Join<Header, Delimiter, Quotation> | ReadableStream<Join<Header, Delimiter, Quotation>> : string | ReadableStream<string>;
|
|
269
271
|
/**
|
|
270
272
|
* CSV Binary.
|
|
271
273
|
*
|
|
@@ -277,4 +279,4 @@ export type CSVBinary = ReadableStream<Uint8Array> | Response | ArrayBuffer | Ui
|
|
|
277
279
|
*
|
|
278
280
|
* @category Types
|
|
279
281
|
*/
|
|
280
|
-
export type CSV = CSVString | CSVBinary
|
|
282
|
+
export type CSV<Header extends ReadonlyArray<string> = [], Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION> = Header extends [] ? CSVString | CSVBinary : CSVString<Header, Delimiter, Quotation>;
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
export declare const CR = "\r";
|
|
2
|
+
export type CR = typeof CR;
|
|
2
3
|
export declare const CRLF = "\r\n";
|
|
4
|
+
export type CRLF = typeof CRLF;
|
|
3
5
|
export declare const LF = "\n";
|
|
6
|
+
export type LF = typeof LF;
|
|
7
|
+
export type Newline = CRLF | CR | LF;
|
|
4
8
|
/**
|
|
5
9
|
* COMMA is a symbol for comma(,).
|
|
6
10
|
*/
|
|
@@ -9,3 +13,7 @@ export declare const COMMA = ",";
|
|
|
9
13
|
* DOUBLE_QUOTE is a symbol for double quote(").
|
|
10
14
|
*/
|
|
11
15
|
export declare const DOUBLE_QUOTE = "\"";
|
|
16
|
+
export declare const DEFAULT_DELIMITER = ",";
|
|
17
|
+
export type DEFAULT_DELIMITER = typeof DEFAULT_DELIMITER;
|
|
18
|
+
export declare const DEFAULT_QUOTATION = "\"";
|
|
19
|
+
export type DEFAULT_QUOTATION = typeof DEFAULT_QUOTATION;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CommonOptions } from './common/types.ts';
|
|
2
2
|
|
|
3
|
-
export interface EscapeFieldOptions extends CommonOptions {
|
|
3
|
+
export interface EscapeFieldOptions<Delimiter extends string, Quotation extends string> extends CommonOptions<Delimiter, Quotation> {
|
|
4
4
|
quote?: true;
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
@@ -11,4 +11,4 @@ export interface EscapeFieldOptions extends CommonOptions {
|
|
|
11
11
|
* @param options The options.
|
|
12
12
|
* @returns The escaped field.
|
|
13
13
|
*/
|
|
14
|
-
export declare function escapeField
|
|
14
|
+
export declare function escapeField<const Delimiter extends string, const Quotation extends string>(value: string, options?: EscapeFieldOptions<Delimiter, Quotation>): string;
|
package/dist/types/parse.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { CSVBinary, CSVRecord, CSVString, ParseBinaryOptions, ParseOptions } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
|
+
import { PickCSVHeader } from './utils/types.ts';
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
6
|
* Parse CSV to records.
|
|
@@ -105,7 +107,10 @@ import { CSVBinary, CSVRecord, CSVString, ParseBinaryOptions, ParseOptions } fro
|
|
|
105
107
|
* // { name: 'Bob', age: '69' }
|
|
106
108
|
* ```
|
|
107
109
|
*/
|
|
108
|
-
export declare function parse<
|
|
110
|
+
export declare function parse<const CSVSource extends CSVString>(csv: CSVSource): AsyncIterableIterator<CSVRecord<PickCSVHeader<CSVSource>>>;
|
|
111
|
+
export declare function parse<const Header extends ReadonlyArray<string>>(csv: CSVString): AsyncIterableIterator<CSVRecord<Header>>;
|
|
112
|
+
export declare function parse<const Header extends ReadonlyArray<string>>(csv: CSVString, options: ParseOptions<Header>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
113
|
+
export declare function parse<const CSVSource extends CSVString, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource, Delimiter, Quotation>>(csv: CSVSource, options: ParseOptions<Header, Delimiter, Quotation>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
109
114
|
/**
|
|
110
115
|
* Parse CSV binary to records.
|
|
111
116
|
*
|
|
@@ -142,7 +147,7 @@ export declare function parse<Header extends ReadonlyArray<string>>(csv: CSVStri
|
|
|
142
147
|
* }
|
|
143
148
|
* ```
|
|
144
149
|
*/
|
|
145
|
-
export declare function parse<Header extends ReadonlyArray<string>>(csv: CSVBinary, options?: ParseBinaryOptions<Header>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
150
|
+
export declare function parse<const Header extends ReadonlyArray<string>>(csv: CSVBinary, options?: ParseBinaryOptions<Header>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
146
151
|
export declare namespace parse {
|
|
147
152
|
/**
|
|
148
153
|
* Parse CSV string to array of records,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { CSVRecord, ParseOptions } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
|
+
import { PickCSVHeader } from './utils/types.ts';
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
6
|
* Parse CSV string to records.
|
|
@@ -26,7 +28,11 @@ import { CSVRecord, ParseOptions } from './common/types.ts';
|
|
|
26
28
|
* // { name: 'Bob', age: '69' }
|
|
27
29
|
* ```
|
|
28
30
|
*/
|
|
29
|
-
export declare function parseString<
|
|
31
|
+
export declare function parseString<const CSVSource extends string>(csv: CSVSource): AsyncIterableIterator<CSVRecord<PickCSVHeader<CSVSource>>>;
|
|
32
|
+
export declare function parseString<const Header extends ReadonlyArray<string>>(csv: string): AsyncIterableIterator<CSVRecord<Header>>;
|
|
33
|
+
export declare function parseString<const Header extends ReadonlyArray<string>>(csv: string, options: ParseOptions<Header>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
34
|
+
export declare function parseString<const CSVSource extends string, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource, Delimiter, Quotation>>(csv: CSVSource, options?: ParseOptions<Header, Delimiter, Quotation>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
35
|
+
export declare function parseString(csv: string, options?: ParseOptions): AsyncIterableIterator<CSVRecord<string[]>>;
|
|
30
36
|
export declare namespace parseString {
|
|
31
37
|
/**
|
|
32
38
|
* Parse CSV string to records.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { CSVRecord, ParseOptions } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
|
+
import { PickCSVHeader } from './utils/types.ts';
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
6
|
* Parse CSV string stream to records.
|
|
@@ -34,7 +36,9 @@ import { CSVRecord, ParseOptions } from './common/types.ts';
|
|
|
34
36
|
* // { name: 'Bob', age: '69' }
|
|
35
37
|
* ```
|
|
36
38
|
*/
|
|
37
|
-
export declare function parseStringStream<Header extends ReadonlyArray<string>>(
|
|
39
|
+
export declare function parseStringStream<const CSVSource extends ReadableStream<string>, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource, Delimiter, Quotation>>(csv: CSVSource, options: ParseOptions<Header, Delimiter, Quotation>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
40
|
+
export declare function parseStringStream<const CSVSource extends ReadableStream<string>, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>>(csv: CSVSource, options?: ParseOptions<Header>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
41
|
+
export declare function parseStringStream<const Header extends ReadonlyArray<string>>(stream: ReadableStream<string>, options?: ParseOptions<Header>): AsyncIterableIterator<CSVRecord<Header>>;
|
|
38
42
|
export declare namespace parseStringStream {
|
|
39
43
|
/**
|
|
40
44
|
* Parse CSV string stream to records.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,3 +1,7 @@
|
|
|
1
1
|
import { CSVRecord, ParseOptions } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
|
+
import { PickCSVHeader } from './utils/types.ts';
|
|
2
4
|
|
|
3
|
-
export declare function parseStringStreamToStream<Header extends ReadonlyArray<string>>(stream:
|
|
5
|
+
export declare function parseStringStreamToStream<const CSVSource extends ReadableStream<string>, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource, Delimiter, Quotation>>(stream: CSVSource, options: ParseOptions<Header, Delimiter, Quotation>): ReadableStream<CSVRecord<Header>>;
|
|
6
|
+
export declare function parseStringStreamToStream<const CSVSource extends ReadableStream<string>, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>>(stream: CSVSource, options?: ParseOptions<Header>): ReadableStream<CSVRecord<Header>>;
|
|
7
|
+
export declare function parseStringStreamToStream<const Header extends ReadonlyArray<string>>(stream: ReadableStream<string>, options?: ParseOptions<Header>): ReadableStream<CSVRecord<Header>>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,3 +1,7 @@
|
|
|
1
1
|
import { CSVRecord, ParseOptions } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
|
+
import { PickCSVHeader } from './utils/types.ts';
|
|
2
4
|
|
|
3
|
-
export declare function parseStringToArraySync<Header extends ReadonlyArray<string>>(csv:
|
|
5
|
+
export declare function parseStringToArraySync<const CSVSource extends string, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource, Delimiter, Quotation>>(csv: CSVSource, options: ParseOptions<Header, Delimiter, Quotation>): CSVRecord<Header>[];
|
|
6
|
+
export declare function parseStringToArraySync<const CSVSource extends string, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>>(csv: CSVSource, options?: ParseOptions<Header>): CSVRecord<Header>[];
|
|
7
|
+
export declare function parseStringToArraySync<const Header extends ReadonlyArray<string>>(csv: string, options?: ParseOptions<Header>): CSVRecord<Header>[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { CSVRecord, CommonOptions } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
|
+
import { PickCSVHeader } from './utils/types.ts';
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
6
|
* Parse CSV string to record of arrays.
|
|
@@ -36,4 +38,6 @@ import { CSVRecord, CommonOptions } from './common/types.ts';
|
|
|
36
38
|
* @beta
|
|
37
39
|
* @throws {RangeError | TypeError} - If provided options are invalid.
|
|
38
40
|
*/
|
|
39
|
-
export declare function parseStringToArraySyncWASM<
|
|
41
|
+
export declare function parseStringToArraySyncWASM<const CSVSource extends string, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource, Delimiter, Quotation>>(csv: CSVSource, options: CommonOptions<Delimiter, Quotation>): CSVRecord<Header>[];
|
|
42
|
+
export declare function parseStringToArraySyncWASM<const CSVSource extends string, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>>(csv: CSVSource, options?: CommonOptions<Delimiter, Quotation>): CSVRecord<Header>[];
|
|
43
|
+
export declare function parseStringToArraySyncWASM<const Header extends ReadonlyArray<string>, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION>(csv: string, options?: CommonOptions<Delimiter, Quotation>): CSVRecord<Header>[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,3 +1,7 @@
|
|
|
1
1
|
import { CSVRecord, ParseOptions } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
|
+
import { PickCSVHeader } from './utils/types.ts';
|
|
2
4
|
|
|
3
|
-
export declare function parseStringToIterableIterator<Header extends ReadonlyArray<string>>(
|
|
5
|
+
export declare function parseStringToIterableIterator<const CSVSource extends string, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource, Delimiter, Quotation>>(stream: CSVSource, options: ParseOptions<Header, Delimiter, Quotation>): IterableIterator<CSVRecord<Header>>;
|
|
6
|
+
export declare function parseStringToIterableIterator<const CSVSource extends string, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>>(stream: CSVSource, options?: ParseOptions<Header>): IterableIterator<CSVRecord<Header>>;
|
|
7
|
+
export declare function parseStringToIterableIterator<const Header extends ReadonlyArray<string>>(stream: string, options?: ParseOptions<Header>): IterableIterator<CSVRecord<Header>>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,3 +1,7 @@
|
|
|
1
1
|
import { CSVRecord, ParseOptions } from './common/types.ts';
|
|
2
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION } from './constants.ts';
|
|
3
|
+
import { PickCSVHeader } from './utils/types.ts';
|
|
2
4
|
|
|
3
|
-
export declare function parseStringToStream<Header extends ReadonlyArray<string>>(
|
|
5
|
+
export declare function parseStringToStream<const CSVSource extends string, const Delimiter extends string = DEFAULT_DELIMITER, const Quotation extends string = DEFAULT_QUOTATION, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource, Delimiter, Quotation>>(stream: CSVSource, options: ParseOptions<Header, Delimiter, Quotation>): ReadableStream<CSVRecord<Header>>;
|
|
6
|
+
export declare function parseStringToStream<const CSVSource extends string, const Header extends ReadonlyArray<string> = PickCSVHeader<CSVSource>>(stream: CSVSource, options?: ParseOptions<Header>): ReadableStream<CSVRecord<Header>>;
|
|
7
|
+
export declare function parseStringToStream<const Header extends ReadonlyArray<string>>(stream: string, options?: ParseOptions<Header>): ReadableStream<CSVRecord<Header>>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { DEFAULT_DELIMITER, DEFAULT_QUOTATION, Newline } from '../constants.ts';
|
|
2
|
+
import { CSVString } from '../web-csv-toolbox.ts';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Generate new string by concatenating all of the elements in array.
|
|
6
|
+
*
|
|
7
|
+
* @category Types
|
|
8
|
+
*
|
|
9
|
+
* @example Default
|
|
10
|
+
*
|
|
11
|
+
* ```ts
|
|
12
|
+
* const header = ["name", "age", "city", "zip"];
|
|
13
|
+
*
|
|
14
|
+
* type _ = Join<typeof header>
|
|
15
|
+
* // `name,age,city,zip`
|
|
16
|
+
* ```
|
|
17
|
+
*
|
|
18
|
+
* @example With different delimiter and quotation
|
|
19
|
+
*
|
|
20
|
+
* ```ts
|
|
21
|
+
* const header = ["name", "a\nge", "city", "zip"];
|
|
22
|
+
*
|
|
23
|
+
* type _ = Join<typeof header, "@", "$">
|
|
24
|
+
* // `name@$a\nge$@city@zip`
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
export type Join<Chars extends ReadonlyArray<string | number | boolean | bigint>, Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION, Nl extends string = Exclude<Newline, Delimiter | Quotation>> = Chars extends readonly [infer F, ...infer R] ? F extends string ? R extends string[] ? `${F extends `${string}${Nl | Delimiter | Quotation}${string}` ? `${Quotation}${F}${Quotation}` : F}${R extends [] ? "" : Delimiter}${Join<R, Delimiter, Quotation>}` : string : string : "";
|
|
28
|
+
/**
|
|
29
|
+
* Generate a delimiter-separated tuple from a string.
|
|
30
|
+
*
|
|
31
|
+
* @category Types
|
|
32
|
+
*
|
|
33
|
+
* @example Default
|
|
34
|
+
*
|
|
35
|
+
* ```ts
|
|
36
|
+
* const header = `name,age,city,zip`;
|
|
37
|
+
*
|
|
38
|
+
* type _ = Split<typeof header>
|
|
39
|
+
* // ["name", "age", "city", "zip"]
|
|
40
|
+
* ```
|
|
41
|
+
*
|
|
42
|
+
* @example With different delimiter and quotation
|
|
43
|
+
*
|
|
44
|
+
* ```ts
|
|
45
|
+
* const header = `name@$a
|
|
46
|
+
* ge$@city@zip`;
|
|
47
|
+
*
|
|
48
|
+
* type _ = Split<typeof header, "@", "$">
|
|
49
|
+
* // ["name", "a\nge", "city", "zip"]
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
export type Split<Char extends string, Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION, Escaping extends boolean = false, Col extends string = "", Result extends string[] = []> = Char extends `${Delimiter}${infer R}` ? Escaping extends true ? Split<R, Delimiter, Quotation, true, `${Col}${Delimiter}`, Result> : Split<R, Delimiter, Quotation, false, "", [...Result, Col]> : Char extends `${Quotation}${infer R}` ? Escaping extends true ? R extends "" | Delimiter | `${Delimiter}${string}` ? Split<R, Delimiter, Quotation, false, Col, Result> : Split<R, Delimiter, Quotation, true, `${Col}${Quotation}`, Result> : Split<R, Delimiter, Quotation, true, Col, Result> : Char extends `${infer F}${infer R}` ? Split<R, Delimiter, Quotation, Escaping, `${Col}${F}`, Result> : [...Result, Col] extends [""] ? readonly string[] : readonly [...Result, Col];
|
|
53
|
+
type ExtractString<Source extends CSVString> = Source extends `${infer S}` | ReadableStream<infer S> ? S : string;
|
|
54
|
+
type ExtractCSVBody<CSVSource extends CSVString, Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION, Nl extends string = Exclude<Newline, Delimiter | Quotation>, Escaping extends boolean = false> = ExtractString<CSVSource> extends `${Quotation}${infer R}` ? Escaping extends true ? R extends Delimiter | Nl | `${Delimiter | Nl}${string}` ? ExtractCSVBody<R, Delimiter, Quotation, Nl, false> : ExtractCSVBody<R, Delimiter, Quotation, Nl, true> : ExtractCSVBody<R, Delimiter, Quotation, Nl, true> : ExtractString<CSVSource> extends `${infer _ extends Nl}${infer R}` ? Escaping extends true ? ExtractCSVBody<R, Delimiter, Quotation, Nl, true> : R : ExtractString<CSVSource> extends `${infer _}${infer R}` ? ExtractCSVBody<R, Delimiter, Quotation, Nl, Escaping> : "";
|
|
55
|
+
/**
|
|
56
|
+
* Extract a CSV header string from a CSVString.
|
|
57
|
+
*
|
|
58
|
+
* @category Types
|
|
59
|
+
*
|
|
60
|
+
* @example Default
|
|
61
|
+
*
|
|
62
|
+
* ```ts
|
|
63
|
+
* const csv = `name,age
|
|
64
|
+
* Alice,42
|
|
65
|
+
* Bob,69`;
|
|
66
|
+
*
|
|
67
|
+
* type _ = ExtractCSVHeader<typeof csv>
|
|
68
|
+
* // "name,age"
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @example With different delimiter and quotation
|
|
72
|
+
*
|
|
73
|
+
* ```ts
|
|
74
|
+
* const csv = `name@$a
|
|
75
|
+
* ge$
|
|
76
|
+
* $Ali
|
|
77
|
+
* ce$@42
|
|
78
|
+
* Bob@69`;
|
|
79
|
+
*
|
|
80
|
+
* type _ = ExtractCSVHeader<typeof csv, "@", "$">
|
|
81
|
+
* // "name@$a\nge$"
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
export type ExtractCSVHeader<CSVSource extends CSVString, Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION, Nl extends string = Exclude<Newline, Delimiter | Quotation>, Escaping extends boolean = false> = ExtractString<CSVSource> extends `${infer Header}${Newline}${ExtractCSVBody<CSVSource, Delimiter, Quotation, Nl, Escaping>}` ? Header : ExtractString<CSVSource>;
|
|
85
|
+
/**
|
|
86
|
+
* Generates a delimiter-separated tuple of CSV headers from a CSVString.
|
|
87
|
+
*
|
|
88
|
+
* @category Types
|
|
89
|
+
*
|
|
90
|
+
* @example Default
|
|
91
|
+
*
|
|
92
|
+
* ```ts
|
|
93
|
+
* const csv = `name,age
|
|
94
|
+
* Alice,42
|
|
95
|
+
* Bob,69`;
|
|
96
|
+
*
|
|
97
|
+
* type _ = PickCSVHeader<typeof csv>
|
|
98
|
+
* // ["name", "age"]
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
101
|
+
* @example With different delimiter and quotation
|
|
102
|
+
*
|
|
103
|
+
* ```ts
|
|
104
|
+
* const csv = `name@$a
|
|
105
|
+
* ge$
|
|
106
|
+
* $Ali
|
|
107
|
+
* ce$@42
|
|
108
|
+
* Bob@69`;
|
|
109
|
+
*
|
|
110
|
+
* type _ = PickCSVHeader<typeof csv, "@", "$">
|
|
111
|
+
* // ["name", "a\nge"]
|
|
112
|
+
* ```
|
|
113
|
+
*/
|
|
114
|
+
export type PickCSVHeader<CSVSource extends CSVString, Delimiter extends string = DEFAULT_DELIMITER, Quotation extends string = DEFAULT_QUOTATION> = ExtractString<CSVSource> extends `${infer S}` ? Split<ExtractCSVHeader<S, Delimiter, Quotation>, Delimiter, Quotation> : ReadonlyArray<string>;
|
|
115
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|