split-webstreams

Break up a stream and reassemble it so that each line is a chunk. split-webstreams is inspired by split2.

However this is for web streams which is support by Node(>18) and browser.

Zero dependency! And package working in node.js (> 18) and browser.

streams sepc: https://streams.spec.whatwg.org/

MDN doc: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API

API

split is same as String/split. But not support limit parameter.

split only accept string chunk, please pipeThrough TextDecoderStream first.

1import { split } from 'split-webstreams';
2const reader = Readable.toWeb(
3  createReadStream(path.join(__dirname, 'test-data.txt'))
4)
5  .pipeThrough(new TextDecoderStream())
6  .pipeThrough(split());
7
8for await (const chunk of reader) {
9  console.log(chunk);
10}

Install

npm

1$ npm i split-webstreams

jsdelivr

ESM

1<script type="module">
2  import { split } from 'https://cdn.jsdelivr.net/npm/split-webstreams@latest';
3  console.log(split());
4</script>

esm-example-html

UMD

1<script src="https://cdn.jsdelivr.net/npm/split-webstreams@latest/dist/split-webstreams.umd.js"></script>
2<script>
3  console.log(window['split-webstreams'].split());
4</script>

umd-example-html

Usage

1(async () => {
2  await fetch(`https://rickandmortyapi.com/api/character/23`)
3    .then((res) => res.body)
4    .then(async (body) => {
5      const reader = body
6        ?.pipeThrough(new TextDecoderStream())
7        .pipeThrough(split())
8        .getReader();
9      for (
10        let result = await reader?.read();
11        !result?.done;
12        result = await reader?.read()
13      ) {
14        console.log('[value]', result?.value);
15      }
16      // …
17    });
18})();