@xylabs/promise 4.13.13 → 4.13.15

package/build/neutral/PromiseEx.d.ts

@@ -0,0 +1,11 @@
+export type PromiseExSubFunc<T, TResult = T> = (value: T) => TResult;
+export type PromiseExFunc<T> = (resolve?: PromiseExSubFunc<T, void>, reject?: PromiseExSubFunc<T, void>) => void;
+export type PromiseExValueFunc<V> = (value?: V) => boolean;
+export declare class PromiseEx<T, V = void> extends Promise<T> {
+    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>;
+    value(onvalue?: (value?: V) => boolean): this;
+}
+//# sourceMappingURL=PromiseEx.d.ts.map

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

@@ -0,0 +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"}

package/build/neutral/fulfilled.d.ts

@@ -0,0 +1,7 @@
+/**
+ * For use with Promise.allSettled to filter only successful results
+ * @param val
+ * @returns
+ */
+export declare const fulfilled: <T>(val: PromiseSettledResult<T>) => val is PromiseFulfilledResult<T>;
+//# sourceMappingURL=fulfilled.d.ts.map

package/build/neutral/fulfilled.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fulfilled.d.ts","sourceRoot":"","sources":["../../src/fulfilled.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,KAAK,oBAAoB,CAAC,CAAC,CAAC,KAAG,GAAG,IAAI,sBAAsB,CAAC,CAAC,CAE1F,CAAA"}

package/build/neutral/fulfilledValues.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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
+ */
+export declare const fulfilledValues: <T>(previousValue: T[], currentValue: PromiseSettledResult<T>) => T[];
+//# sourceMappingURL=fulfilledValues.d.ts.map

package/build/neutral/fulfilledValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fulfilledValues.d.ts","sourceRoot":"","sources":["../../src/fulfilledValues.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,EAAE,eAAe,CAAC,EAAE,EAAE,cAAc,oBAAoB,CAAC,CAAC,CAAC,KAAG,CAAC,EAG/F,CAAA"}

package/build/neutral/index.d.ts

@@ -0,0 +1,8 @@
+export { fulfilled } from './fulfilled.ts';
+export { fulfilledValues } from './fulfilledValues.ts';
+export * from './isPromise.ts';
+export * from './PromiseEx.ts';
+export { rejected } from './rejected.ts';
+export * from './toPromise.ts';
+export * from './types.ts';
+//# sourceMappingURL=index.d.ts.map

package/build/neutral/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA"}

package/build/neutral/isPromise.d.ts

@@ -0,0 +1,7 @@
+import type { TypedValue } from '@xylabs/typeof';
+export interface PromiseType {
+    then: () => unknown;
+}
+export type AnyNonPromise = Exclude<TypedValue, PromiseType>;
+export declare const isPromise: (value: unknown) => value is Promise<unknown>;
+//# sourceMappingURL=isPromise.d.ts.map

package/build/neutral/isPromise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isPromise.d.ts","sourceRoot":"","sources":["../../src/isPromise.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,OAAO,CAAA;CACpB;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;AAE5D,eAAO,MAAM,SAAS,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,OAAO,CAAC,OAAO,CAKlE,CAAA"}

package/build/neutral/rejected.d.ts

@@ -0,0 +1,7 @@
+/**
+ * For use with Promise.allSettled to filter only rejected results
+ * @param val
+ * @returns
+ */
+export declare const rejected: <T>(val: PromiseSettledResult<T>) => val is PromiseRejectedResult;
+//# sourceMappingURL=rejected.d.ts.map

package/build/neutral/rejected.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rejected.d.ts","sourceRoot":"","sources":["../../src/rejected.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,KAAK,oBAAoB,CAAC,CAAC,CAAC,KAAG,GAAG,IAAI,qBAEjE,CAAA"}

package/build/neutral/toPromise.d.ts

@@ -0,0 +1,3 @@
+import type { Promisable } from './types.ts';
+export declare function toPromise<T>(value: Promisable<T>): Promise<T>;
+//# sourceMappingURL=toPromise.d.ts.map

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

@@ -0,0 +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"}

package/build/neutral/types.d.ts

@@ -0,0 +1,10 @@
+import type { PromiseEx } from './PromiseEx.ts';
+export type Promisable<T, V = never> = PromiseEx<T, V> | Promise<T> | T;
+export type PromisableArray<T, V = never> = Promisable<T[], V>;
+export type OptionalPromisable<T, V = never> = Promisable<T | undefined, V>;
+export type OptionalPromisableArray<T, V = never> = PromisableArray<T | undefined, V>;
+export type NullablePromisable<T, V = never> = Promisable<T | null, V>;
+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>;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/promise",
-  "version": "4.13.13",
+  "version": "4.13.15",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "promise",
@@ -36,13 +36,13 @@
   "module": "./dist/neutral/index.mjs",
   "types": "./dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/typeof": "^4.13.13"
+    "@xylabs/typeof": "^4.13.15"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.9",
-    "@xylabs/tsconfig": "^7.0.0-rc.9",
-    "@xylabs/typeof": "^4.13.13",
-    "@xylabs/vitest-extended": "^4.13.13",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/typeof": "^4.13.15",
+    "@xylabs/vitest-extended": "^4.13.15",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },