@oscarpalmer/atoms 0.75.0 → 0.76.0

package/types/colour/is.d.ts

@@ -1,6 +1,6 @@
-import type { HexColour } from '@/colour/hex';
-import type { HSLColour } from '@/colour/hsl';
-import type { RGBColour } from '@/colour/rgb';
+import type { HexColour } from '~/colour/hex';
+import type { HSLColour } from '~/colour/hsl';
+import type { RGBColour } from '~/colour/rgb';
 /**
  * Is the value a colour?
  */

package/types/colour/rgb.d.cts

@@ -7,35 +7,41 @@ export type HSLColourValue = {
 };
 declare class HSLColour extends Colour<HSLColourValue> {
 	/**
-	 * Gets the current hue
+	 * Get the current hue
 	 */
 	get hue(): number;
 	/**
-	 * Sets the current hue
+	 * Set the current hue
 	 */
 	set hue(value: number);
 	/**
-	 * Gets the current lightness
+	 * Get the current lightness
 	 */
 	get lightness(): number;
 	/**
-	 * Sets the current lightness
+	 * Set the current lightness
 	 */
 	set lightness(value: number);
 	/**
-	 * Gets the current saturation
+	 * Get the current saturation
 	 */
 	get saturation(): number;
 	/**
-	 * Sets the current saturation
+	 * Set the current saturation
 	 */
 	set saturation(value: number);
 	constructor(value: HSLColourValue);
+	/**
+	 * @inheritdoc
+	 */
 	toHex(): HexColour;
 	/**
-	 * Converts the colour to an RGB-colour
+	 * Convert the colour to an RGB-colour
 	 */
 	toRgb(): RGBColour;
+	/**
+	 * @inheritdoc
+	 */
 	toString(): string;
 	/**
 	 * Convert an HSL-colour to an RGB-colour
@@ -46,11 +52,11 @@ declare class HexColour {
 	private readonly $colour;
 	private readonly state;
 	/**
-	 * Gets the value of the colour
+	 * Get the value of the colour
 	 */
 	get value(): string;
 	/**
-	 * Sets the value of the colour
+	 * Set the value of the colour
 	 */
 	set value(value: string);
 	constructor(value: string);
@@ -75,7 +81,7 @@ declare abstract class Colour<Model> {
 	private readonly $colour;
 	protected readonly state: ColourState<Model>;
 	/**
-	 * Gets the current value of the colour
+	 * Get the current value of the colour
 	 */
 	get value(): Model;
 	constructor(type: string, value: Model, defaults: Model, properties: Array<keyof Model>);
@@ -98,35 +104,41 @@ export type RGBColourValue = {
 };
 export declare class RGBColour extends Colour<RGBColourValue> {
 	/**
-	 * Gets the current blue value
+	 * Get the current blue value
 	 */
 	get blue(): number;
 	/**
-	 * Sets the current blue value
+	 * Set the current blue value
 	 */
 	set blue(value: number);
 	/**
-	 * Gets the current green value
+	 * Get the current green value
 	 */
 	get green(): number;
 	/**
-	 * Sets the current green value
+	 * Set the current green value
 	 */
 	set green(value: number);
 	/**
-	 * Gets the current red value
+	 * Get the current red value
 	 */
 	get red(): number;
 	/**
-	 * Sets the current red value
+	 * Set the current red value
 	 */
 	set red(value: number);
 	constructor(value: RGBColourValue);
+	/**
+	 * @inheritdoc
+	 */
 	toHex(): HexColour;
 	/**
 	 * Convert the colour to an HSL-colour
 	 */
 	toHsl(): HSLColour;
+	/**
+	 * @inheritdoc
+	 */
 	toString(): string;
 	/**
 	 * Convert an RGB-colour to a hex-colour

package/types/colour/rgb.d.ts

@@ -1,6 +1,6 @@
-import { Colour } from '@/colour/base';
-import type { HexColour } from '@/colour/hex';
-import type { HSLColour } from '@/colour/hsl';
+import { Colour } from '~/colour/base';
+import type { HexColour } from '~/colour/hex';
+import type { HSLColour } from '~/colour/hsl';
 export type RGBColourValue = {
     blue: number;
     green: number;
@@ -8,35 +8,41 @@ export type RGBColourValue = {
 };
 export declare class RGBColour extends Colour<RGBColourValue> {
     /**
-     * Gets the current blue value
+     * Get the current blue value
      */
     get blue(): number;
     /**
-     * Sets the current blue value
+     * Set the current blue value
      */
     set blue(value: number);
     /**
-     * Gets the current green value
+     * Get the current green value
      */
     get green(): number;
     /**
-     * Sets the current green value
+     * Set the current green value
      */
     set green(value: number);
     /**
-     * Gets the current red value
+     * Get the current red value
      */
     get red(): number;
     /**
-     * Sets the current red value
+     * Set the current red value
      */
     set red(value: number);
     constructor(value: RGBColourValue);
+    /**
+     * @inheritdoc
+     */
     toHex(): HexColour;
     /**
      * Convert the colour to an HSL-colour
      */
     toHsl(): HSLColour;
+    /**
+     * @inheritdoc
+     */
     toString(): string;
     /**
      * Convert an RGB-colour to a hex-colour

package/types/emitter.d.cts

@@ -16,19 +16,19 @@ export declare class Emitter<Value> {
 	get value(): Value;
 	constructor(value: Value);
 	/**
-	 * Destroys the emitter
+	 * Destroy the emitter
 	 */
 	destroy(): void;
 	/**
-	 * Emits a new value _(and optionally finishes the emitter)_
+	 * Emit a new value _(and optionally finishes the emitter)_
 	 */
 	emit(value: Value, finish?: boolean): void;
 	/**
-	 * Emits an error _(and optionally finishes the emitter)_
+	 * Emit an error _(and optionally finishes the emitter)_
 	 */
 	error(error: Error, finish?: boolean): void;
 	/**
-	 * Finishes the emitter
+	 * Finish the emitter
 	 */
 	finish(): void;
 }
@@ -36,11 +36,11 @@ export declare class Observable<Value> {
 	private readonly state;
 	constructor(emitter: Emitter<Value>, observers: Map<Subscription<Value>, Observer<Value>>);
 	/**
-	 * Subscribes to value changes
+	 * Subscribe to value changes
 	 */
 	subscribe(observer: Observer<Value>): Subscription<Value>;
 	/**
-	 * Subscribes to value changes
+	 * Subscribe to value changes
 	 */
 	subscribe(onNext: (value: Value) => void, onError?: (error: Error) => void, onComplete?: () => void): Subscription<Value>;
 }
@@ -69,14 +69,17 @@ export declare class Subscription<Value> {
 	 * Is the subscription closed?
 	 */
 	get closed(): boolean;
+	/**
+	 * Destroy the subscription
+	 */
 	destroy(): void;
 	/**
-	 * Unsubscribes from the observable
+	 * Unsubscribe from its observable
 	 */
 	unsubscribe(): void;
 }
 /**
- * Creates a new emitter
+ * Create a new emitter
  */
 export declare function emitter<Value>(value: Value): Emitter<Value>;
 

package/types/emitter.d.ts

@@ -14,19 +14,19 @@ declare class Emitter<Value> {
     get value(): Value;
     constructor(value: Value);
     /**
-     * Destroys the emitter
+     * Destroy the emitter
      */
     destroy(): void;
     /**
-     * Emits a new value _(and optionally finishes the emitter)_
+     * Emit a new value _(and optionally finishes the emitter)_
      */
     emit(value: Value, finish?: boolean): void;
     /**
-     * Emits an error _(and optionally finishes the emitter)_
+     * Emit an error _(and optionally finishes the emitter)_
      */
     error(error: Error, finish?: boolean): void;
     /**
-     * Finishes the emitter
+     * Finish the emitter
      */
     finish(): void;
 }
@@ -34,11 +34,11 @@ declare class Observable<Value> {
     private readonly state;
     constructor(emitter: Emitter<Value>, observers: Map<Subscription<Value>, Observer<Value>>);
     /**
-     * Subscribes to value changes
+     * Subscribe to value changes
      */
     subscribe(observer: Observer<Value>): Subscription<Value>;
     /**
-     * Subscribes to value changes
+     * Subscribe to value changes
      */
     subscribe(onNext: (value: Value) => void, onError?: (error: Error) => void, onComplete?: () => void): Subscription<Value>;
 }
@@ -67,14 +67,17 @@ declare class Subscription<Value> {
      * Is the subscription closed?
      */
     get closed(): boolean;
+    /**
+     * Destroy the subscription
+     */
     destroy(): void;
     /**
-     * Unsubscribes from the observable
+     * Unsubscribe from its observable
      */
     unsubscribe(): void;
 }
 /**
- * Creates a new emitter
+ * Create a new emitter
  */
 export declare function emitter<Value>(value: Value): Emitter<Value>;
 export type { Emitter, Observable, Observer, Subscription };

package/types/function.d.cts

@@ -3,7 +3,7 @@
 export type GenericCallback = (...args: any[]) => any;
 export type Debounced<Callback extends GenericCallback> = Callback & {
 	/**
-	 * Cancels the debounce
+	 * Cancel the debounce
 	 */
 	cancel: () => void;
 };
@@ -11,27 +11,27 @@ declare class Memoised<Callback extends GenericCallback> {
 	readonly state: MemoisedState<Callback>;
 	constructor(callback: Callback);
 	/**
-	 * Clears the cache
+	 * Clear the cache
 	 */
 	clear(): void;
 	/**
-	 * Deletes a result from the cache
+	 * Delete a result from the cache
 	 */
 	delete(key: Parameters<Callback>[0]): boolean;
 	/**
-	 * Destroys the instance, clearing its cache and removing its callback
+	 * Destroy the instance, clearing its cache and removing its callback
 	 */
 	destroy(): void;
 	/**
-	 * Retrieves the result from the cache if it exists, or `undefined` otherwise
+	 * Get a result from the cache if it exists _(or `undefined` otherwise)_
 	 */
 	get(key: Parameters<Callback>[0]): ReturnType<Callback> | undefined;
 	/**
-	 * Checks if the cache has a result for a given key
+	 * Does the result exist?
 	 */
 	has(key: Parameters<Callback>[0]): boolean;
 	/**
-	 * Retrieves the result from the cache if it exists, otherwise runs the callback, caches the result, and returns it
+	 * Get the result from the cache if it exists; otherwise runs the callback, caches the result, and returns it
 	 */
 	run(...parameters: Parameters<Callback>): ReturnType<Callback>;
 }
@@ -40,14 +40,14 @@ export type MemoisedState<Callback extends GenericCallback> = {
 	getter: (...parameters: Parameters<Callback>) => ReturnType<Callback>;
 };
 /**
- * - Debounces a function, ensuring it is only called after `time` milliseconds have passed
+ * - Debounce a function, ensuring it is only called after `time` milliseconds have passed
  * - On subsequent calls, the timer is reset and will wait another `time` milliseconds _(and so on...)_
  * - Time is clamped between _0_ and _1000_ milliseconds
  * - Returns the callback with an added `cancel`-method for manually cancelling the debounce
  */
 export declare function debounce<Callback extends GenericCallback>(callback: Callback, time?: number): Debounced<Callback>;
 /**
- * Memoises a function, caching and retrieving results based on the first parameter
+ * Memoise a function, caching and retrieving results based on the first parameter
  */
 export declare function memoise<Callback extends GenericCallback>(callback: Callback): Memoised<Callback>;
 /**
@@ -55,7 +55,7 @@ export declare function memoise<Callback extends GenericCallback>(callback: Call
  */
 export declare function noop(): void;
 /**
- * - Throttles a function, ensuring it is only called once every `time` milliseconds
+ * - Throttle a function, ensuring it is only called once every `time` milliseconds
  * - Time is clamped between _0_ and _1000_ milliseconds
  */
 export declare function throttle<Callback extends GenericCallback>(callback: Callback, time?: number): Callback;

package/types/function.d.ts

@@ -1,7 +1,7 @@
-import type { GenericCallback } from '@/models';
+import type { GenericCallback } from '~/models';
 type Debounced<Callback extends GenericCallback> = Callback & {
     /**
-     * Cancels the debounce
+     * Cancel the debounce
      */
     cancel: () => void;
 };
@@ -9,27 +9,27 @@ declare class Memoised<Callback extends GenericCallback> {
     readonly state: MemoisedState<Callback>;
     constructor(callback: Callback);
     /**
-     * Clears the cache
+     * Clear the cache
      */
     clear(): void;
     /**
-     * Deletes a result from the cache
+     * Delete a result from the cache
      */
     delete(key: Parameters<Callback>[0]): boolean;
     /**
-     * Destroys the instance, clearing its cache and removing its callback
+     * Destroy the instance, clearing its cache and removing its callback
      */
     destroy(): void;
     /**
-     * Retrieves the result from the cache if it exists, or `undefined` otherwise
+     * Get a result from the cache if it exists _(or `undefined` otherwise)_
      */
     get(key: Parameters<Callback>[0]): ReturnType<Callback> | undefined;
     /**
-     * Checks if the cache has a result for a given key
+     * Does the result exist?
      */
     has(key: Parameters<Callback>[0]): boolean;
     /**
-     * Retrieves the result from the cache if it exists, otherwise runs the callback, caches the result, and returns it
+     * Get the result from the cache if it exists; otherwise runs the callback, caches the result, and returns it
      */
     run(...parameters: Parameters<Callback>): ReturnType<Callback>;
 }
@@ -38,14 +38,14 @@ type MemoisedState<Callback extends GenericCallback> = {
     getter: (...parameters: Parameters<Callback>) => ReturnType<Callback>;
 };
 /**
- * - Debounces a function, ensuring it is only called after `time` milliseconds have passed
+ * - Debounce a function, ensuring it is only called after `time` milliseconds have passed
  * - On subsequent calls, the timer is reset and will wait another `time` milliseconds _(and so on...)_
  * - Time is clamped between _0_ and _1000_ milliseconds
  * - Returns the callback with an added `cancel`-method for manually cancelling the debounce
  */
 export declare function debounce<Callback extends GenericCallback>(callback: Callback, time?: number): Debounced<Callback>;
 /**
- * Memoises a function, caching and retrieving results based on the first parameter
+ * Memoise a function, caching and retrieving results based on the first parameter
  */
 export declare function memoise<Callback extends GenericCallback>(callback: Callback): Memoised<Callback>;
 /**
@@ -53,7 +53,7 @@ export declare function memoise<Callback extends GenericCallback>(callback: Call
  */
 export declare function noop(): void;
 /**
- * - Throttles a function, ensuring it is only called once every `time` milliseconds
+ * - Throttle a function, ensuring it is only called once every `time` milliseconds
  * - Time is clamped between _0_ and _1000_ milliseconds
  */
 export declare function throttle<Callback extends GenericCallback>(callback: Callback, time?: number): Callback;