From 67d521dbe0324ceb3e28a85b185a27139e48e50c Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Sat, 2 Dec 2023 13:36:15 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- assets/highlight.css | 48 +++++++++++------- assets/navigation.js | 2 +- assets/search.js | 2 +- classes/it_byte_stream.AbortError.html | 14 ++++++ classes/it_byte_stream.CodeError.html | 13 +++++ functions/blob_to_it.default.html | 1 + .../browser_readablestream_to_it.default.html | 6 +++ functions/it_all.default.html | 2 + functions/it_batch.default.html | 3 ++ functions/it_batched_bytes.default.html | 4 ++ functions/it_buffer_stream.default.html | 2 + functions/it_byte_stream.byteStream-1.html | 1 + functions/it_drain.default.html | 3 ++ functions/it_filter.default.html | 2 + functions/it_first.default.html | 3 ++ functions/it_flat_batch.default.html | 3 ++ functions/it_foreach.default.html | 2 + functions/it_glob.default.html | 2 + functions/it_last.default.html | 3 ++ functions/it_length.default.html | 2 + .../it_length_prefixed_stream.lpStream.html | 1 + functions/it_map.default.html | 3 ++ functions/it_merge.default.html | 4 ++ functions/it_multipart.default.html | 2 + .../it_ndjson.parse.html | 3 +- functions/it_ndjson.stringify.html | 1 + functions/it_parallel.default.html | 4 ++ functions/it_parallel_batch.default.html | 4 ++ functions/it_peekable.default.html | 1 + functions/it_protobuf_stream.pbStream.html | 1 + functions/it_reduce.default.html | 2 + functions/it_skip.default.html | 2 + functions/it_sort.default.html | 3 ++ functions/it_split.default.html | 2 + functions/it_take.default.html | 2 + .../it_to_browser_readablestream.default.html | 2 + functions/it_to_buffer.default.html | 3 ++ functions/pbStream.html | 1 - index.html | 50 ++++++++++++++----- interfaces/Decoder.html | 2 - interfaces/Encoder.html | 2 - interfaces/MessageStream.html | 10 ---- interfaces/ProtobufStream.html | 12 ----- interfaces/ProtobufStreamOpts.html | 10 ---- ...o_it.BrowserReadableStreamToItOptions.html | 2 + ...atched_bytes.AsyncBatchedBytesOptions.html | 6 +++ ...ched_bytes.AsyncBatchedObjectsOptions.html | 9 ++++ .../it_batched_bytes.BatchedBytesOptions.html | 3 ++ ...t_batched_bytes.BatchedObjectsOptions.html | 6 +++ .../it_buffer_stream.BufferStreamOptions.html | 4 ++ interfaces/it_byte_stream.AbortOptions.html | 2 + interfaces/it_byte_stream.ByteStream.html | 7 +++ interfaces/it_byte_stream.ByteStreamOpts.html | 6 +++ interfaces/it_glob.GlobOptions.html | 27 ++++++++++ ...t_length_prefixed_stream.AbortOptions.html | 2 + ..._prefixed_stream.LengthPrefixedStream.html | 9 ++++ ...fixed_stream.LengthPrefixedStreamOpts.html | 10 ++++ interfaces/it_multipart.Part.html | 3 ++ interfaces/it_parallel.ParallelOptions.html | 4 ++ interfaces/it_peekable.AsyncPeek.html | 2 + interfaces/it_peekable.Peek.html | 2 + interfaces/it_peekable.Push.html | 2 + .../it_protobuf_stream.AbortOptions.html | 2 + interfaces/it_protobuf_stream.Decoder.html | 2 + interfaces/it_protobuf_stream.Encoder.html | 2 + .../it_protobuf_stream.MessageStream.html | 10 ++++ .../it_protobuf_stream.ProtobufStream.html | 12 +++++ ...it_protobuf_stream.ProtobufStreamOpts.html | 10 ++++ interfaces/it_sort.CompareFunction.html | 1 + interfaces/it_split.SplitOptions.html | 2 + modules.html | 12 ----- modules/blob_to_it.html | 27 ++++++++++ modules/browser_readablestream_to_it.html | 38 ++++++++++++++ modules/it_all.html | 33 ++++++++++++ modules/it_batch.html | 33 ++++++++++++ modules/it_batched_bytes.html | 37 ++++++++++++++ modules/it_buffer_stream.html | 28 +++++++++++ modules/it_byte_stream.html | 32 ++++++++++++ modules/it_drain.html | 33 ++++++++++++ modules/it_filter.html | 33 ++++++++++++ modules/it_first.html | 33 ++++++++++++ modules/it_flat_batch.html | 33 ++++++++++++ modules/it_foreach.html | 37 ++++++++++++++ modules/it_glob.html | 27 ++++++++++ modules/it_last.html | 33 ++++++++++++ modules/it_length.html | 35 +++++++++++++ modules/it_length_prefixed_stream.html | 30 +++++++++++ modules/it_map.html | 33 ++++++++++++ modules/it_merge.html | 35 +++++++++++++ modules/it_multipart.html | 25 ++++++++++ modules/it_ndjson.html | 28 +++++++++++ modules/it_parallel.html | 34 +++++++++++++ modules/it_parallel_batch.html | 29 +++++++++++ modules/it_peekable.html | 38 ++++++++++++++ modules/it_protobuf_stream.html | 35 +++++++++++++ modules/it_reduce.html | 33 ++++++++++++ modules/it_skip.html | 33 ++++++++++++ modules/it_sort.html | 34 +++++++++++++ modules/it_split.html | 40 +++++++++++++++ modules/it_take.html | 33 ++++++++++++ modules/it_to_browser_readablestream.html | 27 ++++++++++ modules/it_to_buffer.html | 33 ++++++++++++ types/it_peekable.AsyncPeekable.html | 1 + types/it_peekable.Peekable.html | 1 + 104 files changed, 1335 insertions(+), 83 deletions(-) create mode 100644 classes/it_byte_stream.AbortError.html create mode 100644 classes/it_byte_stream.CodeError.html create mode 100644 functions/blob_to_it.default.html create mode 100644 functions/browser_readablestream_to_it.default.html create mode 100644 functions/it_all.default.html create mode 100644 functions/it_batch.default.html create mode 100644 functions/it_batched_bytes.default.html create mode 100644 functions/it_buffer_stream.default.html create mode 100644 functions/it_byte_stream.byteStream-1.html create mode 100644 functions/it_drain.default.html create mode 100644 functions/it_filter.default.html create mode 100644 functions/it_first.default.html create mode 100644 functions/it_flat_batch.default.html create mode 100644 functions/it_foreach.default.html create mode 100644 functions/it_glob.default.html create mode 100644 functions/it_last.default.html create mode 100644 functions/it_length.default.html create mode 100644 functions/it_length_prefixed_stream.lpStream.html create mode 100644 functions/it_map.default.html create mode 100644 functions/it_merge.default.html create mode 100644 functions/it_multipart.default.html rename interfaces/AbortOptions.html => functions/it_ndjson.parse.html (66%) create mode 100644 functions/it_ndjson.stringify.html create mode 100644 functions/it_parallel.default.html create mode 100644 functions/it_parallel_batch.default.html create mode 100644 functions/it_peekable.default.html create mode 100644 functions/it_protobuf_stream.pbStream.html create mode 100644 functions/it_reduce.default.html create mode 100644 functions/it_skip.default.html create mode 100644 functions/it_sort.default.html create mode 100644 functions/it_split.default.html create mode 100644 functions/it_take.default.html create mode 100644 functions/it_to_browser_readablestream.default.html create mode 100644 functions/it_to_buffer.default.html delete mode 100644 functions/pbStream.html delete mode 100644 interfaces/Decoder.html delete mode 100644 interfaces/Encoder.html delete mode 100644 interfaces/MessageStream.html delete mode 100644 interfaces/ProtobufStream.html delete mode 100644 interfaces/ProtobufStreamOpts.html create mode 100644 interfaces/browser_readablestream_to_it.BrowserReadableStreamToItOptions.html create mode 100644 interfaces/it_batched_bytes.AsyncBatchedBytesOptions.html create mode 100644 interfaces/it_batched_bytes.AsyncBatchedObjectsOptions.html create mode 100644 interfaces/it_batched_bytes.BatchedBytesOptions.html create mode 100644 interfaces/it_batched_bytes.BatchedObjectsOptions.html create mode 100644 interfaces/it_buffer_stream.BufferStreamOptions.html create mode 100644 interfaces/it_byte_stream.AbortOptions.html create mode 100644 interfaces/it_byte_stream.ByteStream.html create mode 100644 interfaces/it_byte_stream.ByteStreamOpts.html create mode 100644 interfaces/it_glob.GlobOptions.html create mode 100644 interfaces/it_length_prefixed_stream.AbortOptions.html create mode 100644 interfaces/it_length_prefixed_stream.LengthPrefixedStream.html create mode 100644 interfaces/it_length_prefixed_stream.LengthPrefixedStreamOpts.html create mode 100644 interfaces/it_multipart.Part.html create mode 100644 interfaces/it_parallel.ParallelOptions.html create mode 100644 interfaces/it_peekable.AsyncPeek.html create mode 100644 interfaces/it_peekable.Peek.html create mode 100644 interfaces/it_peekable.Push.html create mode 100644 interfaces/it_protobuf_stream.AbortOptions.html create mode 100644 interfaces/it_protobuf_stream.Decoder.html create mode 100644 interfaces/it_protobuf_stream.Encoder.html create mode 100644 interfaces/it_protobuf_stream.MessageStream.html create mode 100644 interfaces/it_protobuf_stream.ProtobufStream.html create mode 100644 interfaces/it_protobuf_stream.ProtobufStreamOpts.html create mode 100644 interfaces/it_sort.CompareFunction.html create mode 100644 interfaces/it_split.SplitOptions.html delete mode 100644 modules.html create mode 100644 modules/blob_to_it.html create mode 100644 modules/browser_readablestream_to_it.html create mode 100644 modules/it_all.html create mode 100644 modules/it_batch.html create mode 100644 modules/it_batched_bytes.html create mode 100644 modules/it_buffer_stream.html create mode 100644 modules/it_byte_stream.html create mode 100644 modules/it_drain.html create mode 100644 modules/it_filter.html create mode 100644 modules/it_first.html create mode 100644 modules/it_flat_batch.html create mode 100644 modules/it_foreach.html create mode 100644 modules/it_glob.html create mode 100644 modules/it_last.html create mode 100644 modules/it_length.html create mode 100644 modules/it_length_prefixed_stream.html create mode 100644 modules/it_map.html create mode 100644 modules/it_merge.html create mode 100644 modules/it_multipart.html create mode 100644 modules/it_ndjson.html create mode 100644 modules/it_parallel.html create mode 100644 modules/it_parallel_batch.html create mode 100644 modules/it_peekable.html create mode 100644 modules/it_protobuf_stream.html create mode 100644 modules/it_reduce.html create mode 100644 modules/it_skip.html create mode 100644 modules/it_sort.html create mode 100644 modules/it_split.html create mode 100644 modules/it_take.html create mode 100644 modules/it_to_browser_readablestream.html create mode 100644 modules/it_to_buffer.html create mode 100644 types/it_peekable.AsyncPeekable.html create mode 100644 types/it_peekable.Peekable.html diff --git a/assets/highlight.css b/assets/highlight.css index f02152d1..e3b345d8 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -7,24 +7,28 @@ --dark-hl-2: #9CDCFE; --light-hl-3: #A31515; --dark-hl-3: #CE9178; - --light-hl-4: #008000; - --dark-hl-4: #6A9955; - --light-hl-5: #0000FF; - --dark-hl-5: #569CD6; - --light-hl-6: #0070C1; - --dark-hl-6: #4FC1FF; - --light-hl-7: #795E26; - --dark-hl-7: #DCDCAA; - --light-hl-8: #800000; - --dark-hl-8: #808080; + --light-hl-4: #0000FF; + --dark-hl-4: #569CD6; + --light-hl-5: #0070C1; + --dark-hl-5: #4FC1FF; + --light-hl-6: #795E26; + --dark-hl-6: #DCDCAA; + --light-hl-7: #098658; + --dark-hl-7: #B5CEA8; + --light-hl-8: #008000; + --dark-hl-8: #6A9955; --light-hl-9: #800000; - --dark-hl-9: #569CD6; - --light-hl-10: #000000FF; - --dark-hl-10: #D4D4D4; - --light-hl-11: #E50000; - --dark-hl-11: #9CDCFE; - --light-hl-12: #0000FF; - --dark-hl-12: #CE9178; + --dark-hl-9: #808080; + --light-hl-10: #800000; + --dark-hl-10: #569CD6; + --light-hl-11: #000000FF; + --dark-hl-11: #D4D4D4; + --light-hl-12: #E50000; + --dark-hl-12: #9CDCFE; + --light-hl-13: #0000FF; + --dark-hl-13: #CE9178; + --light-hl-14: #EE0000; + --dark-hl-14: #D7BA7D; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -43,6 +47,8 @@ --hl-10: var(--light-hl-10); --hl-11: var(--light-hl-11); --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); --code-background: var(--light-code-background); } } @@ -60,6 +66,8 @@ --hl-10: var(--dark-hl-10); --hl-11: var(--dark-hl-11); --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); --code-background: var(--dark-code-background); } } @@ -77,6 +85,8 @@ --hl-10: var(--light-hl-10); --hl-11: var(--light-hl-11); --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); --code-background: var(--light-code-background); } @@ -94,6 +104,8 @@ --hl-10: var(--dark-hl-10); --hl-11: var(--dark-hl-11); --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); --code-background: var(--dark-code-background); } @@ -110,4 +122,6 @@ .hl-10 { color: var(--hl-10); } .hl-11 { color: var(--hl-11); } .hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +.hl-14 { color: var(--hl-14); } pre, code { background: var(--code-background); } diff --git a/assets/navigation.js b/assets/navigation.js index c5942166..c4e9d4eb 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42RQQsCIRBG/8ucpYWoPXgL6hgbdIwO6o6t1KroLASx/z2ILbJMOn/vPQY93IDwSsBhJV2gxpNxNgIDL6gDDsYSBi0UxuodmHXUX4DB2dgW+HxZj+wVWqNyLYZsY9pK+sb+1qetpG8xRnHCPQUUfTaSEKXULjhyctCFVor8H2s85R/5GytFvfy8TQ9WPX6oem6pXy/G4x0EzLHP9AEAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62Zb2/TMBDGv0teN8AmNqDvtjEQEmgV4900VU5yabO6cWQ7YhXad0ex87+OfWn9+p77+Tnnal+Tp3+BhFcZLIOIsiiULMxksAgKIrfBMtizpKQg3lextWTrTL7byj0NFsEuy5NgebkI4m1GEw55sHxqUQmkpKQ9TlrmscxYPiDVqiHx+uPb89uiM8XZXwE85EASElEQkgPZT9rU6vVQPcP4rQb8rvMfVf4f9kM+FMp+t2SWS+ApiV2ruogjW1fXveJt22hbE7OxmQwJpcdbmMk1ofTcp1xTkEYiIuOt0YqKeDCjOXPsQBJGBwli2hYka6VA2bsRhzy+1Wm3VZatoY5WmMq2NU8/5yF6gVievuYw37bqySXOrO6MwmbXhGitFo5tsTJNgYf6V2tuMaVYawXu7FIZ+oBxbcgAbkg8YzsGaOx2HCRYN+MgYc5W3ESMy3vOGe9wMSVCHOM66ZB8cfm55/GOJYDjtUobTi3qekZjk5hfxUHWNwyG2qlxzIdCotwOM2zsyOB32E09bCcOL1wNlXCS5cZWUhEPN4rmIPs7zagEbvSjQx4M1SC0Iy4MA5TicHH2lNdysHYosY0BVdjbLNCDYd0xDmTKmo758FWTkKY2lEVGR1UAZec7ZZHjEFKsnu70e0GRkKVRMtGbVcDDTisM1gvkG2l+9Drkw48GzXIUFhzS7BUS272ppetGOvsKdXTHBB57W/1U6as6235vTSxlQsxd0natzVjWddfRwnrTTazUZLmaYk8KYwfsSeGhQSsKsjv3wDdgtlJFfJhRHKydksqsINx8nrRRlK3VADNslI60OsbNOCY7DrLAPHkRzDzq6BCqtIJwAROWaoySHLnpvAjJs3yTpQc7ppW5CisIJ5SC+RVFE8Q+NyV2nGYtc6Q//WG2ROSzbPSWSaiReJuGRkCsU4Bd9drJ7LEO4l+MrAB2k4+lobVK2wNBkZyQUmzdkFKM9//4/cvqaJ/koZiqy7BnH758uri6HNXnAmJZjsZoKNiW4EyyqExt80ij8T2IjLnYCeQrxCzp/zGzY2u5jXifzyLWchvxFwhBNo6/9WPuIMna6nXiPPwwC8+3jVr2NVzTVRFZp6sxvJG7mppDUsbmU06HPJzANQj5MxO7zDzpVQEPbhQG64VNzFVVAOXlju0LwuFb7WCqNxRvpD39WlY0bIkFNX1oqihVBFXkY6V0nGCa1leeUZ9iIQuUZGfu7yrgoZ8UBuuFhebvfWaDbG3+CubD9SR7RinqTfikdRX1ZFWzpq09/wcrh+F35h0AAA==" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 5bf47c10..4e29c953 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VXW2+bMBT+LyevbsoxBBLeNnUPkzZ10qS+oGhygtOiEUDgXqYo/33iFtvBZqTpXio1/i7n5gsHKPPXCsLoAL+TLIbQ9whkbM8hhGLzU5Sc7YHAc5lCCLvnbCuSPKtu+6X5k9inQGCbsqriFYQAR9JL0YV/0vq0yUtxXzTsk16SCV7u2JZXt+r6qCg6VEZYJY8ZSyfpzU5YRZZAwUqeifMAzTnc8W0e89Jk1y1NLseXzCrVLU2W+lHmIt887856pSjqiHFhx1uelEvO4ol6sw5rru1ZiBa71zIRfKpfD77a8OEix4crLYvNVLsGeY3Vc/ZasmKq3Ql9qaUyid95VbFHbh9EDXD9HA7lxsdQj+/SKTS4jQ/hdDvjDNr87CM4ydA+FgbDf0yF1dB6PN0Xwnj8D1HTL4GUZ4/iaeREtYjPzonSSlTxTVLdJNkTr0se27dCk9BoYCO3xnhgkvjRge3Z27fGov17SWhD6n8I7o4J9q7QNOJHB/Yn4Wn8+Y/gl0zwTGO9P6Q1gSSL+RuEB3jhZZXkGYRA5+58BQR2tUn9imtjJbDN9/tabN2tPfCtyMsa0UJuHSCRQ2gwd9drEvX45ufmhwaEQCIcglADUSARHYKoBnKBRO4Q5GogD0jkDUGeBloAiRZD0EID+UAin1A6xxXVYL4GC4BEgQkWaLAlkGhpgi012ApItBpGttJLWlcYHZManhW/qb6p/Hr9kdqSRb0H6NrSRb0P6NkSRr0XuLAnozcE68KjYUxQ7wjWlUfDpKDeEqxLj4ZhQb0nWFcfDfOCelto0xbfMMZ6U2jTlMCAa5vSbNMXXgoef223axQBqz8t8v7b5wC/up2M/dFyAITwcDzKfVv/V8vH/R0gWa5kuRYWzwYsT7I8C6u9dQyOqJBxOco2OKMSMAYW9p69xUywtDu7FbYv2dSxs1umgb9Q3Fc2fvuOqbqHq8JWW2TrUf1Sl5SVZNjsis3QyZE0W5ZFdy0MyUqOi0nkvHmGKXlSJU/fItG+rSVJ6UxDIYDUQu2/vSVZMbSR+senEqZSJXQ6T1vG3eNcsgNJDjqubQM13BeVvJTkZUe27aPmxt+0N74Su2JPjaO0JlAkBU+TjEMYrY/Hv3REflqcEQAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81d72/jOM7+X9yvbs6SZVvut929HzjgDrt497BfikHhNu5MbtI4cNyd6TuY//0gWYpJlXTkNN27T5OJRfKhHpKS6Nj9lvTdl0Nyc/st+bzZrZMbmSa75qlNbpL7bXd/PXTXmyFJk+d+m9wkT936edse/mQu3Q3d3WZYfRqetkmaPGybw6E9JDdJ8j31ukp1VLZuH5vn7aTp8Xn3MGy6HdLlBhE602Tf9O1uwLAmSwC18aftr/u2WTf32/Yw9G3zxPkxDr7DgyM8k0V5tPjjqOT/nI5frY5/dX8fft5bD49WN7uh7R+bh1OGTyk8MT9zEzB5IDI5sbPv29/b3fBTs3tot++D9yq0sRz9SUOLQ2/Oq7hgjJvsKTw3w3Wz3b4KxM1w12y3b08mpycKu4PCoLxvhodPFE574SJIR02xWEdAc2jb9fX9y9AeWNTt+s4OiE7tHw4vu4cfR9EfjeRMSr8ywgnHeXp0hknZw+b/27fDuHJqJizDYX29OVxvdp/afjO06zlsrG4O9Mum3a5/eBza/gLQkbK4yYwBzPH/8/2/24fh7AjA4v/FGCCAXDAKglm6fBxQ8JlIuLwTMlN6mv223zTbi1EAtL2rC3DncmZl++8Xtfh6Njtj8ZXg/CLwv5D/75b675gwi3PlTUAX7VmOGBftXQg28R7m+fGx7a/HLSS5h7ED7sYB8ccTKzXulU/ELdJPyJ32E7nARO3Dp+fd519nwiAKxhVUEweI0sXF6kO33bYPQ8cuUJEggZrLg/zY7tq+eTNIqOYiIKOTCeGLTiYmyHAyvQztXCq9DG1MIgk5zfYP910//KXvwXQ7mVDjNPK0MwDnZLYQEkTi7jD0zygW4+xeYdEYDEAFm77dul0OZL1skVmEaHjZL0bkZN4wJyAyfurWbVRgHAf+sXGBzZ4TFpOHb4iKVzDW0RRQ9tFBzVB0YnULoyF6USOpCDZiH3cN2Tg7ZfjqKBofiid2qi+D64xF4JkGnzkNaD0yXbDlRq+cWNQEAO8YEM+7L32zPwPGUfBCQL6YynYGDi/3BhhkOPy8H2JyAwtcIjvs8fxH1JlbZP4KKVg4LdZrcmty/zpR8O4EoJrGXotzMwVuT9Z9s9lRGxN74SLd1VFT7KZqBMSgfdxsYasGwB2vXASvUxUL2GFiEfeH17d7rJX+cIGbVkdN8XANIA7ttplpuJurF+y6A3XR4Cd8nAdd3zYM/PHSZbA7XdHAHSwG9cdtd09BNt9Hn6//tu3u53ceVh0YdhK2xcUU0+b+0G2f2YWFtHUFhGaNQkl2p/eFW+Np2+P4N5vddesNd86lDXuJc0zHBqRVERuNAa0oFLcNXa/M9xdJHasoFqlFwyFtdx8HMtPHK5dBO6qKxjtimkV8ve/bx83Xdj3TFhhH3vmRS1ttEacQxsKiAwnjzzlnk1g4EccUGlXMieUfVvIXJzh7dmHwUhrePo2xZ5uloE4eeJipJOfpnFPQYsCnj0YXgDx3XlqM+OQh6lKAf7so4t/eAfKJTJs5Fi7wIeqsuKxwjaP/3Jo+Ebfyn4PwKlR8iQkPjpmEI3/ZvZMjk+L3duSp+frnZmj+gXcAF3AkVPwHODKKvIsrger3duZke+UsP5iey4nG/fkugZ3hdj/XlmG88UIXWPbh3vEJLKJgo/jU7C+yzzV6Yje5BgqHsu0/tiROc+EySK2maKwWEIf2eTts9k1PHniOF6N33b9ATTjyJ2W/0BoD1EdgTKrdd+uXeFNXbvhpe1aGM/qpbdZtzyU3ZXeSWG46Oh6OCqJjgphdFBe79b8PHdkVHa/ExvG+6Q8tjdopsiNOAnZ4SBuHod/sPm4eX2btHEctt4VmZt/0zXYLfpoN5sZfW5IvVmD+oHpUGww/6ckRK3uncPfw3Pft7oFLpVnTV1j+JIxQCQer69dt33JHvHlIk+xb4MRm3lFVbOIRjJDRxbeg/YgLtqEDlUt9mW9H79v2s/k5PumLu7bsR+C/tO1nLja8wuPA0154fMzJcr/Y2pUTOWlykuPKQ4TtP8zJM/ybc+35wO31J/HnAxXgC11bYujKjY5wzQyEJutKFPJ1oKLQN790YSKHSYMIX7HhCJtvMRddUryN6GJCuIbKSN8N3f3z40zH2A95h1ZxqHpRjziEfk5z+CSAiK5wgCOmHTzf8QlBudFvmBBoe75JE9p2oy9k+5/t4dB8nP/tTogAybwFR2Sr+7T9k83tMCKw2+e0syNAnW5gnwVrrmUdgepkk/p8UFxbOhbVbCM6GhZce53MovDGQpeK7/39+eavrHD0zARevz3hKEhLMy4O1KKUo2Atz7k4YEuSjsK1OOsWwIpNOxbXorzjgbGJN3O3Zx5j1A2eyF1HzJ2dSDQzN3NOtKrnJ/Ot93OWwadu4bwb/Ji7OLHw+Rs37wk/4t7NAgfY2zXv5sLJOzax6M+7SbMIOOyr3s/dlwkx+9FvWbXhYaxv188PZEdnvHKRrpRTFXuAdJgYxIfPG/Lmkfn+ImitolisFg2HtKNvxpjvo4+0P3VPxt5fHUImtK3KYOhp7N1Z9yisrej56fg7E4f9lnh7jLFgLkTP0K9m9Pyhf1QIB54GbsExpWbdbjdPG/5Be8beFZSbt4yEzyHJKolmKXAW0TQ0n8kCYb6/SMJZRbFQLRoOaXdNvzqGhN/d0W+quYxPrPZoR1lnZry3D3Fy3tqLF/Nu1LbEmxHc9w9pstmt26/Jzbfk97Y/mKp2k8hVvqqTNHk0i695ddYIJE0euqcno+aDu/abffLXjBiH/ClL0tsszbNVVqYilXJVZ3UqU5GtpFIfPqS3XoUdab+wciJJb/NU6JUuazRMoGEySW9FKupVJlKZ6lWRKmNEaJUW7gOSlkg6T9LbMi2yVV1JNCxHw1SS3lbUMIWGFRzkAg0rk/RWpkKutNapTvNqpUWFxpdofMWprdAwDdXWZsZ1hcdrNL7m1NaYh2zUa/lKxZFKMX7A1AQUGqqEpCZOYBaFpTFPc73SCs+FwIwJw4xQqSpWeY6pFZg0YcgRBWkd8yYK3jqmTpS8dUyaMOSIkhyJeROGFkGGl8CMiZrHiUmThgihKZ0ScyQFq1MGmSZZjyTmSOZcaElMkVQotupUlqsqL1KZuUKBhTFr0lAjBekjZk3ajCPjUGLWpKFG5uRIzJq06abIkZg1ySaaxKTlKNOOc5DKgki1HNOYG64kXcowjbnhSlYUjXlQHA1ZUpMjMY+55bEmrWPSclsjM3IkJi0veZyYtLzicWLScsNMLlIlVmVgHHOWW84kNRBzpgwNeU7ZVpghZRc0RSWawgwpQ0NekCMxQ8omWkmODFYwQ0NOr2GYIWUZ0oTrChOkSt51TJCq4NKU19SSpzBTSnNJozBTqoa6VUbqxpwVGbtOY8oKgXQLSneBuSskqxtTV+Qw2etUqlWhilRJItcLzGWhWBvBfqRA+HMSPya1KFndmNMCcaoUqRtzWhjmFLkgF5jUwhCmyGpWYC5Lw5gi47rEZJaGKEUuiSXmsGQ5LDGHZY7mgIzrEnNXstyVmLsScVdkaZ6vyiDNymBfyXJXYu7KkTuzWZaZ2zsX2XHbLEww1irHKjCXJVtJS0xlyVbSEjNZGboKcpGuMJMVX0krzGTFV9IKU1nxlbTCDFaGpyInHKowg5VhpyB3CBUmrjL0FAVVSavgKGBYKMg9WIUJqgwNBbl8VpihyvBQkMtnhSnSGbc0aMyQNjQU5H5AY4a0hGFekuVbY6o0u7vUmCmtkG6yfGvMmWaPcBpTptEhrpSkbsydNgSV5N5SByc5Q1BJRo7G3GlDUEmWVI25q9lFr8bc1WjRK0vKsxqTWBuCSrII15i72h64ySJcY/JqTF5N1b8ak1cbiipyb1lj9mrDTEUeHWpMWm2YqciqVGPSanbHUgfn7ppc+Ut/+sGy4WGcpXG8BIciIqucmsFxEBQyfFVk6I3X4FjDWFUQ5WC8BIcqfmhwFs8KfmhwGM8sjfQZOwuO41k1MzY4kGeGsIo+kWfBkTwzBFXkLni8BsYKnrxXnRNBnwUrTbVdwm6K7ZmQq7MI2ym2aUKuzyLsp9iuSUVWdRF2VGzfRJO5KMKeiu2caDIbRdhVsb0Teu0XYV/Fdk/o1V+EnRXbP6HXfxH0VoTtoJA7ABE0V4RtoWi6AybDFphhRpPrgwgaLGLssNDTEPRYhG2bMNMQtFSEbZww0xA0VYRtnTDTELBmeyearipBX0XY7gm9GRJBZ0XYBgq9HRJBc0XYhgm9IRJBM0XYlgm9JRJBO0XYpgm5KRJ52Lo0zGi6Ixl0VESO1j9NLsMiaK6InN2+iKC7InLcha5o/QGPOduKFkGnReSoHa3JNrcIui7CNlc0XWGCxotQfDENOi9CoZWwJjeZImjCCNtqqemqFLRhhG221HSaq7ArzZ4ARdCJEQqdAWvy/C6CroxQ7ClQBG0ZYXsuS26eiKBLI/g2jQj6NMI2YV7dAJqavoF0wDbfsxGuaWPvW/3e9kO7/vt4/+r2NmnML6/b8S2V35I7d2NLHu9Of0tykdx8+/59upFl/mf0W9HO37eehHMBhLUZnial+9esrpw2/zKiSZMCMIqaEzR/OGOS0ZNIyUmYJx3cy5ftu5cJJ6ZXan5LBDsDQFE3vkOaUlUAVWpO1fg0yyRZKSCZsTPnRceHLYB4BcU1I+4e75rE6knKsVbk4781x4GbA+R1Bo3Py7EkQAdm8c/OPwgJySKxL/2ahAB6VsQ+xzuJlIAtzaIdb4mjKAfwXJaoal4c31Afug2VhzCHOXXufjuYLMC+VB4Oy7uVH1EQCCSoBLLgdLzgpJcgXXJ27sdftwHcIibcjJT7QQWoV/kkqrLRZcXVjklFZ38zC9SAYFVcmtvXk48v1wceg1ojOcPje3GBEIjq3OVnzoWNEX5V5HMQ4znHDnhVObANZkzyNu2vuR6PP/wCNRoEmdm2cArAI72gqgGma362wMuMAXDAUe6SLWd1fEEFTQHZkouwtf/FMcALnWXr//HnKoAfIOfq8PhP5arx+I905Ev3f+WLtgvlwvlZuGwuSrcku+9L933pvtdOn3bWaqen9kt4lvm13H/IC/+h8hXDX1LHGlL6D15PwU/i8VdmYFWCC7LiCpp7gyqYRDD7bFVtd69Y03D5Elx2+FeggigBcmzZdO8hBVIgpgtut2Het4mEwIwU3IQcX8EJ5EBgFZxn4O3/IH3gUsWtcB+DlVQBoYJjwAgRC4gCa0HBGTy+1wIsfUBOcyxs0GzKYMFP/WLs08JHv7vo4jr3C4aLfOWysPAp67KpcClSuHGl+75035fue+2saqdfO/O101cruBUzeITPRv8h9ymX+5Tzu3BzhHMffMaqY8Zy0zS+gxJwAjKq5MLOvw5yEitAYmCnWXGimBaA2Mq7x4biqIbI7gLsjSo/A5KdAavGvxro9QaiALFTcUWNUhJuIQqQKhWXmds9gQDu2bn6YV9aBHIEEKK5s8VT83XdDA1BJ1gNKx9e7Hbtqfk6qiAUgX1M5YOaPXO6VxoBL0Dl1Nzi+jQ+ifh63jTcNQpuIwDeTAQMA9I1J+nfXQPEQOTVnJfuHbUg5+CplpM6vm8E7D0AyJpLtuk1MgAmCChccmYUEAW8AkFWcxHt3swDrIPgqrnQfEUIWNY06ytamjTcYknW0D0ROPBMn3NV8NV5Hkplua/gvl5n7ARRh3uI/bgIZCxHrvCg1APRz5Zi9wdaH9wfaAUAwEaHlR2f4UFiGqYcF8tekph5uA+UcfJhndWwr8IeYMYXcADkJZxxv/hknPj4/C3YiQKjfh2ujov3cRHiYil8IADQuKB/4B+XAnMBvco5JsHfVgNnbijqHGCzyL8UAkwIYDJ3lb/0K4Dg5iE8PAuUw07a7278EYkLk/FZLDAZsOHEHgzH56KAFAzpnNuMuKeFwIkGHjEUC9GIEZW1hkuXYmf9VbRIYDXcxPpNKJ+X4AVnoPIC/2uOt/EpHIAf8qa4yjd0iGtujx6xjR3/tBOYB7DCsWHvH1YHQQuyTTnrlUch/EZIcgrdU+ZAH8gh5VaEyq8MPn4F2zyz+n5H1QDMa+VXFumP42x7yT4z2jwGp1kBC6VHNaviVWMuB8HhTx362Dgg4/ZDmuw3+3a72bXJze2H79//A6ReyV6PfgAA"; \ No newline at end of file diff --git a/classes/it_byte_stream.AbortError.html b/classes/it_byte_stream.AbortError.html new file mode 100644 index 00000000..b26e5f9a --- /dev/null +++ b/classes/it_byte_stream.AbortError.html @@ -0,0 +1,14 @@ +AbortError | Documentation

