@oscarpalmer/atoms 0.74.1 → 0.76.0

package/types/array/sort.d.ts

@@ -1,16 +1,16 @@
-import type { Key } from '../models';
-import type { SortKey, SortKeyCallback } from './models';
+import type { SortKey, SortKeyCallback } from '~/array/models';
+import type { Key } from '~/models';
 /**
- * Sorts an array of items _(ascending by default)_
+ * Sort an array of items _(defaults to ascending)_
  */
-export declare function sort<Value>(array: Value[], descending?: boolean): Value[];
+export declare function sort<Item>(array: Item[], descending?: boolean): Item[];
 /**
- * - Sorts an array of items, using a `key` to sort by a specific value
- * - Ascending by default, but can be changed by setting `descending` to `true`, or using a `SortKey`
+ * - Sort an array of items, using a `key` to sort by a specific value
+ * - Defaults to ascending, but can be changed by setting `descending` to `true`, or using a `SortKey`
  */
-export declare function sort<Value>(array: Value[], key: Key | SortKey<Value> | SortKeyCallback<Value>, descending?: boolean): Value[];
+export declare function sort<Item>(array: Item[], key: Key | SortKey<Item> | SortKeyCallback<Item>, descending?: boolean): Item[];
 /**
- * - Sorts an array of items, using multiple `keys` to sort by specific values
- * - Ascending by default, but can be changed by setting `descending` to `true`, or using `SortKey`
+ * - Sort an array of items, using multiple `keys` to sort by specific values
+ * - Defaults to ascending, but can be changed by setting `descending` to `true`, or using `SortKey`
  */
-export declare function sort<Value>(array: Value[], keys: Array<Key | SortKey<Value> | SortKeyCallback<Value>>, descending?: boolean): Value[];
+export declare function sort<Item>(array: Item[], keys: Array<Key | SortKey<Item> | SortKeyCallback<Item>>, descending?: boolean): Item[];

package/types/array/splice.d.cts

@@ -0,0 +1,22 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+ * Removes and returns all items from an array starting from a specific index
+ */
+export declare function splice<Item>(array: Item[], start: number): Item[];
+/**
+ * Removes and returns _(up to)_ a specific amount of items from an array, starting from a specific index
+ */
+export declare function splice<Item>(array: Item[], start: number, amount: number): Item[];
+/**
+ * - Splices values into an array and returns any removed values
+ * - Uses chunking to avoid stack overflow
+ */
+export declare function splice<Item>(array: Item[], start: number, added: Item[]): Item[];
+/**
+ * - Splices values into an array and returns any removed values
+ * - Uses chunking to avoid stack overflow
+ */
+export declare function splice<Item>(array: Item[], start: number, amount: number, added: Item[]): Item[];
+
+export {};

package/types/array/splice.d.ts

@@ -1,18 +1,18 @@
 /**
  * Removes and returns all items from an array starting from a specific index
  */
-export declare function splice<Value>(array: Value[], start: number): Value[];
+export declare function splice<Item>(array: Item[], start: number): Item[];
 /**
  * Removes and returns _(up to)_ a specific amount of items from an array, starting from a specific index
  */
-export declare function splice<Value>(array: Value[], start: number, amount: number): Value[];
+export declare function splice<Item>(array: Item[], start: number, amount: number): Item[];
 /**
  * - Splices values into an array and returns any removed values
  * - Uses chunking to avoid stack overflow
  */
-export declare function splice<Value>(array: Value[], start: number, values: Value[]): Value[];
+export declare function splice<Item>(array: Item[], start: number, added: Item[]): Item[];
 /**
  * - Splices values into an array and returns any removed values
  * - Uses chunking to avoid stack overflow
  */
-export declare function splice<Value>(array: Value[], start: number, amount: number, values: Value[]): Value[];
+export declare function splice<Item>(array: Item[], start: number, amount: number, added: Item[]): Item[];

package/types/array/to-map.d.cts

