https://github.com/indutny/promise-waitlist

Promise-based Wait List for your apps
https://github.com/indutny/promise-waitlist

Last synced: 3 days ago
JSON representation

Promise-based Wait List for your apps

• Host: GitHub
• URL: https://github.com/indutny/promise-waitlist
• Owner: indutny
• Created: 2019-08-16T21:35:37.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T18:26:08.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T22:54:39.749Z (6 months ago)
• Language: JavaScript
• Size: 128 KB
• Stars: 31
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# promise-waitlist

[![Build Status](https://travis-ci.org/indutny/promise-waitlist.svg?branch=master)](http://travis-ci.org/indutny/promise-waitlist)

Promise-based Wait List for your apps.

## Usage

```js

import WaitList from 'promise-waitlist';

const waitList = new WaitList();

const entry = waitList.waitFor('event');

setTimeout(() => {

  waitList.resolve('event', value); // returns `true` if promise was resolved

}, 1000);

console.log(await entry);  // 42

```

Entries can be cancelled as well:

```js

entry.cancel(/* optional error here */);

```

Wait time could be limited by supplying timeout argument (in milliseconds):

```js

waitList.waitFor('event', 5000);

```

Or, if you wish to pass resolved entry:

```js

const entry = WaitList.resolve(42);

```

In the end whole `WaitList` may be closed, effectively canceling all pending

waits:

```js

waitList.close(/* optional error here*/);

```

## LICENSE

This software is licensed under the MIT License.

Copyright Fedor Indutny, 2019.

Permission is hereby granted, free of charge, to any person obtaining a

copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to permit

persons to whom the Software is furnished to do so, subject to the

following conditions:

The above copyright notice and this permission notice shall be included

in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN

NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,

DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR

OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE

USE OR OTHER DEALINGS IN THE SOFTWARE.