Class AbortError

Hierarchy

Constructors

constructor +

Properties

cause? +code +message +name +stack? +type +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

name

name: string

Optional stack

stack?: string

Readonly type

type: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/it_byte_stream.CodeError.html b/classes/it_byte_stream.CodeError.html new file mode 100644 index 00000000..9405fbdc --- /dev/null +++ b/classes/it_byte_stream.CodeError.html @@ -0,0 +1,13 @@ +CodeError | Documentation

Class CodeError

Hierarchy

Constructors

constructor +

Properties

cause? +code +message +name +stack? +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +

Constructors

constructor

Properties

Optional cause

cause?: unknown

Readonly code

code: string

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/blob_to_it.default.html b/functions/blob_to_it.default.html new file mode 100644 index 00000000..a1942501 --- /dev/null +++ b/functions/blob_to_it.default.html @@ -0,0 +1 @@ +default | Documentation

Function default

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/browser_readablestream_to_it.default.html b/functions/browser_readablestream_to_it.default.html new file mode 100644 index 00000000..851bf7c4 --- /dev/null +++ b/functions/browser_readablestream_to_it.default.html @@ -0,0 +1,6 @@ +default | Documentation

Function default

  • default<T>(stream, options?): AsyncGenerator<T, void, undefined>

  • Turns a browser readable stream into an async iterable. Async iteration over +returned iterable will lock give stream, preventing any other consumer from +acquiring a reader. The lock will be released if iteration loop is broken. To +prevent stream cancelling optional { preventCancel: true } could be passed +as a second argument.

    +

    Type Parameters

    • T

    Parameters

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_all.default.html b/functions/it_all.default.html new file mode 100644 index 00000000..1462870f --- /dev/null +++ b/functions/it_all.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

  • default<T>(source): T[]

  • Collects all values from an (async) iterable and returns them as an array

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T>

    Returns T[]

  • default<T>(source): Promise<T[]>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T> | AsyncIterable<T>

    Returns Promise<T[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_batch.default.html b/functions/it_batch.default.html new file mode 100644 index 00000000..d69434d0 --- /dev/null +++ b/functions/it_batch.default.html @@ -0,0 +1,3 @@ +default | Documentation

Function default

  • default<T>(source, size?): Generator<T[], void, undefined>

  • Takes an (async) iterable that emits things and returns an async iterable that +emits those things in fixed-sized batches

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T>
    • Optional size: number

    Returns Generator<T[], void, undefined>

  • default<T>(source, size?): AsyncGenerator<T[], void, undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T> | AsyncIterable<T>
    • Optional size: number

    Returns AsyncGenerator<T[], void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_batched_bytes.default.html b/functions/it_batched_bytes.default.html new file mode 100644 index 00000000..faa03ebe --- /dev/null +++ b/functions/it_batched_bytes.default.html @@ -0,0 +1,4 @@ +default | Documentation

Function default

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_buffer_stream.default.html b/functions/it_buffer_stream.default.html new file mode 100644 index 00000000..dde0de09 --- /dev/null +++ b/functions/it_buffer_stream.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_byte_stream.byteStream-1.html b/functions/it_byte_stream.byteStream-1.html new file mode 100644 index 00000000..5ee0bc52 --- /dev/null +++ b/functions/it_byte_stream.byteStream-1.html @@ -0,0 +1 @@ +byteStream | Documentation

Function byteStream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_drain.default.html b/functions/it_drain.default.html new file mode 100644 index 00000000..0a0c6196 --- /dev/null +++ b/functions/it_drain.default.html @@ -0,0 +1,3 @@ +default | Documentation

Function default

  • default(source): void

  • Drains an (async) iterable discarding its' content and does not return +anything

    +

    Parameters

    • source: Iterable<unknown>

    Returns void

  • default(source): Promise<void>

  • Parameters

    • source: Iterable<unknown> | AsyncIterable<unknown>

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_filter.default.html b/functions/it_filter.default.html new file mode 100644 index 00000000..e33a684f --- /dev/null +++ b/functions/it_filter.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

  • default<T>(source, fn): AsyncGenerator<T, void, undefined>

  • Filters the passed (async) iterable by using the filter function

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T>
    • fn: ((val) => Promise<boolean>)

    Returns AsyncGenerator<T, void, undefined>

  • default<T>(source, fn): Generator<T, void, undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T>
    • fn: ((val) => boolean)
        • (val): boolean

        • Parameters

          • val: T

          Returns boolean

    Returns Generator<T, void, undefined>

  • default<T>(source, fn): AsyncGenerator<T, void, undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T> | AsyncIterable<T>
    • fn: ((val) => boolean | Promise<boolean>)
        • (val): boolean | Promise<boolean>

        • Parameters

          • val: T

          Returns boolean | Promise<boolean>

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_first.default.html b/functions/it_first.default.html new file mode 100644 index 00000000..1c2f6b5a --- /dev/null +++ b/functions/it_first.default.html @@ -0,0 +1,3 @@ +default | Documentation

Function default

  • default<T>(source): T | undefined

  • Returns the first result from an (async) iterable, unless empty, in which +case returns undefined

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T>

    Returns T | undefined

  • default<T>(source): Promise<T | undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T> | AsyncIterable<T>

    Returns Promise<T | undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_flat_batch.default.html b/functions/it_flat_batch.default.html new file mode 100644 index 00000000..005961a0 --- /dev/null +++ b/functions/it_flat_batch.default.html @@ -0,0 +1,3 @@ +default | Documentation

Function default

  • default<T>(source, batchSize?): Generator<T[], void, undefined>

  • Takes an (async) iterable that emits variable length arrays of things and +returns an async iterable that emits those things in fixed-size batches

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T[]>
    • Optional batchSize: number

    Returns Generator<T[], void, undefined>

  • default<T>(source, batchSize?): AsyncGenerator<T[], void, undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T[]> | AsyncIterable<T[]>
    • Optional batchSize: number

    Returns AsyncGenerator<T[], void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_foreach.default.html b/functions/it_foreach.default.html new file mode 100644 index 00000000..45f8cd64 --- /dev/null +++ b/functions/it_foreach.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

  • default<T>(source, fn): AsyncGenerator<T, void, undefined>

  • Invokes the passed function for each item in an iterable

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T>
    • fn: ((thing) => Promise<void>)

    Returns AsyncGenerator<T, void, undefined>

  • default<T>(source, fn): Generator<T, void, undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T>
    • fn: ((thing) => void)
        • (thing): void

        • Parameters

          • thing: T

          Returns void

    Returns Generator<T, void, undefined>

  • default<T>(source, fn): AsyncGenerator<T, void, undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T> | AsyncIterable<T>
    • fn: ((thing) => void | Promise<void>)
        • (thing): void | Promise<void>

        • Parameters

          • thing: T

          Returns void | Promise<void>

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_glob.default.html b/functions/it_glob.default.html new file mode 100644 index 00000000..e0ccd844 --- /dev/null +++ b/functions/it_glob.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_last.default.html b/functions/it_last.default.html new file mode 100644 index 00000000..7f8ef49f --- /dev/null +++ b/functions/it_last.default.html @@ -0,0 +1,3 @@ +default | Documentation

Function default

  • default<T>(source): T | undefined

  • Returns the last item of an (async) iterable, unless empty, in which case +return undefined

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T>

    Returns T | undefined

  • default<T>(source): Promise<T | undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T> | AsyncIterable<T>

    Returns Promise<T | undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_length.default.html b/functions/it_length.default.html new file mode 100644 index 00000000..17816765 --- /dev/null +++ b/functions/it_length.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

  • default(source): number

  • Consumes the passed iterator and returns the number of items it contained

    +

    Parameters

    • source: Iterable<unknown>

    Returns number

  • default(source): Promise<number>

  • Parameters

    • source: Iterable<unknown> | AsyncIterable<unknown>

    Returns Promise<number>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_length_prefixed_stream.lpStream.html b/functions/it_length_prefixed_stream.lpStream.html new file mode 100644 index 00000000..93321b86 --- /dev/null +++ b/functions/it_length_prefixed_stream.lpStream.html @@ -0,0 +1 @@ +lpStream | Documentation

Function lpStream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_map.default.html b/functions/it_map.default.html new file mode 100644 index 00000000..7399c457 --- /dev/null +++ b/functions/it_map.default.html @@ -0,0 +1,3 @@ +default | Documentation

Function default

  • default<I, O>(source, func): AsyncGenerator<O, void, undefined>

  • Takes an (async) iterable and returns one with each item mapped by the passed +function

    +

    Type Parameters

    • I

    • O

    Parameters

    Returns AsyncGenerator<O, void, undefined>

  • default<I, O>(source, func): Generator<O, void, undefined>

  • Type Parameters

    • I

    • O

    Parameters

    • source: Iterable<I>
    • func: ((val) => O)
        • (val): O

        • Parameters

          • val: I

          Returns O

    Returns Generator<O, void, undefined>

  • default<I, O>(source, func): AsyncGenerator<O, void, undefined>

  • Type Parameters

    • I

    • O

    Parameters

    • source: AsyncIterable<I> | Iterable<I>
    • func: ((val) => O | Promise<O>)

    Returns AsyncGenerator<O, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_merge.default.html b/functions/it_merge.default.html new file mode 100644 index 00000000..566e235e --- /dev/null +++ b/functions/it_merge.default.html @@ -0,0 +1,4 @@ +default | Documentation

Function default

  • default<T>(...sources): Generator<T, void, undefined>

  • Treat one or more iterables as a single iterable.

    +

    Nb. sources are iterated over in parallel so the +order of emitted items is not guaranteed.

    +

    Type Parameters

    • T

    Parameters

    • Rest ...sources: Iterable<T>[]

    Returns Generator<T, void, undefined>

  • default<T>(...sources): AsyncGenerator<T, void, undefined>

  • Type Parameters

    • T

    Parameters

    • Rest ...sources: (AsyncIterable<T> | Iterable<T>)[]

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_multipart.default.html b/functions/it_multipart.default.html new file mode 100644 index 00000000..75c755ba --- /dev/null +++ b/functions/it_multipart.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/AbortOptions.html b/functions/it_ndjson.parse.html similarity index 66% rename from interfaces/AbortOptions.html rename to functions/it_ndjson.parse.html index a2052f14..5be0c369 100644 --- a/interfaces/AbortOptions.html +++ b/functions/it_ndjson.parse.html @@ -1,2 +1 @@ -AbortOptions | it-protobuf-stream

Interface AbortOptions

interface AbortOptions {
    signal?: AbortSignal;
}

Properties

signal? -

Properties

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +parse | Documentation

Function parse

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_ndjson.stringify.html b/functions/it_ndjson.stringify.html new file mode 100644 index 00000000..50e0d0be --- /dev/null +++ b/functions/it_ndjson.stringify.html @@ -0,0 +1 @@ +stringify | Documentation

Function stringify

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_parallel.default.html b/functions/it_parallel.default.html new file mode 100644 index 00000000..6046f26b --- /dev/null +++ b/functions/it_parallel.default.html @@ -0,0 +1,4 @@ +default | Documentation

Function default

  • default<T>(source, options?): AsyncGenerator<T, void, undefined>

  • Takes an (async) iterator that emits promise-returning functions, +invokes them in parallel and emits the results as they become available but +in the same order as the input

    +

    Type Parameters

    • T

    Parameters

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_parallel_batch.default.html b/functions/it_parallel_batch.default.html new file mode 100644 index 00000000..45c960e8 --- /dev/null +++ b/functions/it_parallel_batch.default.html @@ -0,0 +1,4 @@ +default | Documentation

Function default

  • default<T>(source, size?): AsyncGenerator<T, void, undefined>

  • Takes an (async) iterator that emits promise-returning functions, +invokes them in parallel and emits the results as they become available but +in the same order as the input

    +

    Type Parameters

    • T

    Parameters

    • source: AsyncIterable<(() => Promise<T>)> | Iterable<(() => Promise<T>)>
    • size: number = 1

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_peekable.default.html b/functions/it_peekable.default.html new file mode 100644 index 00000000..b764625e --- /dev/null +++ b/functions/it_peekable.default.html @@ -0,0 +1 @@ +default | Documentation

Function default

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_protobuf_stream.pbStream.html b/functions/it_protobuf_stream.pbStream.html new file mode 100644 index 00000000..6a6120aa --- /dev/null +++ b/functions/it_protobuf_stream.pbStream.html @@ -0,0 +1 @@ +pbStream | Documentation

Function pbStream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_reduce.default.html b/functions/it_reduce.default.html new file mode 100644 index 00000000..88392021 --- /dev/null +++ b/functions/it_reduce.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

  • default<T, V>(source, func, init): V

  • Reduces the values yielded by an (async) iterable

    +

    Type Parameters

    • T

    • V

    Parameters

    • source: Iterable<T>
    • func: ((acc, curr) => V)
        • (acc, curr): V

        • Parameters

          • acc: V
          • curr: T

          Returns V

    • init: V

    Returns V

  • default<T, V>(source, func, init): Promise<V>

  • Type Parameters

    • T

    • V

    Parameters

    • source: Iterable<T> | AsyncIterable<T>
    • func: ((acc, curr) => V)
        • (acc, curr): V

        • Parameters

          • acc: V
          • curr: T

          Returns V

    • init: V

    Returns Promise<V>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_skip.default.html b/functions/it_skip.default.html new file mode 100644 index 00000000..9a017275 --- /dev/null +++ b/functions/it_skip.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

  • default<T>(source, offset): Generator<T, void, undefined>

  • Skip items from an iterable

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T>
    • offset: number

    Returns Generator<T, void, undefined>

  • default<T>(source, offset): AsyncGenerator<T, void, undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T> | AsyncIterable<T>
    • offset: number

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_sort.default.html b/functions/it_sort.default.html new file mode 100644 index 00000000..fe54a975 --- /dev/null +++ b/functions/it_sort.default.html @@ -0,0 +1,3 @@ +default | Documentation

Function default

  • default<T>(source, sorter): Generator<T, void, undefined>

  • Collects all values from an async iterator, sorts them +using the passed function and yields them

    +

    Type Parameters

    • T

    Parameters

    Returns Generator<T, void, undefined>

  • default<T>(source, sorter): AsyncGenerator<T, void, undefined>

  • Type Parameters

    • T

    Parameters

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_split.default.html b/functions/it_split.default.html new file mode 100644 index 00000000..40579bef --- /dev/null +++ b/functions/it_split.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_take.default.html b/functions/it_take.default.html new file mode 100644 index 00000000..6911bba9 --- /dev/null +++ b/functions/it_take.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

  • default<T>(source, limit): Generator<T, void, undefined>

  • Stop iteration after n items have been received

    +

    Type Parameters

    • T

    Parameters

    • source: Iterable<T>
    • limit: number

    Returns Generator<T, void, undefined>

  • default<T>(source, limit): AsyncGenerator<T, void, undefined>

  • Type Parameters

    • T

    Parameters

    • source: Iterable<T> | AsyncIterable<T>
    • limit: number

    Returns AsyncGenerator<T, void, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_to_browser_readablestream.default.html b/functions/it_to_browser_readablestream.default.html new file mode 100644 index 00000000..0b884aa4 --- /dev/null +++ b/functions/it_to_browser_readablestream.default.html @@ -0,0 +1,2 @@ +default | Documentation

Function default

  • default<T>(source, queuingStrategy?): ReadableStream<T>

  • Converts an (async) iterator into a WHATWG ReadableStream

    +

    Type Parameters

    • T extends ArrayBufferView

    Parameters

    • source: AsyncIterator<T, any, undefined> | Iterator<T, any, undefined>
    • queuingStrategy: QueuingStrategy<T> = {}

    Returns ReadableStream<T>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/it_to_buffer.default.html b/functions/it_to_buffer.default.html new file mode 100644 index 00000000..02693fbf --- /dev/null +++ b/functions/it_to_buffer.default.html @@ -0,0 +1,3 @@ +default | Documentation

Function default

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/pbStream.html b/functions/pbStream.html deleted file mode 100644 index ebf685e5..00000000 --- a/functions/pbStream.html +++ /dev/null @@ -1 +0,0 @@ -pbStream | it-protobuf-stream

Function pbStream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index d064463c..61e6c201 100644 --- a/index.html +++ b/index.html @@ -1,19 +1,43 @@ -it-protobuf-stream

it-protobuf-stream

codecov +Documentation

Documentation

it

codecov CI

-

Read and write protobuf messages over a duplex stream

+

A collection of utilities for making working with iterables more bearable

-

About

This module makes it easy to send and receive length-prefixed Protobuf encoded -messages over streams.

-

Example

import { pbStream } from 'it-protobuf-stream'
import { MessageType } from './src/my-message-type.js'

// RequestType and ResponseType have been generate from `.proto` files and have
// `.encode` and `.decode` methods for serialization/deserialization

const stream = pbStream(duplex)

// write a message to the stream
stream.write({
  foo: 'bar'
}, MessageType)

// read a message from the stream
const res = await stream.read(MessageType)
-
-

Install

$ npm i it-protobuf-stream
-
-

Browser <script> tag

Loading this module through a script tag will make it's exports available as ItProtobufStream in the global namespace.

-
<script src="https://unpkg.com/it-protobuf-stream/dist/index.min.js"></script>
-
+

Packages

API Docs

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Decoder.html b/interfaces/Decoder.html deleted file mode 100644 index 5b21340b..00000000 --- a/interfaces/Decoder.html +++ /dev/null @@ -1,2 +0,0 @@ -Decoder | it-protobuf-stream

Interface Decoder<T>

A protobuf decoder - takes a byte array and returns an object

-
interface Decoder ((data) => T)

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Encoder.html b/interfaces/Encoder.html deleted file mode 100644 index ac8a8a3f..00000000 --- a/interfaces/Encoder.html +++ /dev/null @@ -1,2 +0,0 @@ -Encoder | it-protobuf-stream

Interface Encoder<T>

A protobuf encoder - takes an object and returns a byte array

-
interface Encoder ((data) => Uint8Array)

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/MessageStream.html b/interfaces/MessageStream.html deleted file mode 100644 index 9d0e925c..00000000 --- a/interfaces/MessageStream.html +++ /dev/null @@ -1,10 +0,0 @@ -MessageStream | it-protobuf-stream

Interface MessageStream<T, S>

A message reader/writer that only uses one type of message

-
interface MessageStream {
    read(options?): Promise<T>;
    unwrap(): ProtobufStream<S>;
    write(d, options?): Promise<void>;
    writeV(d, options?): Promise<void>;
}

Type Parameters

  • T

  • S = unknown

Methods

read -unwrap -write -writeV -

Methods

read

unwrap

write

writeV

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ProtobufStream.html b/interfaces/ProtobufStream.html deleted file mode 100644 index d03ec4a7..00000000 --- a/interfaces/ProtobufStream.html +++ /dev/null @@ -1,12 +0,0 @@ -ProtobufStream | it-protobuf-stream

Interface ProtobufStream<Stream>

Convenience methods for working with protobuf streams

-
interface ProtobufStream {
    pb<T>(proto): MessageStream<T, Stream>;
    read<T>(proto, options?): Promise<T>;
    unwrap(): Stream;
    write<T>(data, proto, options?): Promise<void>;
    writeV<T>(input, proto, options?): Promise<void>;
}

Type Parameters

  • Stream = unknown

Methods

pb -read -unwrap -write -writeV -

Methods

pb

read

unwrap

write

writeV

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ProtobufStreamOpts.html b/interfaces/ProtobufStreamOpts.html deleted file mode 100644 index de3b8e7e..00000000 --- a/interfaces/ProtobufStreamOpts.html +++ /dev/null @@ -1,10 +0,0 @@ -ProtobufStreamOpts | it-protobuf-stream

Interface ProtobufStreamOpts

interface ProtobufStreamOpts {
    lengthDecoder: LengthDecoderFunction;
    lengthEncoder: LengthEncoderFunction;
    maxDataLength: number;
    maxLengthLength: number;
    yieldBytes?: boolean;
}

Hierarchy

Properties

lengthDecoder -lengthEncoder -maxDataLength -maxLengthLength -yieldBytes? -

Properties

lengthDecoder

lengthDecoder: LengthDecoderFunction

lengthEncoder

lengthEncoder: LengthEncoderFunction

maxDataLength

maxDataLength: number

maxLengthLength

maxLengthLength: number

Optional yieldBytes

yieldBytes?: boolean

After the stream is unwrapped, any bytes that have been read from the -incoming stream will be yielded in-order as Uint8Array(s).

-

To yield a single Uint8ArrayList with all unread bytes instead, pass -false here.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/browser_readablestream_to_it.BrowserReadableStreamToItOptions.html b/interfaces/browser_readablestream_to_it.BrowserReadableStreamToItOptions.html new file mode 100644 index 00000000..30681d14 --- /dev/null +++ b/interfaces/browser_readablestream_to_it.BrowserReadableStreamToItOptions.html @@ -0,0 +1,2 @@ +BrowserReadableStreamToItOptions | Documentation

Interface BrowserReadableStreamToItOptions

interface BrowserReadableStreamToItOptions {
    preventCancel?: boolean;
}

Properties

preventCancel? +

Properties

Optional preventCancel

preventCancel?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/it_batched_bytes.AsyncBatchedBytesOptions.html b/interfaces/it_batched_bytes.AsyncBatchedBytesOptions.html new file mode 100644 index 00000000..258e91c4 --- /dev/null +++ b/interfaces/it_batched_bytes.AsyncBatchedBytesOptions.html @@ -0,0 +1,6 @@ +AsyncBatchedBytesOptions | Documentation

Interface AsyncBatchedBytesOptions

interface AsyncBatchedBytesOptions {
    size?: number;
    yieldAfter?: number;
}

Hierarchy

Properties

size? +yieldAfter? +

Properties

Optional size

size?: number

The minimum number of bytes that should be in a batch (default: 1MB)

+

Optional yieldAfter

yieldAfter?: number

If this amount of time passes, yield all the bytes in the batch even +if they are below size (default: 0 - e.g. on every tick)

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/it_batched_bytes.AsyncBatchedObjectsOptions.html b/interfaces/it_batched_bytes.AsyncBatchedObjectsOptions.html new file mode 100644 index 00000000..d19fcd73 --- /dev/null +++ b/interfaces/it_batched_bytes.AsyncBatchedObjectsOptions.html @@ -0,0 +1,9 @@ +AsyncBatchedObjectsOptions | Documentation

Interface AsyncBatchedObjectsOptions<T>

interface AsyncBatchedObjectsOptions {
    size?: number;
    yieldAfter?: number;
    serialize(object, list): void;
}

Type Parameters

  • T

Hierarchy

Properties

size? +yieldAfter? +

Methods

serialize +

Properties

Optional size

size?: number

The minimum number of bytes that should be in a batch (default: 1MB)

+

Optional yieldAfter

yieldAfter?: number

If this amount of time passes, yield all the bytes in the batch even +if they are below size (default: 0 - e.g. on every tick)

+

Methods

serialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/it_batched_bytes.BatchedBytesOptions.html b/interfaces/it_batched_bytes.BatchedBytesOptions.html new file mode 100644 index 00000000..d83f3616 --- /dev/null +++ b/interfaces/it_batched_bytes.BatchedBytesOptions.html @@ -0,0 +1,3 @@ +BatchedBytesOptions | Documentation

Interface BatchedBytesOptions

interface BatchedBytesOptions {
    size?: number;
}

Hierarchy

Properties

size? +

Properties

Optional size

size?: number

The minimum number of bytes that should be in a batch (default: 1MB)

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/it_batched_bytes.BatchedObjectsOptions.html b/interfaces/it_batched_bytes.BatchedObjectsOptions.html new file mode 100644 index 00000000..d031e885 --- /dev/null +++ b/interfaces/it_batched_bytes.BatchedObjectsOptions.html @@ -0,0 +1,6 @@ +BatchedObjectsOptions | Documentation

Interface BatchedObjectsOptions<T>

interface BatchedObjectsOptions {
    size?: number;
    serialize(object, list): void;
}

Type Parameters

  • T

Hierarchy

Properties

size? +

Methods

serialize +

Properties

Optional size

size?: number

The minimum number of bytes that should be in a batch (default: 1MB)

+

Methods

serialize

  • serialize(object, list): void

  • This function should serialize the object and append the +result to the passed list

    +

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/it_buffer_stream.BufferStreamOptions.html b/interfaces/it_buffer_stream.BufferStreamOptions.html new file mode 100644 index 00000000..ac86201c --- /dev/null +++ b/interfaces/it_buffer_stream.BufferStreamOptions.html @@ -0,0 +1,4 @@ +BufferStreamOptions | Documentation

Interface BufferStreamOptions

interface BufferStreamOptions {
    chunkSize?: number;
    collector?(arr): void;
    generator?(length): Uint8Array | Promise<Uint8Array>;
}

Properties

chunkSize? +

Methods

collector? +generator? +

Properties

Optional chunkSize

chunkSize?: number

Methods

Optional collector

Optional generator

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/it_byte_stream.AbortOptions.html b/interfaces/it_byte_stream.AbortOptions.html new file mode 100644 index 00000000..ddcdf737 --- /dev/null +++ b/interfaces/it_byte_stream.AbortOptions.html @@ -0,0 +1,2 @@ +AbortOptions | Documentation

Interface AbortOptions

interface AbortOptions {
    signal?: AbortSignal;
}

Properties

signal? +

Properties

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/it_byte_stream.ByteStream.html b/interfaces/it_byte_stream.ByteStream.html new file mode 100644 index 00000000..7c5ae209 --- /dev/null +++ b/interfaces/it_byte_stream.ByteStream.html @@ -0,0 +1,7 @@ +ByteStream | Documentation

Interface ByteStream<Stream>

interface ByteStream {
    read(bytes?, options?): Promise<Uint8ArrayList>;
    unwrap(): Stream;
    write(input, options?): Promise<void>;
}

Type Parameters

  • Stream = unknown

Methods

read +unwrap +write +

Methods

read

unwrap

write

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/it_byte_stream.ByteStreamOpts.html b/interfaces/it_byte_stream.ByteStreamOpts.html new file mode 100644 index 00000000..1586d2df --- /dev/null +++ b/interfaces/it_byte_stream.ByteStreamOpts.html @@ -0,0 +1,6 @@ +ByteStreamOpts | Documentation

Interface ByteStreamOpts

interface ByteStreamOpts {
    yieldBytes?: boolean;
}

Hierarchy

  • ByteStreamOpts

    Properties

    yieldBytes? +

    Properties

    Optional yieldBytes

    yieldBytes?: boolean

    After the stream is unwrapped, any bytes that have been read from the +incoming stream will be yielded in-order as Uint8Array(s).

    +

    To yield a single Uint8ArrayList with all unread bytes instead, pass +false here.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_glob.GlobOptions.html b/interfaces/it_glob.GlobOptions.html new file mode 100644 index 00000000..17c1d2dd --- /dev/null +++ b/interfaces/it_glob.GlobOptions.html @@ -0,0 +1,27 @@ +GlobOptions | Documentation

    Interface GlobOptions

    interface GlobOptions {
        absolute?: boolean;
        allowWindowsEscape?: boolean;
        cwd?: string;
        debug?: boolean;
        dot?: boolean;
        flipNegate?: boolean;
        magicalBraces?: boolean;
        matchBase?: boolean;
        nobrace?: boolean;
        nocase?: boolean;
        nocaseMagicOnly?: boolean;
        nocomment?: boolean;
        nodir?: boolean;
        noext?: boolean;
        noglobstar?: boolean;
        nonegate?: boolean;
        nonull?: boolean;
        optimizationLevel?: number;
        partial?: boolean;
        platform?: Platform;
        preserveMultipleSlashes?: boolean;
        windowsNoMagicRoot?: boolean;
        windowsPathsNoEscape?: boolean;
    }

    Hierarchy

    Properties

    absolute? +allowWindowsEscape? +cwd? +debug? +dot? +flipNegate? +magicalBraces? +matchBase? +nobrace? +nocase? +nocaseMagicOnly? +nocomment? +nodir? +noext? +noglobstar? +nonegate? +nonull? +optimizationLevel? +partial? +platform? +preserveMultipleSlashes? +windowsNoMagicRoot? +windowsPathsNoEscape? +

    Properties

    Optional absolute

    absolute?: boolean

    If true produces absolute paths (default: false)

    +

    Optional allowWindowsEscape

    allowWindowsEscape?: boolean

    Optional cwd

    cwd?: string

    The current working directory

    +

    Optional debug

    debug?: boolean

    Optional dot

    dot?: boolean

    Optional flipNegate

    flipNegate?: boolean

    Optional magicalBraces

    magicalBraces?: boolean

    Optional matchBase

    matchBase?: boolean

    Optional nobrace

    nobrace?: boolean

    Optional nocase

    nocase?: boolean

    Optional nocaseMagicOnly

    nocaseMagicOnly?: boolean

    Optional nocomment

    nocomment?: boolean

    Optional nodir

    nodir?: boolean

    If true yields file paths and skip directories (default: false)

    +

    Optional noext

    noext?: boolean

    Optional noglobstar

    noglobstar?: boolean

    Optional nonegate

    nonegate?: boolean

    Optional nonull

    nonull?: boolean

    Optional optimizationLevel

    optimizationLevel?: number

    Optional partial

    partial?: boolean

    Optional platform

    platform?: Platform

    Optional preserveMultipleSlashes

    preserveMultipleSlashes?: boolean

    Optional windowsNoMagicRoot

    windowsNoMagicRoot?: boolean

    Optional windowsPathsNoEscape

    windowsPathsNoEscape?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_length_prefixed_stream.AbortOptions.html b/interfaces/it_length_prefixed_stream.AbortOptions.html new file mode 100644 index 00000000..e7a3f547 --- /dev/null +++ b/interfaces/it_length_prefixed_stream.AbortOptions.html @@ -0,0 +1,2 @@ +AbortOptions | Documentation

    Interface AbortOptions

    interface AbortOptions {
        signal?: AbortSignal;
    }

    Properties

    signal? +

    Properties

    Optional signal

    signal?: AbortSignal

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_length_prefixed_stream.LengthPrefixedStream.html b/interfaces/it_length_prefixed_stream.LengthPrefixedStream.html new file mode 100644 index 00000000..efcbfb8f --- /dev/null +++ b/interfaces/it_length_prefixed_stream.LengthPrefixedStream.html @@ -0,0 +1,9 @@ +LengthPrefixedStream | Documentation

    Interface LengthPrefixedStream<Stream>

    interface LengthPrefixedStream {
        read(options?): Promise<Uint8ArrayList>;
        unwrap(): Stream;
        write(input, options?): Promise<void>;
        writeV(input, options?): Promise<void>;
    }

    Type Parameters

    • Stream = unknown

    Methods

    read +unwrap +write +writeV +

    Methods

    read

    unwrap

    write

    writeV

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_length_prefixed_stream.LengthPrefixedStreamOpts.html b/interfaces/it_length_prefixed_stream.LengthPrefixedStreamOpts.html new file mode 100644 index 00000000..c3f8d7a7 --- /dev/null +++ b/interfaces/it_length_prefixed_stream.LengthPrefixedStreamOpts.html @@ -0,0 +1,10 @@ +LengthPrefixedStreamOpts | Documentation

    Interface LengthPrefixedStreamOpts

    interface LengthPrefixedStreamOpts {
        lengthDecoder: LengthDecoderFunction;
        lengthEncoder: LengthEncoderFunction;
        maxDataLength: number;
        maxLengthLength: number;
        yieldBytes?: boolean;
    }

    Hierarchy

    Properties

    lengthDecoder +lengthEncoder +maxDataLength +maxLengthLength +yieldBytes? +

    Properties

    lengthDecoder

    lengthDecoder: LengthDecoderFunction

    lengthEncoder

    lengthEncoder: LengthEncoderFunction

    maxDataLength

    maxDataLength: number

    maxLengthLength

    maxLengthLength: number

    Optional yieldBytes

    yieldBytes?: boolean

    After the stream is unwrapped, any bytes that have been read from the +incoming stream will be yielded in-order as Uint8Array(s).

    +

    To yield a single Uint8ArrayList with all unread bytes instead, pass +false here.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_multipart.Part.html b/interfaces/it_multipart.Part.html new file mode 100644 index 00000000..81acd9d7 --- /dev/null +++ b/interfaces/it_multipart.Part.html @@ -0,0 +1,3 @@ +Part | Documentation

    Interface Part

    interface Part {
        body: AsyncIterable<Uint8Array>;
        headers: IncomingHttpHeaders;
    }

    Properties

    body +headers +

    Properties

    body

    body: AsyncIterable<Uint8Array>

    headers

    headers: IncomingHttpHeaders

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_parallel.ParallelOptions.html b/interfaces/it_parallel.ParallelOptions.html new file mode 100644 index 00000000..d5098020 --- /dev/null +++ b/interfaces/it_parallel.ParallelOptions.html @@ -0,0 +1,4 @@ +ParallelOptions | Documentation

    Interface ParallelOptions

    interface ParallelOptions {
        concurrency?: number;
        ordered?: boolean;
    }

    Properties

    concurrency? +ordered? +

    Properties

    Optional concurrency

    concurrency?: number

    How many jobs to execute in parallel (default: )

    +

    Optional ordered

    ordered?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_peekable.AsyncPeek.html b/interfaces/it_peekable.AsyncPeek.html new file mode 100644 index 00000000..7f9dddb7 --- /dev/null +++ b/interfaces/it_peekable.AsyncPeek.html @@ -0,0 +1,2 @@ +AsyncPeek | Documentation

    Interface AsyncPeek<T>

    interface AsyncPeek {
        peek(): Promise<IteratorResult<T, undefined>>;
    }

    Type Parameters

    • T

    Methods

    peek +

    Methods

    peek

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_peekable.Peek.html b/interfaces/it_peekable.Peek.html new file mode 100644 index 00000000..c647dbaa --- /dev/null +++ b/interfaces/it_peekable.Peek.html @@ -0,0 +1,2 @@ +Peek | Documentation

    Interface Peek<T>

    interface Peek {
        peek(): IteratorResult<T, undefined>;
    }

    Type Parameters

    • T

    Methods

    peek +

    Methods

    peek

    • peek(): IteratorResult<T, undefined>

    • Returns IteratorResult<T, undefined>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_peekable.Push.html b/interfaces/it_peekable.Push.html new file mode 100644 index 00000000..645b04fb --- /dev/null +++ b/interfaces/it_peekable.Push.html @@ -0,0 +1,2 @@ +Push | Documentation

    Interface Push<T>

    interface Push {
        push(value): void;
    }

    Type Parameters

    • T

    Methods

    push +

    Methods

    push

    • push(value): void

    • Parameters

      • value: T

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_protobuf_stream.AbortOptions.html b/interfaces/it_protobuf_stream.AbortOptions.html new file mode 100644 index 00000000..0fa08346 --- /dev/null +++ b/interfaces/it_protobuf_stream.AbortOptions.html @@ -0,0 +1,2 @@ +AbortOptions | Documentation

    Interface AbortOptions

    interface AbortOptions {
        signal?: AbortSignal;
    }

    Properties

    signal? +

    Properties

    Optional signal

    signal?: AbortSignal

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_protobuf_stream.Decoder.html b/interfaces/it_protobuf_stream.Decoder.html new file mode 100644 index 00000000..75720bf8 --- /dev/null +++ b/interfaces/it_protobuf_stream.Decoder.html @@ -0,0 +1,2 @@ +Decoder | Documentation

    Interface Decoder<T>

    A protobuf decoder - takes a byte array and returns an object

    +
    interface Decoder ((data) => T)

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_protobuf_stream.Encoder.html b/interfaces/it_protobuf_stream.Encoder.html new file mode 100644 index 00000000..a55cc900 --- /dev/null +++ b/interfaces/it_protobuf_stream.Encoder.html @@ -0,0 +1,2 @@ +Encoder | Documentation

    Interface Encoder<T>

    A protobuf encoder - takes an object and returns a byte array

    +
    interface Encoder ((data) => Uint8Array)

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_protobuf_stream.MessageStream.html b/interfaces/it_protobuf_stream.MessageStream.html new file mode 100644 index 00000000..237d24a6 --- /dev/null +++ b/interfaces/it_protobuf_stream.MessageStream.html @@ -0,0 +1,10 @@ +MessageStream | Documentation

    Interface MessageStream<T, S>

    A message reader/writer that only uses one type of message

    +
    interface MessageStream {
        read(options?): Promise<T>;
        unwrap(): ProtobufStream<S>;
        write(d, options?): Promise<void>;
        writeV(d, options?): Promise<void>;
    }

    Type Parameters

    • T

    • S = unknown

    Methods

    read +unwrap +write +writeV +

    Methods

    read

    unwrap

    write

    writeV

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_protobuf_stream.ProtobufStream.html b/interfaces/it_protobuf_stream.ProtobufStream.html new file mode 100644 index 00000000..b9d25760 --- /dev/null +++ b/interfaces/it_protobuf_stream.ProtobufStream.html @@ -0,0 +1,12 @@ +ProtobufStream | Documentation

    Interface ProtobufStream<Stream>

    Convenience methods for working with protobuf streams

    +
    interface ProtobufStream {
        pb<T>(proto): MessageStream<T, Stream>;
        read<T>(proto, options?): Promise<T>;
        unwrap(): Stream;
        write<T>(data, proto, options?): Promise<void>;
        writeV<T>(input, proto, options?): Promise<void>;
    }

    Type Parameters

    • Stream = unknown

    Methods

    pb +read +unwrap +write +writeV +

    Methods

    pb

    read

    unwrap

    write

    writeV

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_protobuf_stream.ProtobufStreamOpts.html b/interfaces/it_protobuf_stream.ProtobufStreamOpts.html new file mode 100644 index 00000000..fd4e098b --- /dev/null +++ b/interfaces/it_protobuf_stream.ProtobufStreamOpts.html @@ -0,0 +1,10 @@ +ProtobufStreamOpts | Documentation

    Interface ProtobufStreamOpts

    interface ProtobufStreamOpts {
        lengthDecoder: LengthDecoderFunction;
        lengthEncoder: LengthEncoderFunction;
        maxDataLength: number;
        maxLengthLength: number;
        yieldBytes?: boolean;
    }

    Hierarchy

    Properties

    lengthDecoder +lengthEncoder +maxDataLength +maxLengthLength +yieldBytes? +

    Properties

    lengthDecoder

    lengthDecoder: LengthDecoderFunction

    lengthEncoder

    lengthEncoder: LengthEncoderFunction

    maxDataLength

    maxDataLength: number

    maxLengthLength

    maxLengthLength: number

    Optional yieldBytes

    yieldBytes?: boolean

    After the stream is unwrapped, any bytes that have been read from the +incoming stream will be yielded in-order as Uint8Array(s).

    +

    To yield a single Uint8ArrayList with all unread bytes instead, pass +false here.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_sort.CompareFunction.html b/interfaces/it_sort.CompareFunction.html new file mode 100644 index 00000000..7b33712b --- /dev/null +++ b/interfaces/it_sort.CompareFunction.html @@ -0,0 +1 @@ +CompareFunction | Documentation

    Interface CompareFunction<T>

    interface CompareFunction ((a, b) => number)

    Type Parameters

    • T

    • CompareFunction(a, b): number

    • Parameters

      • a: T
      • b: T

      Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/it_split.SplitOptions.html b/interfaces/it_split.SplitOptions.html new file mode 100644 index 00000000..0d87d5bb --- /dev/null +++ b/interfaces/it_split.SplitOptions.html @@ -0,0 +1,2 @@ +SplitOptions | Documentation

    Interface SplitOptions

    interface SplitOptions {
        delimiter?: Uint8Array;
    }

    Properties

    delimiter? +

    Properties

    Optional delimiter

    delimiter?: Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules.html b/modules.html deleted file mode 100644 index a2245b63..00000000 --- a/modules.html +++ /dev/null @@ -1,12 +0,0 @@ -it-protobuf-stream

    it-protobuf-stream

    This module makes it easy to send and receive length-prefixed Protobuf encoded -messages over streams.

    -

    Example

    import { pbStream } from 'it-protobuf-stream'
    import { MessageType } from './src/my-message-type.js'

    // RequestType and ResponseType have been generate from `.proto` files and have
    // `.encode` and `.decode` methods for serialization/deserialization

    const stream = pbStream(duplex)

    // write a message to the stream
    stream.write({
      foo: 'bar'
    }, MessageType)

    // read a message from the stream
    const res = await stream.read(MessageType)
-
    -

    Index

    Interfaces

    AbortOptions -Decoder -Encoder -MessageStream -ProtobufStream -ProtobufStreamOpts -

    Functions

    pbStream -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/blob_to_it.html b/modules/blob_to_it.html new file mode 100644 index 00000000..11ab0abe --- /dev/null +++ b/modules/blob_to_it.html @@ -0,0 +1,27 @@ +blob-to-it | Documentation

    Module blob-to-it

    Allows reading Blob contents as an async iterator.

    +

    Example

    import toIt from 'blob-to-it'
    import all from 'it-all'

    const content = [ Uint8Array.from([0, 1, 2, 3, 4]) ]
    const blob = new Blob(content)
    const arr = await all(toIt(blob))

    console.info(arr) // [ [ 0, 1, 2, 3, 4 ] ]
+
    +

    codecov +CI

    +
    +

    Turns a blob into an async iterator

    +
    +

    About

    Allows reading Blob contents as an async iterator.

    +

    Example

    import toIt from 'blob-to-it'
    import all from 'it-all'

    const content = [ Uint8Array.from([0, 1, 2, 3, 4]) ]
    const blob = new Blob(content)
    const arr = await all(toIt(blob))

    console.info(arr) // [ [ 0, 1, 2, 3, 4 ] ]
+
    +

    Install

    $ npm i blob-to-it
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as BlobToIt in the global namespace.

    +
    <script src="https://unpkg.com/blob-to-it/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/browser_readablestream_to_it.html b/modules/browser_readablestream_to_it.html new file mode 100644 index 00000000..d6f22f91 --- /dev/null +++ b/modules/browser_readablestream_to_it.html @@ -0,0 +1,38 @@ +browser-readablestream-to-it | Documentation

    Module browser-readablestream-to-it

    Allows treating a browser readable stream as an async iterator.

    +

    Example

    import toIt from 'browser-readablestream-to-it'
    import all from 'it-all'

    const content = [0, 1, 2, 3, 4]

    const stream = new ReadableStream({
      start(controller) {
        for (let i = 0; i < content.length; i++) {
          controller.enqueue(content[i])
        }

        controller.close()
      }
    })

    const arr = await all(toIt(stream))

    console.info(arr) // 0, 1, 2, 3, 4
+
    +

    preventCancel

    By default a readable stream will have .cancel called on it once it has ended or +reading has stopped prematurely.

    +

    To prevent this behaviour, pass preventCancel: true as an option:

    +
    const arr = await all(toIt(stream, { preventCancel: true }))

    console.info(arr) // 0, 1, 2, 3, 4
+
    +

    codecov +CI

    +
    +

    Turns a browser readble stream into an async iterator

    +
    +

    About

    Allows treating a browser readable stream as an async iterator.

    +

    Example

    import toIt from 'browser-readablestream-to-it'
    import all from 'it-all'

    const content = [0, 1, 2, 3, 4]

    const stream = new ReadableStream({
      start(controller) {
        for (let i = 0; i < content.length; i++) {
          controller.enqueue(content[i])
        }

        controller.close()
      }
    })

    const arr = await all(toIt(stream))

    console.info(arr) // 0, 1, 2, 3, 4
+
    +

    preventCancel

    By default a readable stream will have .cancel called on it once it has ended or +reading has stopped prematurely.

    +

    To prevent this behaviour, pass preventCancel: true as an option:

    +
    const arr = await all(toIt(stream, { preventCancel: true }))

    console.info(arr) // 0, 1, 2, 3, 4
+
    +

    Install

    $ npm i browser-readablestream-to-it
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as BrowserReadablestreamToIt in the global namespace.

    +
    <script src="https://unpkg.com/browser-readablestream-to-it/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    BrowserReadableStreamToItOptions +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_all.html b/modules/it_all.html new file mode 100644 index 00000000..01401d5f --- /dev/null +++ b/modules/it_all.html @@ -0,0 +1,33 @@ +it-all | Documentation

    Module it-all

    For when you need a one-liner to collect iterable values.

    +

    Example

    import all from 'it-all'

    // This can also be an iterator, etc
    const values = function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const arr = all(values)

    console.info(arr) // 0, 1, 2, 3, 4
+
    +

    Async sources must be awaited:

    +
    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const arr = await all(values())

    console.info(arr) // 0, 1, 2, 3, 4
+
    +

    codecov +CI

    +
    +

    Collects all values from an (async) iterable and returns them as an array

    +
    +

    About

    For when you need a one-liner to collect iterable values.

    +

    Example

    import all from 'it-all'

    // This can also be an iterator, etc
    const values = function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const arr = all(values)

    console.info(arr) // 0, 1, 2, 3, 4
+
    +

    Async sources must be awaited:

    +
    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const arr = await all(values())

    console.info(arr) // 0, 1, 2, 3, 4
+
    +

    Install

    $ npm i it-all
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItAll in the global namespace.

    +
    <script src="https://unpkg.com/it-all/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_batch.html b/modules/it_batch.html new file mode 100644 index 00000000..f7836531 --- /dev/null +++ b/modules/it_batch.html @@ -0,0 +1,33 @@ +it-batch | Documentation

    Module it-batch

    The final batch may be smaller than the max.

    +

    Example

    import batch from 'it-batch'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]
    const batchSize = 2

    const result = all(batch(values, batchSize))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Async sources must be awaited:

    +
    import batch from 'it-batch'
    import all from 'it-all'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const batchSize = 2
    const result = await all(batch(values(), batchSize))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    codecov +CI

    +
    +

    Takes an async iterator that emits things and emits them as fixed size batches

    +
    +

    About

    The final batch may be smaller than the max.

    +

    Example

    import batch from 'it-batch'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]
    const batchSize = 2

    const result = all(batch(values, batchSize))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Async sources must be awaited:

    +
    import batch from 'it-batch'
    import all from 'it-all'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const batchSize = 2
    const result = await all(batch(values(), batchSize))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Install

    $ npm i it-batch
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItBatch in the global namespace.

    +
    <script src="https://unpkg.com/it-batch/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_batched_bytes.html b/modules/it_batched_bytes.html new file mode 100644 index 00000000..a408e7ab --- /dev/null +++ b/modules/it_batched_bytes.html @@ -0,0 +1,37 @@ +it-batched-bytes | Documentation

    Module it-batched-bytes

    The final batch may be smaller than the max.

    +

    Example

    import batch from 'it-batched-bytes'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values = [
      Uint8Array.from([0]),
      Uint8Array.from([1]),
      Uint8Array.from([2]),
      Uint8Array.from([3]),
      Uint8Array.from([4])
    ]
    const batchSize = 2

    const result = all(batch(values, { size: batchSize }))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Async sources must be awaited:

    +
    import batch from 'it-batched-bytes'
    import all from 'it-all'

    const values = async function * () {
      yield Uint8Array.from([0])
      yield Uint8Array.from([1])
      yield Uint8Array.from([2])
      yield Uint8Array.from([3])
      yield Uint8Array.from([4])
    }
    const batchSize = 2

    const result = await all(batch(values, { size: batchSize }))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    codecov +CI

    +
    +

    Takes an async iterator that emits byte arrays and emits them as fixed size batches

    +
    +

    About

    The final batch may be smaller than the max.

    +

    Example

    import batch from 'it-batched-bytes'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values = [
      Uint8Array.from([0]),
      Uint8Array.from([1]),
      Uint8Array.from([2]),
      Uint8Array.from([3]),
      Uint8Array.from([4])
    ]
    const batchSize = 2

    const result = all(batch(values, { size: batchSize }))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Async sources must be awaited:

    +
    import batch from 'it-batched-bytes'
    import all from 'it-all'

    const values = async function * () {
      yield Uint8Array.from([0])
      yield Uint8Array.from([1])
      yield Uint8Array.from([2])
      yield Uint8Array.from([3])
      yield Uint8Array.from([4])
    }
    const batchSize = 2

    const result = await all(batch(values, { size: batchSize }))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Install

    $ npm i it-batched-bytes
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItBatchedBytes in the global namespace.

    +
    <script src="https://unpkg.com/it-batched-bytes/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    AsyncBatchedBytesOptions +AsyncBatchedObjectsOptions +BatchedBytesOptions +BatchedObjectsOptions +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_buffer_stream.html b/modules/it_buffer_stream.html new file mode 100644 index 00000000..5f3a8ff1 --- /dev/null +++ b/modules/it_buffer_stream.html @@ -0,0 +1,28 @@ +it-buffer-stream | Documentation

    Module it-buffer-stream

    Generate a stream of buffers, useful for testing purposes.

    +

    Example

    import bufferStream from 'it-buffer-stream'

    const totalLength = //... a big number

    // all options are optional, defaults are shown
    const options = {
      chunkSize: 4096, // how many bytes will be in each buffer
      collector: (buffer) => {
        // will be called as each buffer is generated. the final buffer
        // may be smaller than `chunkSize`
      },
      generator: async (size) => {
        // return a promise that resolves to a buffer of length `size`
        //
        // if omitted, `Promise.resolve(crypto.randomBytes(size))` will be used
      }
    }

    let buffers = []

    for await (buf of bufferStream(totalLength, options)) {
      buffers.push(buf)
    }

    // `buffers` is an array of Buffers the combined length of which === totalLength
