@oscarpalmer/atoms 0.75.0 → 0.76.0

package/types/index.d.ts

@@ -1,16 +1,16 @@
-export * from '@/array/index';
-export * from '@/colour/index';
-export * from '@/emitter';
-export * from '@/function';
-export * from '@/is';
-export * from '@/logger';
-export * from '@/math';
-export * from '@/models';
-export * from '@/number';
-export * from '@/query';
-export * from '@/queue';
-export * from '@/random';
-export * from '@/sized';
-export * from '@/string/index';
-export * from '@/touch';
-export * from '@/value/index';
+export * from '~/array/index';
+export * from '~/colour/index';
+export * from '~/emitter';
+export * from '~/function';
+export * from '~/is';
+export * from '~/logger';
+export * from '~/math';
+export * from '~/models';
+export * from '~/number';
+export * from '~/query';
+export * from '~/queue';
+export * from '~/random';
+export * from '~/sized';
+export * from '~/string/index';
+export * from '~/touch';
+export * from '~/value/index';

package/types/internal/array/callbacks.d.cts

@@ -0,0 +1,11 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type GenericCallback = (...args: any[]) => any;
+export type Callbacks = {
+	bool?: GenericCallback;
+	key?: GenericCallback;
+	value?: GenericCallback;
+};
+export declare function getCallbacks(bool?: unknown, key?: unknown, value?: unknown): Callbacks | undefined;
+
+export {};

package/types/internal/array/callbacks.d.ts

@@ -0,0 +1,2 @@
+import type { Callbacks } from '~/array/models';
+export declare function getCallbacks(bool?: unknown, key?: unknown, value?: unknown): Callbacks | undefined;

package/types/internal/array/find.d.cts

@@ -0,0 +1,7 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type FindType = "index" | "value";
+export declare function findValue(type: FindType, array: unknown[], bool: unknown, key: unknown, value: unknown): unknown;
+export declare function findValues(type: "all" | "unique", array: unknown[], bool: unknown, key: unknown, value: unknown): unknown[];
+
+export {};

package/types/internal/array/find.d.ts

@@ -0,0 +1,3 @@
+import type { FindType } from '~/array/models';
+export declare function findValue(type: FindType, array: unknown[], bool: unknown, key: unknown, value: unknown): unknown;
+export declare function findValues(type: 'all' | 'unique', array: unknown[], bool: unknown, key: unknown, value: unknown): unknown[];

package/types/internal/{value-handle.d.ts → value/handle.d.ts}

@@ -1,2 +1,2 @@
-import type { PlainObject } from '@/models';
+import type { PlainObject } from '~/models';
 export declare function handleValue(data: PlainObject, path: string, value: unknown, get: boolean, ignoreCase: boolean): unknown;

package/types/is.d.ts

@@ -1,4 +1,4 @@
-import type { ArrayOrPlainObject, Key, PlainObject, Primitive } from '@/models';
+import type { ArrayOrPlainObject, Key, PlainObject, Primitive } from '~/models';
 /**
  * Is the value an array or a record?
  */

package/types/logger.d.cts

