@xylabs/promise

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/promise

*

Classes

- PromiseEx

Interfaces

- PromiseType

Type Aliases

- PromiseExSubFunc
- PromiseExFunc
- PromiseExValueFunc
- AnyNonPromise
- Promisable
- PromisableArray
- OptionalPromisable
- OptionalPromisableArray
- NullablePromisable
- NullablePromisableArray
- AsyncMutex

Functions

- fulfilled
- fulfilledValues
- isPromise
- rejected
- toPromise

$3

### PromiseEx

@xylabs/promise

*

Extends

- Promise\<T\>

Type Parameters

$3

T

$3

V = void

Constructors

$3

``ts
new PromiseEx(func, value?): PromiseEx;
`

$3

#### func

PromiseExFunc\<T\>

#### value?

V

$3

PromiseEx\<T, V\>

$3

`ts
Promise.constructor
`

Properties

$3

`ts
optional cancelled: boolean;
`

Methods

$3

`ts
then(
onfulfilled?,
onrejected?,
onvalue?): Promise;
`

Attaches callbacks for the resolution and/or rejection of the Promise.

$3

#### TResult1

TResult1 = T

#### TResult2

TResult2 = never

$3

#### onfulfilled?

The callback to execute when the Promise is resolved.

null | (value) => TResult1 \| PromiseLike\<TResult1\>

#### onrejected?

The callback to execute when the Promise is rejected.

null | (reason) => TResult2 \| PromiseLike\<TResult2\>

#### onvalue?

(value?) => boolean

$3

Promise\<TResult1 \| TResult2\>

A Promise for the completion of which ever callback is executed.

$3

`ts
Promise.then
`

*

$3

`ts
value(onvalue?): PromiseEx;
`

$3

#### onvalue?

(value?) => boolean

$3

PromiseEx\<T, V\>

$3

### fulfilled

@xylabs/promise

*

`ts
function fulfilled(val): val is PromiseFulfilledResult;
`

For use with Promise.allSettled to filter only successful results

Type Parameters

$3

T

Parameters

$3

PromiseSettledResult\<T\>

Returns

val is PromiseFulfilledResult

### fulfilledValues

@xylabs/promise

*

`ts
function fulfilledValues(previousValue, currentValue): T[];
`

For use with Promise.allSettled to reduce to only successful result values

Type Parameters

$3

T

Parameters

$3

T[]

$3

PromiseSettledResult\<T\>

Returns

T[]

Examples

`ts
const resolved = Promise.resolve('resolved')
const rejected = Promise.reject('rejected')
const settled = await Promise.allSettled([resolved, rejected])
const results = settled.reduce(fulfilledValues, [] as string[])
// results === [ 'resolved' ]
`

`ts
const resolved = Promise.resolve('resolved')
const rejected = Promise.reject('rejected')
const settled = await Promise.allSettled([resolved, rejected])
const results = settled.reduce(fulfilledValues, [])
// results === [ 'resolved' ]
`

### isPromise

@xylabs/promise

*

`ts
function isPromise(value): value is Promise;
`

Parameters

$3

unknown

Returns

value is Promise

### rejected

@xylabs/promise

*

`ts
function rejected(val): val is PromiseRejectedResult;
`

For use with Promise.allSettled to filter only rejected results

Type Parameters

$3

T

Parameters

$3

PromiseSettledResult\<T\>

Returns

val is PromiseRejectedResult

### toPromise

@xylabs/promise

*

`ts
function toPromise(value): Promise;
`

Type Parameters

$3

T

Parameters

$3

Promisable\<T\>

Returns

Promise\<T\>

$3

### PromiseType

@xylabs/promise

*

Properties

$3

`ts
then: () => unknown;
`

$3

unknown

$3

### AnyNonPromise

@xylabs/promise

*

`ts
type AnyNonPromise = Exclude;
`

### AsyncMutex

@xylabs/promise

*

`ts
type AsyncMutex = Promise;
`

Type Parameters

$3

T

Description

Used to document promises that are being used as Mutexes

### NullablePromisable

@xylabs/promise

*

`ts
type NullablePromisable = Promisable;
`

Type Parameters

$3

T

$3

V = never

### NullablePromisableArray

@xylabs/promise

*

`ts
type NullablePromisableArray = PromisableArray;
`

Type Parameters

$3

T

$3

V = never

### OptionalPromisable

@xylabs/promise

*

`ts
type OptionalPromisable = Promisable;
`

Type Parameters

$3

T

$3

V = never

### OptionalPromisableArray

@xylabs/promise

*

`ts
type OptionalPromisableArray = PromisableArray;
`

Type Parameters

$3

T

$3

V = never

### Promisable

@xylabs/promise

*

`ts
type Promisable = PromiseEx | Promise | T;
`

Type Parameters

$3

T

$3

V = never

### PromisableArray

@xylabs/promise

*

`ts
type PromisableArray = Promisable;
`

Type Parameters

$3

T

$3

V = never

### PromiseExFunc

@xylabs/promise

*

`ts
type PromiseExFunc = (resolve?, reject?) => void;
`

Type Parameters

$3

T

Parameters

$3

PromiseExSubFunc\<T, void\>

$3

PromiseExSubFunc\<T, void\>

Returns

void

### PromiseExSubFunc

@xylabs/promise

*

`ts
type PromiseExSubFunc = (value) => TResult;
`

Type Parameters

$3

T

$3

TResult = T

Parameters

$3

T

Returns

TResult

### PromiseExValueFunc

@xylabs/promise

*

`ts
type PromiseExValueFunc = (value?) => boolean;
`

Type Parameters

$3

V

Parameters

$3

V

Returns

boolean`

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/promise.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/promise
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/promise
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/promise

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/promise/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/promise

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/promise
[socket-link]: https://socket.dev/npm/package/@xylabs/promise