+
    +

    codecov +CI

    +
    +

    An async iterator that emits buffers containing bytes up to a certain length

    +
    +

    About

    Generate a stream of buffers, useful for testing purposes.

    +

    Example

    import bufferStream from 'it-buffer-stream'

    const totalLength = //... a big number

    // all options are optional, defaults are shown
    const options = {
      chunkSize: 4096, // how many bytes will be in each buffer
      collector: (buffer) => {
        // will be called as each buffer is generated. the final buffer
        // may be smaller than `chunkSize`
      },
      generator: async (size) => {
        // return a promise that resolves to a buffer of length `size`
        //
        // if omitted, `Promise.resolve(crypto.randomBytes(size))` will be used
      }
    }

    let buffers = []

    for await (buf of bufferStream(totalLength, options)) {
      buffers.push(buf)
    }

    // `buffers` is an array of Buffers the combined length of which === totalLength
+
    +

    Install

    $ npm i it-buffer-stream
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItBufferStream in the global namespace.

    +
    <script src="https://unpkg.com/it-buffer-stream/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    BufferStreamOptions +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_byte_stream.html b/modules/it_byte_stream.html new file mode 100644 index 00000000..d4bf887b --- /dev/null +++ b/modules/it_byte_stream.html @@ -0,0 +1,32 @@ +it-byte-stream | Documentation

    Module it-byte-stream

    This module makes it easy to send and receive bytes over streams.

    +

    Example

    import { byteStream } from 'it-byte-stream'

    const stream = byteStream(duplex)

    // read the next chunk
    const bytes = await stream.read()

    // read the next five bytes
    const fiveBytes = await stream.read(5)

    // write bytes into the stream
    await stream.write(Uint8Array.from([0, 1, 2, 3, 4]))
+
    +

    codecov +CI

    +
    +

    Read and write arbitrary bytes over a duplex stream

    +
    +

    About

    This module makes it easy to send and receive bytes over streams.

    +

    Example

    import { byteStream } from 'it-byte-stream'

    const stream = byteStream(duplex)

    // read the next chunk
    const bytes = await stream.read()

    // read the next five bytes
    const fiveBytes = await stream.read(5)

    // write bytes into the stream
    await stream.write(Uint8Array.from([0, 1, 2, 3, 4]))
+
    +

    Install

    $ npm i it-byte-stream
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItByteStream in the global namespace.

    +
    <script src="https://unpkg.com/it-byte-stream/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Classes

    AbortError +CodeError +

    Interfaces

    AbortOptions +ByteStream +ByteStreamOpts +

    Functions

    byteStream +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_drain.html b/modules/it_drain.html new file mode 100644 index 00000000..b890334b --- /dev/null +++ b/modules/it_drain.html @@ -0,0 +1,33 @@ +it-drain | Documentation

    Module it-drain

    Mostly useful for tests or when you want to be explicit about consuming an iterable without doing anything with any yielded values.

    +

    Example

    import drain from 'it-drain'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    drain(values)
+
    +

    Async sources must be awaited:

    +
    import drain from 'it-drain'

    const values = async function * {
      yield * [0, 1, 2, 3, 4]
    }

    await drain(values())
