https://github.com/busterc/promise-until

:loop: Calls a function repeatedly if a condition returns false and until the condition returns true and then resolves the promise
https://github.com/busterc/promise-until

es6-promise flow-control promise promise-library promise-modules promises

Last synced: about 2 months ago
JSON representation

:loop: Calls a function repeatedly if a condition returns false and until the condition returns true and then resolves the promise

• Host: GitHub
• URL: https://github.com/busterc/promise-until
• Owner: busterc
• License: isc
• Created: 2015-11-25T22:11:04.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-08-25T21:45:17.000Z (over 6 years ago)
• Last Synced: 2024-11-30T03:16:16.737Z (2 months ago)
• Topics: es6-promise, flow-control, promise, promise-library, promise-modules, promises
• Language: JavaScript
• Homepage:
• Size: 5.86 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# promise-until [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

> Calls a function repeatedly if a condition returns false and until the condition returns true and then resolves the promise

- See Also

  - [promise-do-until](https://github.com/busterc/promise-do-until)

  - [promise-whilst](https://github.com/sindresorhus/promise-whilst)

  - [promise-do-whilst](https://github.com/busterc/promise-do-whilst)

## Installation

```sh

$ npm install --save promise-until

```

## Usage

```js

import promiseUntil from 'promise-until';

let count = 0;

promiseUntil(() => {

  return count === 5;

}, () => {

  count++;

}).then(() => {

  console.log(count);

  // => 5

});

// ...

let max = 0;

promiseUntil(() => {

  return max === 0;

}, () => {

  max++;

}).then(() => {

  console.log(max);

  // => 0

});

```

## API

### promiseUntil(condition, action)

Executes `action` repeatedly if `condition` returns `false` and until `condition` returns `true` and then resolves the promise. Rejects if `action` returns a promise that rejects or if an error is thrown anywhere.

#### condition

Type: `function`

Should return a boolean of whether to continue.

#### action

Type: `function`

Action to run for each iteration.

You can return a promise and it will be handled.

## License

ISC © [Buster Collings]()

[npm-image]: https://badge.fury.io/js/promise-until.svg

[npm-url]: https://npmjs.org/package/promise-until

[travis-image]: https://travis-ci.org/busterc/promise-until.svg?branch=master

[travis-url]: https://travis-ci.org/busterc/promise-until

[daviddm-image]: https://david-dm.org/busterc/promise-until.svg?theme=shields.io

[daviddm-url]: https://david-dm.org/busterc/promise-until