stoppable.js/README.md
Alex A. Naanou 21a343b5d2 started work on docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
2022-07-06 00:23:18 +03:00

47 lines
674 B
Markdown

# stoppable.js
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']
```