+
    +

    codecov +CI

    +
    +

    Empties an async iterator

    +
    +

    About

    Mostly useful for tests or when you want to be explicit about consuming an iterable without doing anything with any yielded values.

    +

    Example

    import drain from 'it-drain'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    drain(values)
+
    +

    Async sources must be awaited:

    +
    import drain from 'it-drain'

    const values = async function * {
      yield * [0, 1, 2, 3, 4]
    }

    await drain(values())
+
    +

    Install

    $ npm i it-drain
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItDrain in the global namespace.

    +
    <script src="https://unpkg.com/it-drain/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_filter.html b/modules/it_filter.html new file mode 100644 index 00000000..eba3e59e --- /dev/null +++ b/modules/it_filter.html @@ -0,0 +1,33 @@ +it-filter | Documentation

    Module it-filter

    Filter values out of an (async)iterable

    +

    Example

    import all from 'it-all'
    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 arr = all(filter(values, fn))

    console.info(arr) // 3, 4
+
    +

    Async sources and filter functions must be awaited:

    +
    import all from 'it-all'
    import filter from 'it-filter'

    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 arr = await all(filter(values, fn))

    console.info(arr) // 3, 4
+
    +

    codecov +CI

    +
    +

    Filters the passed iterable by using the filter function

    +
    +

    About

    Filter values out of an (async)iterable

    +

    Example

    import all from 'it-all'
    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 arr = all(filter(values, fn))

    console.info(arr) // 3, 4
