@oscarpalmer/atoms 0.186.2 → 0.187.0

package/src/internal/value/equal.ts

@@ -30,6 +30,7 @@ export type EqualOptions = {
 type Equalizer = {
 	/**
 	 * Are two strings equal?
+	 *
 	 * @param first First string
 	 * @param second Second string
 	 * @param ignoreCase If `true`, comparison will be case-insensitive
@@ -39,6 +40,7 @@ type Equalizer = {
 
 	/**
 	 * Are two values equal?
+	 *
 	 * @param first First value
 	 * @param second Second value
 	 * @returns `true` if the values are equal, otherwise `false`
@@ -47,12 +49,14 @@ type Equalizer = {
 
 	/**
 	 * Deregister a equality comparison handler for a specific class
+	 *
 	 * @param constructor Class constructor
 	 */
 	deregister: <Instance>(constructor: Constructor<Instance>) => void;
 
 	/**
 	 * Register a equality comparison function for a specific class
+	 *
 	 * @param constructor Class constructor
 	 * @param handler Comparison function
 	 */
@@ -81,7 +85,8 @@ type OptionsKeys<Values> = {
 /**
  * Deregister a equality comparison handler for a specific class
  *
- * Available as `deregisterEqualizer` and `equal.deregister`
+ * _Available as `deregisterEqualizer` and `equal.deregister`_
+ *
  * @param constructor Class constructor
  */
 export function deregisterEqualizer<Instance>(constructor: Constructor<Instance>): void {
@@ -109,6 +114,7 @@ function filterKey(key: string | symbol, options: Options): boolean {
 
 /**
  * Are two strings equal?
+ *
  * @param first First string
  * @param second Second string
  * @param ignoreCase If `true`, comparison will be case-insensitive
@@ -118,6 +124,7 @@ export function equal(first: string, second: string, ignoreCase?: boolean): bool
 
 /**
  * Are two values equal?
+ *
  * @param first First value
  * @param second Second value
  * @param options Comparison options
@@ -331,7 +338,7 @@ function equalValue(first: unknown, second: unknown, options: Options): boolean
 			return equalArrayBuffer(first, second, options);
 
 		case first instanceof Date && second instanceof Date:
-			return Object.is(Number(first), Number(second));
+			return Object.is(first.getTime(), (second as Date).getTime());
 
 		case first instanceof DataView && second instanceof DataView:
 			return equalDataView(first, second, options);
@@ -410,7 +417,8 @@ function getEqualOptions(input?: boolean | EqualOptions): Options {
 /**
  * Create an equalizer with predefined options
  *
- * Available as `initializeEqualizer` and `equal.initialize`
+ * _Available as `initializeEqualizer` and `equal.initialize`_
+ *
  * @param options Comparison options
  * @returns Equalizer function
  */
@@ -428,7 +436,8 @@ export function initializeEqualizer(options?: EqualOptions): Equalizer {
 /**
  * Register a equality comparison function for a specific class
  *
- * Available as `registerEqualizer` and `equal.register`
+ * _Available as `registerEqualizer` and `equal.register`_
+ *
  * @param constructor Class constructor
  * @param handler Comparison function
  */

package/src/internal/value/get.ts

@@ -7,19 +7,19 @@ import {getNestedValue} from './misc';
 /**
  * Get the value from an object using a known path
  *
+ * @param data Object to get value from
+ * @param path Path for value
+ * @returns Found value, or `undefined`
+ *
  * @example
  * ```typescript
  * const data = {foo: {bar: {baz: 42}}};
  *
- * getValue(data, 'foo');         // {bar: {baz: 42}}
- * getValue(data, 'foo.bar');     // {baz: 42}
- * getValue(data, 'foo.bar.baz'); // 42
- * getValue(data, 'foo.nope');    // undefined
+ * getValue(data, 'foo');         // => {bar: {baz: 42}}
+ * getValue(data, 'foo.bar');     // => {baz: 42}
+ * getValue(data, 'foo.bar.baz'); // => 42
+ * getValue(data, 'foo.nope');    // => undefined
  * ```
- *
- * @param data Object to get value from
- * @param path Path for value
- * @returns Found value, or `undefined`
  */
 export function getValue<Data extends PlainObject, Path extends NestedKeys<Data>>(
 	data: Data,
@@ -29,20 +29,20 @@ export function getValue<Data extends PlainObject, Path extends NestedKeys<Data>
 /**
  * Get the value from an object using an unknown path
  *
+ * @param data Object to get value from
+ * @param path Path for value
+ * @param ignoreCase If `true`, path matching is case-insensitive
+ * @returns Found value, or `undefined`
+ *
  * @example
  * ```typescript
  * const data = {foo: {bar: {baz: 42}}};
  *
- * getValue(data, 'foo');               // {bar: {baz: 42}}
- * getValue(data, 'foo.bar');           // {baz: 42}
- * getValue(data, 'Foo.Bar.Baz', true); // 42
- * getValue(data, 'foo.nope');          // undefined
+ * getValue(data, 'foo');               // => {bar: {baz: 42}}
+ * getValue(data, 'foo.bar');           // => {baz: 42}
+ * getValue(data, 'Foo.Bar.Baz', true); // => 42
+ * getValue(data, 'foo.nope');          // => undefined
  * ```
- *
- * @param data Object to get value from
- * @param path Path for value
- * @param ignoreCase If `true`, path matching is case-insensitive
- * @returns Found value, or `undefined`
  */
 export function getValue<Data extends PlainObject>(
 	data: Data,

package/src/internal/value/has.ts

@@ -5,10 +5,21 @@ import {getNestedValue} from './misc';
 // #region Functions
 
 /**
- * Check if a nested property is defined in an object
+ * Check if a property is defined in an object
+ *
  * @param data Object to check in
- * @param path Path for property
+ * @param path Path for property, e.g., `foo.bar.baz`
  * @returns `true` if the property exists, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * const data = {foo: {bar: {baz: 42}}};
+ *
+ * hasValue(data, 'foo');         // => true
+ * hasValue(data, 'foo.bar');     // => true
+ * hasValue(data, 'foo.bar.baz'); // => true
+ * hasValue(data, 'foo.nope');    // => false
+ * ```
  */
 export function hasValue<Data extends PlainObject, Path extends NestedKeys<Data>>(
 	data: Data,
@@ -16,11 +27,22 @@ export function hasValue<Data extends PlainObject, Path extends NestedKeys<Data>
 ): boolean;
 
 /**
- * Check if a nested property is defined in an object
+ * Check if a property is defined in an object
+ *
  * @param data Object to check in
- * @param path Path for property
+ * @param path Path for property, e.g., `foo.bar.baz`
  * @param ignoreCase If `true`, the path matching is case-insensitive
  * @returns `true` if the property exists, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * const data = {foo: {bar: {baz: 42}}};
+ *
+ * hasValue(data, 'foo');               // => true
+ * hasValue(data, 'foo.bar');           // => true
+ * hasValue(data, 'Foo.Bar.Baz', true); // => true
+ * hasValue(data, 'foo.nope');          // => false
+ * ```
  */
 export function hasValue<Data extends PlainObject>(
 	data: Data,
@@ -35,28 +57,49 @@ export function hasValue(data: PlainObject, path: string, ignoreCase?: boolean):
 hasValue.get = hasValueResult;
 
 /**
- * Check if a nested property is defined in an object, and get its value if it is
+ * Check if a property is defined in an object, and get its value if it is
+ *
+ * _Available as `hasValueResult` and `hasValue.get`_
  *
- * Available as `hasValueResult` and `hasValue.get`
  * @param data Object to check in
- * @param path Path for property
+ * @param path Path for property, e.g., `foo.bar.baz`
  * @param ignoreCase If `true`, the path matching is case-insensitive
  * @returns Result object
+ *
+ * @example
+ * ```typescript
+ * const data = {foo: {bar: {baz: 42}}};
+ *
+ * hasValueResult(data, 'foo');         // => {ok: true, value: {bar: {baz: 42}}}
+ * hasValueResult(data, 'foo.bar');     // => {ok: true, value: {baz: 42}}
+ * hasValueResult(data, 'foo.bar.baz'); // => {ok: true, value: 42}
+ * hasValueResult(data, 'foo.nope');    // => {ok: false, error: 'Expected property to exist in object'}
+ * ```
  */
 export function hasValueResult<Data extends PlainObject, Path extends NestedKeys<Data>>(
 	data: Data,
 	path: Path,
-	ignoreCase?: boolean,
 ): Result<NestedValue<Data, ToString<Path>>, string>;
 
 /**
- * Check if a nested property is defined in an object, and get its value if it is
+ * Check if a property is defined in an object, and get its value if it is
+ *
+ * _Available as `hasValueResult` and `hasValue.get`_
  *
- * Available as `hasValueResult` and `hasValue.get`
  * @param data Object to check in
- * @param path Path for property
+ * @param path Path for property, e.g., `foo.bar.baz`
  * @param ignoreCase If `true`, the path matching is case-insensitive
  * @returns Result object
+ *
+ * @example
+ * ```typescript
+ * const data = {foo: {bar: {baz: 42}}};
+ *
+ * hasValueResult(data, 'foo');               // => {ok: true, value: {bar: {baz: 42}}}
+ * hasValueResult(data, 'foo.bar');           // => {ok: true, value: {baz: 42}}
+ * hasValueResult(data, 'Foo.Bar.Baz', true); // => {ok: true, value: 42}
+ * hasValueResult(data, 'foo.nope');          // => {ok: false, error: 'Expected property to exist in object'}
+ * ```
  */
 export function hasValueResult<Data extends PlainObject>(
 	data: Data,

package/src/internal/value/set.ts

@@ -6,10 +6,18 @@ import {getPaths, handleValue} from './misc';
 
 /**
  * Update the value in an object using a known path
+ *
  * @param data Object to set value in
  * @param path Path for value, e.g., `foo.bar.baz`
  * @param updater Function to update the current value
  * @returns Updated object
+ *
+ * @example
+ * ```typescript
+ * const data = {foo: {bar: {baz: 42}}};
+ *
+ * setValue(data, 'foo.bar.baz', (current) => current + 1); // => {foo: {bar: {baz: 43}}}
+ * ```
  */
 export function setValue<Data extends PlainObject, Path extends NestedKeys<Data>>(
 	data: Data,
@@ -19,10 +27,18 @@ export function setValue<Data extends PlainObject, Path extends NestedKeys<Data>
 
 /**
  * Set the value in an object using a known path
+ *
  * @param data Object to set value in
  * @param path Path for value, e.g., `foo.bar.baz`
  * @param value Value to set
  * @returns Updated object
+ *
+ * @example
+ * ```typescript
+ * const data = {foo: {bar: {baz: 42}}};
+ *
+ * setValue(data, 'foo.bar.baz', 99); // => {foo: {bar: {baz: 99}}}
+ * ```
  */
 export function setValue<Data extends PlainObject, Path extends NestedKeys<Data>>(
 	data: Data,
@@ -32,11 +48,19 @@ export function setValue<Data extends PlainObject, Path extends NestedKeys<Data>
 
 /**
  * Set the value in an object using an unknown path
+ *
  * @param data Object to set value in
  * @param path Path for value, e.g., `foo.bar.baz`
  * @param value Value to set
  * @param ignoreCase If `true`, the path matching is case-insensitive
  * @returns Updated object
+ *
+ * @example
+ * ```typescript
+ * const data = {foo: {bar: {baz: 42}}};
+ *
+ * setValue(data, 'Foo.Bar.Baz', 99, true); // => {foo: {bar: {baz: 99}}}
+ * ```
  */
 export function setValue<Data extends PlainObject>(
 	data: Data,

package/src/is.ts

@@ -6,6 +6,7 @@ import {getString} from './internal/string';
 
 /**
  * Is the value empty, or only containing `null` or `undefined` values?
+ *
  * @param value Value to check
  * @returns `true` if the value is considered empty, otherwise `false`
  */
@@ -22,7 +23,9 @@ export function isEmpty(value: unknown): boolean {
 	const {length} = values;
 
 	for (let index = 0; index < length; index += 1) {
-		if (values[index] != null) {
+		const item = values[index];
+
+		if (Array.isArray(item) ? item[1] != null : item != null) {
 			return false;
 		}
 	}
@@ -32,6 +35,7 @@ export function isEmpty(value: unknown): boolean {
 
 /**
  * Is the value not empty, or holding non-empty values?
+ *
  * @param value Value to check
  * @returns `true` if the value is not considered empty, otherwise `false`
  */
@@ -41,6 +45,7 @@ export function isNonEmpty(value: unknown): boolean {
 
 /**
  * Is the value not `undefined` or `null`?
+ *
  * @param value Value to check
  * @returns `true` if the value is not `undefined` or `null`, otherwise `false`
  */
@@ -50,6 +55,7 @@ export function isNonNullable<Value>(value: Value): value is Exclude<Value, unde
 
 /**
  * Is the value not `undefined`, `null`, or stringified as an empty _(no whitespace)_ string?
+ *
  * @param value Value to check
  * @returns `true` if the value is not `undefined`, `null`, or matches an empty string, otherwise `false`
  */
@@ -61,6 +67,7 @@ export function isNonNullableOrEmpty<Value>(
 
 /**
  * Is the value not `undefined`, `null`, or stringified as a whitespace-only string?
+ *
  * @param value Value to check
  * @returns `true` if the value is not `undefined`, `null`, or matches a whitespace-only string, otherwise `false`
  */
@@ -72,6 +79,7 @@ export function isNonNullableOrWhitespace<Value>(
 
 /**
  * Is the value not a number or a number-like string?
+ *
  * @param value Value to check
  * @returns `true` if the value is not a number or a number-like string, otherwise `false`
  */
@@ -81,6 +89,7 @@ export function isNonNumerical<Value>(value: Value): value is Exclude<Value, num
 
 /**
  * Is the value not an object _(or function)_?
+ *
  * @param value Value to check
  * @returns `true` if the value is not an object, otherwise `false`
  */
@@ -90,6 +99,7 @@ export function isNonObject<Value>(value: Value): value is Exclude<Value, object
 
 /**
  * Is the value `undefined` or `null`?
+ *
  * @param value Value to check
  * @returns `true` if the value is `undefined` or `null`, otherwise `false`
  */
@@ -99,6 +109,7 @@ export function isNullable(value: unknown): value is undefined | null {
 
 /**
  * Is the value `undefined`, `null`, or stringified as an empty _(no whitespace)_ string?
+ *
  * @param value Value to check
  * @returns `true` if the value is nullable or matches an empty string, otherwise `false`
  */
@@ -108,6 +119,7 @@ export function isNullableOrEmpty(value: unknown): value is undefined | null | '
 
 /**
  * Is the value `undefined`, `null`, or stringified as a whitespace-only string?
+ *
  * @param value Value to check
  * @returns `true` if the value is nullable or matches a whitespace-only string, otherwise `false`
  */
@@ -117,6 +129,7 @@ export function isNullableOrWhitespace(value: unknown): value is undefined | nul
 
 /**
  * Is the value a number or a number-like string?
+ *
  * @param value Value to check
  * @returns `true` if the value is a number or a number-like string, otherwise `false`
  */
@@ -129,6 +142,7 @@ export function isNumerical(value: unknown): value is number | `${number}` {
 
 /**
  * Is the value an object _(or function)_?
+ *
  * @param value Value to check
  * @returns `true` if the value matches, otherwise `false`
  */

package/src/logger.ts

@@ -79,19 +79,20 @@ class Logger {
 	}
 
 	/**
-	 * Start a logged timer with a label
-	 * @param label Label for the timer
-	 * @returns Time instance
+	 * Start a timed logger with a label
+	 *
+	 * @param label Label for the logger
+	 * @returns _Timed_ instance
 	 */
-	time(label: string): Time {
-		return new Time(label);
+	time(label: string): Timed {
+		return new Timed(label);
 	}
 }
 
 /**
  * A named timer that can be used to log durations to the console
  */
-class Time {
+class Timed {
 	#logger: typeof console.timeLog | undefined;
 	#stopper: typeof console.timeEnd | undefined;
 
@@ -165,6 +166,6 @@ let enabled = true;
 
 // #region Exports
 
-export {logger, type Logger, type Time};
+export {logger, type Logger, type Timed};
 
 // #endregion

package/src/math.ts

@@ -13,9 +13,10 @@ import type {NumericalValues, PlainObject} from './models';
 
 /**
  * Get the average value from a list of items
+ *
  * @param items List of items
  * @param callback Callback to get an item's value
- * @returns Average value, or `NaN` if no average can be calculated
+ * @returns Average value, or `Number.NaN` if no average can be calculated
  */
 export function average<Item>(
 	items: Item[],
@@ -24,9 +25,10 @@ export function average<Item>(
 
 /**
  * Get the average value from a list of items
+ *
  * @param items List of items
  * @param key Key to use for value
- * @returns Average value, or `NaN` if no average can be calculated
+ * @returns Average value, or `Number.NaN` if no average can be calculated
  */
 export function average<Item extends PlainObject>(
 	items: Item[],
@@ -35,8 +37,9 @@ export function average<Item extends PlainObject>(
 
 /**
  * Get the average value from a list of numbers
+ *
  * @param numbers List of numbers
- * @returns Average value, or `NaN` if no average can be calculated
+ * @returns Average value, or `Number.NaN` if no average can be calculated
  */
 export function average(numbers: number[]): number;
 
@@ -48,9 +51,10 @@ export function average(array: unknown[], key?: unknown): number {
 
 /**
  * Round a number up
+ *
  * @param value Number to round up
  * @param decimals Number of decimal places to round to _(defaults to `0`)_
- * @returns Rounded number, or `NaN` if the value if unable to be rounded
+ * @returns Rounded number, or `Number.NaN` if the value if unable to be rounded
  */
 export function ceil(value: number, decimals?: number): number {
 	return roundNumber(Math.ceil, value, decimals);
@@ -58,10 +62,11 @@ export function ceil(value: number, decimals?: number): number {
 
 /**
  * Count the number of items in an array that match a specific value
+ *
  * @param array Array to count for
  * @param callback Callback to get an item's value
  * @param value Value to match and count
- * @returns Number of items that match the condition, or `NaN` if no count can be calculated
+ * @returns Number of items that match the condition, or `Number.NaN` if no count can be calculated
  */
 export function count<Item>(
 	array: Item[],
@@ -71,10 +76,11 @@ export function count<Item>(
 
 /**
  * Count the number of items in an array that have a specific value
+ *
  * @param array Array to count for
  * @param key Key to use for value
  * @param value Value to match and count
- * @returns Number of items with the specified key value, or `NaN` if no count can be calculated
+ * @returns Number of items with the specified key value, or `Number.NaN` if no count can be calculated
  */
 export function count<Item extends PlainObject, ItemKey extends keyof Item>(
 	array: Item[],
@@ -84,8 +90,9 @@ export function count<Item extends PlainObject, ItemKey extends keyof Item>(
 
 /**
  * Count the number of items in an array
+ *
  * @param values Array to count for
- * @returns Number of items, or `NaN` if no count can be calculated
+ * @returns Number of items, or `Number.NaN` if no count can be calculated
  */
 export function count(values: unknown[]): number;
 
@@ -117,9 +124,10 @@ export function count(array: unknown[], key?: unknown, value?: unknown): number
 
 /**
  * Round a number down
+ *
  * @param value Number to round down
  * @param decimals Number of decimal places to round to _(defaults to `0`)_
- * @returns Rounded number, or `NaN` if the value if unable to be rounded
+ * @returns Rounded number, or `Number.NaN` if the value if unable to be rounded
  */
 export function floor(value: number, decimals?: number): number {
 	return roundNumber(Math.floor, value, decimals);
@@ -127,9 +135,10 @@ export function floor(value: number, decimals?: number): number {
 
 /**
  * Get the median value from a list of items
+ *
  * @param array List of items
  * @param callback Callback to get an item's value
- * @returns Median value, or `NaN` if no median can be calculated
+ * @returns Median value, or `Number.NaN` if no median can be calculated
  */
 export function median<Item>(
 	array: Item[],
@@ -138,9 +147,10 @@ export function median<Item>(
 
 /**
  * Get the median value from a list of items
+ *
  * @param array List of items
  * @param key Key to use for value
- * @returns Median value, or `NaN` if no median can be calculated
+ * @returns Median value, or `Number.NaN` if no median can be calculated
  */
 export function median<Item extends PlainObject>(
 	array: Item[],
@@ -149,8 +159,9 @@ export function median<Item extends PlainObject>(
 
 /**
  * Get the median value from a list of numbers
+ *
  * @param array List of numbers
- * @returns Median value, or `NaN` if no median can be calculated
+ * @returns Median value, or `Number.NaN` if no median can be calculated
  */
 export function median(array: number[]): number;
 
@@ -189,9 +200,10 @@ export function median(array: unknown[], key?: unknown): number {
 
 /**
  * Get the minimum value from a list of items
+ *
  * @param items List of items
  * @param callback Callback to get an item's value
- * @returns Minimum value, or `NaN` if no minimum can be found
+ * @returns Minimum value, or `Number.NaN` if no minimum can be found
  */
 export function min<Item>(
 	items: Item[],
@@ -200,9 +212,10 @@ export function min<Item>(
 
 /**
  * Get the minimum value from a list of items
+ *
  * @param items List of items
  * @param key Key to use for value
- * @returns Minimum value, or `NaN` if no minimum can be found
+ * @returns Minimum value, or `Number.NaN` if no minimum can be found
  */
 export function min<Item extends PlainObject>(
 	items: Item[],
@@ -211,8 +224,9 @@ export function min<Item extends PlainObject>(
 
 /**
  * Get the minimum value from a list of numbers
+ *
  * @param values List of numbers
- * @returns Minimum value, or `NaN` if no minimum can be found
+ * @returns Minimum value, or `Number.NaN` if no minimum can be found
  */
 export function min(values: number[]): number;
 
@@ -222,9 +236,10 @@ export function min(array: unknown[], key?: unknown): number {
 
 /**
  * Round a number
+ *
  * @param value Number to round
  * @param decimals Number of decimal places to round to _(defaults to `0`)_
- * @returns Rounded number, or `NaN` if the value if unable to be rounded
+ * @returns Rounded number, or `Number.NaN` if the value if unable to be rounded
  */
 export function round(value: number, decimals?: number): number {
 	return roundNumber(Math.round, value, decimals);
@@ -250,9 +265,10 @@ function roundNumber(
 
 /**
  * Get the sum of a list of items
+ *
  * @param items List of items
  * @param callback Callback to get an item's value
- * @returns Sum of the values, or `NaN` if no sum can be calculated
+ * @returns Sum of the values, or `Number.NaN` if no sum can be calculated
  */
 export function sum<Item>(
 	items: Item[],
@@ -261,9 +277,10 @@ export function sum<Item>(
 
 /**
  * Get the sum of a list of items
+ *
  * @param items List of items
  * @param key Key to use for value
- * @returns Sum of the values, or `NaN` if no sum can be calculated
+ * @returns Sum of the values, or `Number.NaN` if no sum can be calculated
  */
 export function sum<Item extends PlainObject>(
 	items: Item[],
@@ -272,8 +289,9 @@ export function sum<Item extends PlainObject>(
 
 /**
  * Get the sum of a list of numbers
+ *
  * @param values List of numbers
- * @returns Sum of the numbers, or `NaN` if no sum can be calculated
+ * @returns Sum of the numbers, or `Number.NaN` if no sum can be calculated
  */
 export function sum(values: number[]): number;
 

package/src/models.ts

@@ -21,7 +21,7 @@ export type AsyncCancelableCallback<Callback extends GenericAsyncCallback | Gene
 /**
  * For matching any `void`, `Date`, primitive, or `RegExp` values
  *
- * (Thanks, type-fest!)
+ * _(Thanks, type-fest!)_
  */
 export type BuiltIns = void | Date | Primitive | RegExp;
 
@@ -139,7 +139,7 @@ type _NestedValue<Value, Path extends string> = Path extends `${infer ItemKey}.$
 			: never;
 
 /**
- * The nested (keyed) values of an object _(up to 5 levels deep)_
+ * The nested _(keyed)_ values of an object _(up to 5 levels deep)_
  */
 export type NestedValues<Value extends PlainObject> = {
 	[Path in NestedKeys<Value>]: NestedValue<Value, Path>;
@@ -267,7 +267,7 @@ export type TypedArray =
  * ```typescript
  * type A = {a: string};
  * type B = {b: number};
- * type C = UnionToIntersection<A | B>; // {a: string} & {b: number}
+ * type C = UnionToIntersection<A | B>; // => {a: string} & {b: number}
  * ```
  *
  * Thanks, type-fest!

package/src/promise/delay.ts

@@ -7,6 +7,7 @@ import {PROMISE_ABORT_OPTIONS, PROMISE_ABORT_EVENT, type PromiseOptions} from '.
 
 /**
  * Create a delayed promise that resolves after a certain amount of time, or rejects if aborted
+ *
  * @param options Options for the delay
  * @returns Delayed promise
  */
@@ -14,6 +15,7 @@ export function delay(options?: PromiseOptions): Promise<void>;
 
 /**
  * Create a delayed promise that resolves after a certain amount of time
+ *
  * @param time How long to wait for _(in milliseconds; defaults to `0`)_
  * @returns Delayed promise
  */