@oscarpalmer/atoms 0.186.2 → 0.187.0

package/dist/internal/array/index-of.d.mts

@@ -72,7 +72,7 @@ declare namespace indexOf {
 /**
  * Get the index of the last matching item by callback
  *
- * Available as `lastIndexOf` and `indexOf.last`
+ * _Available as `lastIndexOf` and `indexOf.last`_
  *
  * @param array Array to search in
  * @param callback Callback to get an item's value
@@ -92,7 +92,7 @@ declare function lastIndexOf<Item, Callback extends (item: Item, index: number,
 /**
  * Get the index of the last matching item by key
  *
- * Available as `lastIndexOf` and `indexOf.last`
+ * _Available as `lastIndexOf` and `indexOf.last`_
  *
  * @param array Array to search in
  * @param key Key to match items by
@@ -112,7 +112,7 @@ declare function lastIndexOf<Item extends PlainObject, ItemKey extends keyof Ite
 /**
  * Get the index of the last item matching the filter
  *
- * Available as `lastIndexOf` and `indexOf.last`
+ * _Available as `lastIndexOf` and `indexOf.last`_
  *
  * @param array Array to search in
  * @param filter Filter callback to match items
@@ -130,7 +130,7 @@ declare function lastIndexOf<Item>(array: Item[], filter: (item: Item, index: nu
 /**
  * Get the index of the last item matching the given item
  *
- * Available as `lastIndexOf` and `indexOf.last`
+ * _Available as `lastIndexOf` and `indexOf.last`_
  *
  * @param array Array to search in
  * @param item Item to match against

package/dist/internal/array/insert.mjs

@@ -5,7 +5,7 @@ function insertChunkedValues(type, array, items, start, deleteCount) {
 	const actualStart = Math.min(Math.max(0, start), array.length);
 	const chunked = chunk(items);
 	const lastIndex = chunked.length - 1;
-	let index = Number(chunked.length);
+	let index = chunked.length;
 	let returned;
 	while (index > 0) {
 		index -= 1;

package/dist/internal/array/shuffle.d.mts

@@ -1,6 +1,7 @@
 //#region src/internal/array/shuffle.d.ts
 /**
  * Shuffle items in array
+ *
  * @param array Original array
  * @returns Shuffled array
  */

package/dist/internal/array/shuffle.mjs

@@ -2,6 +2,7 @@ import { getRandomInteger } from "../random.mjs";
 //#region src/internal/array/shuffle.ts
 /**
 * Shuffle items in array
+*
 * @param array Original array
 * @returns Shuffled array
 */
@@ -9,7 +10,7 @@ function shuffle(array) {
 	if (!Array.isArray(array)) return [];
 	const shuffled = array.slice();
 	if (shuffled.length < 2) return shuffled;
-	let index = Number(shuffled.length);
+	let index = shuffled.length;
 	while (--index >= 0) {
 		const random = getRandomInteger(0, index);
 		[shuffled[index], shuffled[random]] = [shuffled[random], shuffled[index]];

package/dist/internal/is.d.mts

@@ -2,111 +2,129 @@ import { ArrayOrPlainObject, Constructor, Key, PlainObject, Primitive, TypedArra
 
 //#region src/internal/is.d.ts
 /**
- * Is the value an array or a record?
+ * Is the value an array or a plain object?
+ *
  * @param value Value to check
- * @returns `true` if the value is an array or a record, otherwise `false`
+ * @returns `true` if the value is an array or a plain object, otherwise `false`
  */
 declare function isArrayOrPlainObject(value: unknown): value is ArrayOrPlainObject;
 /**
  * Is the value a constructor function?
+ *
  * @param value Value to check
  * @returns `true` if the value is a constructor function, otherwise `false`
  */
 declare function isConstructor(value: unknown): value is Constructor;
 /**
  * Is the value an instance of the constructor?
+ *
  * @param constructor Class constructor
  * @param value Value to check
  * @returns `true` if the value is an instance of the constructor, otherwise `false`
  */
 declare function isInstanceOf<Instance>(constructor: Constructor<Instance>, value: unknown): value is Instance;
 /**
- * Is the value a key?
+ * Is the value a _Key_?
+ *
  * @param value Value to check
- * @returns `true` if the value is a `Key` _(`number` or `string`)_, otherwise `false`
+ * @returns `true` if the value is a _Key_ _(`number` or `string`)_, otherwise `false`
  */
 declare function isKey(value: unknown): value is Key;
 /**
  * Is the value not an array or a plain object?
+ *
  * @param value Value to check
  * @returns `true` if the value is not an array or a plain object, otherwise `false`
  */
 declare function isNonArrayOrPlainObject<Value>(value: Value): value is Exclude<Value, ArrayOrPlainObject>;
 /**
  * Is the value not a constructor function?
+ *
  * @param value Value to check
  * @returns `true` if the value is not a constructor function, otherwise `false`
  */
 declare function isNonConstructor<Value>(value: Value): value is Exclude<Value, Constructor>;
 /**
  * Is the value not an instance of the constructor?
+ *
  * @param constructor Class constructor
  * @param value Value to check
  * @returns `true` if the value is not an instance of the constructor, otherwise `false`
  */
 declare function isNonInstanceOf<Instance, Value>(constructor: Constructor<Instance>, value: Value): value is Exclude<Value, Instance>;
 /**
- * Is the value not a key?
+ * Is the value not a _Key_?
+ *
  * @param value Value to check
- * @returns `true` if the value is not a `Key` _(`number` or `string`)_, otherwise `false`
+ * @returns `true` if the value is not a _Key_ _(`number` or `string`)_, otherwise `false`
  */
 declare function isNonKey<Value>(value: Value): value is Exclude<Value, Key>;
 /**
  * Is the value not a number?
+ *
  * @param value Value to check
  * @returns `true` if the value is not a `number`, otherwise `false`
  */
 declare function isNonNumber<Value>(value: Value): value is Exclude<Value, number>;
 /**
  * Is the value not a plain object?
+ *
  * @param value Value to check
  * @returns `true` if the value is not a plain object, otherwise `false`
  */
 declare function isNonPlainObject<Value>(value: Value): value is Exclude<Value, PlainObject>;
 /**
  * Is the value not a primitive value?
+ *
  * @param value Value to check
  * @returns `true` if the value is not a primitive value, otherwise `false`
  */
 declare function isNonPrimitive<Value>(value: Value): value is Exclude<Value, Primitive>;
 /**
  * Is the value not a template strings array?
+ *
  * @param value Value to check
  * @returns `true` if the value is not a `TemplateStringsArray`, otherwise `false`
  */
 declare function isNonTemplateStringsArray<Value>(value: Value): value is Exclude<Value, TemplateStringsArray>;
 /**
  * Is the value not a typed array?
+ *
  * @param value Value to check
  * @returns `true` if the value is not a typed array, otherwise `false`
  */
 declare function isNonTypedArray<Value>(value: Value): value is Exclude<Value, TypedArray>;
 /**
  * Is the value a number?
+ *
  * @param value Value to check
  * @returns `true` if the value is a `number`, otherwise `false`
  */
 declare function isNumber(value: unknown): value is number;
 /**
  * Is the value a plain object?
+ *
  * @param value Value to check
  * @returns `true` if the value is a plain object, otherwise `false`
  */
 declare function isPlainObject(value: unknown): value is PlainObject;
 /**
- * - Is the value a primitive value?
+ * Is the value a primitive value?
+ *
  * @param value Value to check
- * @returns `true` if the value matches, otherwise `false`
+ * @returns `true` if the value is a primitive value, otherwise `false`
  */
 declare function isPrimitive(value: unknown): value is Primitive;
 /**
  * Is the value a template strings array?
+ *
  * @param value Value to check
  * @returns `true` if the value is a `TemplateStringsArray`, otherwise `false`
  */
 declare function isTemplateStringsArray(value: unknown): value is TemplateStringsArray;
 /**
  * Is the value a typed array?
+ *
  * @param value Value to check
  * @returns `true` if the value is a typed array, otherwise `false`
  */

package/dist/internal/is.mjs

@@ -1,14 +1,16 @@
 //#region src/internal/is.ts
 /**
-* Is the value an array or a record?
+* Is the value an array or a plain object?
+*
 * @param value Value to check
-* @returns `true` if the value is an array or a record, otherwise `false`
+* @returns `true` if the value is an array or a plain object, otherwise `false`
 */
 function isArrayOrPlainObject(value) {
 	return Array.isArray(value) || isPlainObject(value);
 }
 /**
 * Is the value a constructor function?
+*
 * @param value Value to check
 * @returns `true` if the value is a constructor function, otherwise `false`
 */
@@ -17,6 +19,7 @@ function isConstructor(value) {
 }
 /**
 * Is the value an instance of the constructor?
+*
 * @param constructor Class constructor
 * @param value Value to check
 * @returns `true` if the value is an instance of the constructor, otherwise `false`
@@ -25,15 +28,17 @@ function isInstanceOf(constructor, value) {
 	return isConstructor(constructor) && value instanceof constructor;
 }
 /**
-* Is the value a key?
+* Is the value a _Key_?
+*
 * @param value Value to check
-* @returns `true` if the value is a `Key` _(`number` or `string`)_, otherwise `false`
+* @returns `true` if the value is a _Key_ _(`number` or `string`)_, otherwise `false`
 */
 function isKey(value) {
 	return typeof value === "number" || typeof value === "string";
 }
 /**
 * Is the value not an array or a plain object?
+*
 * @param value Value to check
 * @returns `true` if the value is not an array or a plain object, otherwise `false`
 */
@@ -42,6 +47,7 @@ function isNonArrayOrPlainObject(value) {
 }
 /**
 * Is the value not a constructor function?
+*
 * @param value Value to check
 * @returns `true` if the value is not a constructor function, otherwise `false`
 */
@@ -50,6 +56,7 @@ function isNonConstructor(value) {
 }
 /**
 * Is the value not an instance of the constructor?
+*
 * @param constructor Class constructor
 * @param value Value to check
 * @returns `true` if the value is not an instance of the constructor, otherwise `false`
@@ -58,15 +65,17 @@ function isNonInstanceOf(constructor, value) {
 	return !isInstanceOf(constructor, value);
 }
 /**
-* Is the value not a key?
+* Is the value not a _Key_?
+*
 * @param value Value to check
-* @returns `true` if the value is not a `Key` _(`number` or `string`)_, otherwise `false`
+* @returns `true` if the value is not a _Key_ _(`number` or `string`)_, otherwise `false`
 */
 function isNonKey(value) {
 	return !isKey(value);
 }
 /**
 * Is the value not a number?
+*
 * @param value Value to check
 * @returns `true` if the value is not a `number`, otherwise `false`
 */
@@ -75,6 +84,7 @@ function isNonNumber(value) {
 }
 /**
 * Is the value not a plain object?
+*
 * @param value Value to check
 * @returns `true` if the value is not a plain object, otherwise `false`
 */
@@ -83,6 +93,7 @@ function isNonPlainObject(value) {
 }
 /**
 * Is the value not a primitive value?
+*
 * @param value Value to check
 * @returns `true` if the value is not a primitive value, otherwise `false`
 */
@@ -91,6 +102,7 @@ function isNonPrimitive(value) {
 }
 /**
 * Is the value not a template strings array?
+*
 * @param value Value to check
 * @returns `true` if the value is not a `TemplateStringsArray`, otherwise `false`
 */
@@ -99,6 +111,7 @@ function isNonTemplateStringsArray(value) {
 }
 /**
 * Is the value not a typed array?
+*
 * @param value Value to check
 * @returns `true` if the value is not a typed array, otherwise `false`
 */
@@ -107,6 +120,7 @@ function isNonTypedArray(value) {
 }
 /**
 * Is the value a number?
+*
 * @param value Value to check
 * @returns `true` if the value is a `number`, otherwise `false`
 */
@@ -115,6 +129,7 @@ function isNumber(value) {
 }
 /**
 * Is the value a plain object?
+*
 * @param value Value to check
 * @returns `true` if the value is a plain object, otherwise `false`
 */
@@ -125,9 +140,10 @@ function isPlainObject(value) {
 	return prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null;
 }
 /**
-* - Is the value a primitive value?
+* Is the value a primitive value?
+*
 * @param value Value to check
-* @returns `true` if the value matches, otherwise `false`
+* @returns `true` if the value is a primitive value, otherwise `false`
 */
 function isPrimitive(value) {
 	if (value == null) return true;
@@ -136,6 +152,7 @@ function isPrimitive(value) {
 }
 /**
 * Is the value a template strings array?
+*
 * @param value Value to check
 * @returns `true` if the value is a `TemplateStringsArray`, otherwise `false`
 */
@@ -144,6 +161,7 @@ function isTemplateStringsArray(value) {
 }
 /**
 * Is the value a typed array?
+*
 * @param value Value to check
 * @returns `true` if the value is a typed array, otherwise `false`
 */

package/dist/internal/math/aggregate.d.mts

@@ -17,14 +17,14 @@ declare function getAggregateCallback(key: unknown): Function | undefined;
  * max(
  *   [{id: 1, value: 10}, {id: 2, value: 20}],
  *   item => item.value,
- * ); // 20
+ * ); // => 20
  *
- * max([], item => item.value); // Number.NaN
+ * max([], item => item.value); // => Number.NaN
  * ```
  *
  * @param items List of items
  * @param callback Callback to get an item's value
- * @returns Maximum value, or `NaN` if no maximum can be found
+ * @returns Maximum value, or `Number.NaN` if no maximum can be found
  */
 declare function max<Item>(items: Item[], callback: (item: Item, index: number, array: Item[]) => number): number;
 /**
@@ -35,14 +35,14 @@ declare function max<Item>(items: Item[], callback: (item: Item, index: number,
  * max(
  *   [{id: 1, value: 10}, {id: 2, value: 20}],
  *   'value',
- * ); // 20
+ * ); // => 20
  *
- * max([], 'value'); // Number.NaN
+ * max([], 'value'); // => Number.NaN
  * ```
  *
  * @param items List of items
  * @param key Key to use for value
- * @returns Maximum value, or `NaN` if no maximum can be found
+ * @returns Maximum value, or `Number.NaN` if no maximum can be found
  */
 declare function max<Item extends PlainObject, ItemKey extends keyof NumericalValues<Item>>(items: Item[], key: ItemKey): number;
 /**
@@ -50,12 +50,12 @@ declare function max<Item extends PlainObject, ItemKey extends keyof NumericalVa
  *
  * @example
  * ```typescript
- * max([10, 20]); // 20
- * max([]);       // Number.NaN
+ * max([10, 20]); // => 20
+ * max([]);       // => Number.NaN
  * ```
  *
  * @param values List of numbers
- * @returns Maximum value, or `NaN` if no maximum can be found
+ * @returns Maximum value, or `Number.NaN` if no maximum can be found
  */
 declare function max(values: number[]): number;
 declare function getAggregated(type: NonAverageAggregationType, array: unknown[], key?: unknown): number;

package/dist/internal/number.d.mts

@@ -1,6 +1,7 @@
 //#region src/internal/number.d.ts
 /**
  * Is the number between a minimum and maximum value?
+ *
  * @param value Value to check
  * @param minimum Minimum value
  * @param maximum Maximum value
@@ -9,17 +10,27 @@
 declare function between(value: number, minimum: number, maximum: number): boolean;
 /**
  * Clamp a number between a minimum and maximum value
+ *
  * @param value Value to clamp
  * @param minimum Minimum value
  * @param maximum Maximum value
  * @param loop If `true`, the value will loop around when smaller than the minimum or larger than the maximum _(defaults to `false`)_
  * @returns Clamped value
+ *
+ * @example
+ * ```typescript
+ * clamp(10, 0, 5);       // => 5
+ * clamp(10, 0, 5, true); // => 0
+ * ```
  */
 declare function clamp(value: number, minimum: number, maximum: number, loop?: boolean): number;
 /**
- * Get the number value from an unknown value _(based on Lodash)_
+ * Get the number value from an unknown value
+ *
+ * _(Based on Lodash)_
+ *
  * @param value Original value
- * @returns Original value as a number, or `NaN` if the value is unable to be parsed
+ * @returns Original value as a number, or `Number.NaN` if the value is unable to be parsed
  */
 declare function getNumber(value: unknown): number;
 declare function getNumberOrDefault(value: unknown, defaultValue: number, minimum?: number): number;

package/dist/internal/number.mjs

@@ -2,6 +2,7 @@ import { isNumber } from "./is.mjs";
 //#region src/internal/number.ts
 /**
 * Is the number between a minimum and maximum value?
+*
 * @param value Value to check
 * @param minimum Minimum value
 * @param maximum Maximum value
@@ -18,11 +19,18 @@ function between(value, minimum, maximum) {
 }
 /**
 * Clamp a number between a minimum and maximum value
+*
 * @param value Value to clamp
 * @param minimum Minimum value
 * @param maximum Maximum value
 * @param loop If `true`, the value will loop around when smaller than the minimum or larger than the maximum _(defaults to `false`)_
 * @returns Clamped value
+*
+* @example
+* ```typescript
+* clamp(10, 0, 5);       // => 5
+* clamp(10, 0, 5, true); // => 0
+* ```
 */
 function clamp(value, minimum, maximum, loop) {
 	if (![
@@ -34,9 +42,12 @@ function clamp(value, minimum, maximum, loop) {
 	return value > maximum ? loop === true ? minimum : maximum : value;
 }
 /**
-* Get the number value from an unknown value _(based on Lodash)_
+* Get the number value from an unknown value
+*
+* _(Based on Lodash)_
+*
 * @param value Original value
-* @returns Original value as a number, or `NaN` if the value is unable to be parsed
+* @returns Original value as a number, or `Number.NaN` if the value is unable to be parsed
 */
 function getNumber(value) {
 	if (typeof value === "number") return value;

package/dist/internal/random.d.mts

@@ -1,17 +1,19 @@
 //#region src/internal/random.d.ts
 /**
  * Get a random floating-point number
+ *
  * @param minimum Minimum value
  * @param maximum Maximum value
  * @returns Random floating-point number
  */
-declare function getRandomFloat(minimum?: number, maximum?: number): number;
+declare function getRandomFloatingNumber(minimum?: number, maximum?: number): number;
 /**
  * Get a random integer
+ *
  * @param minimum Minimum value
  * @param maximum Maximum value
  * @returns Random integer
  */
 declare function getRandomInteger(minimum?: number, maximum?: number): number;
 //#endregion
-export { getRandomFloat, getRandomInteger };
+export { getRandomFloatingNumber, getRandomInteger };

package/dist/internal/random.mjs

@@ -1,6 +1,6 @@
 import { isNumber } from "./is.mjs";
 //#region src/internal/random.ts
-function _getRandomFloat(inclusive, minimum, maximum) {
+function getRandomFloatingNumberValue(inclusive, minimum, maximum) {
 	let maxFloat = isNumber(maximum) && maximum <= Number.MAX_SAFE_INTEGER ? maximum : Number.MAX_SAFE_INTEGER;
 	let minFloat = isNumber(minimum) && minimum >= Number.MIN_SAFE_INTEGER ? minimum : Number.MIN_SAFE_INTEGER;
 	if (minFloat === maxFloat) return minFloat;
@@ -9,21 +9,23 @@ function _getRandomFloat(inclusive, minimum, maximum) {
 }
 /**
 * Get a random floating-point number
+*
 * @param minimum Minimum value
 * @param maximum Maximum value
 * @returns Random floating-point number
 */
-function getRandomFloat(minimum, maximum) {
-	return _getRandomFloat(false, minimum, maximum);
+function getRandomFloatingNumber(minimum, maximum) {
+	return getRandomFloatingNumberValue(false, minimum, maximum);
 }
 /**
 * Get a random integer
+*
 * @param minimum Minimum value
 * @param maximum Maximum value
 * @returns Random integer
 */
 function getRandomInteger(minimum, maximum) {
-	return Math.floor(_getRandomFloat(true, minimum, maximum));
+	return Math.floor(getRandomFloatingNumberValue(true, minimum, maximum));
 }
 //#endregion
-export { getRandomFloat, getRandomInteger };
+export { getRandomFloatingNumber, getRandomInteger };

package/dist/internal/result.d.mts

@@ -2,39 +2,45 @@ import { Err, ExtendedErr, Ok, Result } from "../result/models.mjs";
 
 //#region src/internal/result.d.ts
 /**
- * Is the result an extended error?
- * @param result Result to check
- * @returns `true` if the result is an extended error, `false` otherwise
+ * Is the _Result_ an extended error?
+ *
+ * @param result _Result_ to check
+ * @returns `true` if the _Result_ is an extended error, `false` otherwise
  */
 declare function isError<Value, E = Error>(result: ExtendedErr<E> | Result<Value, E>, extended: true): result is ExtendedErr<E>;
 /**
- * Is the result an error?
- * @param result Result to check
- * @returns `true` if the result is an error, `false` otherwise
+ * Is the _Result_ an error?
+ *
+ * @param result _Result_ to check
+ * @returns `true` if the _Result_ is an error, `false` otherwise
  */
 declare function isError<Value, E = Error>(result: Result<Value, E>): result is Err<E>;
 /**
  * Is the value an error?
+ *
  * @param value Value to check
  * @returns `true` if the value is an error, `false` otherwise
  */
 declare function isError(value: unknown): value is Err<unknown> | ExtendedErr<unknown>;
 /**
- * Is the result ok?
- * @param value Result to check
- * @returns `true` if the result is ok, `false` otherwise
+ * Is the _Result_ ok?
+ *
+ * @param value _Result_ to check
+ * @returns `true` if the _Result_ is ok, `false` otherwise
  */
 declare function isOk<Value, E = Error>(value: Result<Value, E>): value is Ok<Value>;
 /**
  * Is the value ok?
+ *
  * @param value Value to check
  * @returns `true` if the value is ok, `false` otherwise
  */
 declare function isOk(value: unknown): value is Ok<unknown>;
 /**
- * Is the value a result?
+ * Is the value a _Result_?
+ *
  * @param value Value to check
- * @returns `true` if the value is a result, `false` otherwise
+ * @returns `true` if the value is a _Result_, `false` otherwise
  */
 declare function isResult(value: unknown): value is ExtendedErr<unknown> | Result<unknown, unknown>;
 //#endregion

package/dist/internal/result.mjs

@@ -1,27 +1,23 @@
 import { isNonPlainObject } from "./is.mjs";
 //#region src/internal/result.ts
-function _isResult(value, okValue) {
-	if (isNonPlainObject(value)) return false;
-	return value.ok === okValue && (okValue ? PROPERTY_VALUE : PROPERTY_ERROR) in value;
-}
 function isError(value, extended) {
-	return _isResult(value, false) && (extended === true ? value.original instanceof Error : true);
+	return isResultValue(value, false) && (extended === true ? value.original instanceof Error : true);
 }
-/**
-* Is the result ok?
-* @param result Result to check
-* @returns `true` if the result is ok, `false` otherwise
-*/
 function isOk(value) {
-	return _isResult(value, true);
+	return isResultValue(value, true);
 }
 /**
-* Is the value a result?
+* Is the value a _Result_?
+*
 * @param value Value to check
-* @returns `true` if the value is a result, `false` otherwise
+* @returns `true` if the value is a _Result_, `false` otherwise
 */
 function isResult(value) {
-	return _isResult(value, true) || _isResult(value, false);
+	return isResultValue(value, true) || isResultValue(value, false);
+}
+function isResultValue(value, okValue) {
+	if (isNonPlainObject(value)) return false;
+	return value.ok === okValue && (okValue ? PROPERTY_VALUE : PROPERTY_ERROR) in value;
 }
 const PROPERTY_ERROR = "error";
 const PROPERTY_VALUE = "value";