@depthbomb/common 2.1.0 → 2.2.0

package/dist/collections.d.cts

@@ -1,17 +1,31 @@
 import { Maybe } from "./typing.cjs";
 
 //#region src/collections.d.ts
+/**
+ * Options for constructing a {@link BoundedQueue}.
+ */
 interface IBoundedQueueOptions {
   maxSize: number;
   overflow?: BoundedQueueOverflow;
 }
+/**
+ * Overflow behavior for {@link BoundedQueue}.
+ */
 declare const enum BoundedQueueOverflow {
   DropOldest = 0,
   DropNewest = 1,
   Throw = 2
 }
+/**
+ * FIFO queue implementation with O(1) amortized dequeue.
+ */
 declare class Queue<T> {
   #private;
+  /**
+   * Creates a queue optionally seeded with initial values.
+   *
+   * @param initial Initial values in dequeue order.
+   */
   constructor(initial?: Iterable<T>);
   /**
    * Get the number of items in the queue.
@@ -56,19 +70,63 @@ declare class Queue<T> {
    */
   toArray(): T[];
 }
+/**
+ * Queue with a fixed maximum size and configurable overflow policy.
+ */
 declare class BoundedQueue<T> {
   #private;
+  /**
+   * Creates a bounded queue.
+   *
+   * @param options Queue size and overflow behavior.
+   * @param initial Optional initial values.
+   */
   constructor(options: IBoundedQueueOptions, initial?: Iterable<T>);
+  /**
+   * Number of values currently stored in the queue.
+   */
   get size(): number;
+  /**
+   * Whether the queue currently has zero items.
+   */
   get isEmpty(): boolean;
+  /**
+   * Whether the queue has reached its maximum size.
+   */
   get isFull(): boolean;
+  /**
+   * Maximum number of elements this queue can hold.
+   */
   get maxSize(): number;
+  /**
+   * Overflow strategy applied when enqueuing into a full queue.
+   */
   get overflow(): BoundedQueueOverflow;
+  /**
+   * Adds an item to the queue, applying overflow behavior when full.
+   *
+   * @param item Item to enqueue.
+   */
   enqueue(item: T): void;
+  /**
+   * Removes and returns the item at the front of the queue.
+   */
   dequeue(): Maybe<T>;
+  /**
+   * Returns the item at the front without removing it.
+   */
   peek(): Maybe<T>;
+  /**
+   * Removes all items from the queue.
+   */
   clear(): void;
+  /**
+   * Iterates queue items from oldest to newest.
+   */
   [Symbol.iterator](): Iterator<T>;
+  /**
+   * Returns queue contents as an array in dequeue order.
+   */
   toArray(): T[];
 }
 //#endregion

package/dist/collections.d.mts

@@ -1,17 +1,31 @@
 import { Maybe } from "./typing.mjs";
 
 //#region src/collections.d.ts
+/**
+ * Options for constructing a {@link BoundedQueue}.
+ */
 interface IBoundedQueueOptions {
   maxSize: number;
   overflow?: BoundedQueueOverflow;
 }
+/**
+ * Overflow behavior for {@link BoundedQueue}.
+ */
 declare const enum BoundedQueueOverflow {
   DropOldest = 0,
   DropNewest = 1,
   Throw = 2
 }
+/**
+ * FIFO queue implementation with O(1) amortized dequeue.
+ */
 declare class Queue<T> {
   #private;
+  /**
+   * Creates a queue optionally seeded with initial values.
+   *
+   * @param initial Initial values in dequeue order.
+   */
   constructor(initial?: Iterable<T>);
   /**
    * Get the number of items in the queue.
@@ -56,19 +70,63 @@ declare class Queue<T> {
    */
   toArray(): T[];
 }
+/**
+ * Queue with a fixed maximum size and configurable overflow policy.
+ */
 declare class BoundedQueue<T> {
   #private;
+  /**
+   * Creates a bounded queue.
+   *
+   * @param options Queue size and overflow behavior.
+   * @param initial Optional initial values.
+   */
   constructor(options: IBoundedQueueOptions, initial?: Iterable<T>);
+  /**
+   * Number of values currently stored in the queue.
+   */
   get size(): number;
+  /**
+   * Whether the queue currently has zero items.
+   */
   get isEmpty(): boolean;
+  /**
+   * Whether the queue has reached its maximum size.
+   */
   get isFull(): boolean;
+  /**
+   * Maximum number of elements this queue can hold.
+   */
   get maxSize(): number;
+  /**
+   * Overflow strategy applied when enqueuing into a full queue.
+   */
   get overflow(): BoundedQueueOverflow;
+  /**
+   * Adds an item to the queue, applying overflow behavior when full.
+   *
+   * @param item Item to enqueue.
+   */
   enqueue(item: T): void;
+  /**
+   * Removes and returns the item at the front of the queue.
+   */
   dequeue(): Maybe<T>;
+  /**
+   * Returns the item at the front without removing it.
+   */
   peek(): Maybe<T>;
+  /**
+   * Removes all items from the queue.
+   */
   clear(): void;
+  /**
+   * Iterates queue items from oldest to newest.
+   */
   [Symbol.iterator](): Iterator<T>;
+  /**
+   * Returns queue contents as an array in dequeue order.
+   */
   toArray(): T[];
 }
 //#endregion

