flynx/stoppable.js
1
0
Fork 0
mirror of https://github.com/flynx/stoppable.js.git synced 2025-10-28 18:30:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2022-07-09 11:21:20 +03:00
parent 3afd4a01bc
commit cf15e7c628
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -56,7 +56,7 @@ stoppable(<async-generator>)
### `stoppable.STOP / stoppable.STOP(..)` ### `stoppable.STOP / stoppable.STOP(..)`
A special object/constructor that can be either returned/thrown _as-is_ or A special object/constructor that can either be returned/thrown _as-is_ or
used to create an _instance_ to be returned thrown. used to create an _instance_ to be returned thrown.
```bnf ```bnf
@ -67,8 +67,9 @@ stoppable.STOP(<value>)
-> <stop-object> -> <stop-object>
``` ```
This will get intercepted by `stoppable(..)` and appropriately handled merging This will get intercepted by `stoppable(..)` and appropriately handled, stopping
it into the return/yield value and stopping the function/iterator. the function iterator and merging the value into the yields of a generator or
returning it from a function depending on the wrapper type.
`<stop-object>` can contain a value that will get handled by `stoppable(..)` (default: `undefined`). `<stop-object>` can contain a value that will get handled by `stoppable(..)` (default: `undefined`).