docs: README per PACKAGE_GUIDELINES — fix H1 to scope, remove License/MIT sections, rename Description to Why, update Node 18→22, fix fictitious peer imports
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
# push-take-until
|
# @push-stream-std/push-take-until
|
||||||
|
|
||||||
Take values from a source stream until a signal stream emits or ends.
|
Take values from a source stream until a signal stream emits or ends.
|
||||||
|
|
||||||
@@ -28,8 +28,7 @@ npm config set -- //hub.kl1.tenere.ai/api/packages/push-stream-std/npm/:_authTok
|
|||||||
npm install @push-stream-std/push-take-until
|
npm install @push-stream-std/push-take-until
|
||||||
```
|
```
|
||||||
|
|
||||||
## Description
|
## Why
|
||||||
|
|
||||||
A push-stream through that passes through values from the source until the provided signal stream ends. When the signal stream ends (either normally or via abort), the take-until stream immediately ends the upstream source and downstream sink, closing the pipeline. This is useful for implementing cancellation patterns — for example, taking values from an event stream until a "stop" button is clicked.
|
A push-stream through that passes through values from the source until the provided signal stream ends. When the signal stream ends (either normally or via abort), the take-until stream immediately ends the upstream source and downstream sink, closing the pipeline. This is useful for implementing cancellation patterns — for example, taking values from an event stream until a "stop" button is clicked.
|
||||||
|
|
||||||
## API
|
## API
|
||||||
@@ -51,8 +50,5 @@ Tests cover passthrough before signal ends, stopping after signal end, normal en
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
Node.js 18 or later. ESM only.
|
Node.js 22 or later. ESM only.
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT
|
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@push-stream-std/push-take-until",
|
"name": "@push-stream-std/push-take-until",
|
||||||
"version": "0.0.7",
|
"version": "0.0.8",
|
||||||
"description": "Take elements until signal stream emits",
|
"description": "Take elements until signal stream emits",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
|
|||||||
Reference in New Issue
Block a user