it-reduce
Version:
Reduces the values yielded from an async iterator
82 lines (49 loc) • 2.31 kB
Markdown
//img.shields.io/codecov/c/github/achingbrain/it.svg?style=flat-square)](https://codecov.io/gh/achingbrain/it)
[](https://github.com/achingbrain/it/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
> Reduces the values yielded from an async iterator
<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->
Reduce the values of an (async)iterable to a single value.
## Example
```javascript
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, index) => acc + curr, 0)
console.info(result) // 10
```
Async sources must be awaited:
```javascript
import reduce from 'it-reduce'
const values = async function * () {
yield * [0, 1, 2, 3, 4]
}
const result = await reduce(values(), (acc, curr, index) => acc + curr, 0)
console.info(result) // 10
```
```console
$ npm i it-reduce
```
Loading this module through a script tag will make its exports available as `ItReduce` in the global namespace.
```html
<script src="https://unpkg.com/it-reduce/dist/index.min.js"></script>
```
- <https://achingbrain.github.io/it/modules/it_reduce.html>
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](https://github.com/achingbrain/it/blob/main/packages/it-reduce/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/achingbrain/it/blob/main/packages/it-reduce/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
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.
[![codecov](https: