@xylabs/promise 4.15.1 → 4.15.2

package/dist/neutral/index.d.ts

@@ -1,4 +1,5 @@
 import { TypedValue } from '@xylabs/typeof';
+export { isPromise } from '@xylabs/typeof';
 
 /**
  * For use with Promise.allSettled to filter only successful results
@@ -27,11 +28,12 @@ declare const fulfilled: <T>(val: PromiseSettledResult<T>) => val is PromiseFulf
  */
 declare const fulfilledValues: <T>(previousValue: T[], currentValue: PromiseSettledResult<T>) => T[];
 
+/** @deprecated */
 interface PromiseType {
     then: () => unknown;
 }
+/** @deprecated */
 type AnyNonPromise = Exclude<TypedValue, PromiseType>;
-declare const isPromise: (value: unknown) => value is Promise<unknown>;
 
 type PromiseExSubFunc<T, TResult = T> = (value: T) => TResult;
 type PromiseExFunc<T> = (resolve?: PromiseExSubFunc<T, void>, reject?: PromiseExSubFunc<T, void>) => void;
@@ -62,5 +64,5 @@ type AsyncMutex<T> = Promise<T>;
 
 declare function toPromise<T>(value: Promisable<T>): Promise<T>;
 
-export { PromiseEx, fulfilled, fulfilledValues, isPromise, rejected, toPromise };
+export { PromiseEx, fulfilled, fulfilledValues, rejected, toPromise };
 export type { AnyNonPromise, AsyncMutex, NullablePromisable, NullablePromisableArray, OptionalPromisable, OptionalPromisableArray, Promisable, PromisableArray, PromiseExFunc, PromiseExSubFunc, PromiseExValueFunc, PromiseType };

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

@@ -1 +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"}
+{"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;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/neutral/index.mjs

@@ -9,14 +9,6 @@ var fulfilledValues = (previousValue, currentValue) => {
   return previousValue;
 };
 
-// src/isPromise.ts
-var isPromise = (value) => {
-  if (typeof value === "object" && !Array.isArray(value)) {
-    return typeof value.then === "function";
-  }
-  return false;
-};
-
 // src/PromiseEx.ts
 var PromiseEx = class extends Promise {
   cancelled;
@@ -49,6 +41,9 @@ var rejected = (val) => {
 function toPromise(value) {
   return value instanceof Promise ? value : Promise.resolve(value);
 }
+
+// src/index.ts
+import { isPromise } from "@xylabs/typeof";
 export {
   PromiseEx,
   fulfilled,

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fulfilled.ts","../../src/fulfilledValues.ts","../../src/isPromise.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","import type { TypedValue } from '@xylabs/typeof'\n\nexport interface PromiseType {\n  then: () => unknown\n}\n\nexport type AnyNonPromise = Exclude<TypedValue, PromiseType>\n\nexport const isPromise = (value: unknown): value is Promise<unknown> => {\n  if (typeof value === 'object' && !Array.isArray(value)) {\n    return typeof (value as PromiseType).then === 'function'\n  }\n  return false\n}\n\n// type test\n/*\nconst x = Promise.resolve()\n\nconst f = (x: AnyNonPromise) => {\n  return x\n}\n\nf(x)\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"],"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;;;ACbO,IAAM,YAAY,CAAC,UAA8C;AACtE,MAAI,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK,GAAG;AACtD,WAAO,OAAQ,MAAsB,SAAS;AAAA,EAChD;AACA,SAAO;AACT;;;ACTO,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;","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","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 './isPromise.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;;;ACGA,SAAS,iBAAiB;","names":[]}

package/dist/neutral/isPromise.d.ts

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

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

@@ -1 +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"}
+{"version":3,"file":"isPromise.d.ts","sourceRoot":"","sources":["../../src/isPromise.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,kBAAkB;AAClB,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,OAAO,CAAA;CACpB;AAED,kBAAkB;AAElB,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/promise",
-  "version": "4.15.1",
+  "version": "4.15.2",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "promise",
@@ -42,12 +42,12 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/typeof": "^4.15.1"
+    "@xylabs/typeof": "^4.15.2"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^7.0.1",
     "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.1",
+    "@xylabs/vitest-extended": "^4.15.2",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/index.ts

@@ -5,3 +5,4 @@ export * from './PromiseEx.ts'
 export { rejected } from './rejected.ts'
 export * from './toPromise.ts'
 export * from './types.ts'
+export { isPromise } from '@xylabs/typeof'

package/src/isPromise.ts

@@ -1,17 +1,22 @@
 import type { TypedValue } from '@xylabs/typeof'
 
+/** @deprecated */
 export interface PromiseType {
   then: () => unknown
 }
 
+/** @deprecated */
+// eslint-disable-next-line sonarjs/deprecation
 export type AnyNonPromise = Exclude<TypedValue, PromiseType>
 
+/*
 export const isPromise = (value: unknown): value is Promise<unknown> => {
   if (typeof value === 'object' && !Array.isArray(value)) {
     return typeof (value as PromiseType).then === 'function'
   }
   return false
 }
+*/
 
 // type test
 /*