@@ -0,0 +1,61 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type KeyedValue<Item, Key extends keyof Item> = Item[Key] extends PropertyKey ? Item[Key] : never;
+export type Key = number | string;
+export type ArrayCallback<Item, Value> = (item: Item, index: number, array: Item[]) => Value;
+export type KeyCallback<Item> = ArrayCallback<Item, Key>;
+export type ValueCallback<Item> = ArrayCallback<Item, unknown>;
+/**
+ * Create a map from an array of items _(using their indices as keys)_
+ */
+export declare function toMap<Item>(array: Item[]): Map<number, Item>;
+/**
+ * Create a map from an array of items using a specific key
+ */
+export declare function toMap<Item, Key extends keyof Item>(array: Item[], key: Key): Map<KeyedValue<Item, Key>, Item>;
+/**
+ * Create a map from an array of items using a specific key, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends keyof Item>(array: Item[], key: Key, arrays: true): Map<KeyedValue<Item, Key>, Item[]>;
+/**
+ * Create a map from an array of items using a specific key
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key): Map<ReturnType<Key>, Item>;
+/**
+ * Create a map from an array of items using a specific key, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key, arrays: true): Map<ReturnType<Key>, Item[]>;
+/**
+ * Create a map from an array of items using a specific key and value
+ */
+export declare function toMap<Item, Key extends keyof Item, Value extends keyof Item>(array: Item[], key: Key, value: Value): Map<KeyedValue<Item, Key>, KeyedValue<Item, Value>>;
+/**
+ * Create a map from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends keyof Item, Value extends keyof Item>(array: Item[], key: Key, value: Value, arrays: true): Map<KeyedValue<Item, Key>, Array<KeyedValue<Item, Value>>>;
+/**
+ * Create a map from an array of items using a specific key and value
+ */
+export declare function toMap<Item, Key extends keyof Item, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value): Map<KeyedValue<Item, Key>, ReturnType<Value>>;
+/**
+ * Create a map from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends keyof Item, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value, arrays: true): Map<KeyedValue<Item, Key>, Array<ReturnType<Value>>>;
+/**
+ * Create a map from an array of items using a specific key and value
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>, Value extends keyof Item>(array: Item[], key: Key, value: Value): Map<ReturnType<Key>, KeyedValue<Item, Value>>;
+/**
+ * Create a map from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>, Value extends keyof Item>(array: Item[], key: Key, value: Value, arrays: true): Map<ReturnType<Key>, Array<KeyedValue<Item, Value>>>;
+/**
+ * Create a map from an array of items using a specific key and value
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value): Map<ReturnType<Key>, ReturnType<Value>>;
+/**
+ * Create a map from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value, arrays: true): Map<ReturnType<Key>, Array<ReturnType<Value>>>;
+
+export {};

package/types/array/to-map.d.ts

@@ -1,32 +1,54 @@
-import type { Key } from '../models';
-import type { KeyCallback } from './models';
+import type { KeyCallback, ValueCallback } from '~/array/models';
+import type { KeyedValue } from '~/models';
 /**
- * Converts an array into a map, using indices as keys
+ * Create a map from an array of items _(using their indices as keys)_
  */
-export declare function toMap<Value>(array: Value[]): Map<number, Value>;
+export declare function toMap<Item>(array: Item[]): Map<number, Item>;
 /**
- * Converts an array into a map, using indices as keys and grouping values into arrays
+ * Create a map from an array of items using a specific key
  */
-export declare function toMap<Value>(array: Value[], arrays: true): Map<number, Value[]>;
+export declare function toMap<Item, Key extends keyof Item>(array: Item[], key: Key): Map<KeyedValue<Item, Key>, Item>;
 /**
- * - Converts an array into a map
- * - Uses `key` to find an identifcation value to use as keys
+ * Create a map from an array of items using a specific key, and grouping them into arrays
  */
-export declare function toMap<Value>(array: Value[], key: Key): Map<Key, Value>;
+export declare function toMap<Item, Key extends keyof Item>(array: Item[], key: Key, arrays: true): Map<KeyedValue<Item, Key>, Item[]>;
 /**
- * - Converts an array into a map
- * - Uses `key` to find an identifcation value to use as keys
- * - Groups values into arrays
+ * Create a map from an array of items using a specific key
  */
-export declare function toMap<Value>(array: Value[], key: Key, arrays: true): Map<Key, Value[]>;
+export declare function toMap<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key): Map<ReturnType<Key>, Item>;
 /**
- * - Converts an array into a map
- * - Uses `key` to find an identifcation value to use as keys
+ * Create a map from an array of items using a specific key, and grouping them into arrays
  */
-export declare function toMap<Value>(array: Value[], key: KeyCallback<Value>): Map<Key, Value>;
+export declare function toMap<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key, arrays: true): Map<ReturnType<Key>, Item[]>;
 /**
- * - Converts an array into a map
- * - Uses `key` to find an identifcation value to use as keys
- * - Groups values into arrays
+ * Create a map from an array of items using a specific key and value
  */