package/dist/guards.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});function e(e){return typeof e==`string`}function t(t){return e(t)&&t.length>0}function n(e){return typeof e==`number`&&Number.isFinite(e)}function r(e){return n(e)&&e>0}function i(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}function a(e){return typeof e==`function`}function o(e){return a(e)&&e.toString().startsWith(`class`)}function s(e){return e===null}function c(e){return e===void 0}function l(e){return s(e)||c(e)}function u(e){return typeof e==`boolean`}function d(e){return!!e}function f(e){return!e}function p(t){return t instanceof Date?h(t):n(t)||e(t)?h(new Date(t)):!1}const m={string:e,nonEmptyString:t,number:n,positiveNumber:r,record:i,function:a,class:o,null:s,undefined:c,nullOrUndefined:l,boolean:u,truthy:d,falsy:f,dateLike:p};function h(e){return!Number.isNaN(e.getTime())}exports.is=m,exports.isBoolean=u,exports.isClass=o,exports.isDateLike=p,exports.isFalsy=f,exports.isFunction=a,exports.isNonEmptyString=t,exports.isNull=s,exports.isNullOrUndefined=l,exports.isNumber=n,exports.isPositiveNumber=r,exports.isRecord=i,exports.isString=e,exports.isTruthy=d,exports.isUndefined=c;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});function e(e){return typeof e==`string`}function t(t){return e(t)&&t.length>0}function n(e){return typeof e==`number`&&Number.isFinite(e)}function r(e){return n(e)&&e>0}function i(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}function a(e){return typeof e==`function`}function o(e){return typeof e==`object`&&!!e&&`then`in e&&typeof e.then==`function`}function s(e){return a(e)&&e.toString().startsWith(`class`)}function c(e){return e===null}function l(e){return e===void 0}function u(e){return c(e)||l(e)}function d(e){return typeof e==`boolean`}function f(e){return!!e}function p(e){return!e}function m(t){return t instanceof Date?g(t):n(t)||e(t)?g(new Date(t)):!1}const h={string:e,nonEmptyString:t,number:n,positiveNumber:r,record:i,function:a,promise:o,class:s,null:c,undefined:l,nullOrUndefined:u,boolean:d,truthy:f,falsy:p,dateLike:m};function g(e){return!Number.isNaN(e.getTime())}exports.is=h,exports.isBoolean=d,exports.isClass=s,exports.isDateLike=m,exports.isFalsy=p,exports.isFunction=a,exports.isNonEmptyString=t,exports.isNull=c,exports.isNullOrUndefined=u,exports.isNumber=n,exports.isPositiveNumber=r,exports.isPromise=o,exports.isRecord=i,exports.isString=e,exports.isTruthy=f,exports.isUndefined=l;

package/dist/guards.d.cts

@@ -1,22 +1,107 @@
 import { Class } from "./typing.cjs";
 
 //#region src/guards.d.ts
+/**
+ * Values that coerce to `false` in JavaScript conditionals.
+ */
 type Falsy = false | 0 | 0n | '' | null | undefined;
+/**
+ * Inputs that can be converted into a valid date.
+ */
 type DateLike = Date | string | number;
+/**
+ * Returns `true` when `value` is a string.
+ *
+ * @param value Value to check.
+ */
 declare function isString(value: unknown): value is string;
+/**
+ * Returns `true` when `value` is a string with at least one character.
+ *
+ * @param value Value to check.
+ */
 declare function isNonEmptyString(value: unknown): value is string;
+/**
+ * Returns `true` when `value` is a finite number.
+ *
+ * @param value Value to check.
+ */
 declare function isNumber(value: unknown): value is number;
+/**
+ * Returns `true` when `value` is a finite number greater than `0`.
+ *
+ * @param value Value to check.
+ */
 declare function isPositiveNumber(value: unknown): value is number;
+/**
+ * Returns `true` when `value` is a non-null object and not an array.
+ *
+ * @param value Value to check.
+ */
 declare function isRecord(value: unknown): value is Record<string, unknown>;
+/**
+ * Returns `true` when `value` is callable.
+ *
+ * @param value Value to check.
+ */
 declare function isFunction(value: unknown): value is Function;
+/**
+ * Returns `true` when `value` is a {@link PromiseConstructor|Promise}.
+ *
+ * @param value Value to check.
+ */
+declare function isPromise<T = unknown>(value: unknown): value is Promise<T>;
+/**
+ * Returns `true` when `value` is an ES class constructor.
+ *
+ * @param value Value to check.
+ */
 declare function isClass<T = unknown>(value: unknown): value is Class<T>;
+/**
+ * Returns `true` when `value` is `null`.
+ *
+ * @param value Value to check.
+ */
 declare function isNull(value: unknown): value is null;
+/**
+ * Returns `true` when `value` is `undefined`.
+ *
+ * @param value Value to check.
+ */
 declare function isUndefined(value: unknown): value is undefined;
+/**
+ * Returns `true` when `value` is either `null` or `undefined`.
+ *
+ * @param value Value to check.
+ */
 declare function isNullOrUndefined(value: unknown): value is null | undefined;
