@xylabs/promise 5.1.1 → 5.1.3

package/dist/neutral/index.d.ts

@@ -1,90 +1,7 @@
-import { TypedValue } from '@xylabs/typeof';
-
-/**
- * For use with Promise.allSettled to filter only successful results
- * @param val
- * @returns
- */
-declare const fulfilled: <T>(val: PromiseSettledResult<T>) => val is PromiseFulfilledResult<T>;
-
-/**
- * For use with Promise.allSettled to reduce to only successful result values
- * @example <caption>Casting the initialValue provided to reduce</caption>
- * 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' ]
- * @example <caption>Providing type parameter to reduce and initialValue type can be inferred</caption>
- * 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' ]
- * @param previousValue
- * @param currentValue
- * @returns
- */
-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;
-}
-
-/**
- * For use with Promise.allSettled to filter only rejected results
- * @param val
- * @returns
- */
-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 };
-export type { AnyNonPromise, AsyncMutex, NullablePromisable, NullablePromisableArray, OptionalPromisable, OptionalPromisableArray, Promisable, PromisableArray, PromiseExFunc, PromiseExSubFunc, PromiseExValueFunc, PromiseType };
+export { fulfilled } from './fulfilled.ts';
+export { fulfilledValues } from './fulfilledValues.ts';
+export * from './PromiseEx.ts';
+export { rejected } from './rejected.ts';
+export * from './toPromise.ts';
+export * from './types.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/index.mjs

@@ -54,4 +54,4 @@ export {
   rejected,
   toPromise
 };
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -1 +1,7 @@
-{"version":3,"sources":["../../src/fulfilled.ts","../../src/fulfilledValues.ts","../../src/PromiseEx.ts","../../src/rejected.ts","../../src/toPromise.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"],"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;","names":[]}
+{
+  "version": 3,
+  "sources": ["../../src/fulfilled.ts", "../../src/fulfilledValues.ts", "../../src/PromiseEx.ts", "../../src/rejected.ts", "../../src/toPromise.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"],
+  "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;",
+  "names": []
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/promise",
-  "version": "5.1.1",
+  "version": "5.1.3",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "promise",
@@ -41,16 +41,16 @@
     "README.md"
   ],
   "dependencies": {
-    "@xylabs/typeof": "~5.1.1"
+    "@xylabs/typeof": "~5.1.3"
   },
   "devDependencies": {
-    "@xylabs/toolchain": "~7.13.2",
-    "@xylabs/tsconfig": "~7.13.2",
+    "@xylabs/toolchain": "~8.0.4",
+    "@xylabs/tsconfig": "~8.0.4",
     "eslint": "^10.3.0",
-    "typescript": "^5.9.3",
-    "vite": "^8.0.10",
-    "vitest": "^4.1.5",
-    "@xylabs/vitest-extended": "~5.1.1"
+    "typescript": "^6.0.3",
+    "vite": "^8.0.13",
+    "vitest": "^4.1.6",
+    "@xylabs/vitest-extended": "~5.1.3"
   },
   "engines": {
     "node": ">=18"