-export declare function toMap<Value>(array: Value[], key: KeyCallback<Value>, arrays: true): Map<Key, Value[]>;
+export declare function toMap<Item, Key extends keyof Item, Value extends keyof Item>(array: Item[], key: Key, value: Value): Map<KeyedValue<Item, Key>, KeyedValue<Item, Value>>;
+/**
+ * Create a map from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends keyof Item, Value extends keyof Item>(array: Item[], key: Key, value: Value, arrays: true): Map<KeyedValue<Item, Key>, Array<KeyedValue<Item, Value>>>;
+/**
+ * Create a map from an array of items using a specific key and value
+ */
+export declare function toMap<Item, Key extends keyof Item, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value): Map<KeyedValue<Item, Key>, ReturnType<Value>>;
+/**
+ * Create a map from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends keyof Item, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value, arrays: true): Map<KeyedValue<Item, Key>, Array<ReturnType<Value>>>;
+/**
+ * Create a map from an array of items using a specific key and value
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>, Value extends keyof Item>(array: Item[], key: Key, value: Value): Map<ReturnType<Key>, KeyedValue<Item, Value>>;
+/**
+ * Create a map from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>, Value extends keyof Item>(array: Item[], key: Key, value: Value, arrays: true): Map<ReturnType<Key>, Array<KeyedValue<Item, Value>>>;
+/**
+ * Create a map from an array of items using a specific key and value
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value): Map<ReturnType<Key>, ReturnType<Value>>;
+/**
+ * Create a map from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toMap<Item, Key extends KeyCallback<Item>, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value, arrays: true): Map<ReturnType<Key>, Array<ReturnType<Value>>>;

package/types/array/to-record.d.cts

@@ -0,0 +1,61 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type KeyedValue<Item, Key extends keyof Item> = Item[Key] extends PropertyKey ? Item[Key] : never;
+export type Key = number | string;
+export type ArrayCallback<Item, Value> = (item: Item, index: number, array: Item[]) => Value;
+export type KeyCallback<Item> = ArrayCallback<Item, Key>;
+export type ValueCallback<Item> = ArrayCallback<Item, unknown>;
+/**
+ * Create a record from an array of items _(using their indices as keys)_
+ */
+export declare function toRecord<Item>(array: Item[]): Record<number, Item>;
+/**
+ * Create a record from an array of items using a specific key
+ */
+export declare function toRecord<Item, Key extends keyof Item>(array: Item[], key: Key): Record<KeyedValue<Item, Key>, Item>;
+/**
+ * Create a record from an array of items using a specific key, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends keyof Item>(array: Item[], key: Key, arrays: true): Record<KeyedValue<Item, Key>, Item[]>;
+/**
+ * Create a record from an array of items using a specific key
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key): Record<ReturnType<Key>, Item>;
+/**
+ * Create a record from an array of items using a specific key, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key, arrays: true): Record<ReturnType<Key>, Item[]>;
+/**
+ * Create a record from an array of items using a specific key and value
+ */
+export declare function toRecord<Item, Key extends keyof Item, Value extends keyof Item>(array: Item[], key: Key, value: Value): Record<KeyedValue<Item, Key>, KeyedValue<Item, Value>>;
+/**
+ * Create a record from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends keyof Item, Value extends keyof Item>(array: Item[], key: Key, value: Value, arrays: true): Record<KeyedValue<Item, Key>, Array<KeyedValue<Item, Value>>>;
+/**
+ * Create a record from an array of items using a specific key and value
+ */
+export declare function toRecord<Item, Key extends keyof Item, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value): Record<KeyedValue<Item, Key>, ReturnType<Value>>;
+/**
+ * Create a record from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends keyof Item, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value, arrays: true): Record<KeyedValue<Item, Key>, Array<ReturnType<Value>>>;
+/**
+ * Create a record from an array of items using a specific key and value
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>, Value extends keyof Item>(array: Item[], key: Key, value: Value): Record<ReturnType<Key>, KeyedValue<Item, Value>>;
+/**
+ * Create a record from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>, Value extends keyof Item>(array: Item[], key: Key, value: Value, arrays: true): Record<ReturnType<Key>, Array<KeyedValue<Item, Value>>>;
+/**
+ * Create a record from an array of items using a specific key and value
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value): Record<ReturnType<Key>, ReturnType<Value>>;
+/**
+ * Create a record from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value, arrays: true): Record<ReturnType<Key>, Array<ReturnType<Value>>>;
+
+export {};

package/types/array/to-record.d.ts

@@ -1,32 +1,54 @@
-import type { Key } from '../models';
-import type { KeyCallback } from './models';
+import type { KeyCallback, ValueCallback } from '~/array/models';
+import type { KeyedValue } from '~/models';
 /**
- * Converts an array into a record, using indices as keys
+ * Create a record from an array of items _(using their indices as keys)_
  */
