@xylabs/promise 4.13.20 → 4.13.21

package/README.md

@@ -12,13 +12,586 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.19
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Documentation
+## API Documentation
+
+**@xylabs/promise**
+
+***
+
+## Classes
+
+- [PromiseEx](#classes/PromiseEx)
+
+## Interfaces
+
+- [PromiseType](#interfaces/PromiseType)
+
+## Type Aliases
+
+- [PromiseExSubFunc](#type-aliases/PromiseExSubFunc)
+- [PromiseExFunc](#type-aliases/PromiseExFunc)
+- [PromiseExValueFunc](#type-aliases/PromiseExValueFunc)
+- [AnyNonPromise](#type-aliases/AnyNonPromise)
+- [Promisable](#type-aliases/Promisable)
+- [PromisableArray](#type-aliases/PromisableArray)
+- [OptionalPromisable](#type-aliases/OptionalPromisable)
+- [OptionalPromisableArray](#type-aliases/OptionalPromisableArray)
+- [NullablePromisable](#type-aliases/NullablePromisable)
+- [NullablePromisableArray](#type-aliases/NullablePromisableArray)
+- [AsyncMutex](#type-aliases/AsyncMutex)
+
+## Functions
+
+- [fulfilled](#functions/fulfilled)
+- [fulfilledValues](#functions/fulfilledValues)
+- [isPromise](#functions/isPromise)
+- [rejected](#functions/rejected)
+- [toPromise](#functions/toPromise)
+
+### classes
+
+  ### <a id="PromiseEx"></a>PromiseEx
+
+[**@xylabs/promise**](#../README)
+
+***
+
+## Extends
+
+- `Promise`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+### V
+
+`V` = `void`
+
+## Constructors
+
+### Constructor
+
+```ts
+new PromiseEx<T, V>(func, value?): PromiseEx<T, V>;
+```
+
+### Parameters
+
+#### func
+
+[`PromiseExFunc`](#../type-aliases/PromiseExFunc)\<`T`\>
+
+#### value?
+
+`V`
+
+### Returns
+
+`PromiseEx`\<`T`, `V`\>
+
+### Overrides
+
+```ts
+Promise<T>.constructor
+```
+
+## Properties
+
+### cancelled?
+
+```ts
+optional cancelled: boolean;
+```
+
+## Methods
+
+### then()
+
+```ts
+then<TResult1, TResult2>(
+   onfulfilled?, 
+   onrejected?, 
+onvalue?): Promise<TResult1 | TResult2>;
+```
+
+Attaches callbacks for the resolution and/or rejection of the Promise.
+
+### Type Parameters
+
+#### TResult1
+
+`TResult1` = `T`
+
+#### TResult2
+
+`TResult2` = `never`
+
+### Parameters
+
+#### 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`
+
+### Returns
+
+`Promise`\<`TResult1` \| `TResult2`\>
+
+A Promise for the completion of which ever callback is executed.
+
+### Overrides
+
+```ts
+Promise.then
+```
+
+***
+
+### value()
+
+```ts
+value(onvalue?): PromiseEx<T, V>;
+```
+
+### Parameters
+
+#### onvalue?
+
+(`value?`) => `boolean`
+
+### Returns
+
+`PromiseEx`\<`T`, `V`\>
+
+### functions
+
+  ### <a id="fulfilled"></a>fulfilled
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+function fulfilled<T>(val): val is PromiseFulfilledResult<T>;
+```
+
+For use with Promise.allSettled to filter only successful results
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### val
+
+`PromiseSettledResult`\<`T`\>
+
+## Returns
+
+`val is PromiseFulfilledResult<T>`
+
+  ### <a id="fulfilledValues"></a>fulfilledValues
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+function fulfilledValues<T>(previousValue, currentValue): T[];
+```
+
+For use with Promise.allSettled to reduce to only successful result values
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### previousValue
+
+`T`[]
+
+### currentValue
+
+`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<string[]>(fulfilledValues, [])
+// results === [ 'resolved' ]
+```
+
+  ### <a id="isPromise"></a>isPromise
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+function isPromise(value): value is Promise<unknown>;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is Promise<unknown>`
+
+  ### <a id="rejected"></a>rejected
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+function rejected<T>(val): val is PromiseRejectedResult;
+```
+
+For use with Promise.allSettled to filter only rejected results
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### val
+
+`PromiseSettledResult`\<`T`\>
+
+## Returns
+
+`val is PromiseRejectedResult`
+
+  ### <a id="toPromise"></a>toPromise
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+function toPromise<T>(value): Promise<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### value
+
+[`Promisable`](#../type-aliases/Promisable)\<`T`\>
+
+## Returns
+
+`Promise`\<`T`\>
+
+### interfaces
+
+  ### <a id="PromiseType"></a>PromiseType
+
+[**@xylabs/promise**](#../README)
+
+***
+
+## Properties
+
+### then()
+
+```ts
+then: () => unknown;
+```
+
+### Returns
+
+`unknown`
+
+### type-aliases
+
+  ### <a id="AnyNonPromise"></a>AnyNonPromise
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type AnyNonPromise = Exclude<TypedValue, PromiseType>;
+```
+
+  ### <a id="AsyncMutex"></a>AsyncMutex
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type AsyncMutex<T> = Promise<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Description
+
+Used to document promises that are being used as Mutexes
+
+  ### <a id="NullablePromisable"></a>NullablePromisable
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type NullablePromisable<T, V> = Promisable<T | null, V>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+### V
+
+`V` = `never`
+
+  ### <a id="NullablePromisableArray"></a>NullablePromisableArray
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type NullablePromisableArray<T, V> = PromisableArray<T | null, V>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+### V
+
+`V` = `never`
+
+  ### <a id="OptionalPromisable"></a>OptionalPromisable
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type OptionalPromisable<T, V> = Promisable<T | undefined, V>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+### V
+
+`V` = `never`
+
+  ### <a id="OptionalPromisableArray"></a>OptionalPromisableArray
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type OptionalPromisableArray<T, V> = PromisableArray<T | undefined, V>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+### V
+
+`V` = `never`
+
+  ### <a id="Promisable"></a>Promisable
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type Promisable<T, V> = PromiseEx<T, V> | Promise<T> | T;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+### V
+
+`V` = `never`
+
+  ### <a id="PromisableArray"></a>PromisableArray
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type PromisableArray<T, V> = Promisable<T[], V>;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+### V
+
+`V` = `never`
+
+  ### <a id="PromiseExFunc"></a>PromiseExFunc
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type PromiseExFunc<T> = (resolve?, reject?) => void;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### resolve?
+
+[`PromiseExSubFunc`](#PromiseExSubFunc)\<`T`, `void`\>
+
+### reject?
+
+[`PromiseExSubFunc`](#PromiseExSubFunc)\<`T`, `void`\>
+
+## Returns
+
+`void`
+
+  ### <a id="PromiseExSubFunc"></a>PromiseExSubFunc
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type PromiseExSubFunc<T, TResult> = (value) => TResult;
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+### TResult
+
+`TResult` = `T`
+
+## Parameters
+
+### value
+
+`T`
+
+## Returns
+
+`TResult`
+
+  ### <a id="PromiseExValueFunc"></a>PromiseExValueFunc
+
+[**@xylabs/promise**](#../README)
+
+***
+
+```ts
+type PromiseExValueFunc<V> = (value?) => boolean;
+```
+
+## Type Parameters
+
+### V
+
+`V`
+
+## Parameters
+
+### value?
+
+`V`
+
+## Returns
+
+`boolean`
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/promise",
-  "version": "4.13.20",
+  "version": "4.13.21",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "promise",
@@ -44,8 +44,8 @@
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^7.0.0",
     "@xylabs/tsconfig": "^7.0.0",
-    "@xylabs/typeof": "^4.13.20",
-    "@xylabs/vitest-extended": "^4.13.20",
+    "@xylabs/typeof": "^4.13.21",
+    "@xylabs/vitest-extended": "^4.13.21",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },