@thi.ng/transducers-async
Version:
Async versions of various highly composable transducers, reducers and iterators
168 lines (122 loc) • 8.07 kB
Markdown
<!-- This file is generated - DO NOT EDIT! -->
<!-- Please see: https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files -->
# 
[](https://www.npmjs.com/package/@thi.ng/transducers-async)
[](https://mastodon.thi.ng/@toxi)
> [!NOTE]
> This is one of 212 standalone projects, maintained as part
> of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
> and anti-framework.
>
> 🚀 Please help me to work full-time on these projects by [sponsoring me on
> GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️
- [About](#about)
- [Evaluators](#evaluators)
- [Generators & iterators](#generators--iterators)
- [Combinators](#combinators)
- [Transducers](#transducers)
- [Reducers](#reducers)
- [Status](#status)
- [Related packages](#related-packages)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [Usage examples](#usage-examples)
- [API](#api)
- [Authors](#authors)
- [License](#license)
## About
Async versions of various highly composable transducers, reducers and iterators. This is a support package for [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers).
### Evaluators
- [`iterator()`](https://docs.thi.ng/umbrella/transducers-async/functions/iterator.html)
- [`reduce()`](https://docs.thi.ng/umbrella/transducers-async/functions/reduce.html)
- [`run()`](https://docs.thi.ng/umbrella/transducers-async/functions/run.html)
- [`step()`](https://docs.thi.ng/umbrella/transducers-async/functions/step.html)
- [`transduce()`](https://docs.thi.ng/umbrella/transducers-async/functions/transduce.html)
### Generators & iterators
- [`asAsyncIterable()`](https://docs.thi.ng/umbrella/transducers-async/functions/asAsyncIterable.html)
- [`concat()`](https://docs.thi.ng/umbrella/transducers-async/functions/concat.html)
- [`events()`](https://docs.thi.ng/umbrella/transducers-async/functions/events.html)
- [`raf()`](https://docs.thi.ng/umbrella/transducers-async/functions/raf.html)
- [`range()`](https://docs.thi.ng/umbrella/transducers-async/functions/range.html)
- [`repeatedly()`](https://docs.thi.ng/umbrella/transducers-async/functions/repeatedly.html)
- [`sidechain()`](https://docs.thi.ng/umbrella/transducers-async/functions/sidechain.html)
- [`source()`](https://docs.thi.ng/umbrella/transducers-async/functions/source.html)
- [`zip()`](https://docs.thi.ng/umbrella/transducers-async/functions/zip.html)
### Combinators
- [`merge()`](https://docs.thi.ng/umbrella/transducers-async/functions/merge.html)
- [`mult()`](https://docs.thi.ng/umbrella/transducers-async/functions/mult.html)
- [`pubsub()`](https://docs.thi.ng/umbrella/transducers-async/functions/pubsub.html)
- [`sync()`](https://docs.thi.ng/umbrella/transducers-async/functions/sync.html)
- [`syncRAF()`](https://docs.thi.ng/umbrella/transducers-async/functions/syncRAF.html)
### Transducers
- [`comp()`](https://docs.thi.ng/umbrella/transducers-async/functions/comp.html)
- [`filter()`](https://docs.thi.ng/umbrella/transducers-async/functions/filter.html)
- [`map()`](https://docs.thi.ng/umbrella/transducers-async/functions/map.html)
- [`mapcat()`](https://docs.thi.ng/umbrella/transducers-async/functions/mapcat.html)
- [`multiplex()`](https://docs.thi.ng/umbrella/transducers-async/functions/multiplex.html)
- [`multiplexObj()`](https://docs.thi.ng/umbrella/transducers-async/functions/multiplexObj.html)
- [`partition()`](https://docs.thi.ng/umbrella/transducers-async/functions/partition.html)
- [`take()`](https://docs.thi.ng/umbrella/transducers-async/functions/take.html)
- [`throttle()`](https://docs.thi.ng/umbrella/transducers-async/functions/throttle.html)
- [`throttleTime()`](https://docs.thi.ng/umbrella/transducers-async/functions/throttleTime.html)
### Reducers
- [`push()`](https://docs.thi.ng/umbrella/transducers-async/functions/push.html)
## Status
**ALPHA** - bleeding edge / work-in-progress
[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Btransducers-async%5D+in%3Atitle)
## Related packages
- [@thi.ng/csp](https://github.com/thi-ng/umbrella/tree/develop/packages/csp) - Primitives & operators for Communicating Sequential Processes based on async/await and async iterables
- [@thi.ng/fibers](https://github.com/thi-ng/umbrella/tree/develop/packages/fibers) - Process hierarchies & operators for cooperative multitasking
- [@thi.ng/rstream](https://github.com/thi-ng/umbrella/tree/develop/packages/rstream) - Reactive streams & subscription primitives for constructing dataflow graphs / pipelines
## Installation
```bash
yarn add @thi.ng/transducers-async
```
ESM import:
```ts
import * as txa from "@thi.ng/transducers-async";
```
Browser ESM import:
```html
<script type="module" src="https://esm.run/@thi.ng/transducers-async"></script>
```
[JSDelivr documentation](https://www.jsdelivr.com/)
For Node.js REPL:
```js
const txa = await import("@thi.ng/transducers-async");
```
Package sizes (brotli'd, pre-treeshake): ESM: 3.25 KB
## Dependencies
- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
- [@thi.ng/buffers](https://github.com/thi-ng/umbrella/tree/develop/packages/buffers)
- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
- [@thi.ng/compose](https://github.com/thi-ng/umbrella/tree/develop/packages/compose)
- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
- [@thi.ng/timestamp](https://github.com/thi-ng/umbrella/tree/develop/packages/timestamp)
- [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers)
Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)
## Usage examples
Two projects in this repo's
[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
directory are using this package:
| Screenshot | Description | Live demo | Source |
|:---------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------|:-------------------------------------------------|:------------------------------------------------------------------------------|
| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/csp-bus.png" width="240"/> | CSP channel-based event handling, async transducers & reactive UI components | [Demo](https://demo.thi.ng/umbrella/csp-bus/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/csp-bus) |
| | Basic & barebones usage of async iterables in thi.ng/rdom | [Demo](https://demo.thi.ng/umbrella/rdom-async/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/rdom-async) |
## API
[Generated API docs](https://docs.thi.ng/umbrella/transducers-async/)
TODO
## Authors
- [Karsten Schmidt](https://thi.ng)
If this project contributes to an academic publication, please cite it as:
```bibtex
@misc{thing-transducers-async,
title = "@thi.ng/transducers-async",
author = "Karsten Schmidt",
note = "https://thi.ng/transducers-async",
year = 2018
}
```
## License
© 2018 - 2025 Karsten Schmidt // Apache License 2.0