-export declare function toRecord<Value>(array: Value[]): Record<number, Value>;
+export declare function toRecord<Item>(array: Item[]): Record<number, Item>;
 /**
- * Converts an array into a record, using indices as keys and grouping values into arrays
+ * Create a record from an array of items using a specific key
  */
-export declare function toRecord<Value>(array: Value[], arrays: true): Record<number, Value[]>;
+export declare function toRecord<Item, Key extends keyof Item>(array: Item[], key: Key): Record<KeyedValue<Item, Key>, Item>;
 /**
- * - Converts an array into a record
- * - Uses `key` to find an identifcation value to use as keys
+ * Create a record from an array of items using a specific key, and grouping them into arrays
  */
-export declare function toRecord<Value>(array: Value[], key: Key): Record<Key, Value>;
+export declare function toRecord<Item, Key extends keyof Item>(array: Item[], key: Key, arrays: true): Record<KeyedValue<Item, Key>, Item[]>;
 /**
- * - Converts an array into a record
- * - Uses `key` to find an identifcation value to use as keys
- * - Groups values into arrays
+ * Create a record from an array of items using a specific key
  */
-export declare function toRecord<Value>(array: Value[], key: Key, arrays: true): Record<Key, Value[]>;
+export declare function toRecord<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key): Record<ReturnType<Key>, Item>;
 /**
- * - Converts an array into a record
- * - Uses `key` to find an identifcation value to use as keys
+ * Create a record from an array of items using a specific key, and grouping them into arrays
  */
-export declare function toRecord<Value>(array: Value[], key: KeyCallback<Value>): Record<Key, Value>;
+export declare function toRecord<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key, arrays: true): Record<ReturnType<Key>, Item[]>;
 /**
- * - Converts an array into a record
- * - Uses `key` to find an identifcation value to use as keys
- * - Groups values into arrays
+ * Create a record from an array of items using a specific key and value
  */
-export declare function toRecord<Value>(array: Value[], key: KeyCallback<Value>, arrays: true): Record<Key, Value[]>;
+export declare function toRecord<Item, Key extends keyof Item, Value extends keyof Item>(array: Item[], key: Key, value: Value): Record<KeyedValue<Item, Key>, KeyedValue<Item, Value>>;
+/**
+ * Create a record from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends keyof Item, Value extends keyof Item>(array: Item[], key: Key, value: Value, arrays: true): Record<KeyedValue<Item, Key>, Array<KeyedValue<Item, Value>>>;
+/**
+ * Create a record from an array of items using a specific key and value
+ */
+export declare function toRecord<Item, Key extends keyof Item, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value): Record<KeyedValue<Item, Key>, ReturnType<Value>>;
+/**
+ * Create a record from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends keyof Item, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value, arrays: true): Record<KeyedValue<Item, Key>, Array<ReturnType<Value>>>;
+/**
+ * Create a record from an array of items using a specific key and value
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>, Value extends keyof Item>(array: Item[], key: Key, value: Value): Record<ReturnType<Key>, KeyedValue<Item, Value>>;
+/**
+ * Create a record from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>, Value extends keyof Item>(array: Item[], key: Key, value: Value, arrays: true): Record<ReturnType<Key>, Array<KeyedValue<Item, Value>>>;
+/**
+ * Create a record from an array of items using a specific key and value
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value): Record<ReturnType<Key>, ReturnType<Value>>;
+/**
+ * Create a record from an array of items using a specific key and value, and grouping them into arrays
+ */
+export declare function toRecord<Item, Key extends KeyCallback<Item>, Value extends ValueCallback<Item>>(array: Item[], key: Key, value: Value, arrays: true): Record<ReturnType<Key>, Array<ReturnType<Value>>>;

package/types/array/unique.d.cts

@@ -0,0 +1,21 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type Key = number | string;
+export type ArrayCallback<Item, Value> = (item: Item, index: number, array: Item[]) => Value;
+export type KeyCallback<Item> = ArrayCallback<Item, Key>;
+/**
+ * Get an array of unique items
+ */
+export declare function unique<Item>(array: Item[]): Item[];
+/**
+ * - Get an array of unique items
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function unique<Item, Key extends keyof Item>(array: Item[], key: Key): Item[];
+/**
+ * - Get an array of unique items
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function unique<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key): Item[];
+
+export {};

package/types/array/unique.d.ts

@@ -1,11 +1,15 @@
-import type { Key } from '../models';
-import type { KeyCallback } from './models';
+import type { KeyCallback } from '~/array/models';
 /**
- * Returns an array of unique items
+ * Get an array of unique items
  */
