mirror of
https://github.com/flynx/stoppable.js.git
synced 2025-10-28 18:30:09 +00:00
started work on docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
7223251ca6
commit
21a343b5d2
45
README.md
45
README.md
@ -1,2 +1,47 @@
|
|||||||
# stoppable.js
|
# stoppable.js
|
||||||
Utility library implementing tooling to make stoppable functions...
|
Utility library implementing tooling to make stoppable functions...
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ npm install --save ig-stoppable
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var stoppable = require('ig-stoppable')
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var func = stoppable(function(){
|
||||||
|
// ...
|
||||||
|
|
||||||
|
throw stoppable.STOP('something')
|
||||||
|
|
||||||
|
// ...
|
||||||
|
})
|
||||||
|
|
||||||
|
var value = func() // -> 'something'
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var gen = stoppable(function*(){
|
||||||
|
// ...
|
||||||
|
|
||||||
|
throw stoppable.STOP('something')
|
||||||
|
|
||||||
|
// ...
|
||||||
|
})
|
||||||
|
|
||||||
|
var value = [...gen()] // -> ['somthing']
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var agen = stoppable(async function*(){
|
||||||
|
// ...
|
||||||
|
|
||||||
|
throw stoppable.STOP('something')
|
||||||
|
|
||||||
|
// ...
|
||||||
|
})
|
||||||
|
|
||||||
|
var value = awat agen() // -> ['something']
|
||||||
|
```
|
||||||
Loading…
x
Reference in New Issue
Block a user