+
    +

    Async sources and filter functions must be awaited:

    +
    import all from 'it-all'
    import filter from 'it-filter'

    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 arr = await all(filter(values, fn))

    console.info(arr) // 3, 4
+
    +

    Install

    $ npm i it-filter
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItFilter in the global namespace.

    +
    <script src="https://unpkg.com/it-filter/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_first.html b/modules/it_first.html new file mode 100644 index 00000000..3d64c7cf --- /dev/null +++ b/modules/it_first.html @@ -0,0 +1,33 @@ +it-first | Documentation

    Module it-first

    Return the first value in an (async)iterable

    +

    Example

    import first from 'it-first'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const res = first(values)

    console.info(res) // 0
+
    +

    Async sources must be awaited:

    +
    import first from 'it-first'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const res = await first(values())

    console.info(res) // 0
+
    +

    codecov +CI

    +
    +

    Returns the first result from an async iterator

    +
    +

    About

    Return the first value in an (async)iterable

    +

    Example

    import first from 'it-first'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const res = first(values)

    console.info(res) // 0
+
    +

    Async sources must be awaited:

    +
    import first from 'it-first'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const res = await first(values())

    console.info(res) // 0
+
    +

    Install

    $ npm i it-first
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItFirst in the global namespace.

    +
    <script src="https://unpkg.com/it-first/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_flat_batch.html b/modules/it_flat_batch.html new file mode 100644 index 00000000..135d5687 --- /dev/null +++ b/modules/it_flat_batch.html @@ -0,0 +1,33 @@ +it-flat-batch | Documentation

    Module it-flat-batch

    The final batch may be smaller than requested batch size.

    +

    Example

    import batch from 'it-flat-batch'
    import all from 'it-all'

    // This can also be an iterator, async iterator, generator, etc
    const values = [[0, 1, 2], [3], [4]]
    const batchSize = 2

    const result = all(batch(values, batchSize))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Async sources must be awaited:

    +
    import batch from 'it-flat-batch'
    import all from 'it-all'

    const values = async function * () {
      yield * [[0, 1, 2], [3], [4]]
    }
    const batchSize = 2

    const result = await all(batch(values(), batchSize))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    codecov +CI

    +
    +

    Takes an async iterator that emits variable length arrays and emits them as fixed size batches

    +
    +

    About

    The final batch may be smaller than requested batch size.

    +

    Example

    import batch from 'it-flat-batch'
    import all from 'it-all'

    // This can also be an iterator, async iterator, generator, etc
    const values = [[0, 1, 2], [3], [4]]
    const batchSize = 2

    const result = all(batch(values, batchSize))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Async sources must be awaited:

    +
    import batch from 'it-flat-batch'
    import all from 'it-all'

    const values = async function * () {
      yield * [[0, 1, 2], [3], [4]]
    }
    const batchSize = 2

    const result = await all(batch(values(), batchSize))

    console.info(result) // [0, 1], [2, 3], [4]
+
    +

    Install

    $ npm i it-flat-batch
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItFlatBatch in the global namespace.

    +
    <script src="https://unpkg.com/it-flat-batch/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_foreach.html b/modules/it_foreach.html new file mode 100644 index 00000000..666ea4a1 --- /dev/null +++ b/modules/it_foreach.html @@ -0,0 +1,37 @@ +it-foreach | Documentation

    Module it-foreach

    Calls a function for each value in an (async)iterable.

    +

    The function can be sync or async.

    +

    Async functions can be awaited on so may slow down processing of the (async)iterable.

    +

    Example

    import each from 'it-foreach'
    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
    const arr = drain(
      each(values, console.info)
    )
+
    +

    Async sources and callbacks must be awaited:

    +
    import each from 'it-foreach'
    import drain from 'it-drain'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    // prints 0, 1, 2, 3, 4
    const arr = await drain(
      each(values(), console.info)
    )
+
    +

    codecov +CI

    +
    +

    Invokes the passed function for each item in an iterable

    +
    +

    About

    Calls a function for each value in an (async)iterable.

    +

    The function can be sync or async.

    +

    Async functions can be awaited on so may slow down processing of the (async)iterable.

    +

    Example

    import each from 'it-foreach'
    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
    const arr = drain(
      each(values, console.info)
    )
+
    +

    Async sources and callbacks must be awaited:

    +
    import each from 'it-foreach'
    import drain from 'it-drain'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    // prints 0, 1, 2, 3, 4
    const arr = await drain(
      each(values(), console.info)
    )
+
    +

    Install

    $ npm i it-foreach
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItForeach in the global namespace.

    +
    <script src="https://unpkg.com/it-foreach/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_glob.html b/modules/it_glob.html new file mode 100644 index 00000000..9d324a16 --- /dev/null +++ b/modules/it_glob.html @@ -0,0 +1,27 @@ +it-glob | Documentation

    Module it-glob

    Like glob but async iterable.

    +

    Example

    import glob from 'it-glob'

    const options = {
      cwd // defaults to process.cwd
      absolute // return absolute paths, defaults to false
      nodir // only yield file paths, skip directories

      // all other options are passed to minimatch
    }

    for await (const path of glob('/path/to/file', '**/*', options)) {
     console.info(path)
    }
