@jesscss/awaitable-pipe 2.0.0-alpha.7 → 2.0.0-alpha.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
|
-
# awaitable-pipe
|
|
1
|
+
# @jesscss/awaitable-pipe
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A tiny, strongly-typed pipe that stays synchronous until a step returns a Promise — with one optional error handler.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
It’s a small utility from the [Jess](https://github.com/jesscss/jess) project,
|
|
6
|
+
where hot paths call functions that are usually — but not always —
|
|
7
|
+
synchronous. It’s zero-dependency and usable on its own: it stays sync when
|
|
8
|
+
everything is sync, and turns into a Promise only when something is async. No
|
|
9
|
+
wrappers, no ceremony.
|
|
6
10
|
|
|
7
11
|
- **Stays sync when it can**: all-sync pipelines return a plain value
|
|
8
12
|
- **Goes async when it must**: any async input/step returns a Promise
|
|
@@ -12,12 +16,12 @@ A tiny, zero-dependency pipe with friendly types that “just works”: it stays
|
|
|
12
16
|
|
|
13
17
|
## Install
|
|
14
18
|
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
# or
|
|
18
|
-
npm i @jesscss/awaitable-pipe
|
|
19
|
+
```sh
|
|
20
|
+
npm install @jesscss/awaitable-pipe
|
|
19
21
|
```
|
|
20
22
|
|
|
23
|
+
Published to npm under both the `latest` and `alpha` dist-tags.
|
|
24
|
+
|
|
21
25
|
## Quick Start
|
|
22
26
|
|
|
23
27
|
```ts
|
|
@@ -181,5 +185,16 @@ const sum = await serialReduce(items, 0, async (acc, n, i) => {
|
|
|
181
185
|
// sum === 6
|
|
182
186
|
```
|
|
183
187
|
|
|
188
|
+
## Status
|
|
189
|
+
|
|
190
|
+
Alpha, as part of the Jess monorepo. Please
|
|
191
|
+
[report issues](https://github.com/jesscss/jess/issues).
|
|
192
|
+
|
|
193
|
+
## Links
|
|
194
|
+
|
|
195
|
+
- Repository: <https://github.com/jesscss/jess>
|
|
196
|
+
- Documentation: <https://jesscss.github.io/> (currently pre-alpha content)
|
|
197
|
+
|
|
184
198
|
## License
|
|
185
|
-
|
|
199
|
+
|
|
200
|
+
[MIT](https://github.com/jesscss/jess/blob/dev/LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jesscss/awaitable-pipe",
|
|
3
|
-
"version": "2.0.0-alpha.
|
|
3
|
+
"version": "2.0.0-alpha.9",
|
|
4
4
|
"description": "A tiny, strongly-typed pipe that stays sync when possible and becomes a Promise when needed. With an optional single-point error handler.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "lib/index.cjs",
|