Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d4nyll/resolve-when
Returns a promise that resolves once condition is met
https://github.com/d4nyll/resolve-when
javascript nodejs promise
Last synced: about 4 hours ago
JSON representation
Returns a promise that resolves once condition is met
- Host: GitHub
- URL: https://github.com/d4nyll/resolve-when
- Owner: d4nyll
- License: mit
- Created: 2018-09-11T22:00:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T04:30:15.000Z (almost 2 years ago)
- Last Synced: 2024-09-14T22:05:46.655Z (2 months ago)
- Topics: javascript, nodejs, promise
- Language: JavaScript
- Size: 504 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# resolve-when
[](https://travis-ci.org/d4nyll/resolve-when)
[](https://snyk.io/test/github/d4nyll/resolve-when?targetFile=package.json)
[](https://www.codefactor.io/repository/github/d4nyll/resolve-when)
[](https://www.codacy.com/app/d4nyll/resolve-when?utm_source=github.com&utm_medium=referral&utm_content=d4nyll/resolve-when&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/d4nyll/resolve-when/maintainability)
[](https://codeclimate.com/github/d4nyll/resolve-when/test_coverage)
[](http://inch-ci.org/github/d4nyll/resolve-when)
[](https://greenkeeper.io/)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fd4nyll%2Fresolve-when?ref=badge_shield)
Returns a promise that resolves once condition is met
## Installation
[](https://nodei.co/npm/resolve-when/)
`resolve-when` is published at [npmjs.com](https://www.npmjs.com/), and can be installed using [`npm`](https://docs.npmjs.com/cli/npm) or [`yarn`](https://yarnpkg.com/lang/en/).
```bash
$ npm install resolve-when # npm
$ yarn add resolve-when # yarn
```
```js
import resolveWhen from 'resolve-when'; // ES6+
const resolveWhen = require('resolve-when'); // ES5
```
## Usage
`resolveWhen` is a function with the following signature:
```
resolveWhen(condition, options)
```
* `condition` _Function_ - a function that will be evaluated to determine when `resolveWhen` should resolve. It is not passed any parameters. Defaults to a function that always resolves to `true`
* `options` _Object_
* `max` _Integer_ - Maximum number of times that `condition` should be ran. If `max` is undefined, `0`, a negative number, or `Infinity`, it will iterate forever. Defaults to `undefined`
* `interval` _Integer_ - Number of milliseconds to wait before running `condition` again. Defaults to `50`
### Defaults properties
`resolveWhen.defaults` is a read-only property containing the default `options` object used.
### Return Values
If `condition` returns true, `resolveWhen` will resolve without any value.
If the maximum number of iterations has been reached and `condition` has not returned `true`, `resolveWhen` will reject with ``Error(`Maximum iterations (${max}) exceeded`)``, where `max` is the same as `options.max`
## Contributing
```bash
$ git clone [email protected]:d4nyll/resolve-when.git
$ yarn
$ yarn run test
```
### Tests
Tests are written in [Mocha](https://mochajs.org/) with the [`assert`](https://nodejs.org/api/assert.html) module. We are also using [`lolex`](https://github.com/sinonjs/lolex) as a fake timer to ensure our unit tests run as quick as possible.
### Code Quality
We have used [`husky`](https://github.com/typicode/husky) to help you ensure:
* Your code is linted
* All tests pass
* Coverage is at 100%
Any PRs which does not pass the linter, tests or coverage tools will be rejected.
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fd4nyll%2Fresolve-when?ref=badge_large)