+
    +

    See the minimatch docs for the full list of options.

    +

    codecov +CI

    +
    +

    Async iterable filename pattern matcher

    +
    +

    About

    Like glob but async iterable.

    +

    Example

    import glob from 'it-glob'

    const options = {
      cwd // defaults to process.cwd
      absolute // return absolute paths, defaults to false
      nodir // only yield file paths, skip directories

      // all other options are passed to minimatch
    }

    for await (const path of glob('/path/to/file', '**/*', options)) {
     console.info(path)
    }
+
    +

    See the minimatch docs for the full list of options.

    +

    Install

    $ npm i it-glob
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    GlobOptions +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_last.html b/modules/it_last.html new file mode 100644 index 00000000..94c0bc5f --- /dev/null +++ b/modules/it_last.html @@ -0,0 +1,33 @@ +it-last | Documentation

    Module it-last

    Return the last value from an (async)iterable.

    +

    Example

    import last from 'it-last'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const res = last(values)

    console.info(res) // 4
+
    +

    Async sources must be awaited:

    +
    import last from 'it-last'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const res = await last(values())

    console.info(res) // 4
+
    +

    codecov +CI

    +
    +

    Returns the last result from an async iterator

    +
    +

    About

    Return the last value from an (async)iterable.

    +

    Example

    import last from 'it-last'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const res = last(values)

    console.info(res) // 4
+
    +

    Async sources must be awaited:

    +
    import last from 'it-last'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const res = await last(values())

    console.info(res) // 4
+
    +

    Install

    $ npm i it-last
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItLast in the global namespace.

    +
    <script src="https://unpkg.com/it-last/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_length.html b/modules/it_length.html new file mode 100644 index 00000000..dffc7aa2 --- /dev/null +++ b/modules/it_length.html @@ -0,0 +1,35 @@ +it-length | Documentation

    Module it-length

    Counts the number of items in an (async)iterable.

    +

    N.b. will consume the iterable

    +

    Example

    import length from 'it-length'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const res = length(values)

    console.info(res) // 5
+
    +

    Async sources must be awaited:

    +
    import length from 'it-length'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const res = await length(values())

    console.info(res) // 5
+
    +

    codecov +CI

    +
    +

    Counts the number of items in an async iterable

    +
    +

    About

    Counts the number of items in an (async)iterable.

    +

    N.b. will consume the iterable

    +

    Example

    import length from 'it-length'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const res = length(values)

    console.info(res) // 5
+
    +

    Async sources must be awaited:

    +
    import length from 'it-length'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const res = await length(values())

    console.info(res) // 5
+
    +

    Install

    $ npm i it-length
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItLength in the global namespace.

    +
    <script src="https://unpkg.com/it-length/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_length_prefixed_stream.html b/modules/it_length_prefixed_stream.html new file mode 100644 index 00000000..6123944d --- /dev/null +++ b/modules/it_length_prefixed_stream.html @@ -0,0 +1,30 @@ +it-length-prefixed-stream | Documentation

    Module it-length-prefixed-stream

    This module makes it easy to send and receive length-prefixed byte arrays over streams.

    +

    Example

    import { lpStream } from 'it-length-prefixed-stream'

    const stream = lpStream(duplex)

    // read the next length-prefixed chunk
    const bytes = await stream.read()

    // write a length-prefixed chunk
    await stream.write(Uint8Array.from([0, 1, 2, 3, 4]))

    // write several chunks, all individually length-prefixed
    await stream.writeV([
      Uint8Array.from([0, 1, 2, 3, 4]),
      Uint8Array.from([5, 6, 7, 8, 9])
    ])
+
    +

    codecov +CI

    +
    +

    Read and write length-prefixed byte arrays over a duplex stream

    +
    +

    About

    This module makes it easy to send and receive length-prefixed byte arrays over streams.

    +

    Example

    import { lpStream } from 'it-length-prefixed-stream'

    const stream = lpStream(duplex)

    // read the next length-prefixed chunk
    const bytes = await stream.read()

    // write a length-prefixed chunk
    await stream.write(Uint8Array.from([0, 1, 2, 3, 4]))

    // write several chunks, all individually length-prefixed
    await stream.writeV([
      Uint8Array.from([0, 1, 2, 3, 4]),
      Uint8Array.from([5, 6, 7, 8, 9])
    ])
+
    +

    Install

    $ npm i it-length-prefixed-stream
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItLengthPrefixedStream in the global namespace.

    +
    <script src="https://unpkg.com/it-length-prefixed-stream/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    AbortOptions +LengthPrefixedStream +LengthPrefixedStreamOpts +

    Functions

    lpStream +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_map.html b/modules/it_map.html new file mode 100644 index 00000000..5296f1c8 --- /dev/null +++ b/modules/it_map.html @@ -0,0 +1,33 @@ +it-map | Documentation

    Module it-map

    Convert one value from an (async)iterator into another.

    +

    Example

    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++)

    console.info(result) // [1, 2, 3, 4, 5]
+
    +

    Async sources and transforms must be awaited:

    +
    import map from 'it-map'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const result = await map(values(), async (val) => val++)

    console.info(result) // [1, 2, 3, 4, 5]
+
    +

    codecov +CI

    +
    +

    Maps the values yielded by an async iterator

    +
    +

    About

    Convert one value from an (async)iterator into another.

    +

    Example

    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++)

    console.info(result) // [1, 2, 3, 4, 5]
+
    +

    Async sources and transforms must be awaited:

    +
    import map from 'it-map'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const result = await map(values(), async (val) => val++)

    console.info(result) // [1, 2, 3, 4, 5]
+
    +

    Install

    $ npm i it-map
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItMap in the global namespace.

    +
    <script src="https://unpkg.com/it-map/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_merge.html b/modules/it_merge.html new file mode 100644 index 00000000..52b96c6f --- /dev/null +++ b/modules/it_merge.html @@ -0,0 +1,35 @@ +it-merge | Documentation

    Module it-merge

    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.

    +

    Example

    import merge from 'it-merge'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values1 = [0, 1, 2, 3, 4]
    const values2 = [5, 6, 7, 8, 9]

    const arr = all(merge(values1, values2))

    console.info(arr) // 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
+
    +

    Async sources must be awaited:

    +
    import merge from 'it-merge'
    import all from 'it-all'

    // This can also be an iterator, async iterator, generator, etc
    const values1 = async function * () {
      yield * [0, 1, 2, 3, 4]
    }
    const values2 = async function * () {
      yield * [5, 6, 7, 8, 9]
    }

    const arr = await all(merge(values1(), values2()))

    console.info(arr) // 0, 1, 5, 6, 2, 3, 4, 7, 8, 9  <- nb. order is not guaranteed
+
    +

    codecov +CI

    +
    +

    Treat one or more iterables as a single iterable

    +
    +

    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.

    +

    Example

    import merge from 'it-merge'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values1 = [0, 1, 2, 3, 4]
    const values2 = [5, 6, 7, 8, 9]

    const arr = all(merge(values1, values2))

    console.info(arr) // 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
+
    +

    Async sources must be awaited:

    +
    import merge from 'it-merge'
    import all from 'it-all'

    // This can also be an iterator, async iterator, generator, etc
    const values1 = async function * () {
      yield * [0, 1, 2, 3, 4]
    }
    const values2 = async function * () {
      yield * [5, 6, 7, 8, 9]
    }

    const arr = await all(merge(values1(), values2()))

    console.info(arr) // 0, 1, 5, 6, 2, 3, 4, 7, 8, 9  <- nb. order is not guaranteed
+
    +

    Install

    $ npm i it-merge
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItMerge in the global namespace.

    +
    <script src="https://unpkg.com/it-merge/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_multipart.html b/modules/it_multipart.html new file mode 100644 index 00000000..29f4d212 --- /dev/null +++ b/modules/it_multipart.html @@ -0,0 +1,25 @@ +it-multipart | Documentation

    Module it-multipart

    Allows iterating over multipart messages found in a HTTP request/

    +

    Example

    import http from 'http'
    import multipart from 'it-multipart'

    http.createServer(async (req, res) => {
      if (req.method === 'POST' && req.headers['content-type']) {
        for await (const part of multipart(req)) {
          console.log(`part with HTTP headers ${part.headers}`)

          // nb. part.body must be consumed before the next part is emitted
          for await (const chunk of part.body) {
            console.log(`part with content ${part.name} contents:`, chunk.toString())
          }
        }

        console.log('finished parsing')
        res.writeHead(200)
        res.end()
      }

      res.writeHead(404)
      res.end()
    }).listen(5001, () => {
      console.log('server listening on port 5001')
    })
+
    +

    codecov +CI

    +
    +

    Async iterable http multipart message parser

    +
    +

    About

    Allows iterating over multipart messages found in a HTTP request/

    +

    Example

    import http from 'http'
    import multipart from 'it-multipart'

    http.createServer(async (req, res) => {
      if (req.method === 'POST' && req.headers['content-type']) {
        for await (const part of multipart(req)) {
          console.log(`part with HTTP headers ${part.headers}`)

          // nb. part.body must be consumed before the next part is emitted
          for await (const chunk of part.body) {
            console.log(`part with content ${part.name} contents:`, chunk.toString())
          }
        }

        console.log('finished parsing')
        res.writeHead(200)
        res.end()
      }

      res.writeHead(404)
      res.end()
    }).listen(5001, () => {
      console.log('server listening on port 5001')
    })
+
    +

    Install

    $ npm i it-multipart
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    Part +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_ndjson.html b/modules/it_ndjson.html new file mode 100644 index 00000000..7a7cc817 --- /dev/null +++ b/modules/it_ndjson.html @@ -0,0 +1,28 @@ +it-ndjson | Documentation

    Module it-ndjson

    Turn (async)iterable values into JSON and back again.

    +

    Example

    import ndjson from 'it-ndjson'
    import all from 'it-all'

    // This can also be an iterator, async iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const arr = await all(ndjson.stringify(values))

    console.info(arr) // '0\n', '1\n', '2\n', '3\n', '4\n'

    const res = await all(ndjson.parse(arr))

    console.info(res) // [0, 1, 2, 3, 4]
+
    +

    codecov +CI

    +
    +

    Parse iterators as ndjson and transform iterators to ndjson

    +
    +

    About

    Turn (async)iterable values into JSON and back again.

    +

    Example

    import ndjson from 'it-ndjson'
    import all from 'it-all'

    // This can also be an iterator, async iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const arr = await all(ndjson.stringify(values))

    console.info(arr) // '0\n', '1\n', '2\n', '3\n', '4\n'

    const res = await all(ndjson.parse(arr))

    console.info(res) // [0, 1, 2, 3, 4]
+
    +

    Install

    $ npm i it-ndjson
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItNdjson in the global namespace.

    +
    <script src="https://unpkg.com/it-ndjson/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    parse +stringify +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_parallel.html b/modules/it_parallel.html new file mode 100644 index 00000000..9772bf86 --- /dev/null +++ b/modules/it_parallel.html @@ -0,0 +1,34 @@ +it-parallel | Documentation

    Module it-parallel

    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

    import parallel from 'it-parallel'
    import all from 'it-all'
    import delay from 'delay'

    // This can also be an iterator, async iterator, generator, etc
    const input = [
      async () => {
        console.info('start 1')
        await delay(500)

        console.info('end 1')
        return 1
      },
      async () => {
        console.info('start 2')
        await delay(200)

        console.info('end 2')
        return 2
      },
      async () => {
        console.info('start 3')
        await delay(100)

        console.info('end 3')
        return 3
      }
    ]

    const result = await all(parallel(input, {
      concurrency: 2
    }))

    // output:
    // start 1
    // start 2
    // end 2
    // start 3
    // end 3
    // end 1

    console.info(result) // [2, 3, 1]
+
    +

    If order is important, pass ordered: true as an option:

    +
    const result = await all(parallel(input, {
      concurrency: 2,
      ordered: true
    }))

    // output:
    // start 1
    // start 2
    // end 2
    // start 3
    // end 3
    // end 1

    console.info(result) // [1, 2, 3]
+
    +

    codecov +CI

    +
    +

    Process incoming async(iterable) functions in parallel

    +
    +

    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

    import parallel from 'it-parallel'
    import all from 'it-all'
    import delay from 'delay'

    // This can also be an iterator, async iterator, generator, etc
    const input = [
      async () => {
        console.info('start 1')
        await delay(500)

        console.info('end 1')
        return 1
      },
      async () => {
        console.info('start 2')
        await delay(200)

        console.info('end 2')
        return 2
      },
      async () => {
        console.info('start 3')
        await delay(100)

        console.info('end 3')
        return 3
      }
    ]

    const result = await all(parallel(input, {
      concurrency: 2
    }))

    // output:
    // start 1
    // start 2
    // end 2
    // start 3
    // end 3
    // end 1

    console.info(result) // [2, 3, 1]
+
    +

    If order is important, pass ordered: true as an option:

    +
    const result = await all(parallel(input, {
      concurrency: 2,
      ordered: true
    }))

    // output:
    // start 1
    // start 2
    // end 2
    // start 3
    // end 3
    // end 1

    console.info(result) // [1, 2, 3]
+
    +

    Install

    $ npm i it-parallel
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItParallel in the global namespace.

    +
    <script src="https://unpkg.com/it-parallel/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    ParallelOptions +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_parallel_batch.html b/modules/it_parallel_batch.html new file mode 100644 index 00000000..06d3310b --- /dev/null +++ b/modules/it_parallel_batch.html @@ -0,0 +1,29 @@ +it-parallel-batch | Documentation

    Module it-parallel-batch

    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.

    +

    Example

    import parallelBatch from 'it-parallel-batch'
    import all from 'it-all'
    import delay from 'delay'

    // This can also be an iterator, async iterator, generator, etc
    const input = [
      async () => {
        await delay(500)

        return 1
      },
      async () => {
        await delay(200)

        return 2
      },
      async () => {
        await delay(100)

        return 3
      }
    ]

    const batchSize = 2

    const result = await all(parallelBatch(input, batchSize))

    console.info(result) // [1, 2, 3]
+
    +

    codecov +CI

    +
    +

    Process (async)iterable values as functions with concurrency control

    +
    +

    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.

    +

    Example

    import parallelBatch from 'it-parallel-batch'
    import all from 'it-all'
    import delay from 'delay'

    // This can also be an iterator, async iterator, generator, etc
    const input = [
      async () => {
        await delay(500)

        return 1
      },
      async () => {
        await delay(200)

        return 2
      },
      async () => {
        await delay(100)

        return 3
      }
    ]

    const batchSize = 2

    const result = await all(parallelBatch(input, batchSize))

    console.info(result) // [1, 2, 3]
+
    +

    Install

    $ npm i it-parallel-batch
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItParallelBatch in the global namespace.

    +
    <script src="https://unpkg.com/it-parallel-batch/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_peekable.html b/modules/it_peekable.html new file mode 100644 index 00000000..e0712dfd --- /dev/null +++ b/modules/it_peekable.html @@ -0,0 +1,38 @@ +it-peekable | Documentation

    Module it-peekable

    Lets you look at the contents of an async iterator and decide what to do

    +

    Example

    import peekable from 'it-peekable'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const it = peekable(value)

    const first = it.peek()

    console.info(first) // 0

    it.push(first)

    console.info([...it])
    // [ 0, 1, 2, 3, 4 ]
+
    +

    Async sources must be awaited:

    +
    import peekable from 'it-peekable'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const it = peekable(values())

    const first = await it.peek()

    console.info(first) // 0

    it.push(first)

    console.info(await all(it))
    // [ 0, 1, 2, 3, 4 ]
+
    +

    codecov +CI

    +
    +

    Allows peeking/pushing an iterable

    +
    +

    About

    Lets you look at the contents of an async iterator and decide what to do

    +

    Example

    import peekable from 'it-peekable'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const it = peekable(value)

    const first = it.peek()

    console.info(first) // 0

    it.push(first)

    console.info([...it])
    // [ 0, 1, 2, 3, 4 ]
+
    +

    Async sources must be awaited:

    +
    import peekable from 'it-peekable'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const it = peekable(values())

    const first = await it.peek()

    console.info(first) // 0

    it.push(first)

    console.info(await all(it))
    // [ 0, 1, 2, 3, 4 ]
+
    +

    Install

    $ npm i it-peekable
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItPeekable in the global namespace.

    +
    <script src="https://unpkg.com/it-peekable/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    AsyncPeek +Peek +Push +

    Type Aliases

    AsyncPeekable +Peekable +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_protobuf_stream.html b/modules/it_protobuf_stream.html new file mode 100644 index 00000000..eecf26d6 --- /dev/null +++ b/modules/it_protobuf_stream.html @@ -0,0 +1,35 @@ +it-protobuf-stream | Documentation

    Module it-protobuf-stream

    This module makes it easy to send and receive length-prefixed Protobuf encoded +messages over streams.

    +

    Example

    import { pbStream } from 'it-protobuf-stream'
    import { MessageType } from './src/my-message-type.js'

    // RequestType and ResponseType have been generate from `.proto` files and have
    // `.encode` and `.decode` methods for serialization/deserialization

    const stream = pbStream(duplex)

    // write a message to the stream
    stream.write({
      foo: 'bar'
    }, MessageType)

    // read a message from the stream
    const res = await stream.read(MessageType)
+
    +

    codecov +CI

    +
    +

    Read and write protobuf messages over a duplex stream

    +
    +

    About

    This module makes it easy to send and receive length-prefixed Protobuf encoded +messages over streams.

    +

    Example

    import { pbStream } from 'it-protobuf-stream'
    import { MessageType } from './src/my-message-type.js'

    // RequestType and ResponseType have been generate from `.proto` files and have
    // `.encode` and `.decode` methods for serialization/deserialization

    const stream = pbStream(duplex)

    // write a message to the stream
    stream.write({
      foo: 'bar'
    }, MessageType)

    // read a message from the stream
    const res = await stream.read(MessageType)
+
    +

    Install

    $ npm i it-protobuf-stream
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItProtobufStream in the global namespace.

    +
    <script src="https://unpkg.com/it-protobuf-stream/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    AbortOptions +Decoder +Encoder +MessageStream +ProtobufStream +ProtobufStreamOpts +

    Functions

    pbStream +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_reduce.html b/modules/it_reduce.html new file mode 100644 index 00000000..323ac857 --- /dev/null +++ b/modules/it_reduce.html @@ -0,0 +1,33 @@ +it-reduce | Documentation

    Module it-reduce

    Reduce the values of an (async)iterable to a single value.

    +

    Example

    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)

    console.info(result) // 10
+
    +

    Async sources must be awaited:

    +
    import reduce from 'it-reduce'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const result = await reduce(values(), (acc, curr) => acc + curr, 0)

    console.info(result) // 10
+
    +

    codecov +CI

    +
    +

    Reduces the values yielded from an async iterator

    +
    +

    About

    Reduce the values of an (async)iterable to a single value.

    +

    Example

    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)

    console.info(result) // 10
+
    +

    Async sources must be awaited:

    +
    import reduce from 'it-reduce'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const result = await reduce(values(), (acc, curr) => acc + curr, 0)

    console.info(result) // 10
+
    +

    Install

    $ npm i it-reduce
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItReduce in the global namespace.

    +
    <script src="https://unpkg.com/it-reduce/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_skip.html b/modules/it_skip.html new file mode 100644 index 00000000..ef8463b5 --- /dev/null +++ b/modules/it_skip.html @@ -0,0 +1,33 @@ +it-skip | Documentation

    Module it-skip

    For when you are only interested in later values from an (async)iterable.

    +

    Example

    import take from 'it-skip'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const arr = all(skip(values, 2))

    console.info(arr) // 2, 3, 4
+
    +

    Async sources must be awaited:

    +
    import take from 'it-skip'
    import all from 'it-all'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const arr = await all(skip(values(), 2))

    console.info(arr) // 2, 3, 4
+
    +

    codecov +CI

    +
    +

    Skip items from an iterable

    +
    +

    About

    For when you are only interested in later values from an (async)iterable.

    +

    Example

    import take from 'it-skip'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const arr = all(skip(values, 2))

    console.info(arr) // 2, 3, 4
+
    +

    Async sources must be awaited:

    +
    import take from 'it-skip'
    import all from 'it-all'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const arr = await all(skip(values(), 2))

    console.info(arr) // 2, 3, 4
+
    +

    Install

    $ npm i it-skip
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItSkip in the global namespace.

    +
    <script src="https://unpkg.com/it-skip/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_sort.html b/modules/it_sort.html new file mode 100644 index 00000000..ce0cec89 --- /dev/null +++ b/modules/it_sort.html @@ -0,0 +1,34 @@ +it-sort | Documentation

    Module it-sort

    Consumes all values from an (async)iterable and returns them sorted by the passed sort function.

    +

    Example

    import sort from 'it-sort'
    import all from 'it-all'

    const sorter = (a, b) => {
      return a.localeCompare(b)
    }

    // This can also be an iterator, generator, etc
    const values = ['foo', 'bar']

    const arr = all(sort(values, sorter))

    console.info(arr) // 'bar', 'foo'
+
    +

    Async sources must be awaited:

    +
    import sort from 'it-sort'
    import all from 'it-all'

    const sorter = (a, b) => {
      return a.localeCompare(b)
    }

    const values = async function * () {
      yield * ['foo', 'bar']
    }

    const arr = await all(sort(values, sorter))

    console.info(arr) // 'bar', 'foo'
+
    +

    codecov +CI

    +
    +

    Collects all values from an async iterator, sorts them using the passed function and yields them

    +
    +

    About

    Consumes all values from an (async)iterable and returns them sorted by the passed sort function.

    +

    Example

    import sort from 'it-sort'
    import all from 'it-all'

    const sorter = (a, b) => {
      return a.localeCompare(b)
    }

    // This can also be an iterator, generator, etc
    const values = ['foo', 'bar']

    const arr = all(sort(values, sorter))

    console.info(arr) // 'bar', 'foo'
+
    +

    Async sources must be awaited:

    +
    import sort from 'it-sort'
    import all from 'it-all'

    const sorter = (a, b) => {
      return a.localeCompare(b)
    }

    const values = async function * () {
      yield * ['foo', 'bar']
    }

    const arr = await all(sort(values, sorter))

    console.info(arr) // 'bar', 'foo'
+
    +

    Install

    $ npm i it-sort
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItSort in the global namespace.

    +
    <script src="https://unpkg.com/it-sort/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    CompareFunction +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_split.html b/modules/it_split.html new file mode 100644 index 00000000..6c2972f6 --- /dev/null +++ b/modules/it_split.html @@ -0,0 +1,40 @@ +it-split | Documentation

    Module it-split

    Searches Uint8Arrays emitted by an (async)iterable for a delimiter and yields chunks split by that delimiter.

    +

    Example

    import split from 'it-split'

    const encoder = new TextEncoder()

    // This can also be an iterator, generator, etc
    const values = [
      encoder.encode('hello\nwor'),
      encoder.encode('ld')
    ]

    const arr = all(split(values))

    console.info(arr) // [encoder.encode('hello'), encoder.encode('world')]
+
    +

    You can also split by arbitrary delimiters:

    +
    const values = [
      Uint8Array.from([0, 1, 2, 3]),
      Uint8Array.from([0, 1, 2, 3]),
      Uint8Array.from([1, 1, 2])
    ]
    const delimiter = Uint8Array.from([1, 2])

    const arr = all(split(values, {
      delimiter
    }))

    console.info(arr) // [ Buffer.from([0]), Buffer.from([3, 0]), Buffer.from([3, 1]) ]
+
    +

    Async sources must be awaited:

    +
    import split from 'it-split'

    const encoder = new TextEncoder()

    const values = async function * () {
      yield * [
        encoder.encode('hello\nwor'),
        encoder.encode('ld')
      ]
    }

    const arr = await all(split(values()))

    console.info(arr) // [encoder.encode('hello'), encoder.encode('world')]
+
    +

    codecov +CI

    +
    +

    Splits Uint8Arrays emitted by an (async) iterable by a delimiter

    +
    +

    About

    Searches Uint8Arrays emitted by an (async)iterable for a delimiter and yields chunks split by that delimiter.

    +

    Example

    import split from 'it-split'

    const encoder = new TextEncoder()

    // This can also be an iterator, generator, etc
    const values = [
      encoder.encode('hello\nwor'),
      encoder.encode('ld')
    ]

    const arr = all(split(values))

    console.info(arr) // [encoder.encode('hello'), encoder.encode('world')]
+
    +

    You can also split by arbitrary delimiters:

    +
    const values = [
      Uint8Array.from([0, 1, 2, 3]),
      Uint8Array.from([0, 1, 2, 3]),
      Uint8Array.from([1, 1, 2])
    ]
    const delimiter = Uint8Array.from([1, 2])

    const arr = all(split(values, {
      delimiter
    }))

    console.info(arr) // [ Buffer.from([0]), Buffer.from([3, 0]), Buffer.from([3, 1]) ]
+
    +

    Async sources must be awaited:

    +
    import split from 'it-split'

    const encoder = new TextEncoder()

    const values = async function * () {
      yield * [
        encoder.encode('hello\nwor'),
        encoder.encode('ld')
      ]
    }

    const arr = await all(split(values()))

    console.info(arr) // [encoder.encode('hello'), encoder.encode('world')]
+
    +

    Install

    $ npm i it-split
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItSplit in the global namespace.

    +
    <script src="https://unpkg.com/it-split/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Interfaces

    SplitOptions +

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_take.html b/modules/it_take.html new file mode 100644 index 00000000..fd214ae2 --- /dev/null +++ b/modules/it_take.html @@ -0,0 +1,33 @@ +it-take | Documentation

    Module it-take

    For when you only want a few values out of an (async)iterable.

    +

    Example

    import take from 'it-take'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const arr = all(take(values, 2))

    console.info(arr) // 0, 1
+
    +

    Async sources must be awaited:

    +
    import take from 'it-take'
    import all from 'it-all'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const arr = await all(take(values(), 2))

    console.info(arr) // 0, 1
+
    +

    codecov +CI

    +
    +

    Stop iteration after n items have been received

    +
    +

    About

    For when you only want a few values out of an (async)iterable.

    +

    Example

    import take from 'it-take'
    import all from 'it-all'

    // This can also be an iterator, generator, etc
    const values = [0, 1, 2, 3, 4]

    const arr = all(take(values, 2))

    console.info(arr) // 0, 1
+
    +

    Async sources must be awaited:

    +
    import take from 'it-take'
    import all from 'it-all'

    const values = async function * () {
      yield * [0, 1, 2, 3, 4]
    }

    const arr = await all(take(values(), 2))

    console.info(arr) // 0, 1
+
    +

    Install

    $ npm i it-take
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItTake in the global namespace.

    +
    <script src="https://unpkg.com/it-take/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_to_browser_readablestream.html b/modules/it_to_browser_readablestream.html new file mode 100644 index 00000000..26ae9153 --- /dev/null +++ b/modules/it_to_browser_readablestream.html @@ -0,0 +1,27 @@ +it-to-browser-readablestream | Documentation

    Module it-to-browser-readablestream

    Turns an (async)iterable into a W3C ReadbleStream.

    +

    Example

    import toBrowserReadableStream from 'it-to-browser-readablestream'

    // This can also be an iterator, async iterator, generator, etc
    const values = [Buffer.from([0, 1]), Buffer.from([2, 3])]

    const stream = await toBrowserReadableStream(values)

    for await (const buf of stream) {
      console.info(buf) // Buffer[0, 1]
    }
+
    +

    codecov +CI

    +
    +

    Takes an async iterator and turns it into a browser readable stream

    +
    +

    About

    Turns an (async)iterable into a W3C ReadbleStream.

    +

    Example

    import toBrowserReadableStream from 'it-to-browser-readablestream'

    // This can also be an iterator, async iterator, generator, etc
    const values = [Buffer.from([0, 1]), Buffer.from([2, 3])]

    const stream = await toBrowserReadableStream(values)

    for await (const buf of stream) {
      console.info(buf) // Buffer[0, 1]
    }
+
    +

    Install

    $ npm i it-to-browser-readablestream
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItToBrowserReadablestream in the global namespace.

    +
    <script src="https://unpkg.com/it-to-browser-readablestream/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/it_to_buffer.html b/modules/it_to_buffer.html new file mode 100644 index 00000000..0408b647 --- /dev/null +++ b/modules/it_to_buffer.html @@ -0,0 +1,33 @@ +it-to-buffer | Documentation

    Module it-to-buffer

    Collects all Uint8Array values from an (async)iterable and returns them as a single Uint8Array.

    +

    Example

    import toBuffer from 'it-to-buffer'

    // This can also be an iterator, generator, etc
    const values = [Buffer.from([0, 1]), Buffer.from([2, 3])]

    const result = toBuffer(values)

    console.info(result) // Buffer[0, 1, 2, 3]
+
    +

    Async sources must be awaited:

    +
    import toBuffer from 'it-to-buffer'

    const values = async function * () {
      yield Buffer.from([0, 1])
      yield Buffer.from([2, 3])
    }

    const result = await toBuffer(values())

    console.info(result) // Buffer[0, 1, 2, 3]
+
    +

    codecov +CI

    +
    +

    Takes an async iterator that yields buffers and concatenates them all together

    +
    +

    About

    Collects all Uint8Array values from an (async)iterable and returns them as a single Uint8Array.

    +

    Example

    import toBuffer from 'it-to-buffer'

    // This can also be an iterator, generator, etc
    const values = [Buffer.from([0, 1]), Buffer.from([2, 3])]

    const result = toBuffer(values)

    console.info(result) // Buffer[0, 1, 2, 3]
+
    +

    Async sources must be awaited:

    +
    import toBuffer from 'it-to-buffer'

    const values = async function * () {
      yield Buffer.from([0, 1])
      yield Buffer.from([2, 3])
    }

    const result = await toBuffer(values())

    console.info(result) // Buffer[0, 1, 2, 3]
+
    +

    Install

    $ npm i it-to-buffer
+
    +

    Browser <script> tag

    Loading this module through a script tag will make it's exports available as ItToBuffer in the global namespace.

    +
    <script src="https://unpkg.com/it-to-buffer/dist/index.min.js"></script>
+
    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribution

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    Index

    Functions

    default +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/it_peekable.AsyncPeekable.html b/types/it_peekable.AsyncPeekable.html new file mode 100644 index 00000000..b86c19fe --- /dev/null +++ b/types/it_peekable.AsyncPeekable.html @@ -0,0 +1 @@ +AsyncPeekable | Documentation

    Type alias AsyncPeekable<T>

    AsyncPeekable<T>: AsyncIterable<T> & AsyncPeek<T> & Push<T> & AsyncIterator<T>

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/it_peekable.Peekable.html b/types/it_peekable.Peekable.html new file mode 100644 index 00000000..0853ffd7 --- /dev/null +++ b/types/it_peekable.Peekable.html @@ -0,0 +1 @@ +Peekable | Documentation

    Type alias Peekable<T>

    Peekable<T>: Iterable<T> & Peek<T> & Push<T> & Iterator<T>

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file