web-csv-toolbox
    Preparing search index...

    Function parseStringStream

    • Parse CSV string stream to records.

      Type Parameters

      • const CSVSource extends ReadableStream<string>
      • const Delimiter extends string = ","
      • const Quotation extends string = "\""
      • const Header extends readonly string[] = PickCSVHeader<CSVSource, Delimiter, Quotation>

      Parameters

      Returns AsyncIterableIterator<CSVRecord<Header>>

      Async iterable iterator of records.

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

      import { parseStringStream } 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 parseStringStream(csv)) {
        console.log(record);
      }
      // Prints:
      // { name: 'Alice', age: '42' }
      // { name: 'Bob', age: '69' }

    • Parse CSV string stream to records.

      Type Parameters

      Parameters

      Returns AsyncIterableIterator<CSVRecord<Header>>

      Async iterable iterator of records.

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

      import { parseStringStream } 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 parseStringStream(csv)) {
        console.log(record);
      }
      // Prints:
      // { name: 'Alice', age: '42' }
      // { name: 'Bob', age: '69' }

    • Parse CSV string stream to records.

      Type Parameters

      • const Header extends readonly string[]

      Parameters

      Returns AsyncIterableIterator<CSVRecord<Header>>

      Async iterable iterator of records.

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

      import { parseStringStream } 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 parseStringStream(csv)) {
        console.log(record);
      }
      // Prints:
      // { name: 'Alice', age: '42' }
      // { name: 'Bob', age: '69' }

    Settings

    Member Visibility