@@ -2,14 +2,14 @@
 
 declare class Logger {
 	/**
-	 * Logs any number of values at the "debug" log level
+	 * Log any number of values at the "debug" log level
 	 */
 	get debug(): {
 		(...data: any[]): void;
 		(message?: any, ...optionalParams: any[]): void;
 	};
 	/**
-	 * Logs the value and shows all its properties
+	 * Log the value and shows all its properties
 	 */
 	get dir(): {
 		(item?: any, options?: any): void;
@@ -24,49 +24,49 @@ declare class Logger {
 	 */
 	set enabled(value: boolean);
 	/**
-	 * Logs any number of values at the "error" log level
+	 * Log any number of values at the "error" log level
 	 */
 	get error(): {
 		(...data: any[]): void;
 		(message?: any, ...optionalParams: any[]): void;
 	};
 	/**
-	 * Logs any number of values at the "info" log level
+	 * Log any number of values at the "info" log level
 	 */
 	get info(): {
 		(...data: any[]): void;
 		(message?: any, ...optionalParams: any[]): void;
 	};
 	/**
-	 * Logs any number of values at the "log" log level
+	 * Log any number of values at the "log" log level
 	 */
 	get log(): {
 		(...data: any[]): void;
 		(message?: any, ...optionalParams: any[]): void;
 	};
 	/**
-	 * Logs data as a table, with optional properties to use as columns
+	 * Log data as a table, with optional properties to use as columns
 	 */
 	get table(): {
 		(tabularData?: any, properties?: string[]): void;
 		(tabularData: any, properties?: readonly string[]): void;
 	};
 	/**
-	 * Logs any number of values together with a trace from where it was called
+	 * Log any number of values together with a trace from where it was called
 	 */
 	get trace(): {
 		(...data: any[]): void;
 		(message?: any, ...optionalParams: any[]): void;
 	};
 	/**
-	 * Logs any number of values at the "warn" log level
+	 * Log any number of values at the "warn" log level
 	 */
 	get warn(): {
 		(...data: any[]): void;
 		(message?: any, ...optionalParams: any[]): void;
 	};
 	/**
-	 * - Starts a logged timer with a label
+	 * - Start a logged timer with a label
 	 * - Returns a `Time`-object for logging the current duration of the timer and stopping the timer _(and logging the total duration)_
 	 */
 	time(label: string): Time;
@@ -75,13 +75,13 @@ declare class Time {
 	private readonly state;
 	constructor(label: string);
 	/**
-	 * - Logs the current duration of the timer
-	 * - Ignored if logging is disabled
+	 * - Log the current duration of the timer
+	 * - _(Ignored if logging is disabled)_
 	 */
 	log(): void;
 	/**
-	 * - Stops the timer and logs the total duration
-	 * - Will always log the total duration, even if logging is disabled
+	 * - Stop the timer and logs the total duration
+	 * - _(Will always log the total duration, even if logging is disabled)_
 	 */
 	stop(): void;
 }

package/types/logger.d.ts

@@ -3,14 +3,14 @@ declare global {
 }
 declare class Logger {
     /**
-     * Logs any number of values at the "debug" log level
+     * Log any number of values at the "debug" log level
      */
     get debug(): {
         (...data: any[]): void;
         (message?: any, ...optionalParams: any[]): void;
     };
     /**
-     * Logs the value and shows all its properties
+     * Log the value and shows all its properties
      */
     get dir(): {
         (item?: any, options?: any): void;
@@ -25,49 +25,49 @@ declare class Logger {
      */
     set enabled(value: boolean);
     /**
-     * Logs any number of values at the "error" log level
+     * Log any number of values at the "error" log level
      */
     get error(): {
         (...data: any[]): void;
         (message?: any, ...optionalParams: any[]): void;
     };
     /**
-     * Logs any number of values at the "info" log level
+     * Log any number of values at the "info" log level
      */
     get info(): {
         (...data: any[]): void;
         (message?: any, ...optionalParams: any[]): void;
     };
     /**
-     * Logs any number of values at the "log" log level
+     * Log any number of values at the "log" log level
      */
     get log(): {
         (...data: any[]): void;
         (message?: any, ...optionalParams: any[]): void;
     };
     /**
-     * Logs data as a table, with optional properties to use as columns
+     * Log data as a table, with optional properties to use as columns
      */
     get table(): {
         (tabularData?: any, properties?: string[]): void;
         (tabularData: any, properties?: readonly string[]): void;
     };
     /**
-     * Logs any number of values together with a trace from where it was called
+     * Log any number of values together with a trace from where it was called
      */
     get trace(): {
         (...data: any[]): void;
         (message?: any, ...optionalParams: any[]): void;
     };
     /**
-     * Logs any number of values at the "warn" log level
+     * Log any number of values at the "warn" log level
      */
     get warn(): {
         (...data: any[]): void;
         (message?: any, ...optionalParams: any[]): void;
     };
     /**
-     * - Starts a logged timer with a label
+     * - Start a logged timer with a label
      * - Returns a `Time`-object for logging the current duration of the timer and stopping the timer _(and logging the total duration)_
      */
     time(label: string): Time;
@@ -76,13 +76,13 @@ declare class Time {
     private readonly state;
     constructor(label: string);
     /**
-     * - Logs the current duration of the timer
-     * - Ignored if logging is disabled
+     * - Log the current duration of the timer
+     * - _(Ignored if logging is disabled)_
      */
     log(): void;
     /**
-     * - Stops the timer and logs the total duration
-     * - Will always log the total duration, even if logging is disabled
+     * - Stop the timer and logs the total duration
+     * - _(Will always log the total duration, even if logging is disabled)_
      */
     stop(): void;
 }

package/types/math.d.cts

@@ -13,7 +13,7 @@ export declare function max(values: number[]): number;
  */
 export declare function min(values: number[]): number;
 /**
- * Rounds a number to a specific number of decimal places _(defaults to 0)_
+ * Round a number to a specific number of decimal places _(defaults to 0)_
  */
 export declare function round(value: number, decimals?: number): number;
 /**

package/types/math.d.ts

@@ -11,7 +11,7 @@ export declare function max(values: number[]): number;
  */
 export declare function min(values: number[]): number;
 /**
- * Rounds a number to a specific number of decimal places _(defaults to 0)_
+ * Round a number to a specific number of decimal places _(defaults to 0)_
  */
 export declare function round(value: number, decimals?: number): number;
 /**

package/types/models.d.cts

@@ -1299,14 +1299,14 @@ export type EventPosition = {
 	x: number;
 	y: number;
 };
+export type KeyedValue<
+	Item,
+	Key extends keyof Item,
+> = Item[Key] extends PropertyKey ? Item[Key] : never;
 export type NestedArrayType<Value> = Value extends Array<infer NestedValue>
 	? NestedArrayType<NestedValue>
 	: Value;
 export type GenericCallback = (...args: any[]) => any;
-export type GetterSetter<Value> = {
-	get(): Value;
-	set(value: Value): void;
-};
 export type Key = number | string;
 export type PlainObject = UnknownRecord;
 export type UnknownArrayOrRecord = UnknownArray | UnknownRecord;

package/types/models.d.ts

@@ -4,12 +4,9 @@ export type EventPosition = {
     x: number;
     y: number;
 };
+export type KeyedValue<Item, Key extends keyof Item> = Item[Key] extends PropertyKey ? Item[Key] : never;
 export type NestedArrayType<Value> = Value extends Array<infer NestedValue> ? NestedArrayType<NestedValue> : Value;
 export type GenericCallback = (...args: any[]) => any;
-export type GetterSetter<Value> = {
-    get(): Value;
-    set(value: Value): void;
-};
 export type Key = number | string;
 export type PlainObject = UnknownRecord;
 export type UnknownArrayOrRecord = UnknownArray | UnknownRecord;

package/types/number.d.cts

@@ -5,12 +5,12 @@
  */
 export declare function between(value: number, min: number, max: number): boolean;
 /**
- * - Clamps a number between a minimum and maximum value
+ * - Clamp a number between a minimum and maximum value
  * - If `loop` is `true`, when the value is less than the minimum, it will be clamped as the maximum, and vice versa
  */
 export declare function clamp(value: number, min: number, max: number, loop?: boolean): number;
 /**
- * - Gets the number value from an unknown value
+ * - Get the number value from an unknown value
  * - Returns `NaN` if the value is `undefined`, `null`, or cannot be parsed
  * - Based on Lodash :-)
  */

package/types/number.d.ts

@@ -3,12 +3,12 @@
  */
 export declare function between(value: number, min: number, max: number): boolean;
 /**
- * - Clamps a number between a minimum and maximum value
+ * - Clamp a number between a minimum and maximum value
  * - If `loop` is `true`, when the value is less than the minimum, it will be clamped as the maximum, and vice versa
  */
 export declare function clamp(value: number, min: number, max: number, loop?: boolean): number;
 /**
- * - Gets the number value from an unknown value
+ * - Get the number value from an unknown value
  * - Returns `NaN` if the value is `undefined`, `null`, or cannot be parsed
  * - Based on Lodash :-)
  */

package/types/query.d.cts

@@ -33,11 +33,11 @@ isObject('hello');
 export type UnknownRecord = Record<PropertyKey, unknown>;
 export type PlainObject = UnknownRecord;
 /**
- * Converts a query string to a plain _(nested)_ object
+ * Convert a query string to a plain _(nested)_ object
  */
 export declare function fromQuery(query: string): PlainObject;
 /**
- * Converts a plain _(nested)_ object to a query string
+ * Convert a plain _(nested)_ object to a query string
  */
 export declare function toQuery(parameters: PlainObject): string;
 

package/types/query.d.ts

@@ -1,9 +1,9 @@
-import type { PlainObject } from '@/models';
+import type { PlainObject } from '~/models';
 /**
- * Converts a query string to a plain _(nested)_ object
+ * Convert a query string to a plain _(nested)_ object
  */
 export declare function fromQuery(query: string): PlainObject;
 /**
- * Converts a plain _(nested)_ object to a query string
+ * Convert a plain _(nested)_ object to a query string
  */
 export declare function toQuery(parameters: PlainObject): string;

package/types/queue.d.cts

@@ -1,7 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
 /**
- * Queues a callback to be executed at the next best time
+ * Queue a callback to be executed at the next best time
  */
 export declare function queue(callback: () => void): void;
 

package/types/queue.d.ts

@@ -2,6 +2,6 @@ declare global {
     var _atomic_queued: Set<() => void>;
 }
 /**
- * Queues a callback to be executed at the next best time
+ * Queue a callback to be executed at the next best time
  */
 export declare function queue(callback: () => void): void;

package/types/random.d.cts

@@ -1,40 +1,36 @@
 // Generated by dts-bundle-generator v9.5.1
 
 /**
- * Returns a random boolean
+ * Get a random boolean
  */
 export declare function getRandomBoolean(): boolean;
 /**
- * Returns a random string of characters with a specified length
+ * Get a random string of characters with a specified length
  * - `selection` defaults to all lowercase letters in the English alphabet
  */
 export declare function getRandomCharacters(length: number, selection?: string): string;
 /**
- * Returns a random hexadecimal colour
+ * Get a random hexadecimal colour
  */
 export declare function getRandomColour(): string;
 /**
- * Returns a random date
- */
-export declare function getRandomDate(earliest?: Date, latest?: Date): Date;
-/**
- * Returns a random floating-point number
+ * Get a random floating-point number
  */
 export declare function getRandomFloat(min?: number, max?: number): number;
 /**
- * Returns a random hexadecimal character
+ * Get a random hexadecimal character
  */
 export declare function getRandomHex(): string;
 /**
- * Returns a random integer
+ * Get a random integer
  */
 export declare function getRandomInteger(min?: number, max?: number): number;
 /**
- * Returns a random item from an array
+ * Get a random item from an array
  */
 export declare function getRandomItem<Value>(array: Value[]): Value;
 /**
- * - Returns an amount of random items from an array
+ * - Get an amount of random items from an array
  * - If `amount` is not specified, a shuffled array will be returned instead
  */
 export declare function getRandomItems<Value>(array: Value[], amount?: number): Value[];

package/types/random.d.ts

@@ -1,38 +1,34 @@
 /**
- * Returns a random boolean
+ * Get a random boolean
  */
 export declare function getRandomBoolean(): boolean;
 /**
- * Returns a random string of characters with a specified length
+ * Get a random string of characters with a specified length
  * - `selection` defaults to all lowercase letters in the English alphabet
  */
 export declare function getRandomCharacters(length: number, selection?: string): string;
 /**
- * Returns a random hexadecimal colour
+ * Get a random hexadecimal colour
  */
 export declare function getRandomColour(): string;
 /**
- * Returns a random date
- */
-export declare function getRandomDate(earliest?: Date, latest?: Date): Date;
-/**
- * Returns a random floating-point number
+ * Get a random floating-point number
  */
 export declare function getRandomFloat(min?: number, max?: number): number;
 /**
- * Returns a random hexadecimal character
+ * Get a random hexadecimal character
  */
 export declare function getRandomHex(): string;
 /**
- * Returns a random integer
+ * Get a random integer
  */
 export declare function getRandomInteger(min?: number, max?: number): number;
 /**
- * Returns a random item from an array
+ * Get a random item from an array
  */
 export declare function getRandomItem<Value>(array: Value[]): Value;
 /**
- * - Returns an amount of random items from an array
+ * - Get an amount of random items from an array
  * - If `amount` is not specified, a shuffled array will be returned instead
  */
 export declare function getRandomItems<Value>(array: Value[], amount?: number): Value[];

package/types/sized.d.cts

@@ -16,18 +16,18 @@ export declare class SizedMap<Key = unknown, Value = unknown> extends Map<Key, V
 	 */
 	get maximum(): number;
 	/**
-	 * Creates a new Map with entries and a maximum size _(2^20)_
+	 * Create a new Map with entries and a maximum size _(2^20)_
 	 */
 	constructor(entries: Array<[
 		Key,
 		Value
 	]>);
 	/**
-	 * Creates a new Map with a maximum size _(but clamped at 2^24)_
+	 * Create a new Map with a maximum size _(but clamped at 2^24)_
 	 */
 	constructor(maximum: number);
 	/**
-	 * Creates a new Map with _(optional)_ entries and a maximum size _(defaults to 2^20; clamped at 2^24)_
+	 * Create a new Map with _(optional)_ entries and a maximum size _(defaults to 2^20; clamped at 2^24)_
 	 */
 	constructor(entries?: Array<[
 		Key,
@@ -58,15 +58,15 @@ export declare class SizedSet<Value = unknown> extends Set<Value> {
 	 */
 	get maximum(): number;
 	/**
-	 * Creates a new Set with values and a maximum size _(2^20)_
+	 * Create a new Set with values and a maximum size _(2^20)_
 	 */
 	constructor(values: Value[]);
 	/**
-	 * Creates a new Set with a maximum size _(but clamped at 2^24)_
+	 * Create a new Set with a maximum size _(but clamped at 2^24)_
 	 */
 	constructor(maximum: number);
 	/**
-	 * Creates a new Set with _(optional)_ values and a maximum size _(defaults to 2^20; clamped at 2^24)_
+	 * Create a new Set with _(optional)_ values and a maximum size _(defaults to 2^20; clamped at 2^24)_
 	 */
 	constructor(values?: Value[], maximum?: number);
 	/**

package/types/sized.d.ts

@@ -14,15 +14,15 @@ export declare class SizedMap<Key = unknown, Value = unknown> extends Map<Key, V
      */
     get maximum(): number;
     /**
-     * Creates a new Map with entries and a maximum size _(2^20)_
+     * Create a new Map with entries and a maximum size _(2^20)_
      */
     constructor(entries: Array<[Key, Value]>);
     /**
-     * Creates a new Map with a maximum size _(but clamped at 2^24)_
+     * Create a new Map with a maximum size _(but clamped at 2^24)_
      */
     constructor(maximum: number);
     /**
-     * Creates a new Map with _(optional)_ entries and a maximum size _(defaults to 2^20; clamped at 2^24)_
+     * Create a new Map with _(optional)_ entries and a maximum size _(defaults to 2^20; clamped at 2^24)_
      */
     constructor(entries?: Array<[Key, Value]>, maximum?: number);
     /**
@@ -50,15 +50,15 @@ export declare class SizedSet<Value = unknown> extends Set<Value> {
      */
     get maximum(): number;
     /**
-     * Creates a new Set with values and a maximum size _(2^20)_
+     * Create a new Set with values and a maximum size _(2^20)_
      */
     constructor(values: Value[]);
     /**
-     * Creates a new Set with a maximum size _(but clamped at 2^24)_
+     * Create a new Set with a maximum size _(but clamped at 2^24)_
      */
     constructor(maximum: number);
     /**
-     * Creates a new Set with _(optional)_ values and a maximum size _(defaults to 2^20; clamped at 2^24)_
+     * Create a new Set with _(optional)_ values and a maximum size _(defaults to 2^20; clamped at 2^24)_
      */
     constructor(values?: Value[], maximum?: number);
     /**

package/types/string/index.d.cts

@@ -66,6 +66,9 @@ export type Options = {
 	 */
 	pattern?: RegExp;
 };
+/**
+ * Render a string from a template with variables
+ */
 export declare function template(value: string, variables: PlainObject, options?: Partial<Options>): string;
 /**
  * Create a new UUID
@@ -76,15 +79,15 @@ export declare function createUuid(): string;
  */
 export declare function getString(value: unknown): string;
 /**
- * Joins an array into a string while ignoring empty values _(with an optional delimiter)_
+ * Join an array into a string while ignoring empty values _(with an optional delimiter)_
  */
 export declare function join(value: unknown[], delimiter?: string): string;
 /**
- * Parses a JSON string into its proper value _(or `undefined` if it fails)_
+ * Parse a JSON string into its proper value _(or `undefined` if it fails)_
  */
 export declare function parse(value: string, reviver?: (this: unknown, key: string, value: unknown) => unknown): unknown;
 /**
- * Truncates a string to a specified length, when possible
+ * Truncate a string to a specified length, when possible
  * - Returned as-is if the string is already short enough
  * - A suffix may be appended to the truncated string, e.g., an ellipsis
  */

package/types/string/index.d.ts

@@ -7,15 +7,15 @@ export declare function createUuid(): string;
  */
 export declare function getString(value: unknown): string;
 /**
- * Joins an array into a string while ignoring empty values _(with an optional delimiter)_
+ * Join an array into a string while ignoring empty values _(with an optional delimiter)_
  */
 export declare function join(value: unknown[], delimiter?: string): string;
 /**
- * Parses a JSON string into its proper value _(or `undefined` if it fails)_
+ * Parse a JSON string into its proper value _(or `undefined` if it fails)_
  */
 export declare function parse(value: string, reviver?: (this: unknown, key: string, value: unknown) => unknown): unknown;
 /**
- * Truncates a string to a specified length, when possible
+ * Truncate a string to a specified length, when possible
  * - Returned as-is if the string is already short enough
  * - A suffix may be appended to the truncated string, e.g., an ellipsis
  */

package/types/string/template.d.cts

@@ -42,6 +42,9 @@ export type Options = {
 	 */
 	pattern?: RegExp;
 };
+/**
+ * Render a string from a template with variables
+ */
 export declare function template(value: string, variables: PlainObject, options?: Partial<Options>): string;
 
 export {};

package/types/string/template.d.ts

@@ -1,4 +1,4 @@
-import type { PlainObject } from '@/models';
+import type { PlainObject } from '~/models';
 type Options = {
     /**
      * Ignore case when searching for variables?
@@ -9,5 +9,8 @@ type Options = {
      */
     pattern?: RegExp;
 };
+/**
+ * Render a string from a template with variables
+ */
 export declare function template(value: string, variables: PlainObject, options?: Partial<Options>): string;
 export {};