@rgrannell/promise v9.4.0

promise (v9.3.0)

Stability

0 - Experimental

Utilities for working with promises

Table of Contents

• stall
  • Parameters
• promise.timeout
  • Parameters
• promise.waitUntil
  • Parameters
• promise.sequence
  • Parameters

API Documentation

stall

Wait for a set time-period before resolving

Parameters

• fn
• duration (optional, default 0)
• the function function to call post stall
• the number timeout in milliseconds

Returns promise

promise.timeout

Trello API wrapper

Parameters

• the error error to throw
• the number timeout in milliseconds

Returns promise

promise.waitUntil

Wait until a sync or async function resolves.

Parameters

• fn function a sync or async function.
• interval number the polling interval.

Returns promise

promise.sequence

Run a series of asyncronous nullary functions sequentially

Parameters

• tasks Array<function> a list of functions to run

Returns Promise<Array<any>> an array of values

Dependencies

• Node.js >= v10.6.0
• NPM >= v10.6.0

License

Copyright (c) 2020 Róisín Grannell

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.