@xylabs/promise 5.0.83 → 5.0.84

package/README.md

@@ -59,6 +59,9 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
+An extended Promise that carries an optional attached value and supports cancellation.
+The value can be inspected via the `then` or `value` methods to conditionally cancel.
+
 ## Extends
 
 - `Promise`\<`T`\>
@@ -109,6 +112,8 @@ Promise<T>.constructor
 optional cancelled: boolean;
 ```
 
+Whether the promise has been cancelled via a value callback.
+
 ## Methods
 
 ### then()
@@ -170,16 +175,22 @@ Promise.then
 value(onvalue?): PromiseEx<T, V>;
 ```
 
+Inspects the attached value via the callback; if it returns true, marks the promise as cancelled.
+
 ### Parameters
 
 #### onvalue?
 
 (`value?`) => `boolean`
 
+A callback that receives the attached value and returns whether to cancel.
+
 ### Returns
 
 `PromiseEx`\<`T`, `V`\>
 
+This instance for chaining.
+
 ### functions
 
   ### <a id="fulfilled"></a>fulfilled
@@ -272,6 +283,8 @@ const results = settled.reduce<string[]>(fulfilledValues, [])
 function isPromise(value): value is Promise<unknown>;
 ```
 
+Type guard that checks whether a value is a Promise instance.
+
 ### Parameters
 
 ### value
@@ -288,6 +301,8 @@ function isPromise(value): value is Promise<unknown>;
 function isPromise<T>(value): value is Extract<T, Promise<unknown>>;
 ```
 
+Type guard that checks whether a value is a Promise instance.
+
 ### Type Parameters
 
 ### T
@@ -342,6 +357,8 @@ For use with Promise.allSettled to filter only rejected results
 function toPromise<T>(value): Promise<T>;
 ```
 
+Wraps a value in a Promise if it is not already one.
+
 ## Type Parameters
 
 ### T
@@ -354,10 +371,14 @@ function toPromise<T>(value): Promise<T>;
 
 [`Promisable`](#../type-aliases/Promisable)\<`T`\>
 
+A value that may or may not be a Promise.
+
 ## Returns
 
 `Promise`\<`T`\>
 
+A Promise resolving to the value.
+
 ### interfaces
 
   ### <a id="PromiseType"></a>PromiseType
@@ -366,6 +387,8 @@ function toPromise<T>(value): Promise<T>;
 
 ***
 
+An interface representing any thenable (promise-like) object.
+
 ## Properties
 
 ### then()
@@ -390,6 +413,8 @@ then: () => unknown;
 type AnyNonPromise = Exclude<TypedValue, PromiseType>;
 ```
 
