@xylabs/promise 4.12.44 → 4.13.1

package/dist/neutral/index.d.ts

@@ -0,0 +1,76 @@
+import type { TypedValue } from '@xylabs/typeof';
+
+export declare type AnyNonPromise = Exclude<TypedValue, PromiseType>;
+
+/** @description Used to document promises that are being used as Mutexes */
+export declare type AsyncMutex<T> = Promise<T>;
+
+/**
+ * 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>;
+
+/**
+ * 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[];
+
+export declare const isPromise: (value: unknown) => value is Promise<unknown>;
+
+export declare type NullablePromisable<T, V = never> = Promisable<T | null, V>;
+
+export declare type NullablePromisableArray<T, V = never> = PromisableArray<T | null, V>;
+
+export declare type OptionalPromisable<T, V = never> = Promisable<T | undefined, V>;
+
+export declare type OptionalPromisableArray<T, V = never> = PromisableArray<T | undefined, V>;
+
+export declare type Promisable<T, V = never> = PromiseEx<T, V> | Promise<T> | T;
+
+export declare type PromisableArray<T, V = never> = Promisable<T[], V>;
+
+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;
+}
+
+export declare type PromiseExFunc<T> = (resolve?: PromiseExSubFunc<T, void>, reject?: PromiseExSubFunc<T, void>) => void;
+
+export declare type PromiseExSubFunc<T, TResult = T> = (value: T) => TResult;
+
+export declare type PromiseExValueFunc<V> = (value?: V) => boolean;
+
+export declare interface PromiseType {
+    then: () => unknown;
+}
+
+/**
+ * For use with Promise.allSettled to filter only rejected results
+ * @param val
+ * @returns
+ */
+export declare const rejected: <T>(val: PromiseSettledResult<T>) => val is PromiseRejectedResult;
+
+export declare function toPromise<T>(value: Promisable<T>): Promise<T>;
+
+export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/promise",
-  "version": "4.12.44",
+  "version": "4.13.1",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "promise",
@@ -28,21 +28,21 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "types": "./dist/types/index.d.ts",
+  "types": "./dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/typeof": "^4.12.44"
+    "@xylabs/typeof": "^4.13.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig": "^6.5.12",
-    "@xylabs/typeof": "^4.12.44",
-    "@xylabs/vitest-extended": "^4.12.44",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.7",
+    "@xylabs/tsconfig": "^7.0.0-rc.7",
+    "@xylabs/typeof": "^4.13.1",
+    "@xylabs/vitest-extended": "^4.13.1",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/dist/types/PromiseEx.d.ts

@@ -1,11 +0,0 @@
-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/dist/types/PromiseEx.d.ts.map

@@ -1 +0,0 @@
-{"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/dist/types/fulfilled.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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/dist/types/fulfilled.d.ts.map

@@ -1 +0,0 @@
-{"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/dist/types/fulfilledValues.d.ts

@@ -1,20 +0,0 @@
-/**
- * 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/dist/types/fulfilledValues.d.ts.map

@@ -1 +0,0 @@
-{"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/dist/types/index.d.ts

@@ -1,8 +0,0 @@
-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/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"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/dist/types/isPromise.d.ts

@@ -1,7 +0,0 @@
-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/dist/types/isPromise.d.ts.map

@@ -1 +0,0 @@
-{"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/dist/types/rejected.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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/dist/types/rejected.d.ts.map

@@ -1 +0,0 @@
-{"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/dist/types/toPromise.d.ts

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

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

@@ -1 +0,0 @@
-{"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/dist/types/types.d.ts

@@ -1,10 +0,0 @@
-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/dist/types/types.d.ts.map

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