From b168296357504d70ec4ec0486d6de166f8ee5446 Mon Sep 17 00:00:00 2001 From: Alex Potsides Date: Thu, 25 Apr 2024 18:06:42 +0100 Subject: [PATCH] docs: update readme files (#127) Regenerates all docs --- packages/blob-to-it/README.md | 19 +++++++++++++-- packages/blob-to-it/package.json | 2 +- .../browser-readablestream-to-it/README.md | 19 +++++++++++++-- packages/it-all/README.md | 19 +++++++++++++-- packages/it-batch/README.md | 19 +++++++++++++-- packages/it-batched-bytes/README.md | 19 +++++++++++++-- packages/it-buffer-stream/README.md | 19 +++++++++++++-- packages/it-byte-stream/README.md | 19 +++++++++++++-- packages/it-drain/README.md | 19 +++++++++++++-- packages/it-filter/README.md | 23 +++++++++++++++---- packages/it-first/README.md | 19 +++++++++++++-- packages/it-flat-batch/README.md | 19 +++++++++++++-- packages/it-foreach/README.md | 23 +++++++++++++++---- packages/it-glob/README.md | 4 ++-- packages/it-last/README.md | 19 +++++++++++++-- packages/it-length-prefixed-stream/README.md | 19 +++++++++++++-- packages/it-length/README.md | 19 +++++++++++++-- packages/it-map/README.md | 23 +++++++++++++++---- packages/it-merge/README.md | 19 +++++++++++++-- packages/it-multipart/README.md | 19 +++++++++++++-- packages/it-ndjson/README.md | 19 +++++++++++++-- packages/it-parallel-batch/README.md | 19 +++++++++++++-- packages/it-parallel/README.md | 19 +++++++++++++-- packages/it-peekable/README.md | 19 +++++++++++++-- packages/it-protobuf-stream/README.md | 19 +++++++++++++-- packages/it-reduce/README.md | 23 +++++++++++++++---- packages/it-skip/README.md | 19 +++++++++++++-- packages/it-sort/README.md | 19 +++++++++++++-- packages/it-split/README.md | 19 +++++++++++++-- packages/it-take/README.md | 19 +++++++++++++-- .../it-to-browser-readablestream/README.md | 19 +++++++++++++-- .../it-to-browser-readablestream/package.json | 6 ++--- packages/it-to-buffer/README.md | 19 +++++++++++++-- 33 files changed, 524 insertions(+), 74 deletions(-) diff --git a/packages/blob-to-it/README.md b/packages/blob-to-it/README.md index 0093ca97..681606d3 100644 --- a/packages/blob-to-it/README.md +++ b/packages/blob-to-it/README.md @@ -7,6 +7,21 @@ # About + + Allows reading Blob contents as an async iterator. ## Example @@ -44,8 +59,8 @@ Loading this module through a script tag will make it's exports available as `Bl Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/blob-to-it/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/blob-to-it/LICENSE-MIT) / ) # Contribution diff --git a/packages/blob-to-it/package.json b/packages/blob-to-it/package.json index 456ebdeb..dbdb0828 100644 --- a/packages/blob-to-it/package.json +++ b/packages/blob-to-it/package.json @@ -52,7 +52,7 @@ "browser-readablestream-to-it": "^2.0.0" }, "devDependencies": { - "aegir": "^42.2.5", + "aegir": "^42.2.7", "it-all": "^3.0.0" } } diff --git a/packages/browser-readablestream-to-it/README.md b/packages/browser-readablestream-to-it/README.md index c8637204..cb0890ac 100644 --- a/packages/browser-readablestream-to-it/README.md +++ b/packages/browser-readablestream-to-it/README.md @@ -7,6 +7,21 @@ # About + + Allows treating a browser readable stream as an async iterator. ## Example @@ -67,8 +82,8 @@ Loading this module through a script tag will make it's exports available as `Br Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/browser-readablestream-to-it/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/browser-readablestream-to-it/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-all/README.md b/packages/it-all/README.md index 26d1cb5c..6cde74b7 100644 --- a/packages/it-all/README.md +++ b/packages/it-all/README.md @@ -7,6 +7,21 @@ # About + + For when you need a one-liner to collect iterable values. ## Example @@ -58,8 +73,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-all/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-all/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-batch/README.md b/packages/it-batch/README.md index 97f0a390..3128a1ac 100644 --- a/packages/it-batch/README.md +++ b/packages/it-batch/README.md @@ -7,6 +7,21 @@ # About + + The final batch may be smaller than the max. ## Example @@ -62,8 +77,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-batch/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-batch/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-batched-bytes/README.md b/packages/it-batched-bytes/README.md index cbd20ee1..ea89edff 100644 --- a/packages/it-batched-bytes/README.md +++ b/packages/it-batched-bytes/README.md @@ -7,6 +7,21 @@ # About + + The final batch may be smaller than the max. ## Example @@ -72,8 +87,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-batched-bytes/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-batched-bytes/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-buffer-stream/README.md b/packages/it-buffer-stream/README.md index 8b25e99e..206efff1 100644 --- a/packages/it-buffer-stream/README.md +++ b/packages/it-buffer-stream/README.md @@ -7,6 +7,21 @@ # About + + Generate a stream of buffers, useful for testing purposes. ## Example @@ -61,8 +76,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-buffer-stream/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-buffer-stream/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-byte-stream/README.md b/packages/it-byte-stream/README.md index e73794d5..2ef41f57 100644 --- a/packages/it-byte-stream/README.md +++ b/packages/it-byte-stream/README.md @@ -7,6 +7,21 @@ # About + + This module makes it easy to send and receive bytes over streams. ## Example @@ -48,8 +63,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-byte-stream/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-byte-stream/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-drain/README.md b/packages/it-drain/README.md index 70ce13c5..c7734de3 100644 --- a/packages/it-drain/README.md +++ b/packages/it-drain/README.md @@ -7,6 +7,21 @@ # About + + Mostly useful for tests or when you want to be explicit about consuming an iterable without doing anything with any yielded values. ## Example @@ -54,8 +69,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-drain/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-drain/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-filter/README.md b/packages/it-filter/README.md index b3420274..19378527 100644 --- a/packages/it-filter/README.md +++ b/packages/it-filter/README.md @@ -7,6 +7,21 @@ # About + + Filter values out of an (async)iterable ## Example @@ -18,7 +33,7 @@ import filter from 'it-filter' // This can also be an iterator, generator, etc const values = [0, 1, 2, 3, 4] -const fn = val => val > 2 // Return boolean to keep item +const fn = (val, index) => val > 2 // Return boolean to keep item const arr = all(filter(values, fn)) @@ -35,7 +50,7 @@ const values = async function * () { yield * [0, 1, 2, 3, 4] } -const fn = async val => val > 2 // Return boolean or promise of boolean to keep item +const fn = async val => (val, index) > 2 // Return boolean or promise of boolean to keep item const arr = await all(filter(values, fn)) @@ -64,8 +79,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-filter/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-filter/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-first/README.md b/packages/it-first/README.md index e6e4d803..78c1d15a 100644 --- a/packages/it-first/README.md +++ b/packages/it-first/README.md @@ -7,6 +7,21 @@ # About + + Return the first value in an (async)iterable ## Example @@ -58,8 +73,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-first/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-first/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-flat-batch/README.md b/packages/it-flat-batch/README.md index 3dbd7305..f62b2680 100644 --- a/packages/it-flat-batch/README.md +++ b/packages/it-flat-batch/README.md @@ -7,6 +7,21 @@ # About + + The final batch may be smaller than requested batch size. ## Example @@ -62,8 +77,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-flat-batch/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-flat-batch/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-foreach/README.md b/packages/it-foreach/README.md index 5c12a70c..da79641b 100644 --- a/packages/it-foreach/README.md +++ b/packages/it-foreach/README.md @@ -7,6 +7,21 @@ # About + + Calls a function for each value in an (async)iterable. The function can be sync or async. @@ -22,7 +37,7 @@ import drain from 'it-drain' // This can also be an iterator, generator, etc const values = [0, 1, 2, 3, 4] -// prints 0, 1, 2, 3, 4 +// prints [0, 0], [1, 1], [2, 2], [3, 3], [4, 4] const arr = drain( each(values, console.info) ) @@ -38,7 +53,7 @@ const values = async function * () { yield * [0, 1, 2, 3, 4] } -// prints 0, 1, 2, 3, 4 +// prints [0, 0], [1, 1], [2, 2], [3, 3], [4, 4] const arr = await drain( each(values(), console.info) ) @@ -66,8 +81,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-foreach/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-foreach/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-glob/README.md b/packages/it-glob/README.md index 169915c2..c2830b4e 100644 --- a/packages/it-glob/README.md +++ b/packages/it-glob/README.md @@ -55,8 +55,8 @@ $ npm i it-glob Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-glob/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-glob/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-last/README.md b/packages/it-last/README.md index 5f0ccd53..e94fe244 100644 --- a/packages/it-last/README.md +++ b/packages/it-last/README.md @@ -7,6 +7,21 @@ # About + + Return the last value from an (async)iterable. ## Example @@ -58,8 +73,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-last/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-last/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-length-prefixed-stream/README.md b/packages/it-length-prefixed-stream/README.md index b302efbc..f772a01f 100644 --- a/packages/it-length-prefixed-stream/README.md +++ b/packages/it-length-prefixed-stream/README.md @@ -7,6 +7,21 @@ # About + + This module makes it easy to send and receive length-prefixed byte arrays over streams. ## Example @@ -51,8 +66,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-length-prefixed-stream/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-length-prefixed-stream/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-length/README.md b/packages/it-length/README.md index 2a8a0da9..3b03040a 100644 --- a/packages/it-length/README.md +++ b/packages/it-length/README.md @@ -7,6 +7,21 @@ # About + + Counts the number of items in an (async)iterable. N.b. will consume the iterable @@ -60,8 +75,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-length/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-length/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-map/README.md b/packages/it-map/README.md index 9b0043dc..d342c365 100644 --- a/packages/it-map/README.md +++ b/packages/it-map/README.md @@ -7,6 +7,21 @@ # About + + Convert one value from an (async)iterator into another. ## Example @@ -17,7 +32,7 @@ import map from 'it-map' // This can also be an iterator, generator, etc const values = [0, 1, 2, 3, 4] -const result = map(values, (val) => val++) +const result = map(values, (val, index) => val++) console.info(result) // [1, 2, 3, 4, 5] ``` @@ -31,7 +46,7 @@ const values = async function * () { yield * [0, 1, 2, 3, 4] } -const result = await map(values(), async (val) => val++) +const result = await map(values(), async (val, index) => val++) console.info(result) // [1, 2, 3, 4, 5] ``` @@ -58,8 +73,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-map/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-map/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-merge/README.md b/packages/it-merge/README.md index 3f9afd24..39ab7e3d 100644 --- a/packages/it-merge/README.md +++ b/packages/it-merge/README.md @@ -7,6 +7,21 @@ # About + + Merge several (async)iterables into one, yield values as they arrive. Nb. sources are iterated over in parallel so the order of emitted items is not guaranteed. @@ -67,8 +82,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-merge/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-merge/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-multipart/README.md b/packages/it-multipart/README.md index d0cec309..ba4e744d 100644 --- a/packages/it-multipart/README.md +++ b/packages/it-multipart/README.md @@ -7,6 +7,21 @@ # About + + Allows iterating over multipart messages found in a HTTP request/ ## Example @@ -52,8 +67,8 @@ $ npm i it-multipart Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-multipart/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-multipart/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-ndjson/README.md b/packages/it-ndjson/README.md index 715dd47b..3b86ab5f 100644 --- a/packages/it-ndjson/README.md +++ b/packages/it-ndjson/README.md @@ -7,6 +7,21 @@ # About + + Turn (async)iterable values into JSON and back again. ## Example @@ -49,8 +64,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-ndjson/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-ndjson/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-parallel-batch/README.md b/packages/it-parallel-batch/README.md index 91046931..149a3960 100644 --- a/packages/it-parallel-batch/README.md +++ b/packages/it-parallel-batch/README.md @@ -7,6 +7,21 @@ # About + + Takes an async iterator that emits promise-returning functions, invokes them in parallel and emits the results in the same order as the input. The final batch may be smaller than the batch size. @@ -66,8 +81,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-parallel-batch/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-parallel-batch/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-parallel/README.md b/packages/it-parallel/README.md index 60b7fdcf..6c6c034d 100644 --- a/packages/it-parallel/README.md +++ b/packages/it-parallel/README.md @@ -7,6 +7,21 @@ # About + + Takes an (async) iterable that emits promise-returning functions, invokes them in parallel up to the concurrency limit and emits the results as they become available, optionally in the same order as the input ## Example @@ -97,8 +112,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-parallel/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-parallel/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-peekable/README.md b/packages/it-peekable/README.md index 27873fc3..1fae98ac 100644 --- a/packages/it-peekable/README.md +++ b/packages/it-peekable/README.md @@ -7,6 +7,21 @@ # About + + Lets you look at the contents of an async iterator and decide what to do ## Example @@ -72,8 +87,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-peekable/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-peekable/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-protobuf-stream/README.md b/packages/it-protobuf-stream/README.md index 75044823..f52b6377 100644 --- a/packages/it-protobuf-stream/README.md +++ b/packages/it-protobuf-stream/README.md @@ -7,6 +7,21 @@ # About + + This module makes it easy to send and receive length-prefixed Protobuf encoded messages over streams. @@ -52,8 +67,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-protobuf-stream/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-protobuf-stream/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-reduce/README.md b/packages/it-reduce/README.md index 50513b42..2a954ee3 100644 --- a/packages/it-reduce/README.md +++ b/packages/it-reduce/README.md @@ -7,6 +7,21 @@ # About + + Reduce the values of an (async)iterable to a single value. ## Example @@ -17,7 +32,7 @@ import reduce from 'it-reduce' // This can also be an iterator, generator, etc const values = [0, 1, 2, 3, 4] -const result = reduce(values, (acc, curr) => acc + curr, 0) +const result = reduce(values, (acc, curr, index) => acc + curr, 0) console.info(result) // 10 ``` @@ -31,7 +46,7 @@ const values = async function * () { yield * [0, 1, 2, 3, 4] } -const result = await reduce(values(), (acc, curr) => acc + curr, 0) +const result = await reduce(values(), (acc, curr, index) => acc + curr, 0) console.info(result) // 10 ``` @@ -58,8 +73,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-reduce/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-reduce/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-skip/README.md b/packages/it-skip/README.md index 0599977c..7005a5ad 100644 --- a/packages/it-skip/README.md +++ b/packages/it-skip/README.md @@ -7,6 +7,21 @@ # About + + For when you are only interested in later values from an (async)iterable. ## Example @@ -60,8 +75,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-skip/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-skip/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-sort/README.md b/packages/it-sort/README.md index 183b3f8b..3ba64832 100644 --- a/packages/it-sort/README.md +++ b/packages/it-sort/README.md @@ -7,6 +7,21 @@ # About + + Consumes all values from an (async)iterable and returns them sorted by the passed sort function. ## Example @@ -68,8 +83,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-sort/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-sort/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-split/README.md b/packages/it-split/README.md index 9f1ce23f..cf121c2b 100644 --- a/packages/it-split/README.md +++ b/packages/it-split/README.md @@ -7,6 +7,21 @@ # About + + Searches `Uint8Array`s emitted by an (async)iterable for a delimiter and yields chunks split by that delimiter. ## Example @@ -85,8 +100,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-split/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-split/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-take/README.md b/packages/it-take/README.md index 0b214d4a..f8f67f00 100644 --- a/packages/it-take/README.md +++ b/packages/it-take/README.md @@ -7,6 +7,21 @@ # About + + For when you only want a few values out of an (async)iterable. ## Example @@ -60,8 +75,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-take/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-take/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-to-browser-readablestream/README.md b/packages/it-to-browser-readablestream/README.md index 64b23d06..7862bd3a 100644 --- a/packages/it-to-browser-readablestream/README.md +++ b/packages/it-to-browser-readablestream/README.md @@ -7,6 +7,21 @@ # About + + Turns an (async)iterable into a W3C ReadbleStream. ## Example @@ -46,8 +61,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-to-browser-readablestream/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-to-browser-readablestream/LICENSE-MIT) / ) # Contribution diff --git a/packages/it-to-browser-readablestream/package.json b/packages/it-to-browser-readablestream/package.json index d7af67a8..292c0993 100644 --- a/packages/it-to-browser-readablestream/package.json +++ b/packages/it-to-browser-readablestream/package.json @@ -48,10 +48,10 @@ "test:firefox": "aegir test -t browser -- --browser firefox", "test:firefox-webworker": "aegir test -t webworker -- --browser firefox" }, - "devDependencies": { - "aegir": "^42.2.5" - }, "dependencies": { "get-iterator": "^2.0.1" + }, + "devDependencies": { + "aegir": "^42.2.5" } } diff --git a/packages/it-to-buffer/README.md b/packages/it-to-buffer/README.md index 3549a886..bfeb1152 100644 --- a/packages/it-to-buffer/README.md +++ b/packages/it-to-buffer/README.md @@ -7,6 +7,21 @@ # About + + Collects all `Uint8Array` values from an (async)iterable and returns them as a single `Uint8Array`. ## Example @@ -59,8 +74,8 @@ Loading this module through a script tag will make it's exports available as `It Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-to-buffer/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-to-buffer/LICENSE-MIT) / ) # Contribution