+Any non-promise typed value, excluding thenables.
+
   ### <a id="AsyncMutex"></a>AsyncMutex
 
 [**@xylabs/promise**](#../README)
@@ -420,6 +445,8 @@ Used to document promises that are being used as Mutexes
 type NullablePromisable<T, V> = Promisable<T | null, V>;
 ```
 
+A Promisable that may resolve to null.
+
 ## Type Parameters
 
 ### T
@@ -440,6 +467,8 @@ type NullablePromisable<T, V> = Promisable<T | null, V>;
 type NullablePromisableArray<T, V> = PromisableArray<T | null, V>;
 ```
 
+A Promisable array where elements may be null.
+
 ## Type Parameters
 
 ### T
@@ -460,6 +489,8 @@ type NullablePromisableArray<T, V> = PromisableArray<T | null, V>;
 type OptionalPromisable<T, V> = Promisable<T | undefined, V>;
 ```
 
+A Promisable that may resolve to undefined.
+
 ## Type Parameters
 
 ### T
@@ -480,6 +511,8 @@ type OptionalPromisable<T, V> = Promisable<T | undefined, V>;
 type OptionalPromisableArray<T, V> = PromisableArray<T | undefined, V>;
 ```
 
+A Promisable array where elements may be undefined.
+
 ## Type Parameters
 
 ### T
@@ -500,6 +533,8 @@ type OptionalPromisableArray<T, V> = PromisableArray<T | undefined, V>;
 type Promisable<T, V> = PromiseEx<T, V> | Promise<T> | T;
 ```
 
+A value that may be a Promise, PromiseEx, or a plain synchronous value.
+
 ## Type Parameters
 
 ### T
@@ -520,6 +555,8 @@ type Promisable<T, V> = PromiseEx<T, V> | Promise<T> | T;
 type PromisableArray<T, V> = Promisable<T[], V>;
 ```
 
+A Promisable that resolves to an array.
+
 ## Type Parameters
 
 ### T
@@ -540,6 +577,8 @@ type PromisableArray<T, V> = Promisable<T[], V>;
 type PromiseExFunc<T> = (resolve?, reject?) => void;
 ```
 
+The executor function passed to the PromiseEx constructor.
+
 ## Type Parameters
 
 ### T
@@ -570,6 +609,8 @@ type PromiseExFunc<T> = (resolve?, reject?) => void;
 type PromiseExSubFunc<T, TResult> = (value) => TResult;
 ```
 
+A resolve/reject callback used within PromiseEx.
+
 ## Type Parameters
 
 ### T
@@ -600,6 +641,8 @@ type PromiseExSubFunc<T, TResult> = (value) => TResult;
 type PromiseExValueFunc<V> = (value?) => boolean;
 ```
 
+A callback that inspects the attached value and returns whether to cancel the promise.
+
 ## Type Parameters
 
 ### V

package/dist/neutral/PromiseEx.d.ts

@@ -1,11 +1,24 @@
+/** A resolve/reject callback used within PromiseEx. */
 export type PromiseExSubFunc<T, TResult = T> = (value: T) => TResult;
+/** The executor function passed to the PromiseEx constructor. */
 export type PromiseExFunc<T> = (resolve?: PromiseExSubFunc<T, void>, reject?: PromiseExSubFunc<T, void>) => void;
+/** A callback that inspects the attached value and returns whether to cancel the promise. */
 export type PromiseExValueFunc<V> = (value?: V) => boolean;
+/**
+ * An extended Promise that carries an optional attached value and supports cancellation.
+ * The value can be inspected via the `then` or `value` methods to conditionally cancel.
+ */
 export declare class PromiseEx<T, V = void> extends Promise<T> {
+    /** Whether the promise has been cancelled via a value callback. */
     cancelled?: boolean;
     private _value?;
     constructor(func: PromiseExFunc<T>, value?: V);
     then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined, onvalue?: (value?: V) => boolean): Promise<TResult1 | TResult2>;
+    /**
+     * Inspects the attached value via the callback; if it returns true, marks the promise as cancelled.
+     * @param onvalue - A callback that receives the attached value and returns whether to cancel.
+     * @returns This instance for chaining.
+     */
     value(onvalue?: (value?: V) => boolean): this;
 }
 //# sourceMappingURL=PromiseEx.d.ts.map

package/dist/neutral/PromiseEx.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PromiseEx.d.ts","sourceRoot":"","sources":["../../src/PromiseEx.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAA;AACpE,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,IAAI,CAAA;AAChH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,OAAO,CAAA;AAE1D,qBAAa,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACpD,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,MAAM,CAAC,CAAG;gBAEN,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAMpC,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EAC1C,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EACjF,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EACvF,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,OAAO,GAC/B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAO/B,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,OAAO;CAMvC"}
+{"version":3,"file":"PromiseEx.d.ts","sourceRoot":"","sources":["../../src/PromiseEx.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,MAAM,MAAM,gBAAgB,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAA;AAEpE,iEAAiE;AACjE,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,IAAI,CAAA;AAEhH,6FAA6F;AAC7F,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,OAAO,CAAA;AAE1D;;;GAGG;AACH,qBAAa,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACpD,mEAAmE;IACnE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,MAAM,CAAC,CAAG;gBAEN,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAMpC,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EAC1C,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EACjF,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EACvF,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,OAAO,GAC/B,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAO/B;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,OAAO;CAMvC"}

package/dist/neutral/index.d.ts

@@ -28,14 +28,27 @@ declare const fulfilled: <T>(val: PromiseSettledResult<T>) => val is PromiseFulf
  */
 declare const fulfilledValues: <T>(previousValue: T[], currentValue: PromiseSettledResult<T>) => T[];
 
+/** A resolve/reject callback used within PromiseEx. */
 type PromiseExSubFunc<T, TResult = T> = (value: T) => TResult;
+/** The executor function passed to the PromiseEx constructor. */
 type PromiseExFunc<T> = (resolve?: PromiseExSubFunc<T, void>, reject?: PromiseExSubFunc<T, void>) => void;
+/** A callback that inspects the attached value and returns whether to cancel the promise. */
 type PromiseExValueFunc<V> = (value?: V) => boolean;
+/**
+ * An extended Promise that carries an optional attached value and supports cancellation.
+ * The value can be inspected via the `then` or `value` methods to conditionally cancel.
+ */
 declare class PromiseEx<T, V = void> extends Promise<T> {
+    /** Whether the promise has been cancelled via a value callback. */
     cancelled?: boolean;
     private _value?;
     constructor(func: PromiseExFunc<T>, value?: V);
     then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined, onvalue?: (value?: V) => boolean): Promise<TResult1 | TResult2>;
+    /**
+     * Inspects the attached value via the callback; if it returns true, marks the promise as cancelled.
+     * @param onvalue - A callback that receives the attached value and returns whether to cancel.
+     * @returns This instance for chaining.
+     */
     value(onvalue?: (value?: V) => boolean): this;
 }
 
@@ -46,19 +59,32 @@ declare class PromiseEx<T, V = void> extends Promise<T> {
  */
 declare const rejected: <T>(val: PromiseSettledResult<T>) => val is PromiseRejectedResult;
 
+/** A value that may be a Promise, PromiseEx, or a plain synchronous value. */
 type Promisable<T, V = never> = PromiseEx<T, V> | Promise<T> | T;
+/** A Promisable that resolves to an array. */
 type PromisableArray<T, V = never> = Promisable<T[], V>;
+/** A Promisable that may resolve to undefined. */
 type OptionalPromisable<T, V = never> = Promisable<T | undefined, V>;
+/** A Promisable array where elements may be undefined. */
 type OptionalPromisableArray<T, V = never> = PromisableArray<T | undefined, V>;
+/** A Promisable that may resolve to null. */
 type NullablePromisable<T, V = never> = Promisable<T | null, V>;
+/** A Promisable array where elements may be null. */
 type NullablePromisableArray<T, V = never> = PromisableArray<T | null, V>;
 /** @description Used to document promises that are being used as Mutexes */
 type AsyncMutex<T> = Promise<T>;
+/** An interface representing any thenable (promise-like) object. */
 interface PromiseType {
     then: () => unknown;
 }
+/** Any non-promise typed value, excluding thenables. */
 type AnyNonPromise = Exclude<TypedValue, PromiseType>;
 
+/**
+ * Wraps a value in a Promise if it is not already one.
+ * @param value - A value that may or may not be a Promise.
+ * @returns A Promise resolving to the value.
+ */
 declare function toPromise<T>(value: Promisable<T>): Promise<T>;
 
 export { PromiseEx, fulfilled, fulfilledValues, rejected, toPromise };

package/dist/neutral/index.mjs

@@ -11,6 +11,7 @@ var fulfilledValues = (previousValue, currentValue) => {
 
 // src/PromiseEx.ts
 var PromiseEx = class extends Promise {
+  /** Whether the promise has been cancelled via a value callback. */
   cancelled;
   _value;
   constructor(func, value) {
@@ -24,6 +25,11 @@ var PromiseEx = class extends Promise {
     }
     return super.then(onfulfilled, onrejected);
   }
+  /**
+   * Inspects the attached value via the callback; if it returns true, marks the promise as cancelled.
+   * @param onvalue - A callback that receives the attached value and returns whether to cancel.
+   * @returns This instance for chaining.
+   */
   value(onvalue) {
     if (onvalue?.(this._value)) {
       this.cancelled = true;

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fulfilled.ts","../../src/fulfilledValues.ts","../../src/PromiseEx.ts","../../src/rejected.ts","../../src/toPromise.ts","../../src/index.ts"],"sourcesContent":["/**\n * For use with Promise.allSettled to filter only successful results\n * @param val\n * @returns\n */\nexport const fulfilled = <T>(val: PromiseSettledResult<T>): val is PromiseFulfilledResult<T> => {\n  return val.status === 'fulfilled'\n}\n","/**\n * For use with Promise.allSettled to reduce to only successful result values\n * @example <caption>Casting the initialValue provided to reduce</caption>\n * const resolved = Promise.resolve('resolved')\n * const rejected = Promise.reject('rejected')\n * const settled = await Promise.allSettled([resolved, rejected])\n * const results = settled.reduce(fulfilledValues, [] as string[])\n * // results === [ 'resolved' ]\n * @example <caption>Providing type parameter to reduce and initialValue type can be inferred</caption>\n * const resolved = Promise.resolve('resolved')\n * const rejected = Promise.reject('rejected')\n * const settled = await Promise.allSettled([resolved, rejected])\n * const results = settled.reduce<string[]>(fulfilledValues, [])\n * // results === [ 'resolved' ]\n * @param previousValue\n * @param currentValue\n * @returns\n */\nexport const fulfilledValues = <T>(previousValue: T[], currentValue: PromiseSettledResult<T>): T[] => {\n  if (currentValue.status === 'fulfilled') previousValue.push(currentValue.value)\n  return previousValue\n}\n","export type PromiseExSubFunc<T, TResult = T> = (value: T) => TResult\nexport type PromiseExFunc<T> = (resolve?: PromiseExSubFunc<T, void>, reject?: PromiseExSubFunc<T, void>) => void\nexport type PromiseExValueFunc<V> = (value?: V) => boolean\n\nexport class PromiseEx<T, V = void> extends Promise<T> {\n  cancelled?: boolean\n  private _value?: V\n\n  constructor(func: PromiseExFunc<T>, value?: V) {\n    super(func)\n    this._value = value\n  }\n\n  // eslint-disable-next-line unicorn/no-thenable\n  override then<TResult1 = T, TResult2 = never>(\n    onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined,\n    onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined,\n    onvalue?: (value?: V) => boolean,\n  ): Promise<TResult1 | TResult2> {\n    if (onvalue?.(this._value)) {\n      this.cancelled = true\n    }\n    return super.then(onfulfilled, onrejected)\n  }\n\n  value(onvalue?: (value?: V) => boolean) {\n    if (onvalue?.(this._value)) {\n      this.cancelled = true\n    }\n    return this\n  }\n}\n","/**\n * For use with Promise.allSettled to filter only rejected results\n * @param val\n * @returns\n */\nexport const rejected = <T>(val: PromiseSettledResult<T>): val is PromiseRejectedResult => {\n  return val.status === 'rejected'\n}\n","import type { Promisable } from './types.ts'\n\nexport function toPromise<T>(value: Promisable<T>): Promise<T> {\n  return value instanceof Promise ? value : Promise.resolve(value)\n}\n","export { fulfilled } from './fulfilled.ts'\nexport { fulfilledValues } from './fulfilledValues.ts'\nexport * from './PromiseEx.ts'\nexport { rejected } from './rejected.ts'\nexport * from './toPromise.ts'\nexport * from './types.ts'\nexport { isPromise } from '@xylabs/typeof'\n"],"mappings":";AAKO,IAAM,YAAY,CAAI,QAAmE;AAC9F,SAAO,IAAI,WAAW;AACxB;;;ACWO,IAAM,kBAAkB,CAAI,eAAoB,iBAA+C;AACpG,MAAI,aAAa,WAAW,YAAa,eAAc,KAAK,aAAa,KAAK;AAC9E,SAAO;AACT;;;ACjBO,IAAM,YAAN,cAAqC,QAAW;AAAA,EACrD;AAAA,EACQ;AAAA,EAER,YAAY,MAAwB,OAAW;AAC7C,UAAM,IAAI;AACV,SAAK,SAAS;AAAA,EAChB;AAAA;AAAA,EAGS,KACP,aACA,YACA,SAC8B;AAC9B,QAAI,UAAU,KAAK,MAAM,GAAG;AAC1B,WAAK,YAAY;AAAA,IACnB;AACA,WAAO,MAAM,KAAK,aAAa,UAAU;AAAA,EAC3C;AAAA,EAEA,MAAM,SAAkC;AACtC,QAAI,UAAU,KAAK,MAAM,GAAG;AAC1B,WAAK,YAAY;AAAA,IACnB;AACA,WAAO;AAAA,EACT;AACF;;;AC1BO,IAAM,WAAW,CAAI,QAA+D;AACzF,SAAO,IAAI,WAAW;AACxB;;;ACLO,SAAS,UAAa,OAAkC;AAC7D,SAAO,iBAAiB,UAAU,QAAQ,QAAQ,QAAQ,KAAK;AACjE;;;ACEA,SAAS,iBAAiB;","names":[]}
+{"version":3,"sources":["../../src/fulfilled.ts","../../src/fulfilledValues.ts","../../src/PromiseEx.ts","../../src/rejected.ts","../../src/toPromise.ts","../../src/index.ts"],"sourcesContent":["/**\n * For use with Promise.allSettled to filter only successful results\n * @param val\n * @returns\n */\nexport const fulfilled = <T>(val: PromiseSettledResult<T>): val is PromiseFulfilledResult<T> => {\n  return val.status === 'fulfilled'\n}\n","/**\n * For use with Promise.allSettled to reduce to only successful result values\n * @example <caption>Casting the initialValue provided to reduce</caption>\n * const resolved = Promise.resolve('resolved')\n * const rejected = Promise.reject('rejected')\n * const settled = await Promise.allSettled([resolved, rejected])\n * const results = settled.reduce(fulfilledValues, [] as string[])\n * // results === [ 'resolved' ]\n * @example <caption>Providing type parameter to reduce and initialValue type can be inferred</caption>\n * const resolved = Promise.resolve('resolved')\n * const rejected = Promise.reject('rejected')\n * const settled = await Promise.allSettled([resolved, rejected])\n * const results = settled.reduce<string[]>(fulfilledValues, [])\n * // results === [ 'resolved' ]\n * @param previousValue\n * @param currentValue\n * @returns\n */\nexport const fulfilledValues = <T>(previousValue: T[], currentValue: PromiseSettledResult<T>): T[] => {\n  if (currentValue.status === 'fulfilled') previousValue.push(currentValue.value)\n  return previousValue\n}\n","/** A resolve/reject callback used within PromiseEx. */\nexport type PromiseExSubFunc<T, TResult = T> = (value: T) => TResult\n\n/** The executor function passed to the PromiseEx constructor. */\nexport type PromiseExFunc<T> = (resolve?: PromiseExSubFunc<T, void>, reject?: PromiseExSubFunc<T, void>) => void\n\n/** A callback that inspects the attached value and returns whether to cancel the promise. */\nexport type PromiseExValueFunc<V> = (value?: V) => boolean\n\n/**\n * An extended Promise that carries an optional attached value and supports cancellation.\n * The value can be inspected via the `then` or `value` methods to conditionally cancel.\n */\nexport class PromiseEx<T, V = void> extends Promise<T> {\n  /** Whether the promise has been cancelled via a value callback. */\n  cancelled?: boolean\n  private _value?: V\n\n  constructor(func: PromiseExFunc<T>, value?: V) {\n    super(func)\n    this._value = value\n  }\n\n  // eslint-disable-next-line unicorn/no-thenable\n  override then<TResult1 = T, TResult2 = never>(\n    onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined,\n    onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined,\n    onvalue?: (value?: V) => boolean,\n  ): Promise<TResult1 | TResult2> {\n    if (onvalue?.(this._value)) {\n      this.cancelled = true\n    }\n    return super.then(onfulfilled, onrejected)\n  }\n\n  /**\n   * Inspects the attached value via the callback; if it returns true, marks the promise as cancelled.\n   * @param onvalue - A callback that receives the attached value and returns whether to cancel.\n   * @returns This instance for chaining.\n   */\n  value(onvalue?: (value?: V) => boolean) {\n    if (onvalue?.(this._value)) {\n      this.cancelled = true\n    }\n    return this\n  }\n}\n","/**\n * For use with Promise.allSettled to filter only rejected results\n * @param val\n * @returns\n */\nexport const rejected = <T>(val: PromiseSettledResult<T>): val is PromiseRejectedResult => {\n  return val.status === 'rejected'\n}\n","import type { Promisable } from './types.ts'\n\n/**\n * Wraps a value in a Promise if it is not already one.\n * @param value - A value that may or may not be a Promise.\n * @returns A Promise resolving to the value.\n */\nexport function toPromise<T>(value: Promisable<T>): Promise<T> {\n  return value instanceof Promise ? value : Promise.resolve(value)\n}\n","export { fulfilled } from './fulfilled.ts'\nexport { fulfilledValues } from './fulfilledValues.ts'\nexport * from './PromiseEx.ts'\nexport { rejected } from './rejected.ts'\nexport * from './toPromise.ts'\nexport * from './types.ts'\nexport { isPromise } from '@xylabs/typeof'\n"],"mappings":";AAKO,IAAM,YAAY,CAAI,QAAmE;AAC9F,SAAO,IAAI,WAAW;AACxB;;;ACWO,IAAM,kBAAkB,CAAI,eAAoB,iBAA+C;AACpG,MAAI,aAAa,WAAW,YAAa,eAAc,KAAK,aAAa,KAAK;AAC9E,SAAO;AACT;;;ACRO,IAAM,YAAN,cAAqC,QAAW;AAAA;AAAA,EAErD;AAAA,EACQ;AAAA,EAER,YAAY,MAAwB,OAAW;AAC7C,UAAM,IAAI;AACV,SAAK,SAAS;AAAA,EAChB;AAAA;AAAA,EAGS,KACP,aACA,YACA,SAC8B;AAC9B,QAAI,UAAU,KAAK,MAAM,GAAG;AAC1B,WAAK,YAAY;AAAA,IACnB;AACA,WAAO,MAAM,KAAK,aAAa,UAAU;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,SAAkC;AACtC,QAAI,UAAU,KAAK,MAAM,GAAG;AAC1B,WAAK,YAAY;AAAA,IACnB;AACA,WAAO;AAAA,EACT;AACF;;;ACzCO,IAAM,WAAW,CAAI,QAA+D;AACzF,SAAO,IAAI,WAAW;AACxB;;;ACAO,SAAS,UAAa,OAAkC;AAC7D,SAAO,iBAAiB,UAAU,QAAQ,QAAQ,QAAQ,KAAK;AACjE;;;ACHA,SAAS,iBAAiB;","names":[]}

package/dist/neutral/toPromise.d.ts

@@ -1,3 +1,8 @@
 import type { Promisable } from './types.ts';
+/**
+ * Wraps a value in a Promise if it is not already one.
+ * @param value - A value that may or may not be a Promise.
+ * @returns A Promise resolving to the value.
+ */
 export declare function toPromise<T>(value: Promisable<T>): Promise<T>;
 //# sourceMappingURL=toPromise.d.ts.map

package/dist/neutral/toPromise.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toPromise.d.ts","sourceRoot":"","sources":["../../src/toPromise.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAE7D"}
+{"version":3,"file":"toPromise.d.ts","sourceRoot":"","sources":["../../src/toPromise.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAE7D"}

package/dist/neutral/types.d.ts

@@ -1,15 +1,23 @@
 import type { TypedValue } from '@xylabs/typeof';
 import type { PromiseEx } from './PromiseEx.ts';
+/** A value that may be a Promise, PromiseEx, or a plain synchronous value. */
 export type Promisable<T, V = never> = PromiseEx<T, V> | Promise<T> | T;
+/** A Promisable that resolves to an array. */
 export type PromisableArray<T, V = never> = Promisable<T[], V>;
+/** A Promisable that may resolve to undefined. */
 export type OptionalPromisable<T, V = never> = Promisable<T | undefined, V>;
+/** A Promisable array where elements may be undefined. */
 export type OptionalPromisableArray<T, V = never> = PromisableArray<T | undefined, V>;
+/** A Promisable that may resolve to null. */
 export type NullablePromisable<T, V = never> = Promisable<T | null, V>;
+/** A Promisable array where elements may be null. */
 export type NullablePromisableArray<T, V = never> = PromisableArray<T | null, V>;
 /** @description Used to document promises that are being used as Mutexes */
 export type AsyncMutex<T> = Promise<T>;
+/** An interface representing any thenable (promise-like) object. */
 export interface PromiseType {
     then: () => unknown;
 }
+/** Any non-promise typed value, excluding thenables. */
 export type AnyNonPromise = Exclude<TypedValue, PromiseType>;
 //# sourceMappingURL=types.d.ts.map

package/dist/neutral/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AACvE,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;AAC9D,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,UAAU,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,CAAA;AAC3E,MAAM,MAAM,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,eAAe,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,CAAA;AACrF,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,UAAU,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;AACtE,MAAM,MAAM,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,eAAe,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;AAEhF,4EAA4E;AAC5E,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAA;AAEtC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,OAAO,CAAA;CACpB;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,8EAA8E;AAC9E,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAEvE,8CAA8C;AAC9C,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;AAE9D,kDAAkD;AAClD,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,UAAU,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,CAAA;AAE3E,0DAA0D;AAC1D,MAAM,MAAM,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,eAAe,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,CAAA;AAErF,6CAA6C;AAC7C,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,UAAU,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;AAEtE,qDAAqD;AACrD,MAAM,MAAM,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,eAAe,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;AAEhF,4EAA4E;AAC5E,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAA;AAEtC,oEAAoE;AACpE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,OAAO,CAAA;CACpB;AAED,wDAAwD;AACxD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/promise",
-  "version": "5.0.83",
+  "version": "5.0.84",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "promise",
@@ -42,12 +42,12 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/typeof": "~5.0.83"
+    "@xylabs/typeof": "~5.0.84"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
-    "@xylabs/vitest-extended": "~5.0.83",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
+    "@xylabs/vitest-extended": "~5.0.84",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },