open-index/open-npm huggingface dataset:
npm package: @rgrannell/promise
Description: Utilities for working with promises
Latest version: 9.4.0


# promise (v9.3.0)

## Stability

> 0 - Experimental

Utilities for working with promises



## Table of Contents

- [stall](#stall)
  * [Parameters](#parameters)
- [promise.timeout](#promisetimeout)
  * [Parameters](#parameters-1)
- [promise.waitUntil](#promisewaituntil)
  * [Parameters](#parameters-2)
- [promise.sequence](#promisesequence)
  * [Parameters](#parameters-3)

## API Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## stall

Wait for a set time-period before resolving

### Parameters

-   `fn`  
-   `duration`   (optional, default `0`)
-   `the` **[function][1]** function to call post stall
-   `the` **[number][2]** timeout in milliseconds

Returns **[promise][3]** 

## promise.timeout

Trello API wrapper

### Parameters

-   `the` **[error][4]** error to throw
-   `the` **[number][2]** timeout in milliseconds

Returns **[promise][3]** 

## promise.waitUntil

Wait until a sync or async function resolves.

### Parameters

-   `fn` **[function][1]** a sync or async function.
-   `interval` **[number][2]** the polling interval.

Returns **[promise][3]** 

## promise.sequence

Run a series of asyncronous nullary functions sequentially

### Parameters

-   `tasks` **[Array][5]&lt;[function][1]>** a list of functions to run

Returns **[Promise][3]&lt;[Array][5]&lt;any>>** an array of values

[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function

[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise

[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error

[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array


## 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.
npm package: @rgrannell/readme
Description: A tool for generating readme's
Latest version: 9.4.0


# readme (v9.3.0)

## Stability

> 0 - Experimental

A tool for generating readme&#39;s



## Table of Contents

- [summariseExports](#summariseexports)
  * [Parameters](#parameters)

## API Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## summariseExports

Summarise a packages exports

### Parameters

-   `path` **[string][1]** the package path

Returns **[string][1]** a markdown document describing a package's exports

[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String


## 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.
npm package: @rgrannell/set
Description: Utilities for working with sets
Latest version: 9.4.0


# set (v9.3.0)

## Stability

> 0 - Experimental

Utilities for working with sets



## Table of Contents

- [set.equals](#setequals)
  * [Parameters](#parameters)
- [set.union](#setunion)
  * [Parameters](#parameters-1)
- [set.intersection](#setintersection)
  * [Parameters](#parameters-2)
- [set.diff](#setdiff)
  * [Parameters](#parameters-3)

## API Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## set.equals

Do two sets contain the same values?

### Parameters

-   `set0` **[Set][1]** a set
-   `set1` **[Set][1]** a set

Returns **[boolean][2]** true

## set.union

Return a set containing the conjunction of two sets

### Parameters

-   `set0` **[Set][1]** a set
-   `set1` **[Set][1]** a set

Returns **[Set][1]** a conjoined set

## set.intersection

Return a set containing elements in both sets

### Parameters

-   `set0` **[Set][1]** a set
-   `set1` **[Set][1]** a set

Returns **[Set][1]** an intersected set

## set.diff

Return the elements in set1 not in set0

### Parameters

-   `set0` **[Set][1]** a set
-   `set1` **[Set][1]** a set

Returns **[Set][1]** the subset of the two provided sets

[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set

[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean


## 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.
npm package: @rgrannell/ssl-labs
Description: A wrapper for SSL-Labs
Latest version: 9.4.0


# ssl-labs (v9.3.0)

## Stability

> 0 - Experimental

A wrapper for SSL-Labs



## Table of Contents



## API Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->


## 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.
npm package: @rgrannell/units
Description: A library for working with promises
Latest version: 9.4.0


# units (v9.3.0)

## Stability

> 0 - Experimental

A library for working with promises



## Table of Contents



## API Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->


## 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.