+/**
+ * Returns `true` when `value` is a boolean.
+ *
+ * @param value Value to check.
+ */
 declare function isBoolean(value: unknown): value is boolean;
+/**
+ * Returns `true` when `value` is truthy.
+ *
+ * @param value Value to check.
+ */
 declare function isTruthy<T>(value: T | Falsy): value is T;
+/**
+ * Returns `true` when `value` is falsy.
+ *
+ * @param value Value to check.
+ */
 declare function isFalsy(value: unknown): value is Falsy;
+/**
+ * Returns `true` when `value` can be converted to a valid `Date`.
+ *
+ * @param value Value to check.
+ */
 declare function isDateLike(value: unknown): value is DateLike;
+/**
+ * Namespaced aliases for all guard helpers.
+ */
 declare const is: {
   string: typeof isString;
   nonEmptyString: typeof isNonEmptyString;
@@ -24,6 +109,7 @@ declare const is: {
   positiveNumber: typeof isPositiveNumber;
   record: typeof isRecord;
   function: typeof isFunction;
+  promise: typeof isPromise;
   class: typeof isClass;
   null: typeof isNull;
   undefined: typeof isUndefined;
@@ -34,4 +120,4 @@ declare const is: {
   dateLike: typeof isDateLike;
 };
 //#endregion
-export { DateLike, Falsy, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isPositiveNumber, isRecord, isString, isTruthy, isUndefined };
+export { DateLike, Falsy, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isPositiveNumber, isPromise, isRecord, isString, isTruthy, isUndefined };

package/dist/guards.d.mts

@@ -1,22 +1,107 @@
 import { Class } from "./typing.mjs";
 
 //#region src/guards.d.ts
+/**
+ * Values that coerce to `false` in JavaScript conditionals.
+ */
 type Falsy = false | 0 | 0n | '' | null | undefined;
+/**
+ * Inputs that can be converted into a valid date.
+ */
 type DateLike = Date | string | number;
+/**
+ * Returns `true` when `value` is a string.
+ *
+ * @param value Value to check.
+ */
 declare function isString(value: unknown): value is string;
+/**
+ * Returns `true` when `value` is a string with at least one character.
+ *
+ * @param value Value to check.
+ */
 declare function isNonEmptyString(value: unknown): value is string;
+/**
+ * Returns `true` when `value` is a finite number.
+ *
+ * @param value Value to check.
+ */
 declare function isNumber(value: unknown): value is number;
+/**
+ * Returns `true` when `value` is a finite number greater than `0`.
+ *
+ * @param value Value to check.
+ */
 declare function isPositiveNumber(value: unknown): value is number;
+/**
+ * Returns `true` when `value` is a non-null object and not an array.
+ *
+ * @param value Value to check.
+ */
 declare function isRecord(value: unknown): value is Record<string, unknown>;
+/**
+ * Returns `true` when `value` is callable.
+ *
+ * @param value Value to check.
+ */
 declare function isFunction(value: unknown): value is Function;
+/**
+ * Returns `true` when `value` is a {@link PromiseConstructor|Promise}.
+ *
+ * @param value Value to check.
+ */
+declare function isPromise<T = unknown>(value: unknown): value is Promise<T>;
+/**
+ * Returns `true` when `value` is an ES class constructor.
+ *
+ * @param value Value to check.
+ */
 declare function isClass<T = unknown>(value: unknown): value is Class<T>;
+/**
+ * Returns `true` when `value` is `null`.
+ *
+ * @param value Value to check.
+ */
 declare function isNull(value: unknown): value is null;
+/**
+ * Returns `true` when `value` is `undefined`.
+ *
+ * @param value Value to check.
+ */
 declare function isUndefined(value: unknown): value is undefined;
+/**
+ * Returns `true` when `value` is either `null` or `undefined`.
+ *
+ * @param value Value to check.
+ */
 declare function isNullOrUndefined(value: unknown): value is null | undefined;
+/**
+ * Returns `true` when `value` is a boolean.
+ *
+ * @param value Value to check.
+ */
 declare function isBoolean(value: unknown): value is boolean;
+/**
+ * Returns `true` when `value` is truthy.
+ *
+ * @param value Value to check.
+ */
 declare function isTruthy<T>(value: T | Falsy): value is T;
+/**
+ * Returns `true` when `value` is falsy.
+ *
+ * @param value Value to check.
+ */
 declare function isFalsy(value: unknown): value is Falsy;
+/**
+ * Returns `true` when `value` can be converted to a valid `Date`.
+ *
+ * @param value Value to check.
+ */
 declare function isDateLike(value: unknown): value is DateLike;
+/**
+ * Namespaced aliases for all guard helpers.
+ */
 declare const is: {
   string: typeof isString;
   nonEmptyString: typeof isNonEmptyString;
@@ -24,6 +109,7 @@ declare const is: {
   positiveNumber: typeof isPositiveNumber;
   record: typeof isRecord;
   function: typeof isFunction;
+  promise: typeof isPromise;
   class: typeof isClass;
   null: typeof isNull;
   undefined: typeof isUndefined;
@@ -34,4 +120,4 @@ declare const is: {
   dateLike: typeof isDateLike;
 };
 //#endregion
-export { DateLike, Falsy, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isPositiveNumber, isRecord, isString, isTruthy, isUndefined };
+export { DateLike, Falsy, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isPositiveNumber, isPromise, isRecord, isString, isTruthy, isUndefined };

package/dist/guards.mjs

@@ -1 +1 @@
-function e(e){return typeof e==`string`}function t(t){return e(t)&&t.length>0}function n(e){return typeof e==`number`&&Number.isFinite(e)}function r(e){return n(e)&&e>0}function i(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}function a(e){return typeof e==`function`}function o(e){return a(e)&&e.toString().startsWith(`class`)}function s(e){return e===null}function c(e){return e===void 0}function l(e){return s(e)||c(e)}function u(e){return typeof e==`boolean`}function d(e){return!!e}function f(e){return!e}function p(t){return t instanceof Date?h(t):n(t)||e(t)?h(new Date(t)):!1}const m={string:e,nonEmptyString:t,number:n,positiveNumber:r,record:i,function:a,class:o,null:s,undefined:c,nullOrUndefined:l,boolean:u,truthy:d,falsy:f,dateLike:p};function h(e){return!Number.isNaN(e.getTime())}export{m as is,u as isBoolean,o as isClass,p as isDateLike,f as isFalsy,a as isFunction,t as isNonEmptyString,s as isNull,l as isNullOrUndefined,n as isNumber,r as isPositiveNumber,i as isRecord,e as isString,d as isTruthy,c as isUndefined};
+function e(e){return typeof e==`string`}function t(t){return e(t)&&t.length>0}function n(e){return typeof e==`number`&&Number.isFinite(e)}function r(e){return n(e)&&e>0}function i(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}function a(e){return typeof e==`function`}function o(e){return typeof e==`object`&&!!e&&`then`in e&&typeof e.then==`function`}function s(e){return a(e)&&e.toString().startsWith(`class`)}function c(e){return e===null}function l(e){return e===void 0}function u(e){return c(e)||l(e)}function d(e){return typeof e==`boolean`}function f(e){return!!e}function p(e){return!e}function m(t){return t instanceof Date?g(t):n(t)||e(t)?g(new Date(t)):!1}const h={string:e,nonEmptyString:t,number:n,positiveNumber:r,record:i,function:a,promise:o,class:s,null:c,undefined:l,nullOrUndefined:u,boolean:d,truthy:f,falsy:p,dateLike:m};function g(e){return!Number.isNaN(e.getTime())}export{h as is,d as isBoolean,s as isClass,m as isDateLike,p as isFalsy,a as isFunction,t as isNonEmptyString,c as isNull,u as isNullOrUndefined,n as isNumber,r as isPositiveNumber,o as isPromise,i as isRecord,e as isString,f as isTruthy,l as isUndefined};

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./collections.cjs`),t=require(`./decorators.cjs`),n=require(`./functional.cjs`),r=require(`./guards.cjs`),i=require(`./timing.cjs`),a=require(`./promise.cjs`),o=require(`./lazy.cjs`),s=require(`./number.cjs`),c=require(`./random.cjs`),l=require(`./state.cjs`),u=require(`./typing.cjs`),d=require(`./url.cjs`);exports.BoundedQueue=e.BoundedQueue,exports.BoundedQueueOverflow=e.BoundedQueueOverflow,exports.Flag=l.Flag,exports.Queue=e.Queue,exports.ResettableValue=l.ResettableValue,exports.RetryJitter=i.RetryJitter,exports.URLPath=d.URLPath,exports.abortAfter=i.abortAfter,exports.allSettledDetailed=a.allSettledDetailed,exports.allSettledSuccessful=a.allSettledSuccessful,exports.assume=u.assume,exports.average=s.average,exports.cache=t.cache,exports.cast=u.cast,exports.clamp=s.clamp,exports.err=u.err,exports.inRange=s.inRange,exports.is=r.is,exports.isBoolean=r.isBoolean,exports.isClass=r.isClass,exports.isDateLike=r.isDateLike,exports.isFalsy=r.isFalsy,exports.isFunction=r.isFunction,exports.isNonEmptyString=r.isNonEmptyString,exports.isNull=r.isNull,exports.isNullOrUndefined=r.isNullOrUndefined,exports.isNumber=r.isNumber,exports.isOk=u.isOk,exports.isPositiveNumber=r.isPositiveNumber,exports.isRecord=r.isRecord,exports.isString=r.isString,exports.isTruthy=r.isTruthy,exports.isUndefined=r.isUndefined,exports.lazy=o.lazy,exports.lazyAsync=o.lazyAsync,exports.mapErr=u.mapErr,exports.mapOk=u.mapOk,exports.ok=u.ok,exports.once=n.once,exports.pMap=a.pMap,exports.pickRandom=c.pickRandom,exports.pickWeighted=c.pickWeighted,exports.pollUntil=i.pollUntil,exports.pool=a.pool,exports.raceSignals=i.raceSignals,exports.randomFloat=c.randomFloat,exports.randomInt=c.randomInt,exports.rejectionTimeout=i.rejectionTimeout,exports.resettableLazy=l.resettableLazy,exports.resettableLazyAsync=l.resettableLazyAsync,exports.retry=i.retry,exports.roundTo=s.roundTo,exports.sequential=a.sequential,exports.sum=s.sum,exports.timeout=i.timeout,exports.tryCatchAsync=u.tryCatchAsync,exports.typedEntries=u.typedEntries,exports.url=d.url,exports.withAbort=i.withAbort,exports.withTimeout=i.withTimeout;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./collections.cjs`),t=require(`./decorators.cjs`),n=require(`./functional.cjs`),r=require(`./guards.cjs`),i=require(`./timing.cjs`),a=require(`./promise.cjs`),o=require(`./lazy.cjs`),s=require(`./number.cjs`),c=require(`./random.cjs`),l=require(`./state.cjs`),u=require(`./typing.cjs`),d=require(`./url.cjs`);exports.BoundedQueue=e.BoundedQueue,exports.BoundedQueueOverflow=e.BoundedQueueOverflow,exports.Flag=l.Flag,exports.Queue=e.Queue,exports.ResettableValue=l.ResettableValue,exports.RetryJitter=i.RetryJitter,exports.URLPath=d.URLPath,exports.abortAfter=i.abortAfter,exports.allSettledDetailed=a.allSettledDetailed,exports.allSettledSuccessful=a.allSettledSuccessful,exports.assume=u.assume,exports.average=s.average,exports.cache=t.cache,exports.cast=u.cast,exports.clamp=s.clamp,exports.err=u.err,exports.inRange=s.inRange,exports.is=r.is,exports.isBoolean=r.isBoolean,exports.isClass=r.isClass,exports.isDateLike=r.isDateLike,exports.isFalsy=r.isFalsy,exports.isFunction=r.isFunction,exports.isNonEmptyString=r.isNonEmptyString,exports.isNull=r.isNull,exports.isNullOrUndefined=r.isNullOrUndefined,exports.isNumber=r.isNumber,exports.isOk=u.isOk,exports.isPositiveNumber=r.isPositiveNumber,exports.isPromise=r.isPromise,exports.isRecord=r.isRecord,exports.isString=r.isString,exports.isTruthy=r.isTruthy,exports.isUndefined=r.isUndefined,exports.lazy=o.lazy,exports.lazyAsync=o.lazyAsync,exports.mapErr=u.mapErr,exports.mapOk=u.mapOk,exports.ok=u.ok,exports.once=n.once,exports.pMap=a.pMap,exports.pickRandom=c.pickRandom,exports.pickWeighted=c.pickWeighted,exports.pollUntil=i.pollUntil,exports.pool=a.pool,exports.raceSignals=i.raceSignals,exports.randomFloat=c.randomFloat,exports.randomInt=c.randomInt,exports.rejectionTimeout=i.rejectionTimeout,exports.resettableLazy=l.resettableLazy,exports.resettableLazyAsync=l.resettableLazyAsync,exports.retry=i.retry,exports.roundTo=s.roundTo,exports.sequential=a.sequential,exports.sum=s.sum,exports.timeout=i.timeout,exports.tryCatchAsync=u.tryCatchAsync,exports.typedEntries=u.typedEntries,exports.url=d.url,exports.withAbort=i.withAbort,exports.withTimeout=i.withTimeout;

package/dist/index.d.cts

@@ -1,8 +1,8 @@
-import { Arrayable, Awaitable, Class, Maybe, Nullable, Prettify, Result, assume, cast, err, isOk, mapErr, mapOk, ok, tryCatchAsync, typedEntries } from "./typing.cjs";
+import { Arrayable, Awaitable, AwaitableFn, Class, Fn, Maybe, Nullable, Prettify, Result, assume, cast, err, isOk, mapErr, mapOk, ok, tryCatchAsync, typedEntries } from "./typing.cjs";
 import { BoundedQueue, BoundedQueueOverflow, IBoundedQueueOptions, Queue } from "./collections.cjs";
 import { cache } from "./decorators.cjs";
 import { once } from "./functional.cjs";
-import { DateLike, Falsy, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isPositiveNumber, isRecord, isString, isTruthy, isUndefined } from "./guards.cjs";
+import { DateLike, Falsy, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isPositiveNumber, isPromise, isRecord, isString, isTruthy, isUndefined } from "./guards.cjs";
 import { IRetryOptions, RetryJitter, abortAfter, pollUntil, raceSignals, rejectionTimeout, retry, timeout, withAbort, withTimeout } from "./timing.cjs";
 import { IConcurrencyOptions, SettledDetailed, allSettledDetailed, allSettledSuccessful, pMap, pool, sequential } from "./promise.cjs";
 import { lazy, lazyAsync } from "./lazy.cjs";
@@ -10,4 +10,4 @@ import { average, clamp, inRange, roundTo, sum } from "./number.cjs";
 import { IWeightedItem, pickRandom, pickWeighted, randomFloat, randomInt } from "./random.cjs";
 import { Flag, ResettableValue, resettableLazy, resettableLazyAsync } from "./state.cjs";
 import { QueryObject, QueryValue, URLLike, URLPath, url } from "./url.cjs";
-export { Arrayable, Awaitable, BoundedQueue, BoundedQueueOverflow, Class, DateLike, Falsy, Flag, IBoundedQueueOptions, IConcurrencyOptions, IRetryOptions, IWeightedItem, Maybe, Nullable, Prettify, QueryObject, QueryValue, Queue, ResettableValue, Result, RetryJitter, SettledDetailed, URLLike, URLPath, abortAfter, allSettledDetailed, allSettledSuccessful, assume, average, cache, cast, clamp, err, inRange, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isOk, isPositiveNumber, isRecord, isString, isTruthy, isUndefined, lazy, lazyAsync, mapErr, mapOk, ok, once, pMap, pickRandom, pickWeighted, pollUntil, pool, raceSignals, randomFloat, randomInt, rejectionTimeout, resettableLazy, resettableLazyAsync, retry, roundTo, sequential, sum, timeout, tryCatchAsync, typedEntries, url, withAbort, withTimeout };
+export { Arrayable, Awaitable, AwaitableFn, BoundedQueue, BoundedQueueOverflow, Class, DateLike, Falsy, Flag, Fn, IBoundedQueueOptions, IConcurrencyOptions, IRetryOptions, IWeightedItem, Maybe, Nullable, Prettify, QueryObject, QueryValue, Queue, ResettableValue, Result, RetryJitter, SettledDetailed, URLLike, URLPath, abortAfter, allSettledDetailed, allSettledSuccessful, assume, average, cache, cast, clamp, err, inRange, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isOk, isPositiveNumber, isPromise, isRecord, isString, isTruthy, isUndefined, lazy, lazyAsync, mapErr, mapOk, ok, once, pMap, pickRandom, pickWeighted, pollUntil, pool, raceSignals, randomFloat, randomInt, rejectionTimeout, resettableLazy, resettableLazyAsync, retry, roundTo, sequential, sum, timeout, tryCatchAsync, typedEntries, url, withAbort, withTimeout };

package/dist/index.d.mts

@@ -1,8 +1,8 @@
-import { Arrayable, Awaitable, Class, Maybe, Nullable, Prettify, Result, assume, cast, err, isOk, mapErr, mapOk, ok, tryCatchAsync, typedEntries } from "./typing.mjs";
+import { Arrayable, Awaitable, AwaitableFn, Class, Fn, Maybe, Nullable, Prettify, Result, assume, cast, err, isOk, mapErr, mapOk, ok, tryCatchAsync, typedEntries } from "./typing.mjs";
 import { BoundedQueue, BoundedQueueOverflow, IBoundedQueueOptions, Queue } from "./collections.mjs";
 import { cache } from "./decorators.mjs";
 import { once } from "./functional.mjs";
-import { DateLike, Falsy, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isPositiveNumber, isRecord, isString, isTruthy, isUndefined } from "./guards.mjs";
+import { DateLike, Falsy, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isPositiveNumber, isPromise, isRecord, isString, isTruthy, isUndefined } from "./guards.mjs";
 import { IRetryOptions, RetryJitter, abortAfter, pollUntil, raceSignals, rejectionTimeout, retry, timeout, withAbort, withTimeout } from "./timing.mjs";
 import { IConcurrencyOptions, SettledDetailed, allSettledDetailed, allSettledSuccessful, pMap, pool, sequential } from "./promise.mjs";
 import { lazy, lazyAsync } from "./lazy.mjs";
@@ -10,4 +10,4 @@ import { average, clamp, inRange, roundTo, sum } from "./number.mjs";
 import { IWeightedItem, pickRandom, pickWeighted, randomFloat, randomInt } from "./random.mjs";
 import { Flag, ResettableValue, resettableLazy, resettableLazyAsync } from "./state.mjs";
 import { QueryObject, QueryValue, URLLike, URLPath, url } from "./url.mjs";
-export { Arrayable, Awaitable, BoundedQueue, BoundedQueueOverflow, Class, DateLike, Falsy, Flag, IBoundedQueueOptions, IConcurrencyOptions, IRetryOptions, IWeightedItem, Maybe, Nullable, Prettify, QueryObject, QueryValue, Queue, ResettableValue, Result, RetryJitter, SettledDetailed, URLLike, URLPath, abortAfter, allSettledDetailed, allSettledSuccessful, assume, average, cache, cast, clamp, err, inRange, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isOk, isPositiveNumber, isRecord, isString, isTruthy, isUndefined, lazy, lazyAsync, mapErr, mapOk, ok, once, pMap, pickRandom, pickWeighted, pollUntil, pool, raceSignals, randomFloat, randomInt, rejectionTimeout, resettableLazy, resettableLazyAsync, retry, roundTo, sequential, sum, timeout, tryCatchAsync, typedEntries, url, withAbort, withTimeout };
+export { Arrayable, Awaitable, AwaitableFn, BoundedQueue, BoundedQueueOverflow, Class, DateLike, Falsy, Flag, Fn, IBoundedQueueOptions, IConcurrencyOptions, IRetryOptions, IWeightedItem, Maybe, Nullable, Prettify, QueryObject, QueryValue, Queue, ResettableValue, Result, RetryJitter, SettledDetailed, URLLike, URLPath, abortAfter, allSettledDetailed, allSettledSuccessful, assume, average, cache, cast, clamp, err, inRange, is, isBoolean, isClass, isDateLike, isFalsy, isFunction, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isOk, isPositiveNumber, isPromise, isRecord, isString, isTruthy, isUndefined, lazy, lazyAsync, mapErr, mapOk, ok, once, pMap, pickRandom, pickWeighted, pollUntil, pool, raceSignals, randomFloat, randomInt, rejectionTimeout, resettableLazy, resettableLazyAsync, retry, roundTo, sequential, sum, timeout, tryCatchAsync, typedEntries, url, withAbort, withTimeout };

package/dist/index.mjs

@@ -1 +1 @@
-import{BoundedQueue as e,BoundedQueueOverflow as t,Queue as n}from"./collections.mjs";import{cache as r}from"./decorators.mjs";import{once as i}from"./functional.mjs";import{is as a,isBoolean as o,isClass as s,isDateLike as c,isFalsy as l,isFunction as u,isNonEmptyString as d,isNull as f,isNullOrUndefined as p,isNumber as m,isPositiveNumber as h,isRecord as g,isString as _,isTruthy as v,isUndefined as y}from"./guards.mjs";import{RetryJitter as b,abortAfter as x,pollUntil as S,raceSignals as C,rejectionTimeout as w,retry as T,timeout as E,withAbort as D,withTimeout as O}from"./timing.mjs";import{allSettledDetailed as k,allSettledSuccessful as A,pMap as j,pool as M,sequential as N}from"./promise.mjs";import{lazy as P,lazyAsync as F}from"./lazy.mjs";import{average as I,clamp as L,inRange as R,roundTo as z,sum as B}from"./number.mjs";import{pickRandom as V,pickWeighted as H,randomFloat as U,randomInt as W}from"./random.mjs";import{Flag as G,ResettableValue as K,resettableLazy as q,resettableLazyAsync as J}from"./state.mjs";import{assume as Y,cast as X,err as Z,isOk as Q,mapErr as $,mapOk as ee,ok as te,tryCatchAsync as ne,typedEntries as re}from"./typing.mjs";import{URLPath as ie,url as ae}from"./url.mjs";export{e as BoundedQueue,t as BoundedQueueOverflow,G as Flag,n as Queue,K as ResettableValue,b as RetryJitter,ie as URLPath,x as abortAfter,k as allSettledDetailed,A as allSettledSuccessful,Y as assume,I as average,r as cache,X as cast,L as clamp,Z as err,R as inRange,a as is,o as isBoolean,s as isClass,c as isDateLike,l as isFalsy,u as isFunction,d as isNonEmptyString,f as isNull,p as isNullOrUndefined,m as isNumber,Q as isOk,h as isPositiveNumber,g as isRecord,_ as isString,v as isTruthy,y as isUndefined,P as lazy,F as lazyAsync,$ as mapErr,ee as mapOk,te as ok,i as once,j as pMap,V as pickRandom,H as pickWeighted,S as pollUntil,M as pool,C as raceSignals,U as randomFloat,W as randomInt,w as rejectionTimeout,q as resettableLazy,J as resettableLazyAsync,T as retry,z as roundTo,N as sequential,B as sum,E as timeout,ne as tryCatchAsync,re as typedEntries,ae as url,D as withAbort,O as withTimeout};
+import{BoundedQueue as e,BoundedQueueOverflow as t,Queue as n}from"./collections.mjs";import{cache as r}from"./decorators.mjs";import{once as i}from"./functional.mjs";import{is as a,isBoolean as o,isClass as s,isDateLike as c,isFalsy as l,isFunction as u,isNonEmptyString as d,isNull as f,isNullOrUndefined as p,isNumber as m,isPositiveNumber as h,isPromise as g,isRecord as _,isString as v,isTruthy as y,isUndefined as b}from"./guards.mjs";import{RetryJitter as x,abortAfter as S,pollUntil as C,raceSignals as w,rejectionTimeout as T,retry as E,timeout as D,withAbort as O,withTimeout as k}from"./timing.mjs";import{allSettledDetailed as A,allSettledSuccessful as j,pMap as M,pool as N,sequential as P}from"./promise.mjs";import{lazy as F,lazyAsync as I}from"./lazy.mjs";import{average as L,clamp as R,inRange as z,roundTo as B,sum as V}from"./number.mjs";import{pickRandom as H,pickWeighted as U,randomFloat as W,randomInt as G}from"./random.mjs";import{Flag as K,ResettableValue as q,resettableLazy as J,resettableLazyAsync as Y}from"./state.mjs";import{assume as X,cast as Z,err as Q,isOk as $,mapErr as ee,mapOk as te,ok as ne,tryCatchAsync as re,typedEntries as ie}from"./typing.mjs";import{URLPath as ae,url as oe}from"./url.mjs";export{e as BoundedQueue,t as BoundedQueueOverflow,K as Flag,n as Queue,q as ResettableValue,x as RetryJitter,ae as URLPath,S as abortAfter,A as allSettledDetailed,j as allSettledSuccessful,X as assume,L as average,r as cache,Z as cast,R as clamp,Q as err,z as inRange,a as is,o as isBoolean,s as isClass,c as isDateLike,l as isFalsy,u as isFunction,d as isNonEmptyString,f as isNull,p as isNullOrUndefined,m as isNumber,$ as isOk,h as isPositiveNumber,g as isPromise,_ as isRecord,v as isString,y as isTruthy,b as isUndefined,F as lazy,I as lazyAsync,ee as mapErr,te as mapOk,ne as ok,i as once,M as pMap,H as pickRandom,U as pickWeighted,C as pollUntil,N as pool,w as raceSignals,W as randomFloat,G as randomInt,T as rejectionTimeout,J as resettableLazy,Y as resettableLazyAsync,E as retry,B as roundTo,P as sequential,V as sum,D as timeout,re as tryCatchAsync,ie as typedEntries,oe as url,O as withAbort,k as withTimeout};

package/dist/lazy.d.cts

@@ -1,5 +1,17 @@
 //#region src/lazy.d.ts
+/**
+ * Creates a getter that computes its value once and then returns the cached result.
+ *
+ * @param factory Function used to create the value.
+ * @returns A zero-argument getter for the lazily-created value.
+ */
 declare function lazy<T>(factory: () => T): () => T;
+/**
+ * Creates a getter that runs an async factory once and reuses the same promise.
+ *
+ * @param factory Async function used to create the value.
+ * @returns A zero-argument getter returning the cached promise.
+ */
 declare function lazyAsync<T>(factory: () => Promise<T>): () => Promise<T>;
 //#endregion
 export { lazy, lazyAsync };

package/dist/lazy.d.mts

@@ -1,5 +1,17 @@
 //#region src/lazy.d.ts
+/**
+ * Creates a getter that computes its value once and then returns the cached result.
+ *
+ * @param factory Function used to create the value.
+ * @returns A zero-argument getter for the lazily-created value.
+ */
 declare function lazy<T>(factory: () => T): () => T;
+/**
+ * Creates a getter that runs an async factory once and reuses the same promise.
+ *
+ * @param factory Async function used to create the value.
+ * @returns A zero-argument getter returning the cached promise.
+ */
 declare function lazyAsync<T>(factory: () => Promise<T>): () => Promise<T>;
 //#endregion
 export { lazy, lazyAsync };

package/dist/number.d.cts

@@ -1,8 +1,39 @@
 //#region src/number.d.ts
+/**
+ * Restricts a number to the closed interval `[min, max]`.
+ *
+ * @param value Input value.
+ * @param min Lower bound.
+ * @param max Upper bound.
+ */
 declare function clamp(value: number, min: number, max: number): number;
+/**
+ * Returns whether a number is within the provided range.
+ *
+ * @param value Input value.
+ * @param min Lower bound.
+ * @param max Upper bound.
+ * @param inclusive Whether range endpoints are included.
+ */
 declare function inRange(value: number, min: number, max: number, inclusive?: boolean): boolean;
+/**
+ * Rounds a number to a fixed count of decimal places.
+ *
+ * @param value Number to round.
+ * @param decimals Decimal places to keep.
+ */
 declare function roundTo(value: number, decimals?: number): number;
+/**
+ * Sums all numbers from an iterable.
+ *
+ * @param values Numbers to add.
+ */
 declare function sum(values: Iterable<number>): number;
+/**
+ * Calculates the arithmetic mean of numbers from an iterable.
+ *
+ * @param values Numbers to average.
+ */
 declare function average(values: Iterable<number>): number;
 //#endregion
 export { average, clamp, inRange, roundTo, sum };

package/dist/number.d.mts

@@ -1,8 +1,39 @@
 //#region src/number.d.ts
+/**
+ * Restricts a number to the closed interval `[min, max]`.
+ *
+ * @param value Input value.
+ * @param min Lower bound.
+ * @param max Upper bound.
+ */
 declare function clamp(value: number, min: number, max: number): number;
+/**
+ * Returns whether a number is within the provided range.
+ *
+ * @param value Input value.
+ * @param min Lower bound.
+ * @param max Upper bound.
+ * @param inclusive Whether range endpoints are included.
+ */
 declare function inRange(value: number, min: number, max: number, inclusive?: boolean): boolean;
+/**
+ * Rounds a number to a fixed count of decimal places.
+ *
+ * @param value Number to round.
+ * @param decimals Decimal places to keep.
+ */
 declare function roundTo(value: number, decimals?: number): number;
+/**
+ * Sums all numbers from an iterable.
+ *
+ * @param values Numbers to add.
+ */
 declare function sum(values: Iterable<number>): number;
+/**
+ * Calculates the arithmetic mean of numbers from an iterable.
+ *
+ * @param values Numbers to average.
+ */
 declare function average(values: Iterable<number>): number;
 //#endregion
 export { average, clamp, inRange, roundTo, sum };

package/dist/promise.d.cts

@@ -1,6 +1,9 @@
 import { Awaitable } from "./typing.cjs";
 
 //#region src/promise.d.ts
+/**
+ * Configuration for promise concurrency helpers.
+ */
 interface IConcurrencyOptions {
   concurrency?: number;
 }
@@ -11,6 +14,9 @@ interface IConcurrencyOptions {
  * @returns A promise that resolves to an array of successful results
  */
 declare function allSettledSuccessful<T>(promises: Array<Awaitable<T>>): Promise<T[]>;
+/**
+ * Detailed output from {@link allSettledDetailed}.
+ */
 interface SettledDetailed<T> {
   results: Array<PromiseSettledResult<T>>;
   fulfilled: T[];