-export declare function unique<Value>(array: Value[]): Value[];
+export declare function unique<Item>(array: Item[]): Item[];
 /**
- * - Returns an array of unique items
+ * - Get an array of unique items
  * - Use `key` to find a comparison value to match with `value`
  */
-export declare function unique<Value>(array: Value[], key: Key | KeyCallback<Value>): Value[];
+export declare function unique<Item, Key extends keyof Item>(array: Item[], key: Key): Item[];
+/**
+ * - Get an array of unique items
+ * - Use `key` to find a comparison value to match with `value`
+ */
+export declare function unique<Item, Key extends KeyCallback<Item>>(array: Item[], key: Key): Item[];

package/types/colour/base.d.cts

@@ -0,0 +1,153 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type HSLColourValue = {
+	hue: number;
+	lightness: number;
+	saturation: number;
+};
+declare class HSLColour extends Colour<HSLColourValue> {
+	/**
+	 * Get the current hue
+	 */
+	get hue(): number;
+	/**
+	 * Set the current hue
+	 */
+	set hue(value: number);
+	/**
+	 * Get the current lightness
+	 */
+	get lightness(): number;
+	/**
+	 * Set the current lightness
+	 */
+	set lightness(value: number);
+	/**
+	 * Get the current saturation
+	 */
+	get saturation(): number;
+	/**
+	 * Set the current saturation
+	 */
+	set saturation(value: number);
+	constructor(value: HSLColourValue);
+	/**
+	 * @inheritdoc
+	 */
+	toHex(): HexColour;
+	/**
+	 * Convert the colour to an RGB-colour
+	 */
+	toRgb(): RGBColour;
+	/**
+	 * @inheritdoc
+	 */
+	toString(): string;
+	/**
+	 * Convert an HSL-colour to an RGB-colour
+	 */
+	static toRgb(value: HSLColourValue): RGBColour;
+}
+declare class HexColour {
+	private readonly $colour;
+	private readonly state;
+	/**
+	 * Get the value of the colour
+	 */
+	get value(): string;
+	/**
+	 * Set the value of the colour
+	 */
+	set value(value: string);
+	constructor(value: string);
+	/**
+	 * Convert the colour to an RGB-colour
+	 */
+	toHsl(): HSLColour;
+	/**
+	 * Convert the colour to an HSL-colour
+	 */
+	toRgb(): RGBColour;
+	/**
+	 * Get the colour as a string _(prefixed with #)_
+	 */
+	toString(): string;
+	/**
+	 * Convert a hex-colour to an RGB-colour
+	 */
+	static toRgb(value: string): RGBColour;
+}
+export declare abstract class Colour<Model> {
+	private readonly $colour;
+	protected readonly state: ColourState<Model>;
+	/**
+	 * Get the current value of the colour
+	 */
+	get value(): Model;
+	constructor(type: string, value: Model, defaults: Model, properties: Array<keyof Model>);
+	/**
+	 * Convert the colour to a hex-colour
+	 */
+	abstract toHex(): HexColour;
+	/**
+	 * Get the colour as a _CSS-formatted_ string
+	 */
+	abstract toString(): string;
+}
+export type ColourState<Model> = {
+	value: Model;
+};
+export type RGBColourValue = {
+	blue: number;
+	green: number;
+	red: number;
+};
+declare class RGBColour extends Colour<RGBColourValue> {
+	/**
+	 * Get the current blue value
+	 */
+	get blue(): number;
+	/**
+	 * Set the current blue value
+	 */
+	set blue(value: number);
+	/**
+	 * Get the current green value
+	 */
+	get green(): number;
+	/**
+	 * Set the current green value
+	 */
+	set green(value: number);
+	/**
+	 * Get the current red value
+	 */
+	get red(): number;
+	/**
+	 * 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
+	 */
+	static toHex(value: RGBColourValue): HexColour;
+	/**
+	 * - Convert an RGB-colour to an HSL-colour
+	 */
+	static toHsl(rgb: RGBColourValue): HSLColour;
+}
+
+export {};

package/types/colour/base.d.ts

@@ -1,9 +1,9 @@
-import type { HexColour } from './hex';
+import type { HexColour } from '~/colour/hex';
 export 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>);