@oscarpalmer/atoms 0.186.2 → 0.187.0

package/dist/promise/models.mjs

@@ -1,6 +1,6 @@
 //#region src/promise/models.ts
 /**
-* A promise that can be canceled
+* A _Promise_ that can be canceled
 */
 var CancelablePromise = class extends Promise {
 	#rejector;
@@ -13,8 +13,9 @@ var CancelablePromise = class extends Promise {
 		this.#rejector = rejector;
 	}
 	/**
-	* Cancel the promise, rejecting it with an optional reason
-	* @param reason Optional reason for canceling the promise
+	* Cancel the _Promise_, rejecting it with an optional reason
+	*
+	* @param reason Optional reason for canceling the _Promise_
 	*/
 	cancel(reason) {
 		this.#rejector(reason);

package/dist/promise/timed.d.mts

@@ -4,17 +4,19 @@ import { PromiseOptions } from "./models.mjs";
 //#region src/promise/timed.d.ts
 declare function getTimedPromise<Value>(promise: Promise<Value>, time: number, signal?: AbortSignal): Promise<Value>;
 /**
- * Create a promise that should be settled within a certain amount of time
- * @param promise Promise to settle
+ * Create a _Promise_ that should be settled within a certain amount of time
+ *
+ * @param promise _Promise_ to settle
  * @param options Timed options
- * @returns Timed promise
+ * @returns Timed _Promise_
  */
 declare function timed<Value>(promise: Promise<Value>, options: RequiredKeys<PromiseOptions, 'time'>): Promise<Value>;
 /**
- * Create a promise that should be settled within a certain amount of time
- * @param promise Promise to settle
+ * Create a _Promise_ that should be settled within a certain amount of time
+ *
+ * @param promise _Promise_ to settle
  * @param time How long to wait for _(in milliseconds; defaults to `0`)_
- * @returns Timed promise
+ * @returns Timed _Promise_
  */
 declare function timed<Value>(promise: Promise<Value>, time: number): Promise<Value>;
 //#endregion

package/dist/query.d.mts

@@ -3,12 +3,14 @@ import { PlainObject } from "./models.mjs";
 //#region src/query.d.ts
 /**
  * Convert a query string to a plain _(nested)_ object
+ *
  * @param query Query string to convert
  * @returns Plain object representation of the query string
  */
 declare function fromQuery(query: string): PlainObject;
 /**
  * Convert a plain _(nested)_ object to a query string
+ *
  * @param parameters Plain object to convert
  * @returns Query string representation of the object
  */

package/dist/query.mjs

@@ -5,6 +5,7 @@ import { setValue } from "./internal/value/set.mjs";
 //#region src/query.ts
 /**
 * Convert a query string to a plain _(nested)_ object
+*
 * @param query Query string to convert
 * @returns Plain object representation of the query string
 */
@@ -56,6 +57,7 @@ function setQueryValue(parameters, key, value) {
 }
 /**
 * Convert a plain _(nested)_ object to a query string
+*
 * @param parameters Plain object to convert
 * @returns Query string representation of the object
 */

package/dist/queue.d.mts

@@ -7,7 +7,7 @@ import { GenericAsyncCallback, GenericCallback } from "./models.mjs";
 declare class KeyedQueue<CallbackParameters extends Parameters<GenericAsyncCallback>, CallbackResult> {
   #private;
   /**
-   * Is any queue active?
+   * Get keys of all active queues
    */
   get active(): string[];
   /**
@@ -19,11 +19,11 @@ declare class KeyedQueue<CallbackParameters extends Parameters<GenericAsyncCallb
    */
   get concurrency(): number;
   /**
-   * Are all queues empty?
+   * Get keys of all empty queues
    */
   get empty(): string[];
   /**
-   * Are all queues full?
+   * Get keys of all full queues
    */
   get full(): string[];
   /**
@@ -49,6 +49,7 @@ declare class KeyedQueue<CallbackParameters extends Parameters<GenericAsyncCallb
   constructor(callback: GenericAsyncCallback, options: Required<QueueOptions>);
   /**
    * Queue an item for a specific key
+   *
    * @param key Key to queue the item for
    * @param parameters Parameters to use when item runs
    * @param signal Optional signal to abort the item
@@ -57,22 +58,26 @@ declare class KeyedQueue<CallbackParameters extends Parameters<GenericAsyncCallb
   add(key: string, parameters: Tail<CallbackParameters>, signal?: AbortSignal): Queued<CallbackResult>;
   /**
    * Clear all items for a specific key _(or all items for all keys, if no key is provided)_
+   *
    * @param key Optional key to clear the queue for
    */
   clear(key?: string): void;
   /**
    * Get the queue for a specific key
+   *
    * @param key Key to get the queue for
    * @returns Queue for the key, or `undefined` if it doesn't exist
    */
   get(key: string): Queue<Tail<CallbackParameters>, CallbackResult> | undefined;
   /**
    * Pause the queue for a specific key _(or all queues, if no key is provided)_
+   *
    * @param key Optional key to pause the queue for
    */
   pause(key?: string): void;
   /**
    * Remove a specific item for a specific key
+   *
    * @param key Key to remove the item for
    * @param id ID of the item to remove
    */
@@ -81,6 +86,7 @@ declare class KeyedQueue<CallbackParameters extends Parameters<GenericAsyncCallb
    * Remove a queue and its items for a specific key
    *
    * _(To remove all items for a specific key, use `clear()` instead)_
+   *
    * @param key Key to remove the queue for
    */
   remove(key: string): void;
@@ -90,6 +96,7 @@ declare class KeyedQueue<CallbackParameters extends Parameters<GenericAsyncCallb
   remove(): void;
   /**
    * Resume the queue for a specific key _(or all queues, if no key is provided)_
+   *
    * @param key Optional key to resume the queue for
    */
   resume(key?: string): void;
@@ -134,6 +141,7 @@ declare class Queue<CallbackParameters extends Parameters<GenericAsyncCallback>,
   constructor(callback: GenericAsyncCallback, options: Required<QueueOptions>, key?: string);
   /**
    * Add an item to the queue
+   *
    * @param parameters Parameters to use when item runs
    * @param signal Optional signal to abort the item
    * @returns Queued item
@@ -152,6 +160,7 @@ declare class Queue<CallbackParameters extends Parameters<GenericAsyncCallback>,
   pause(): void;
   /**
    * Remove and reject a specific item in the queue
+   *
    * @param id ID of queued item
    */
   remove(id: number): void;
@@ -207,13 +216,15 @@ type Tail<Values extends any[]> = Values extends [infer _, ...infer Rest] ? Rest
 declare function keyedQueue<Callback extends GenericAsyncCallback>(callback: Callback, options?: QueueOptions): KeyedQueue<Parameters<Callback>, Awaited<ReturnType<Callback>>>;
 /**
  * Create a queue for an asynchronous callback function
+ *
  * @param callback Callback function for queued items
  * @param options Queue options
  * @returns Queue instance
  */
 declare function queue<Callback extends (key: string, ...parameters: any[]) => Promise<void>>(callback: Callback, options?: QueueOptions): Queue<Parameters<Callback>, Awaited<ReturnType<Callback>>>;
 /**
- * Create a queue for an asynchronous callback function
+ * Create a queue for a synchronous callback function
+ *
  * @param callback Callback function for queued items
  * @param options Queue options
  * @returns Queue instance

package/dist/queue.mjs

@@ -8,7 +8,7 @@ var KeyedQueue = class {
 	#options;
 	#queues = /* @__PURE__ */ new Map();
 	/**
-	* Is any queue active?
+	* Get keys of all active queues
 	*/
 	get active() {
 		return this.#getStatus(STATUS_ACTIVE);
@@ -26,13 +26,13 @@ var KeyedQueue = class {
 		return this.#options.concurrency;
 	}
 	/**
-	* Are all queues empty?
+	* Get keys of all empty queues
 	*/
 	get empty() {
 		return this.#getStatus(STATUS_EMPTY);
 	}
 	/**
-	* Are all queues full?
+	* Get keys of all full queues
 	*/
 	get full() {
 		return this.#getStatus(STATUS_FULL);
@@ -76,6 +76,7 @@ var KeyedQueue = class {
 	}
 	/**
 	* Queue an item for a specific key
+	*
 	* @param key Key to queue the item for
 	* @param parameters Parameters to use when item runs
 	* @param signal Optional signal to abort the item
@@ -86,6 +87,7 @@ var KeyedQueue = class {
 	}
 	/**
 	* Clear all items for a specific key _(or all items for all keys, if no key is provided)_
+	*
 	* @param key Optional key to clear the queue for
 	*/
 	clear(key) {
@@ -93,6 +95,7 @@ var KeyedQueue = class {
 	}
 	/**
 	* Get the queue for a specific key
+	*
 	* @param key Key to get the queue for
 	* @returns Queue for the key, or `undefined` if it doesn't exist
 	*/
@@ -101,6 +104,7 @@ var KeyedQueue = class {
 	}
 	/**
 	* Pause the queue for a specific key _(or all queues, if no key is provided)_
+	*
 	* @param key Optional key to pause the queue for
 	*/
 	pause(key) {
@@ -123,6 +127,7 @@ var KeyedQueue = class {
 	}
 	/**
 	* Resume the queue for a specific key _(or all queues, if no key is provided)_
+	*
 	* @param key Optional key to resume the queue for
 	*/
 	resume(key) {
@@ -220,6 +225,7 @@ var Queue = class {
 	}
 	/**
 	* Add an item to the queue
+	*
 	* @param parameters Parameters to use when item runs
 	* @param signal Optional signal to abort the item
 	* @returns Queued item
@@ -276,6 +282,7 @@ var Queue = class {
 	}
 	/**
 	* Remove and reject a specific item in the queue
+	*
 	* @param id ID of queued item
 	*/
 	remove(id) {

package/dist/random.d.mts

@@ -1,13 +1,15 @@
-import { getRandomFloat, getRandomInteger } from "./internal/random.mjs";
+import { getRandomFloatingNumber, getRandomInteger } from "./internal/random.mjs";
 
 //#region src/random.d.ts
 /**
  * Get a random boolean
+ *
  * @returns Random boolean
  */
 declare function getRandomBoolean(): boolean;
 /**
  * Get a random string of characters with a specified length
+ *
  * @param length Length of random string
  * @param selection String of characters to select from _(defaults to lowercase English alphabet)_
  * @returns Random string of characters
@@ -15,23 +17,27 @@ declare function getRandomBoolean(): boolean;
 declare function getRandomCharacters(length: number, selection?: string): string;
 /**
  * Get a random hexadecimal color
+ *
  * @param prefix Prefix the color with `#`? _(defaults to `false`)_
  * @returns Random hexadecimal color string in the format `(#)RRGGBB`
  */
 declare function getRandomColor(prefix?: boolean): string;
 /**
  * Get a random hexadecimal character
+ *
  * @returns Random hexadecimal character from `0-9` and `A-F`
  */
 declare function getRandomHex(): string;
 /**
  * Get a random item from an array
+ *
  * @param array Array to get a random item from
  * @returns Random item from the array, or `undefined` if unable to retrieve one
  */
 declare function getRandomItem<Value>(array: Value[]): Value | undefined;
 /**
  * Get an amount of random items from an array
+ *
  * @param array Array to get random items from
  * @param amount Amount of items to return
  * @returns Array of random items
@@ -39,9 +45,10 @@ declare function getRandomItem<Value>(array: Value[]): Value | undefined;
 declare function getRandomItems<Value>(array: Value[], amount: number): Value[];
 /**
  * Get a shuffled array
+ *
  * @param array Array to get random items from
  * @returns Shuffled version of the original array
  */
 declare function getRandomItems<Value>(array: Value[]): Value[];
 //#endregion
-export { getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems };
+export { getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloatingNumber as getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems };

package/dist/random.mjs

@@ -1,9 +1,10 @@
-import { getRandomFloat, getRandomInteger } from "./internal/random.mjs";
+import { getRandomFloatingNumber, getRandomInteger } from "./internal/random.mjs";
 import { shuffle } from "./internal/array/shuffle.mjs";
 import { join } from "./internal/string.mjs";
 //#region src/random.ts
 /**
 * Get a random boolean
+*
 * @returns Random boolean
 */
 function getRandomBoolean() {
@@ -11,6 +12,7 @@ function getRandomBoolean() {
 }
 /**
 * Get a random string of characters with a specified length
+*
 * @param length Length of random string
 * @param selection String of characters to select from _(defaults to lowercase English alphabet)_
 * @returns Random string of characters
@@ -24,6 +26,7 @@ function getRandomCharacters(length, selection) {
 }
 /**
 * Get a random hexadecimal color
+*
 * @param prefix Prefix the color with `#`? _(defaults to `false`)_
 * @returns Random hexadecimal color string in the format `(#)RRGGBB`
 */
@@ -32,6 +35,7 @@ function getRandomColor(prefix) {
 }
 /**
 * Get a random hexadecimal character
+*
 * @returns Random hexadecimal character from `0-9` and `A-F`
 */
 function getRandomHex() {
@@ -39,6 +43,7 @@ function getRandomHex() {
 }
 /**
 * Get a random item from an array
+*
 * @param array Array to get a random item from
 * @returns Random item from the array, or `undefined` if unable to retrieve one
 */
@@ -57,4 +62,4 @@ const BOOLEAN_MODIFIER = .5;
 const HEX_CHARACTERS = "0123456789ABCDEF";
 const HEX_MAXIMUM = 15;
 //#endregion
-export { getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems };
+export { getRandomBoolean, getRandomCharacters, getRandomColor, getRandomFloatingNumber as getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems };

package/dist/result/index.d.mts

@@ -2,10 +2,11 @@ import { ExtendedResult, Result } from "./models.mjs";
 
 //#region src/result/index.d.ts
 /**
- * Executes a promise, catching any errors, and returns a result
+ * Executes a _Promise_, catching any errors, and returns a result
  *
- * Available as `asyncAttempt` and `attempt.async`
- * @param promise Promise to execute
+ * _Available as `asyncAttempt` and `attempt.async`_
+ *
+ * @param promise _Promise_ to execute
  * @param error Error value
  * @returns Callback result
  */
@@ -13,30 +14,34 @@ declare function asyncAttempt<Value, E>(promise: Promise<Value>, error: E): Prom
 /**
  * Executes a callback asynchronously, catching any errors, and returns a result
  *
- * Available as `asyncAttempt` and `attempt.async`
+ * _Available as `asyncAttempt` and `attempt.async`_
+ *
  * @param callback Callback to execute
  * @param error Error value
  * @returns Callback result
  */
 declare function asyncAttempt<Value, E>(callback: () => Promise<Value>, error: E): Promise<ExtendedResult<Awaited<Value>, E>>;
 /**
- * Executes a promise, catching any errors, and returns a result
+ * Executes a _Promise_, catching any errors, and returns a result
+ *
+ * _Available as `asyncAttempt` and `attempt.async`_
  *
- * Available as `asyncAttempt` and `attempt.async`
- * @param promise Promise to execute
+ * @param promise _Promise_ to execute
  * @returns Callback result
  */
 declare function asyncAttempt<Value>(promise: Promise<Value>): Promise<Result<Awaited<Value>>>;
 /**
  * Executes a callback asynchronously, catching any errors, and returns a result
  *
- * Available as `asyncAttempt` and `attempt.async`
+ * _Available as `asyncAttempt` and `attempt.async`_
+ *
  * @param callback Callback to execute
  * @returns Callback result
  */
 declare function asyncAttempt<Value>(callback: () => Promise<Value>): Promise<Result<Awaited<Value>>>;
 /**
  * Executes a callback, catching any errors, and returns a result
+ *
  * @param callback Callback to execute
  * @param error Error value
  * @returns Callback result
@@ -44,6 +49,7 @@ declare function asyncAttempt<Value>(callback: () => Promise<Value>): Promise<Re
 declare function attempt<Value, E>(callback: () => Value, error: E): ExtendedResult<Value, E>;
 /**
  * Executes a callback, catching any errors, and returns a result
+ *
  * @param callback Callback to execute
  * @returns Callback result
  */

package/dist/result/match.d.mts

@@ -2,33 +2,41 @@ import { AnyResult, ResultMatch } from "./models.mjs";
 
 //#region src/result/match.d.ts
 /**
- * Handles a result with match callbacks
+ * Handles a _Result_ with match callbacks
  *
- * Available as `asyncMatchResult` and `matchResult.async`
- * @param result Result to handle
+ * _Available as `asyncMatchResult` and `matchResult.async`_
+ *
+ * @param result _Result_ to handle
  * @param handler Match callbacks
+ * @returns Matched value-_Promise_
  */
 declare function asyncMatchResult<Value, Returned, E = Error>(result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>), handler: ResultMatch<Value, Returned, E>): Promise<Returned>;
 /**
- * Handles a result with match callbacks
+ * Handles a _Result_ with match callbacks
+ *
+ * _Available as `asyncMatchResult` and `matchResult.async`_
  *
- * Available as `asyncMatchResult` and `matchResult.async`
- * @param result Result to handle
+ * @param result _Result_ to handle
  * @param ok Ok callback
  * @param error Error callback
+ * @returns Matched value-_Promise_
  */
 declare function asyncMatchResult<Value, Returned, E = Error>(result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>), ok: ResultMatch<Value, Returned, E>['ok'], error: ResultMatch<Value, Returned, E>['error']): Promise<Returned>;
 /**
- * Handles a result with match callbacks
- * @param result Result to handle
+ * Handles a _Result_ with match callbacks
+ *
+ * @param result _Result_ to handle
  * @param handler Match callbacks
+ * @returns Matched value
  */
 declare function matchResult<Value, Returned, E = Error>(result: AnyResult<Value, E> | (() => AnyResult<Value, E>), handler: ResultMatch<Value, Returned, E>): Returned;
 /**
- * Handles a result with match callbacks
- * @param result Result to handle
+ * Handles a _Result_ with match callbacks
+ *
+ * @param result _Result_ to handle
  * @param ok Ok callback
  * @param error Error callback
+ * @returns Matched value
  */
 declare function matchResult<Value, Returned, E = Error>(result: AnyResult<Value, E> | (() => AnyResult<Value, E>), ok: ResultMatch<Value, Returned, E>['ok'], error: ResultMatch<Value, Returned, E>['error']): Returned;
 declare namespace matchResult {

package/dist/result/misc.d.mts

@@ -4,6 +4,7 @@ import { isError, isOk, isResult } from "../internal/result.mjs";
 //#region src/result/misc.d.ts
 /**
  * Creates an extended error result
+ *
  * @param value Error value
  * @param original Original error
  * @returns Error result
@@ -11,6 +12,7 @@ import { isError, isOk, isResult } from "../internal/result.mjs";
 declare function error<E>(value: E, original: Error): ExtendedErr<E>;
 /**
  * Creates an error result
+ *
  * @param value Error value
  * @returns Error result
  */
@@ -18,38 +20,43 @@ declare function error<E>(value: E): Err<E>;
 declare function getError<E>(value: E, original?: Error): Err<E> | ExtendedErr<E>;
 /**
  * Creates an ok result
+ *
  * @param value Value
  * @returns Ok result
  */
 declare function ok<Value>(value: Value): Ok<Value>;
 /**
- * Converts a result to a promise
+ * Converts a result to a _Promise_
  *
  * Resolves if ok, rejects for error
+ *
  * @param callback Callback to get the result
  * @returns Promised result
  */
 declare function toPromise<Value, E = Error>(callback: () => AnyResult<Value, E>): Promise<Value>;
 /**
- * Converts a result to a promise
+ * Converts a result to a _Promise_
  *
  * Resolves if ok, rejects for error
- * @param result Result to convert
+ *
+ * @param result _Result_ to convert
  * @returns Promised result
  */
 declare function toPromise<Value, E = Error>(result: AnyResult<Value, E>): Promise<Value>;
 /**
  * Gets the value of an ok result _(or a default value)_
- * @param value Result to unwrap
+ *
+ * @param value _Result_ to unwrap
  * @param defaultValue Default value
- * @returns Value of the result _(or the default value)_
+ * @returns Value of the _Result_ _(or the default value)_
  */
 declare function unwrap<Value, E = Error>(value: Result<Value, E>, defaultValue: Value): Value;
 /**
  * Gets the value of an ok result _(or a default value)_
- * @param value Result to unwrap
+ *
+ * @param value _Result_ to unwrap
  * @param defaultValue Default value
- * @returns Value of the result _(or the default value)_
+ * @returns Value of the _Result_ _(or the default value)_
  */
 declare function unwrap(value: unknown, defaultValue: unknown): unknown;
 //#endregion

package/dist/result/misc.mjs

@@ -13,6 +13,7 @@ function getError(value, original) {
 }
 /**
 * Creates an ok result
+*
 * @param value Value
 * @returns Ok result
 */
@@ -23,10 +24,11 @@ function ok(value) {
 	};
 }
 /**
-* Converts a result to a promise
+* Converts a _Result_ to a _Promise_
 *
 * Resolves if ok, rejects for error
-* @param result Result to convert
+*
+* @param result _Result_ to convert
 * @returns Promised result
 */
 async function toPromise(result) {

package/dist/result/models.d.mts

@@ -39,6 +39,7 @@ type Result<Value, E = Error> = Err<E> | Ok<Value>;
 type ResultMatch<Value, Returned, E = Error> = {
   /**
    * Callback for error result
+   *
    * @param error Error value
    * @param original Original error, if available
    * @returns Value to return
@@ -46,6 +47,7 @@ type ResultMatch<Value, Returned, E = Error> = {
   error: (error: E, original?: Error) => Returned;
   /**
    * Callback for ok result
+   *
    * @param value Ok value
    * @returns Value to return
    */