forked from public/fvtt-cthulhu-eternal
Initial import with skill sheet working
This commit is contained in:
100
node_modules/async-settle/README.md
generated
vendored
Normal file
100
node_modules/async-settle/README.md
generated
vendored
Normal file
@@ -0,0 +1,100 @@
|
||||
<p align="center">
|
||||
<a href="https://gulpjs.com">
|
||||
<img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
# async-settle
|
||||
|
||||
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coveralls Status][coveralls-image]][coveralls-url]
|
||||
|
||||
Settle an async function. It will always complete successfully with an object of the resulting state.
|
||||
|
||||
Handles completion and errors for callbacks, promises, observables and streams.
|
||||
|
||||
Will run call the function on `nextTick`. This will cause all functions to be async.
|
||||
|
||||
## Usage
|
||||
|
||||
### Successful completion
|
||||
|
||||
```js
|
||||
var asyncSettle = require('async-settle');
|
||||
|
||||
asyncSettle(
|
||||
function (done) {
|
||||
// do async things
|
||||
done(null, 2);
|
||||
},
|
||||
function (error, result) {
|
||||
// `error` will ALWAYS be null on execution of the first function.
|
||||
// `result` will ALWAYS be a settled object with the result or error of the first function.
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
### Failed completion
|
||||
|
||||
```js
|
||||
var asyncSettle = require('async-settle');
|
||||
|
||||
asyncSettle(
|
||||
function (done) {
|
||||
// do async things
|
||||
done(new Error('Some Error Occurred'));
|
||||
},
|
||||
function (error, result) {
|
||||
// `error` will ALWAYS be null on execution of the first function.
|
||||
// `result` will ALWAYS be a settled object with the result or error of the first function.
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### `asyncSettle(fn, callback)`
|
||||
|
||||
Takes a function to execute (`fn`) and a function to call on completion (`callback`).
|
||||
|
||||
#### `fn([done])`
|
||||
|
||||
Optionally takes a callback (`done`) to call when async tasks are complete.
|
||||
|
||||
Executed in the context of [`async-done`][async-done], with all errors and results being settled.
|
||||
|
||||
Completion is handled by [`async-done` completion and error resolution][completions].
|
||||
|
||||
#### `callback(error, result)`
|
||||
|
||||
Called on completion of `fn` and recieves a settled object as the `result` argument.
|
||||
|
||||
The `error` argument will always be `null`.
|
||||
|
||||
#### Settled Object
|
||||
|
||||
Settled values have two properties, `state` and `value`.
|
||||
|
||||
`state` has two possible options `'error'` and `'success'`.
|
||||
|
||||
`value` will be the value passed to original callback.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[downloads-image]: https://img.shields.io/npm/dm/async-settle.svg?style=flat-square
|
||||
[npm-url]: https://www.npmjs.com/package/async-settle
|
||||
[npm-image]: https://img.shields.io/npm/v/async-settle.svg?style=flat-square
|
||||
|
||||
[ci-url]: https://github.com/gulpjs/async-settle/actions?query=workflow:dev
|
||||
[ci-image]: https://img.shields.io/github/workflow/status/gulpjs/async-settle/dev?style=flat-square
|
||||
|
||||
[coveralls-url]: https://coveralls.io/r/gulpjs/async-settle
|
||||
[coveralls-image]: https://img.shields.io/coveralls/gulpjs/async-settle/master.svg?style=flat-square
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[async-done]: https://github.com/gulpjs/async-done
|
||||
[completions]: https://github.com/gulpjs/async-done#completion-and-error-resolution
|
||||
<!-- prettier-ignore-end -->
|
||||
Reference in New Issue
Block a user