@oscarpalmer/atoms 0.75.0 → 0.76.0

package/dist/js/colour/hsl.cjs

@@ -5,37 +5,37 @@ const colour_functions = require("./functions.cjs");
 const number = require("../number.cjs");
 class HSLColour extends colour_base.Colour {
   /**
-   * Gets the current hue
+   * Get the current hue
    */
   get hue() {
     return +this.state.value.hue;
   }
   /**
-   * Sets the current hue
+   * Set the current hue
    */
   set hue(value) {
     this.state.value.hue = number.clamp(value, 0, 360);
   }
   /**
-   * Gets the current lightness
+   * Get the current lightness
    */
   get lightness() {
     return +this.state.value.lightness;
   }
   /**
-   * Sets the current lightness
+   * Set the current lightness
    */
   set lightness(value) {
     this.state.value.lightness = number.clamp(value, 0, 100);
   }
   /**
-   * Gets the current saturation
+   * Get the current saturation
    */
   get saturation() {
     return +this.state.value.saturation;
   }
   /**
-   * Sets the current saturation
+   * Set the current saturation
    */
   set saturation(value) {
     this.state.value.saturation = number.clamp(value, 0, 100);
@@ -43,15 +43,21 @@ class HSLColour extends colour_base.Colour {
   constructor(value) {
     super("hsl", value, defaults, properties);
   }
+  /**
+   * @inheritdoc
+   */
   toHex() {
     return HSLColour.toRgb(this.state.value).toHex();
   }
   /**
-   * Converts the colour to an RGB-colour
+   * Convert the colour to an RGB-colour
    */
   toRgb() {
     return HSLColour.toRgb(this.state.value);
   }
+  /**
+   * @inheritdoc
+   */
   toString() {
     return `hsl(${this.state.value.hue}, ${this.state.value.saturation}%, ${this.state.value.lightness}%)`;
   }

package/dist/js/colour/hsl.js

@@ -3,37 +3,37 @@ import { hslToRgb } from "./functions.js";
 import { clamp } from "../number.js";
 class HSLColour extends Colour {
   /**
-   * Gets the current hue
+   * Get the current hue
    */
   get hue() {
     return +this.state.value.hue;
   }
   /**
-   * Sets the current hue
+   * Set the current hue
    */
   set hue(value) {
     this.state.value.hue = clamp(value, 0, 360);
   }
   /**
-   * Gets the current lightness
+   * Get the current lightness
    */
   get lightness() {
     return +this.state.value.lightness;
   }
   /**
-   * Sets the current lightness
+   * Set the current lightness
    */
   set lightness(value) {
     this.state.value.lightness = clamp(value, 0, 100);
   }
   /**
-   * Gets the current saturation
+   * Get the current saturation
    */
   get saturation() {
     return +this.state.value.saturation;
   }
   /**
-   * Sets the current saturation
+   * Set the current saturation
    */
   set saturation(value) {
     this.state.value.saturation = clamp(value, 0, 100);
@@ -41,15 +41,21 @@ class HSLColour extends Colour {
   constructor(value) {
     super("hsl", value, defaults, properties);
   }
+  /**
+   * @inheritdoc
+   */
   toHex() {
     return HSLColour.toRgb(this.state.value).toHex();
   }
   /**
-   * Converts the colour to an RGB-colour
+   * Convert the colour to an RGB-colour
    */
   toRgb() {
     return HSLColour.toRgb(this.state.value);
   }
+  /**
+   * @inheritdoc
+   */
   toString() {
     return `hsl(${this.state.value.hue}, ${this.state.value.saturation}%, ${this.state.value.lightness}%)`;
   }

package/dist/js/colour/rgb.cjs

@@ -5,37 +5,37 @@ const colour_functions = require("./functions.cjs");
 const number = require("../number.cjs");
 class RGBColour extends colour_base.Colour {
   /**
-   * Gets the current blue value
+   * Get the current blue value
    */
   get blue() {
     return +this.state.value.blue;
   }
   /**
-   * Sets the current blue value
+   * Set the current blue value
    */
   set blue(value) {
     this.state.value.blue = number.clamp(value, 0, 255);
   }
   /**
-   * Gets the current green value
+   * Get the current green value
    */
   get green() {
     return +this.state.value.green;
   }
   /**
-   * Sets the current green value
+   * Set the current green value
    */
   set green(value) {
     this.state.value.green = number.clamp(value, 0, 255);
   }
   /**
-   * Gets the current red value
+   * Get the current red value
    */
   get red() {
     return +this.state.value.red;
   }
   /**
-   * Sets the current red value
+   * Set the current red value
    */
   set red(value) {
     this.state.value.red = number.clamp(value, 0, 255);
@@ -43,6 +43,9 @@ class RGBColour extends colour_base.Colour {
   constructor(value) {
     super("rgb", value, defaults, properties);
   }
+  /**
+   * @inheritdoc
+   */
   toHex() {
     return RGBColour.toHex(this.value);
   }
@@ -52,6 +55,9 @@ class RGBColour extends colour_base.Colour {
   toHsl() {
     return RGBColour.toHsl(this.value);
   }
+  /**
+   * @inheritdoc
+   */
   toString() {
     return `rgb(${this.value.red}, ${this.value.green}, ${this.value.blue})`;
   }

package/dist/js/colour/rgb.js

@@ -3,37 +3,37 @@ import { rgbToHex, rgbToHsl } from "./functions.js";
 import { clamp } from "../number.js";
 class RGBColour extends Colour {
   /**
-   * Gets the current blue value
+   * Get the current blue value
    */
   get blue() {
     return +this.state.value.blue;
   }
   /**
-   * Sets the current blue value
+   * Set the current blue value
    */
   set blue(value) {
     this.state.value.blue = clamp(value, 0, 255);
   }
   /**
-   * Gets the current green value
+   * Get the current green value
    */
   get green() {
     return +this.state.value.green;
   }
   /**
-   * Sets the current green value
+   * Set the current green value
    */
   set green(value) {
     this.state.value.green = clamp(value, 0, 255);
   }
   /**
-   * Gets the current red value
+   * Get the current red value
    */
   get red() {
     return +this.state.value.red;
   }
   /**
-   * Sets the current red value
+   * Set the current red value
    */
   set red(value) {
     this.state.value.red = clamp(value, 0, 255);
@@ -41,6 +41,9 @@ class RGBColour extends Colour {
   constructor(value) {
     super("rgb", value, defaults, properties);
   }
+  /**
+   * @inheritdoc
+   */
   toHex() {
     return RGBColour.toHex(this.value);
   }
@@ -50,6 +53,9 @@ class RGBColour extends Colour {
   toHsl() {
     return RGBColour.toHsl(this.value);
   }
+  /**
+   * @inheritdoc
+   */
   toString() {
     return `rgb(${this.value.red}, ${this.value.green}, ${this.value.blue})`;
   }

package/dist/js/emitter.cjs

@@ -30,13 +30,13 @@ class Emitter {
     };
   }
   /**
-   * Destroys the emitter
+   * Destroy the emitter
    */
   destroy() {
     finishEmitter(this.state, false);
   }
   /**
-   * Emits a new value _(and optionally finishes the emitter)_
+   * Emit a new value _(and optionally finishes the emitter)_
    */
   emit(value, finish) {
     var _a;
@@ -51,7 +51,7 @@ class Emitter {
     }
   }
   /**
-   * Emits an error _(and optionally finishes the emitter)_
+   * Emit an error _(and optionally finishes the emitter)_
    */
   error(error, finish) {
     var _a;
@@ -65,7 +65,7 @@ class Emitter {
     }
   }
   /**
-   * Finishes the emitter
+   * Finish the emitter
    */
   finish() {
     finishEmitter(this.state, true);
@@ -101,13 +101,16 @@ class Subscription {
     var _a;
     return this.state.closed || !(((_a = this.state.emitter) == null ? void 0 : _a.active) ?? false);
   }
+  /**
+   * Destroy the subscription
+   */
   destroy() {
     this.unsubscribe();
     this.state.emitter = void 0;
     this.state.observers = void 0;
   }
   /**
-   * Unsubscribes from the observable
+   * Unsubscribe from its observable
    */
   unsubscribe() {
     var _a;

package/dist/js/emitter.js

@@ -28,13 +28,13 @@ class Emitter {
     };
   }
   /**
-   * Destroys the emitter
+   * Destroy the emitter
    */
   destroy() {
     finishEmitter(this.state, false);
   }
   /**
-   * Emits a new value _(and optionally finishes the emitter)_
+   * Emit a new value _(and optionally finishes the emitter)_
    */
   emit(value, finish) {
     var _a;
@@ -49,7 +49,7 @@ class Emitter {
     }
   }
   /**
-   * Emits an error _(and optionally finishes the emitter)_
+   * Emit an error _(and optionally finishes the emitter)_
    */
   error(error, finish) {
     var _a;
@@ -63,7 +63,7 @@ class Emitter {
     }
   }
   /**
-   * Finishes the emitter
+   * Finish the emitter
    */
   finish() {
     finishEmitter(this.state, true);
@@ -99,13 +99,16 @@ class Subscription {
     var _a;
     return this.state.closed || !(((_a = this.state.emitter) == null ? void 0 : _a.active) ?? false);
   }
+  /**
+   * Destroy the subscription
+   */
   destroy() {
     this.unsubscribe();
     this.state.emitter = void 0;
     this.state.observers = void 0;
   }
   /**
-   * Unsubscribes from the observable
+   * Unsubscribe from its observable
    */
   unsubscribe() {
     var _a;

package/dist/js/function.cjs

@@ -16,21 +16,21 @@ class Memoised {
     this.state = { cache, getter };
   }
   /**
-   * Clears the cache
+   * Clear the cache
    */
   clear() {
     var _a;
     (_a = this.state.cache) == null ? void 0 : _a.clear();
   }
   /**
-   * Deletes a result from the cache
+   * Delete a result from the cache
    */
   delete(key) {
     var _a;
     return (_a = this.state.cache) == null ? void 0 : _a.delete(key);
   }
   /**
-   * Destroys the instance, clearing its cache and removing its callback
+   * Destroy the instance, clearing its cache and removing its callback
    */
   destroy() {
     this.state.cache.clear();
@@ -38,21 +38,21 @@ class Memoised {
     this.state.getter = noop;
   }
   /**
-   * 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) {
     var _a;
     return (_a = this.state.cache) == null ? void 0 : _a.get(key);
   }
   /**
-   * Checks if the cache has a result for a given key
+   * Does the result exist?
    */
   has(key) {
     var _a;
     return ((_a = this.state.cache) == null ? void 0 : _a.has(key)) ?? false;
   }
   /**
-   * 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) {
     return this.state.getter(...parameters);

package/dist/js/function.js

@@ -14,21 +14,21 @@ class Memoised {
     this.state = { cache, getter };
   }
   /**
-   * Clears the cache
+   * Clear the cache
    */
   clear() {
     var _a;
     (_a = this.state.cache) == null ? void 0 : _a.clear();
   }
   /**
-   * Deletes a result from the cache
+   * Delete a result from the cache
    */
   delete(key) {
     var _a;
     return (_a = this.state.cache) == null ? void 0 : _a.delete(key);
   }
   /**
-   * Destroys the instance, clearing its cache and removing its callback
+   * Destroy the instance, clearing its cache and removing its callback
    */
   destroy() {
     this.state.cache.clear();
@@ -36,21 +36,21 @@ class Memoised {
     this.state.getter = noop;
   }
   /**
-   * 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) {
     var _a;
     return (_a = this.state.cache) == null ? void 0 : _a.get(key);
   }
   /**
-   * Checks if the cache has a result for a given key
+   * Does the result exist?
    */
   has(key) {
     var _a;
     return ((_a = this.state.cache) == null ? void 0 : _a.has(key)) ?? false;
   }
   /**
-   * 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) {
     return this.state.getter(...parameters);

package/dist/js/index.cjs

@@ -79,7 +79,6 @@ exports.queue = queue.queue;
 exports.getRandomBoolean = random.getRandomBoolean;
 exports.getRandomCharacters = random.getRandomCharacters;
 exports.getRandomColour = random.getRandomColour;
-exports.getRandomDate = random.getRandomDate;
 exports.getRandomFloat = random.getRandomFloat;
 exports.getRandomHex = random.getRandomHex;
 exports.getRandomInteger = random.getRandomInteger;

package/dist/js/index.js

@@ -8,7 +8,7 @@ import { average, max, min, round, sum } from "./math.js";
 import { between, clamp, getNumber } from "./number.js";
 import { fromQuery, toQuery } from "./query.js";
 import { queue } from "./queue.js";
-import { getRandomBoolean, getRandomCharacters, getRandomColour, getRandomDate, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems } from "./random.js";
+import { getRandomBoolean, getRandomCharacters, getRandomColour, getRandomFloat, getRandomHex, getRandomInteger, getRandomItem, getRandomItems } from "./random.js";
 import { SizedMap, SizedSet } from "./sized.js";
 import { createUuid, getString, join, parse, truncate, words } from "./string/index.js";
 import "./touch.js";
@@ -77,7 +77,6 @@ export {
   getRandomBoolean,
   getRandomCharacters,
   getRandomColour,
-  getRandomDate,
   getRandomFloat,
   getRandomHex,
   getRandomInteger,

package/dist/js/internal/array/callbacks.cjs

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+function getCallback(value) {
+  switch (typeof value) {
+    case "function":
+      return value;
+    case "number":
+    case "string":
+      return typeof value === "string" && value.includes(".") ? void 0 : (obj) => obj[value];
+    default:
+      return;
+  }
+}
+function getCallbacks(bool, key, value) {
+  if (typeof bool === "function") {
+    return { bool };
+  }
+  return {
+    key: getCallback(key),
+    value: getCallback(value)
+  };
+}
+exports.getCallbacks = getCallbacks;

package/dist/js/internal/array/callbacks.js

@@ -0,0 +1,23 @@
+function getCallback(value) {
+  switch (typeof value) {
+    case "function":
+      return value;
+    case "number":
+    case "string":
+      return typeof value === "string" && value.includes(".") ? void 0 : (obj) => obj[value];
+    default:
+      return;
+  }
+}
+function getCallbacks(bool, key, value) {
+  if (typeof bool === "function") {
+    return { bool };
+  }
+  return {
+    key: getCallback(key),
+    value: getCallback(value)
+  };
+}
+export {
+  getCallbacks
+};

package/dist/js/internal/{array-find.cjs → array/find.cjs}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const internal_arrayCallbacks = require("./array-callbacks.cjs");
-function findValue(type, array, value, key) {
+const internal_array_callbacks = require("./callbacks.cjs");
+function findValue(type, array, bool, key, value) {
   var _a;
-  const callbacks = internal_arrayCallbacks.getCallbacks(value, key);
+  const callbacks = internal_array_callbacks.getCallbacks(bool, key);
   if ((callbacks == null ? void 0 : callbacks.bool) == null && (callbacks == null ? void 0 : callbacks.key) == null) {
-    return type === "index" ? array.indexOf(value) : array.find((item) => item === value);
+    return type === "index" ? array.findIndex((item) => item === value) : array.find((item) => item === value);
   }
   if (callbacks.bool != null) {
     const index = array.findIndex(callbacks.bool);
@@ -20,28 +20,27 @@ function findValue(type, array, value, key) {
   }
   return type === "index" ? -1 : void 0;
 }
-function findValues(type, array, value, key) {
+function findValues(type, array, bool, key, value) {
   var _a;
-  const callbacks = internal_arrayCallbacks.getCallbacks(value, key);
+  const callbacks = internal_array_callbacks.getCallbacks(bool, key);
   const { length } = array;
   if (type === "unique" && (callbacks == null ? void 0 : callbacks.key) == null && length >= 100) {
     return Array.from(new Set(array));
   }
-  if (typeof (callbacks == null ? void 0 : callbacks.bool) === "function") {
+  if ((callbacks == null ? void 0 : callbacks.bool) != null) {
     return array.filter(callbacks.bool);
   }
   if (type === "all" && key == null) {
     return array.filter((item) => item === value);
   }
-  const hasCallback = typeof (callbacks == null ? void 0 : callbacks.key) === "function";
   const result = [];
-  const values = hasCallback ? [] : result;
+  const values = (callbacks == null ? void 0 : callbacks.key) != null ? [] : result;
   for (let index = 0; index < length; index += 1) {
     const item = array[index];
-    const itemKey = hasCallback ? (_a = callbacks.key) == null ? void 0 : _a.call(callbacks, item, index, array) : item;
-    if (type === "all" && itemKey === value || type === "unique" && values.indexOf(itemKey) === -1) {
+    const keyed = ((_a = callbacks == null ? void 0 : callbacks.key) == null ? void 0 : _a.call(callbacks, item, index, array)) ?? item;
+    if (type === "all" && keyed === value || type === "unique" && values.indexOf(keyed) === -1) {
       if (values !== result) {
-        values.push(itemKey);
+        values.push(keyed);
       }
       result.push(item);
     }

package/dist/js/internal/{array-find.js → array/find.js}

@@ -1,9 +1,9 @@
-import { getCallbacks } from "./array-callbacks.js";
-function findValue(type, array, value, key) {
+import { getCallbacks } from "./callbacks.js";
+function findValue(type, array, bool, key, value) {
   var _a;
-  const callbacks = getCallbacks(value, key);
+  const callbacks = getCallbacks(bool, key);
   if ((callbacks == null ? void 0 : callbacks.bool) == null && (callbacks == null ? void 0 : callbacks.key) == null) {
-    return type === "index" ? array.indexOf(value) : array.find((item) => item === value);
+    return type === "index" ? array.findIndex((item) => item === value) : array.find((item) => item === value);
   }
   if (callbacks.bool != null) {
     const index = array.findIndex(callbacks.bool);
@@ -18,28 +18,27 @@ function findValue(type, array, value, key) {
   }
   return type === "index" ? -1 : void 0;
 }
-function findValues(type, array, value, key) {
+function findValues(type, array, bool, key, value) {
   var _a;
-  const callbacks = getCallbacks(value, key);
+  const callbacks = getCallbacks(bool, key);
   const { length } = array;
   if (type === "unique" && (callbacks == null ? void 0 : callbacks.key) == null && length >= 100) {
     return Array.from(new Set(array));
   }
-  if (typeof (callbacks == null ? void 0 : callbacks.bool) === "function") {
+  if ((callbacks == null ? void 0 : callbacks.bool) != null) {
     return array.filter(callbacks.bool);
   }
   if (type === "all" && key == null) {
     return array.filter((item) => item === value);
   }
-  const hasCallback = typeof (callbacks == null ? void 0 : callbacks.key) === "function";
   const result = [];
-  const values = hasCallback ? [] : result;
+  const values = (callbacks == null ? void 0 : callbacks.key) != null ? [] : result;
   for (let index = 0; index < length; index += 1) {
     const item = array[index];
-    const itemKey = hasCallback ? (_a = callbacks.key) == null ? void 0 : _a.call(callbacks, item, index, array) : item;
-    if (type === "all" && itemKey === value || type === "unique" && values.indexOf(itemKey) === -1) {
+    const keyed = ((_a = callbacks == null ? void 0 : callbacks.key) == null ? void 0 : _a.call(callbacks, item, index, array)) ?? item;
+    if (type === "all" && keyed === value || type === "unique" && values.indexOf(keyed) === -1) {
       if (values !== result) {
-        values.push(itemKey);
+        values.push(keyed);
       }
       result.push(item);
     }