@xylabs/promise 5.0.79 → 5.0.81

package/README.md

@@ -34,7 +34,6 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 - [PromiseExSubFunc](#type-aliases/PromiseExSubFunc)
 - [PromiseExFunc](#type-aliases/PromiseExFunc)
 - [PromiseExValueFunc](#type-aliases/PromiseExValueFunc)
-- [AnyNonPromise](#type-aliases/AnyNonPromise)
 - [Promisable](#type-aliases/Promisable)
 - [PromisableArray](#type-aliases/PromisableArray)
 - [OptionalPromisable](#type-aliases/OptionalPromisable)
@@ -42,14 +41,15 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 - [NullablePromisable](#type-aliases/NullablePromisable)
 - [NullablePromisableArray](#type-aliases/NullablePromisableArray)
 - [AsyncMutex](#type-aliases/AsyncMutex)
+- [AnyNonPromise](#type-aliases/AnyNonPromise)
 
 ## Functions
 
 - [fulfilled](#functions/fulfilled)
 - [fulfilledValues](#functions/fulfilledValues)
-- [isPromise](#functions/isPromise)
 - [rejected](#functions/rejected)
 - [toPromise](#functions/toPromise)
+- [isPromise](#functions/isPromise)
 
 ### classes
 
@@ -138,13 +138,13 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
 
 The callback to execute when the Promise is resolved.
 
-`null` | (`value`) => `TResult1` \| `PromiseLike`\<`TResult1`\>
+(`value`) => `TResult1` \| `PromiseLike`\<`TResult1`\> | `null`
 
 #### onrejected?
 
 The callback to execute when the Promise is rejected.
 
-`null` | (`reason`) => `TResult2` \| `PromiseLike`\<`TResult2`\>
+(`reason`) => `TResult2` \| `PromiseLike`\<`TResult2`\> | `null`
 
 #### onvalue?
 
@@ -266,20 +266,44 @@ const results = settled.reduce<string[]>(fulfilledValues, [])
 
 ***
 
+## Call Signature
+
 ```ts
 function isPromise(value): value is Promise<unknown>;
 ```
 
-## Parameters
+### Parameters
 
 ### value
 
 `unknown`
 
-## Returns
+### Returns
 
 `value is Promise<unknown>`
 
+## Call Signature
+
+```ts
+function isPromise<T>(value): value is Extract<T, Promise<unknown>>;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
+
+`T`
+
+### Returns
+
+`value is Extract<T, Promise<unknown>>`
+
   ### <a id="rejected"></a>rejected
 
 [**@xylabs/promise**](#../README)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/promise",
-  "version": "5.0.79",
+  "version": "5.0.81",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "promise",
@@ -29,28 +29,25 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/typeof": "~5.0.79"
+    "@xylabs/typeof": "~5.0.81",
+    "@xylabs/vitest-extended": "~5.0.81"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
-    "@xylabs/vitest-extended": "~5.0.79",
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },

package/src/PromiseEx.ts

@@ -1,32 +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 class PromiseEx<T, V = void> extends Promise<T> {
-  cancelled?: boolean
-  private _value?: V
-
-  constructor(func: PromiseExFunc<T>, value?: V) {
-    super(func)
-    this._value = value
-  }
-
-  // eslint-disable-next-line unicorn/no-thenable
-  override 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> {
-    if (onvalue?.(this._value)) {
-      this.cancelled = true
-    }
-    return super.then(onfulfilled, onrejected)
-  }
-
-  value(onvalue?: (value?: V) => boolean) {
-    if (onvalue?.(this._value)) {
-      this.cancelled = true
-    }
-    return this
-  }
-}

package/src/fulfilled.ts

@@ -1,8 +0,0 @@
-/**
- * For use with Promise.allSettled to filter only successful results
- * @param val
- * @returns
- */
-export const fulfilled = <T>(val: PromiseSettledResult<T>): val is PromiseFulfilledResult<T> => {
-  return val.status === 'fulfilled'
-}

package/src/fulfilledValues.ts

@@ -1,22 +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 const fulfilledValues = <T>(previousValue: T[], currentValue: PromiseSettledResult<T>): T[] => {
-  if (currentValue.status === 'fulfilled') previousValue.push(currentValue.value)
-  return previousValue
-}

package/src/index.ts

@@ -1,7 +0,0 @@
-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'
-export { isPromise } from '@xylabs/typeof'

package/src/rejected.ts

@@ -1,8 +0,0 @@
-/**
- * For use with Promise.allSettled to filter only rejected results
- * @param val
- * @returns
- */
-export const rejected = <T>(val: PromiseSettledResult<T>): val is PromiseRejectedResult => {
-  return val.status === 'rejected'
-}

package/src/spec/vitest.customMatchers.d.ts

@@ -1,18 +0,0 @@
-// vitest.customMatchers.d.ts
-import 'vitest'
-
-// Extend the expect Matchers interface
-declare module 'vitest' {
-  interface Assertion<T = unknown> {
-    toBeNumber(): T
-  }
-  interface Assertion<T = unknown> {
-    toBeFunction(): T
-  }
-  interface Assertion<T = unknown> {
-    toBeString(): T
-  }
-  interface Assertion<T = unknown> {
-    toBeArrayOfSize(size: number): T
-  }
-}

package/src/toPromise.ts

@@ -1,5 +0,0 @@
-import type { Promisable } from './types.ts'
-
-export function toPromise<T>(value: Promisable<T>): Promise<T> {
-  return value instanceof Promise ? value : Promise.resolve(value)
-}

package/src/types.ts

@@ -1,19 +0,0 @@
-import type { TypedValue } from '@xylabs/typeof'
-
-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>
-
-export interface PromiseType {
-  then: () => unknown
-}
-
-export type AnyNonPromise = Exclude<TypedValue, PromiseType>