docs: update readme files (#127)

Regenerates all docs
achingbrain · Apr 25, 2024 · b168296 · b168296
1 parent 837e99e
commit b168296
Show file tree

Hide file tree

Showing 33 changed files with 524 additions and 74 deletions.
diff --git a/packages/blob-to-it/README.md b/packages/blob-to-it/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/blob-to-it/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/blob-to-it/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git 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
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/browser-readablestream-to-it/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/browser-readablestream-to-it/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-all/README.md b/packages/it-all/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-all/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-all/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-batch/README.md b/packages/it-batch/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-batch/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-batch/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-batched-bytes/README.md b/packages/it-batched-bytes/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-batched-bytes/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-batched-bytes/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-buffer-stream/README.md b/packages/it-buffer-stream/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-buffer-stream/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-buffer-stream/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-byte-stream/README.md b/packages/it-byte-stream/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-byte-stream/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-byte-stream/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-drain/README.md b/packages/it-drain/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-drain/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-drain/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-filter/README.md b/packages/it-filter/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-filter/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-filter/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-first/README.md b/packages/it-first/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-first/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-first/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

diff --git a/packages/it-flat-batch/README.md b/packages/it-flat-batch/README.md
@@ -7,6 +7,21 @@
 
 # About
 
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
 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) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-flat-batch/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-flat-batch/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution