@ts-fns/stdlib 0.1.0 → 0.2.0

package/dist/map/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../../src/map/clear.ts","../../src/map/entries.ts","../../src/map/forEach.ts","../../src/map/from.ts","../../src/map/get.ts","../../src/map/groupBy.ts","../../src/map/keys.ts","../../src/map/remove.ts","../../src/map/set.ts","../../src/map/values.ts"],"sourcesContent":["export function clear<K, V>(data: Map<K, V>): Map<K, V> {\n  data.clear();\n  return data;\n}\n","export function entries<K, V>(data: Map<K, V>): MapIterator<[K, V]> {\n  return data.entries();\n}\n","import { purry } from '../function/purry';\n\nfunction forEachImplementation<K, V>(\n  data: Map<K, V>,\n  callbackfn: (value: V, key: K, map: Map<K, V>) => void,\n): Map<K, V> {\n  data.forEach(callbackfn);\n  return data;\n}\n\nexport function forEach<K, V>(callbackfn: (value: V, key: K, set: Map<K, V>) => void): (data: Map<K, V>) => Map<K, V>;\nexport function forEach<K, V>(data: Map<K, V>, callbackfn: (value: V, key: K, set: Map<K, V>) => void): Map<K, V>;\nexport function forEach(...args: readonly unknown[]): unknown {\n  return purry(forEachImplementation, args);\n}\n","export function from<K, V>(iterable: Iterable<[K, V]> | readonly (readonly [K, V])[]): Map<K, V> {\n  return new Map(iterable);\n}\n\nexport function empty<K, V>(): Map<K, V> {\n  return new Map();\n}\n","import { purry } from '../function/purry';\n\nfunction getImplementation<K, V>(data: Map<K, V>, key: K): V | undefined {\n  return data.get(key);\n}\n\nexport function get<K>(key: K): <V>(data: Map<K, V>) => V | undefined;\nexport function get<K, V>(data: Map<K, V>, key: K): V | undefined;\nexport function get(...args: readonly unknown[]): unknown {\n  return purry(getImplementation, args);\n}\n","import { purry } from '../function/purry';\n\nfunction groupByImplementation<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]> {\n  return Map.groupBy(items, keySelector);\n}\n\nexport function groupBy<K, T>(keySelector: (item: T, index: number) => K): (items: Iterable<T>) => Map<K, T[]>;\nexport function groupBy<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]>;\nexport function groupBy(...args: readonly unknown[]): unknown {\n  return purry(groupByImplementation, args);\n}\n","export function keys<K, V>(data: Map<K, V>): MapIterator<K> {\n  return data.keys();\n}\n","import { purry } from '../function/purry';\n\nfunction removeImplementation<K, V>(data: Map<K, V>, key: K): Map<K, V> {\n  data.delete(key);\n  return data;\n}\n\n/**\n * TODO: should this return a tuple?\n */\nexport function remove<K>(key: K): <V>(data: Map<K, V>) => Map<K, V>;\nexport function remove<K, V>(data: Map<K, V>, key: K): Map<K, V>;\nexport function remove(...args: readonly unknown[]): unknown {\n  return purry(removeImplementation, args);\n}\n","import { purry } from '../function/purry';\n\nfunction setImplementation<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V> {\n  return data.set(key, value);\n}\n\nexport function set<K, V>(key: K, value: V): (data: Map<K, V>) => Map<K, V>;\nexport function set<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V>;\nexport function set(...args: readonly unknown[]): unknown {\n  return purry(setImplementation, args);\n}\n","export function values<K, V>(data: Map<K, V>): MapIterator<V> {\n  return data.values();\n}\n"],"mappings":";;AAAA,SAAgB,MAAY,MAA4B;CACtD,KAAK,MAAM;CACX,OAAO;AACT;;;ACHA,SAAgB,QAAc,MAAsC;CAClE,OAAO,KAAK,QAAQ;AACtB;;;ACAA,SAAS,sBACP,MACA,YACW;CACX,KAAK,QAAQ,UAAU;CACvB,OAAO;AACT;AAIA,SAAgB,QAAQ,GAAG,MAAmC;CAC5D,OAAO,MAAM,uBAAuB,IAAI;AAC1C;;;ACdA,SAAgB,KAAW,UAAsE;CAC/F,OAAO,IAAI,IAAI,QAAQ;AACzB;AAEA,SAAgB,QAAyB;CACvC,uBAAO,IAAI,IAAI;AACjB;;;ACJA,SAAS,kBAAwB,MAAiB,KAAuB;CACvE,OAAO,KAAK,IAAI,GAAG;AACrB;AAIA,SAAgB,IAAI,GAAG,MAAmC;CACxD,OAAO,MAAM,mBAAmB,IAAI;AACtC;;;ACRA,SAAS,sBAA4B,OAAoB,aAAyD;CAChH,OAAO,IAAI,QAAQ,OAAO,WAAW;AACvC;AAIA,SAAgB,QAAQ,GAAG,MAAmC;CAC5D,OAAO,MAAM,uBAAuB,IAAI;AAC1C;;;ACVA,SAAgB,KAAW,MAAiC;CAC1D,OAAO,KAAK,KAAK;AACnB;;;ACAA,SAAS,qBAA2B,MAAiB,KAAmB;CACtE,KAAK,OAAO,GAAG;CACf,OAAO;AACT;AAOA,SAAgB,OAAO,GAAG,MAAmC;CAC3D,OAAO,MAAM,sBAAsB,IAAI;AACzC;;;ACZA,SAAS,kBAAwB,MAAiB,KAAQ,OAAqB;CAC7E,OAAO,KAAK,IAAI,KAAK,KAAK;AAC5B;AAIA,SAAgB,IAAI,GAAG,MAAmC;CACxD,OAAO,MAAM,mBAAmB,IAAI;AACtC;;;ACVA,SAAgB,OAAa,MAAiC;CAC5D,OAAO,KAAK,OAAO;AACrB"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/map/_globalAliases.ts","../../src/map/clear.ts","../../src/map/entries.ts","../../src/map/forEach.ts","../../src/map/from.ts","../../src/map/get.ts","../../src/map/getOrInsert.ts","../../src/map/groupBy.ts","../../src/map/keys.ts","../../src/map/remove.ts","../../src/map/set.ts","../../src/map/values.ts"],"sourcesContent":["/**\n * Alias of the built-in map constructor. `new Map() === new Map.Ctor()`\n * @function\n */\nexport const Ctor = Map;\n","/**\n * Removes all entries from a map and returns the same map.\n *\n * @example\n * ```ts\n * clear(new Map([['a', 1], ['b', 2]])); // Map(0) {}\n * ```\n */\nexport function clear<K, V>(data: Map<K, V>): Map<K, V> {\n  data.clear();\n  return data;\n}\n","/**\n * Returns an iterator of a map's key-value pairs.\n *\n * @example\n * ```ts\n * [...entries(new Map([['a', 1], ['b', 2]]))]; // [['a', 1], ['b', 2]]\n * ```\n */\nexport function entries<K, V>(data: Map<K, V>): MapIterator<[K, V]> {\n  return data.entries();\n}\n","import { purry } from '../function/purry';\n\nfunction forEachImplementation<K, V>(\n  data: Map<K, V>,\n  callbackfn: (value: V, key: K, map: Map<K, V>) => void,\n): Map<K, V> {\n  data.forEach(callbackfn);\n  return data;\n}\n\n/**\n * Runs a callback for each map entry and returns the same map.\n *\n * @example\n * ```ts\n * const map = new Map([['a', 1], ['b', 2]]);\n * forEach(map, (value, key) => console.log(key, value)); // map\n * forEach((value, key) => console.log(key, value))(map); // map\n * ```\n */\nexport function forEach<K, V>(callbackfn: (value: V, key: K, set: Map<K, V>) => void): (data: Map<K, V>) => Map<K, V>;\nexport function forEach<K, V>(data: Map<K, V>, callbackfn: (value: V, key: K, set: Map<K, V>) => void): Map<K, V>;\nexport function forEach(...args: readonly unknown[]): unknown {\n  return purry(forEachImplementation, args);\n}\n","/**\n * Creates a map from an iterable of key-value pairs.\n *\n * @example\n * ```ts\n * from([['a', 1], ['b', 2]]); // Map { 'a' => 1, 'b' => 2 }\n * ```\n */\nexport function from<K, V>(iterable: Iterable<[K, V]> | readonly (readonly [K, V])[]): Map<K, V> {\n  return new Map(iterable);\n}\n\n/**\n * Creates an empty map.\n *\n * @example\n * ```ts\n * empty(); // Map(0) {}\n * ```\n */\nexport function empty<K, V>(): Map<K, V> {\n  return new Map();\n}\n","import { purry } from '../function/purry';\n\nfunction getImplementation<K, V>(data: Map<K, V>, key: K): V | undefined {\n  return data.get(key);\n}\n\n/**\n * Returns the value associated with a key, or `undefined` when the key is absent.\n *\n * @example\n * ```ts\n * const map = new Map([['a', 1]]);\n * get(map, 'a'); // 1\n * get(map, 'b'); // undefined\n * get('a')(map); // 1\n * ```\n */\nexport function get<K>(key: K): <V>(data: Map<K, V>) => V | undefined;\nexport function get<K, V>(data: Map<K, V>, key: K): V | undefined;\nexport function get(...args: readonly unknown[]): unknown {\n  return purry(getImplementation, args);\n}\n","import { NotYetImplementedError } from '../errors';\n\n/**\n * Inserts a default value when a key is absent and returns the same map.\n *\n * @example\n * ```ts\n * const map = new Map<string, number>();\n * getOrInsert(map, 'a', 1); // Map { 'a' => 1 }\n * getOrInsert(map, 'a', 2); // Map { 'a' => 1 }\n * ```\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function getOrInsert<K, V>(map: Map<K, V>, key: K, defaultValue: V): Map<K, V> {\n  throw new NotYetImplementedError('M.getOrInsert not yet implemented');\n}\n\n/**\n * Inserts a computed value when a key is absent and returns the same map.\n *\n * @example\n * ```ts\n * const map = new Map<string, number>();\n * getOrInsertComputed(map, 'a', () => 1); // Map { 'a' => 1 }\n * getOrInsertComputed(map, 'a', () => 2); // Map { 'a' => 1 }\n * ```\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function getOrInsertComputed<K, V>(map: Map<K, V>, key: K, callback: (key: K) => V): Map<K, V> {\n  throw new NotYetImplementedError('M.getOrInsertComputed not yet implemented');\n}\n","import { purry } from '../function/purry';\n\nfunction groupByImplementation<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]> {\n  return Map.groupBy(items, keySelector);\n}\n\n/**\n * Groups iterable items into a map keyed by a selector function.\n *\n * @example\n * ```ts\n * groupBy(\n *   [{ id: 1 }, { id: 2 }, { id: 1 }],\n *   item => item.id,\n * ); // Map { 1 => [{ id: 1 }, { id: 1 }], 2 => [{ id: 2 }] }\n * groupBy(item => item.id)([{ id: 1 }, { id: 2 }]); // Map { 1 => [...], 2 => [...] }\n * ```\n */\nexport function groupBy<K, T>(keySelector: (item: T, index: number) => K): (items: Iterable<T>) => Map<K, T[]>;\nexport function groupBy<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]>;\nexport function groupBy(...args: readonly unknown[]): unknown {\n  return purry(groupByImplementation, args);\n}\n","/**\n * Returns an iterator of a map's keys.\n *\n * @example\n * ```ts\n * [...keys(new Map([['a', 1], ['b', 2]]))]; // ['a', 'b']\n * ```\n */\nexport function keys<K, V>(data: Map<K, V>): MapIterator<K> {\n  return data.keys();\n}\n","import { purry } from '../function/purry';\n\nfunction removeImplementation<K, V>(data: Map<K, V>, key: K): Map<K, V> {\n  data.delete(key);\n  return data;\n}\n\n/**\n * Removes an entry by key and returns the same map.\n *\n * @example\n * ```ts\n * const map = new Map([['a', 1], ['b', 2]]);\n * remove(map, 'a'); // Map { 'b' => 2 }\n * remove('b')(map); // Map(0) {}\n * ```\n */\nexport function remove<K>(key: K): <V>(data: Map<K, V>) => Map<K, V>;\nexport function remove<K, V>(data: Map<K, V>, key: K): Map<K, V>;\nexport function remove(...args: readonly unknown[]): unknown {\n  return purry(removeImplementation, args);\n}\n","import { purry } from '../function/purry';\n\nfunction setImplementation<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V> {\n  return data.set(key, value);\n}\n\n/**\n * Sets a key-value pair and returns the same map.\n *\n * @example\n * ```ts\n * set(new Map(), 'a', 1); // Map { 'a' => 1 }\n * set('b', 2)(new Map([['a', 1]])); // Map { 'a' => 1, 'b' => 2 }\n * ```\n */\nexport function set<K, V>(key: K, value: V): (data: Map<K, V>) => Map<K, V>;\nexport function set<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V>;\nexport function set(...args: readonly unknown[]): unknown {\n  return purry(setImplementation, args);\n}\n","/**\n * Returns an iterator of a map's values.\n *\n * @example\n * ```ts\n * [...values(new Map([['a', 1], ['b', 2]]))]; // [1, 2]\n * ```\n */\nexport function values<K, V>(data: Map<K, V>): MapIterator<V> {\n  return data.values();\n}\n"],"mappings":";;;;;;;AAIA,MAAa,OAAO;;;;;;;;;;;ACIpB,SAAgB,MAAY,MAA4B;CACtD,KAAK,MAAM;CACX,OAAO;AACT;;;;;;;;;;;ACHA,SAAgB,QAAc,MAAsC;CAClE,OAAO,KAAK,QAAQ;AACtB;;;ACRA,SAAS,sBACP,MACA,YACW;CACX,KAAK,QAAQ,UAAU;CACvB,OAAO;AACT;AAcA,SAAgB,QAAQ,GAAG,MAAmC;CAC5D,OAAO,MAAM,uBAAuB,IAAI;AAC1C;;;;;;;;;;;AChBA,SAAgB,KAAW,UAAsE;CAC/F,OAAO,IAAI,IAAI,QAAQ;AACzB;;;;;;;;;AAUA,SAAgB,QAAyB;CACvC,uBAAO,IAAI,IAAI;AACjB;;;ACpBA,SAAS,kBAAwB,MAAiB,KAAuB;CACvE,OAAO,KAAK,IAAI,GAAG;AACrB;AAeA,SAAgB,IAAI,GAAG,MAAmC;CACxD,OAAO,MAAM,mBAAmB,IAAI;AACtC;;;;;;;;;;;;;ACRA,SAAgB,YAAkB,KAAgB,KAAQ,cAA4B;CACpF,MAAM,IAAI,uBAAuB,mCAAmC;AACtE;;;;;;;;;;;AAaA,SAAgB,oBAA0B,KAAgB,KAAQ,UAAoC;CACpG,MAAM,IAAI,uBAAuB,2CAA2C;AAC9E;;;AC5BA,SAAS,sBAA4B,OAAoB,aAAyD;CAChH,OAAO,IAAI,QAAQ,OAAO,WAAW;AACvC;AAgBA,SAAgB,QAAQ,GAAG,MAAmC;CAC5D,OAAO,MAAM,uBAAuB,IAAI;AAC1C;;;;;;;;;;;ACdA,SAAgB,KAAW,MAAiC;CAC1D,OAAO,KAAK,KAAK;AACnB;;;ACRA,SAAS,qBAA2B,MAAiB,KAAmB;CACtE,KAAK,OAAO,GAAG;CACf,OAAO;AACT;AAcA,SAAgB,OAAO,GAAG,MAAmC;CAC3D,OAAO,MAAM,sBAAsB,IAAI;AACzC;;;ACnBA,SAAS,kBAAwB,MAAiB,KAAQ,OAAqB;CAC7E,OAAO,KAAK,IAAI,KAAK,KAAK;AAC5B;AAaA,SAAgB,IAAI,GAAG,MAAmC;CACxD,OAAO,MAAM,mBAAmB,IAAI;AACtC;;;;;;;;;;;ACXA,SAAgB,OAAa,MAAiC;CAC5D,OAAO,KAAK,OAAO;AACrB"}

package/dist/number/index.cjs

@@ -1,10 +1,25 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_purry = require("../purry-B2_0DGLV.cjs");
+const require_purry = require("../purry-Dqp_F64t.cjs");
 const require_errors = require("../errors-O-d_Vemi.cjs");
 require("../order/index.cjs");
 //#region src/number/_globalAliases.ts
+/**
+* Number predicates from the global `Number` object: `isFinite`, `isInteger`, and `isSafeInteger`.
+* @function
+*
+* @example
+* ```ts
+* isFinite(42); // true
+* isInteger(3.14); // false
+* isSafeInteger(Number.MAX_SAFE_INTEGER); // true
+* ```
+*/
 const { isFinite, isInteger, isSafeInteger } = Number;
-const numberConstructor = Number;
+/**
+* Alias of the built-in number constructor. `new Number() === new Number.Ctor()`
+* @function
+*/
+const Ctor = Number;
 //#endregion
 //#region src/number/add.ts
 function addImplementation(left, right) {
@@ -15,6 +30,16 @@ function add(...args) {
 }
 //#endregion
 //#region src/number/compare.ts
+/**
+* Compares two numbers and returns their ordering.
+*
+* @example
+* ```ts
+* compare(1, 2); // -1
+* compare(2, 2); // 0
+* compare(3, 2); // 1
+* ```
+*/
 function compare(left, right) {
 	if (left < right) return -1;
 	if (left > right) return 1;
@@ -22,6 +47,14 @@ function compare(left, right) {
 }
 //#endregion
 //#region src/number/decrement.ts
+/**
+* Returns the number decremented by one.
+*
+* @example
+* ```ts
+* decrement(5); // 4
+* ```
+*/
 function decrement(num) {
 	return num - 1;
 }
@@ -35,15 +68,27 @@ function divide(...args) {
 }
 //#endregion
 //#region src/number/increment.ts
+/**
+* Returns the number incremented by one.
+*
+* @example
+* ```ts
+* increment(5); // 6
+* ```
+*/
 function increment(num) {
 	return num + 1;
 }
 //#endregion
 //#region src/number/isNaN.ts
 /**
+* Checks whether a number is `NaN`.
 *
-* @param num
-* @returns
+* @example
+* ```ts
+* isNaN(NaN); // true
+* isNaN(0); // false
+* ```
 */
 function isNaN(num) {
 	return Number.isNaN(num);
@@ -51,11 +96,7 @@ function isNaN(num) {
 //#endregion
 //#region src/number/isNil.ts
 /**
-* Check whether a value is nullish (`null` or `undefined`)
-*
-* @category Guard
-* @param value - The value to check.
-* @returns `true` if `value` is `null` or `undefined`; otherwise `false`.
+* Checks whether a value is nullish (`null` or `undefined`).
 *
 * @example
 * ```ts
@@ -70,9 +111,13 @@ function isNil(value) {
 //#endregion
 //#region src/number/isNotNaN.ts
 /**
+* Checks whether a number is not `NaN`.
 *
-* @param num
-* @returns
+* @example
+* ```ts
+* isNotNaN(0); // true
+* isNotNaN(NaN); // false
+* ```
 */
 function isNotNaN(num) {
 	return !Number.isNaN(num);
@@ -80,11 +125,7 @@ function isNotNaN(num) {
 //#endregion
 //#region src/number/isNumber.ts
 /**
-* Check whether a value is a number (primitive `number`, not `NaN`).
-*
-* @category Guard
-* @param data - The value to check.
-* @returns `true` if `data` is a number; otherwise `false`.
+* Checks whether a value is a primitive `number`.
 *
 * @example
 * ```ts
@@ -108,7 +149,14 @@ function multiply(...args) {
 //#endregion
 //#region src/number/parseFloat.ts
 /**
+* Parses a floating-point number from a string.
+* Returns a NaN error when the input is not a valid number.
 *
+* @example
+* ```ts
+* parseFloat('3.14'); // 3.14
+* parseFloat('abc'); // NaNError
+* ```
 */
 function parseFloat(data) {
 	const num = Number.parseFloat(data);
@@ -118,7 +166,14 @@ function parseFloat(data) {
 //#endregion
 //#region src/number/parseInt.ts
 /**
-* @throws {NanError}
+* Parses a base-10 integer from a string.
+* Returns a NaN error when the input is not a valid integer.
+*
+* @example
+* ```ts
+* parseInt('42'); // 42
+* parseInt('abc'); // NaNError
+* ```
 */
 function parseInt(data) {
 	const num = Number.parseInt(data, 10);
@@ -138,6 +193,15 @@ function parseIntBase(...args) {
 }
 //#endregion
 //#region src/number/product.ts
+/**
+* Multiplies all numbers in an array.
+*
+* @example
+* ```ts
+* product([2, 3, 4]); // 24
+* product([]); // 1
+* ```
+*/
 function product(data) {
 	return data.reduce((a, b) => a * b, 1);
 }
@@ -151,11 +215,20 @@ function subtract(...args) {
 }
 //#endregion
 //#region src/number/sum.ts
+/**
+* Sums all numbers in an array.
+*
+* @example
+* ```ts
+* sum([1, 2, 3]); // 6
+* sum([]); // 0
+* ```
+*/
 function sum(data) {
 	return data.reduce((a, b) => a + b, 0);
 }
 //#endregion
-exports.Number = numberConstructor;
+exports.Ctor = Ctor;
 exports.add = add;
 exports.compare = compare;
 exports.decrement = decrement;

package/dist/number/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["purry","purry","purry","NaNError","NaNError","NaNError","purry","purry"],"sources":["../../src/number/_globalAliases.ts","../../src/number/add.ts","../../src/number/compare.ts","../../src/number/decrement.ts","../../src/number/divide.ts","../../src/number/increment.ts","../../src/number/isNaN.ts","../../src/number/isNil.ts","../../src/number/isNotNaN.ts","../../src/number/isNumber.ts","../../src/number/multiply.ts","../../src/number/parseFloat.ts","../../src/number/parseInt.ts","../../src/number/parseIntBase.ts","../../src/number/product.ts","../../src/number/subtract.ts","../../src/number/sum.ts"],"sourcesContent":["export const { isFinite, isInteger, isSafeInteger } = Number;\n\nconst numberConstructor = Number;\nexport { numberConstructor as Number };\n","import { purry } from '../function/purry';\n\nfunction addImplementation(left: number, right: number): number {\n  return left + right;\n}\n\nexport function add(right: number): (left: number) => number;\nexport function add(left: number, right: number): number;\nexport function add(...args: unknown[]): unknown {\n  return purry(addImplementation, args);\n}\n","import type { Order } from '../order';\nimport { eq, gt, lt } from '../order';\n\nexport function compare(left: number, right: number): Order {\n  if (left < right) return lt;\n  if (left > right) return gt;\n  return eq;\n}\n","export function decrement(num: number): number {\n  return num - 1;\n}\n","import { purry } from '../function/purry';\n\nfunction divideImplementation(left: number, right: number): number {\n  return left / right;\n}\n\nexport function divide(right: number): (left: number) => number;\nexport function divide(left: number, right: number): number;\nexport function divide(...args: unknown[]): unknown {\n  return purry(divideImplementation, args);\n}\n","export function increment(num: number): number {\n  return num + 1;\n}\n","/**\n *\n * @param num\n * @returns\n */\nexport function isNaN(num: number): boolean {\n  return Number.isNaN(num);\n}\n","/**\n * Check whether a value is nullish (`null` or `undefined`)\n *\n * @category Guard\n * @param value - The value to check.\n * @returns `true` if `value` is `null` or `undefined`; otherwise `false`.\n *\n * @example\n * ```ts\n * isNil(null); // true\n * isNil(undefined); // true\n * isNil(0); // false\n * ```\n */\nexport function isNil<T>(value: T): value is T & (null | undefined) {\n  return value == null;\n}\n","/**\n *\n * @param num\n * @returns\n */\nexport function isNotNaN(num: number): boolean {\n  return !Number.isNaN(num);\n}\n","import type { NarrowedTo } from '../types';\n\n/**\n * Check whether a value is a number (primitive `number`, not `NaN`).\n *\n * @category Guard\n * @param data - The value to check.\n * @returns `true` if `data` is a number; otherwise `false`.\n *\n * @example\n * ```ts\n * isNumber(1); // true\n * isNumber(Infinity); // true\n * isNumber(NaN); // true\n * isNumber('1'); // false\n * ```\n */\nexport function isNumber<T>(data: T | number): data is NarrowedTo<T, number> {\n  return typeof data === 'number';\n}\n","import { purry } from '../function/purry';\n\nfunction multiplyImplementation(left: number, right: number): number {\n  return left * right;\n}\n\nexport function multiply(right: number): (left: number) => number;\nexport function multiply(left: number, right: number): number;\nexport function multiply(...args: unknown[]): unknown {\n  return purry(multiplyImplementation, args);\n}\n","import { NaNError } from '../errors';\n\n/**\n *\n */\nexport function parseFloat(data: string): NaNError | number {\n  const num = Number.parseFloat(data);\n\n  if (Number.isNaN(num)) {\n    return new NaNError(`Num.parseFloat() :: \"${data}\" is NaN`);\n  }\n\n  return num;\n}\n","import { NaNError } from '../errors';\n\n/**\n * @throws {NanError}\n */\nexport function parseInt(data: string): NaNError | number {\n  const num = Number.parseInt(data, 10);\n\n  if (Number.isNaN(num)) {\n    return new NaNError(`Num.parseInt() :: \"${data}\" is NaN`);\n  }\n\n  return num;\n}\n","import { NaNError } from '../errors';\nimport { purry } from '../function/purry';\n\nfunction parseIntBaseImplementation(data: string, radix: number): number {\n  if (typeof radix !== 'number') {\n    throw new NaNError(`Num.parseFloat(_, radix) :: \"${data}\" must be number`);\n  }\n\n  const num = Number.parseInt(data, radix);\n\n  if (Number.isNaN(num)) {\n    throw new NaNError(`Num.parseFloat(data, _) :: \"${data}\" is NaN`);\n  }\n\n  return num;\n}\n\n/**\n *\n * @throws {NaNError}\n */\nexport function parseIntBase(radix: number): (data: string) => number;\nexport function parseIntBase(data: string, radix: number): number;\nexport function parseIntBase(...args: unknown[]): unknown {\n  return purry(parseIntBaseImplementation, args);\n}\n","export function product(data: number[]): number {\n  return data.reduce((a, b) => a * b, 1);\n}\n","import { purry } from '../function/purry';\n\nfunction subtractImplementation(left: number, right: number): number {\n  return left - right;\n}\n\nexport function subtract(right: number): (left: number) => number;\nexport function subtract(left: number, right: number): number;\nexport function subtract(...args: unknown[]): unknown {\n  return purry(subtractImplementation, args);\n}\n","export function sum(data: number[]): number {\n  return data.reduce((a, b) => a + b, 0);\n}\n"],"mappings":";;;;;AAAA,MAAa,EAAE,UAAU,WAAW,kBAAkB;AAEtD,MAAM,oBAAoB;;;ACA1B,SAAS,kBAAkB,MAAc,OAAuB;CAC9D,OAAO,OAAO;AAChB;AAIA,SAAgB,IAAI,GAAG,MAA0B;CAC/C,OAAOA,cAAAA,MAAM,mBAAmB,IAAI;AACtC;;;ACPA,SAAgB,QAAQ,MAAc,OAAsB;CAC1D,IAAI,OAAO,OAAO,OAAA;CAClB,IAAI,OAAO,OAAO,OAAA;CAClB,OAAA;AACF;;;ACPA,SAAgB,UAAU,KAAqB;CAC7C,OAAO,MAAM;AACf;;;ACAA,SAAS,qBAAqB,MAAc,OAAuB;CACjE,OAAO,OAAO;AAChB;AAIA,SAAgB,OAAO,GAAG,MAA0B;CAClD,OAAOC,cAAAA,MAAM,sBAAsB,IAAI;AACzC;;;ACVA,SAAgB,UAAU,KAAqB;CAC7C,OAAO,MAAM;AACf;;;;;;;;ACGA,SAAgB,MAAM,KAAsB;CAC1C,OAAO,OAAO,MAAM,GAAG;AACzB;;;;;;;;;;;;;;;;;ACOA,SAAgB,MAAS,OAA2C;CAClE,OAAO,SAAS;AAClB;;;;;;;;ACXA,SAAgB,SAAS,KAAsB;CAC7C,OAAO,CAAC,OAAO,MAAM,GAAG;AAC1B;;;;;;;;;;;;;;;;;;ACUA,SAAgB,SAAY,MAAiD;CAC3E,OAAO,OAAO,SAAS;AACzB;;;ACjBA,SAAS,uBAAuB,MAAc,OAAuB;CACnE,OAAO,OAAO;AAChB;AAIA,SAAgB,SAAS,GAAG,MAA0B;CACpD,OAAOC,cAAAA,MAAM,wBAAwB,IAAI;AAC3C;;;;;;ACLA,SAAgB,WAAW,MAAiC;CAC1D,MAAM,MAAM,OAAO,WAAW,IAAI;CAElC,IAAI,OAAO,MAAM,GAAG,GAClB,OAAO,IAAIC,eAAAA,SAAS,wBAAwB,KAAK,SAAS;CAG5D,OAAO;AACT;;;;;;ACRA,SAAgB,SAAS,MAAiC;CACxD,MAAM,MAAM,OAAO,SAAS,MAAM,EAAE;CAEpC,IAAI,OAAO,MAAM,GAAG,GAClB,OAAO,IAAIC,eAAAA,SAAS,sBAAsB,KAAK,SAAS;CAG1D,OAAO;AACT;;;ACVA,SAAS,2BAA2B,MAAc,OAAuB;CACvE,IAAI,OAAO,UAAU,UACnB,MAAM,IAAIC,eAAAA,SAAS,gCAAgC,KAAK,iBAAiB;CAG3E,MAAM,MAAM,OAAO,SAAS,MAAM,KAAK;CAEvC,IAAI,OAAO,MAAM,GAAG,GAClB,MAAM,IAAIA,eAAAA,SAAS,+BAA+B,KAAK,SAAS;CAGlE,OAAO;AACT;AAQA,SAAgB,aAAa,GAAG,MAA0B;CACxD,OAAOC,cAAAA,MAAM,4BAA4B,IAAI;AAC/C;;;ACzBA,SAAgB,QAAQ,MAAwB;CAC9C,OAAO,KAAK,QAAQ,GAAG,MAAM,IAAI,GAAG,CAAC;AACvC;;;ACAA,SAAS,uBAAuB,MAAc,OAAuB;CACnE,OAAO,OAAO;AAChB;AAIA,SAAgB,SAAS,GAAG,MAA0B;CACpD,OAAOC,cAAAA,MAAM,wBAAwB,IAAI;AAC3C;;;ACVA,SAAgB,IAAI,MAAwB;CAC1C,OAAO,KAAK,QAAQ,GAAG,MAAM,IAAI,GAAG,CAAC;AACvC"}
+{"version":3,"file":"index.cjs","names":["purry","purry","purry","NaNError","NaNError","NaNError","purry","purry"],"sources":["../../src/number/_globalAliases.ts","../../src/number/add.ts","../../src/number/compare.ts","../../src/number/decrement.ts","../../src/number/divide.ts","../../src/number/increment.ts","../../src/number/isNaN.ts","../../src/number/isNil.ts","../../src/number/isNotNaN.ts","../../src/number/isNumber.ts","../../src/number/multiply.ts","../../src/number/parseFloat.ts","../../src/number/parseInt.ts","../../src/number/parseIntBase.ts","../../src/number/product.ts","../../src/number/subtract.ts","../../src/number/sum.ts"],"sourcesContent":["/**\n * Number predicates from the global `Number` object: `isFinite`, `isInteger`, and `isSafeInteger`.\n * @function\n *\n * @example\n * ```ts\n * isFinite(42); // true\n * isInteger(3.14); // false\n * isSafeInteger(Number.MAX_SAFE_INTEGER); // true\n * ```\n */\nexport const { isFinite, isInteger, isSafeInteger } = Number;\n\n/**\n * Alias of the built-in number constructor. `new Number() === new Number.Ctor()`\n * @function\n */\nexport const Ctor = Number;\n","import { purry } from '../function/purry';\n\nfunction addImplementation(left: number, right: number): number {\n  return left + right;\n}\n\n/**\n * Adds two numbers together.\n *\n * @example\n * ```ts\n * add(1, 2); // 3\n * add(2)(1); // 3\n * ```\n */\nexport function add(right: number): (left: number) => number;\nexport function add(left: number, right: number): number;\nexport function add(...args: unknown[]): unknown {\n  return purry(addImplementation, args);\n}\n","import type { Order } from '../order';\nimport { eq, gt, lt } from '../order';\n\n/**\n * Compares two numbers and returns their ordering.\n *\n * @example\n * ```ts\n * compare(1, 2); // -1\n * compare(2, 2); // 0\n * compare(3, 2); // 1\n * ```\n */\nexport function compare(left: number, right: number): Order {\n  if (left < right) return lt;\n  if (left > right) return gt;\n  return eq;\n}\n","/**\n * Returns the number decremented by one.\n *\n * @example\n * ```ts\n * decrement(5); // 4\n * ```\n */\nexport function decrement(num: number): number {\n  return num - 1;\n}\n","import { purry } from '../function/purry';\n\nfunction divideImplementation(left: number, right: number): number {\n  return left / right;\n}\n\n/**\n * Divides one number by another.\n *\n * @example\n * ```ts\n * divide(10, 2); // 5\n * divide(2)(10); // 5\n * ```\n */\nexport function divide(right: number): (left: number) => number;\nexport function divide(left: number, right: number): number;\nexport function divide(...args: unknown[]): unknown {\n  return purry(divideImplementation, args);\n}\n","/**\n * Returns the number incremented by one.\n *\n * @example\n * ```ts\n * increment(5); // 6\n * ```\n */\nexport function increment(num: number): number {\n  return num + 1;\n}\n","/**\n * Checks whether a number is `NaN`.\n *\n * @example\n * ```ts\n * isNaN(NaN); // true\n * isNaN(0); // false\n * ```\n */\nexport function isNaN(num: number): boolean {\n  return Number.isNaN(num);\n}\n","/**\n * Checks whether a value is nullish (`null` or `undefined`).\n *\n * @example\n * ```ts\n * isNil(null); // true\n * isNil(undefined); // true\n * isNil(0); // false\n * ```\n */\nexport function isNil<T>(value: T): value is T & (null | undefined) {\n  return value == null;\n}\n","/**\n * Checks whether a number is not `NaN`.\n *\n * @example\n * ```ts\n * isNotNaN(0); // true\n * isNotNaN(NaN); // false\n * ```\n */\nexport function isNotNaN(num: number): boolean {\n  return !Number.isNaN(num);\n}\n","import type { NarrowedTo } from '../types';\n\n/**\n * Checks whether a value is a primitive `number`.\n *\n * @example\n * ```ts\n * isNumber(1); // true\n * isNumber(Infinity); // true\n * isNumber(NaN); // true\n * isNumber('1'); // false\n * ```\n */\nexport function isNumber<T>(data: T | number): data is NarrowedTo<T, number> {\n  return typeof data === 'number';\n}\n","import { purry } from '../function/purry';\n\nfunction multiplyImplementation(left: number, right: number): number {\n  return left * right;\n}\n\n/**\n * Multiplies two numbers together.\n *\n * @example\n * ```ts\n * multiply(3, 4); // 12\n * multiply(4)(3); // 12\n * ```\n */\nexport function multiply(right: number): (left: number) => number;\nexport function multiply(left: number, right: number): number;\nexport function multiply(...args: unknown[]): unknown {\n  return purry(multiplyImplementation, args);\n}\n","import { NaNError } from '../errors';\n\n/**\n * Parses a floating-point number from a string.\n * Returns a NaN error when the input is not a valid number.\n *\n * @example\n * ```ts\n * parseFloat('3.14'); // 3.14\n * parseFloat('abc'); // NaNError\n * ```\n */\nexport function parseFloat(data: string): NaNError | number {\n  const num = Number.parseFloat(data);\n\n  if (Number.isNaN(num)) {\n    return new NaNError(`Num.parseFloat() :: \"${data}\" is NaN`);\n  }\n\n  return num;\n}\n","import { NaNError } from '../errors';\n\n/**\n * Parses a base-10 integer from a string.\n * Returns a NaN error when the input is not a valid integer.\n *\n * @example\n * ```ts\n * parseInt('42'); // 42\n * parseInt('abc'); // NaNError\n * ```\n */\nexport function parseInt(data: string): NaNError | number {\n  const num = Number.parseInt(data, 10);\n\n  if (Number.isNaN(num)) {\n    return new NaNError(`Num.parseInt() :: \"${data}\" is NaN`);\n  }\n\n  return num;\n}\n","import { NaNError } from '../errors';\nimport { purry } from '../function/purry';\n\nfunction parseIntBaseImplementation(data: string, radix: number): number {\n  if (typeof radix !== 'number') {\n    throw new NaNError(`Num.parseFloat(_, radix) :: \"${data}\" must be number`);\n  }\n\n  const num = Number.parseInt(data, radix);\n\n  if (Number.isNaN(num)) {\n    throw new NaNError(`Num.parseFloat(data, _) :: \"${data}\" is NaN`);\n  }\n\n  return num;\n}\n\n/**\n * Parses an integer from a string in the given radix.\n * Throws a NaN error when the radix is invalid or parsing fails.\n *\n * @example\n * ```ts\n * parseIntBase('ff', 16); // 255\n * parseIntBase(16)('ff'); // 255\n * ```\n */\nexport function parseIntBase(radix: number): (data: string) => number;\nexport function parseIntBase(data: string, radix: number): number;\nexport function parseIntBase(...args: unknown[]): unknown {\n  return purry(parseIntBaseImplementation, args);\n}\n","/**\n * Multiplies all numbers in an array.\n *\n * @example\n * ```ts\n * product([2, 3, 4]); // 24\n * product([]); // 1\n * ```\n */\nexport function product(data: number[]): number {\n  return data.reduce((a, b) => a * b, 1);\n}\n","import { purry } from '../function/purry';\n\nfunction subtractImplementation(left: number, right: number): number {\n  return left - right;\n}\n\n/**\n * Subtracts one number from another.\n *\n * @example\n * ```ts\n * subtract(10, 3); // 7\n * subtract(3)(10); // 7\n * ```\n */\nexport function subtract(right: number): (left: number) => number;\nexport function subtract(left: number, right: number): number;\nexport function subtract(...args: unknown[]): unknown {\n  return purry(subtractImplementation, args);\n}\n","/**\n * Sums all numbers in an array.\n *\n * @example\n * ```ts\n * sum([1, 2, 3]); // 6\n * sum([]); // 0\n * ```\n */\nexport function sum(data: number[]): number {\n  return data.reduce((a, b) => a + b, 0);\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAWA,MAAa,EAAE,UAAU,WAAW,kBAAkB;;;;;AAMtD,MAAa,OAAO;;;ACfpB,SAAS,kBAAkB,MAAc,OAAuB;CAC9D,OAAO,OAAO;AAChB;AAaA,SAAgB,IAAI,GAAG,MAA0B;CAC/C,OAAOA,cAAAA,MAAM,mBAAmB,IAAI;AACtC;;;;;;;;;;;;;ACNA,SAAgB,QAAQ,MAAc,OAAsB;CAC1D,IAAI,OAAO,OAAO,OAAA;CAClB,IAAI,OAAO,OAAO,OAAA;CAClB,OAAA;AACF;;;;;;;;;;;ACTA,SAAgB,UAAU,KAAqB;CAC7C,OAAO,MAAM;AACf;;;ACRA,SAAS,qBAAqB,MAAc,OAAuB;CACjE,OAAO,OAAO;AAChB;AAaA,SAAgB,OAAO,GAAG,MAA0B;CAClD,OAAOC,cAAAA,MAAM,sBAAsB,IAAI;AACzC;;;;;;;;;;;ACXA,SAAgB,UAAU,KAAqB;CAC7C,OAAO,MAAM;AACf;;;;;;;;;;;;ACDA,SAAgB,MAAM,KAAsB;CAC1C,OAAO,OAAO,MAAM,GAAG;AACzB;;;;;;;;;;;;;ACDA,SAAgB,MAAS,OAA2C;CAClE,OAAO,SAAS;AAClB;;;;;;;;;;;;ACHA,SAAgB,SAAS,KAAsB;CAC7C,OAAO,CAAC,OAAO,MAAM,GAAG;AAC1B;;;;;;;;;;;;;;ACEA,SAAgB,SAAY,MAAiD;CAC3E,OAAO,OAAO,SAAS;AACzB;;;ACbA,SAAS,uBAAuB,MAAc,OAAuB;CACnE,OAAO,OAAO;AAChB;AAaA,SAAgB,SAAS,GAAG,MAA0B;CACpD,OAAOC,cAAAA,MAAM,wBAAwB,IAAI;AAC3C;;;;;;;;;;;;;ACPA,SAAgB,WAAW,MAAiC;CAC1D,MAAM,MAAM,OAAO,WAAW,IAAI;CAElC,IAAI,OAAO,MAAM,GAAG,GAClB,OAAO,IAAIC,eAAAA,SAAS,wBAAwB,KAAK,SAAS;CAG5D,OAAO;AACT;;;;;;;;;;;;;ACRA,SAAgB,SAAS,MAAiC;CACxD,MAAM,MAAM,OAAO,SAAS,MAAM,EAAE;CAEpC,IAAI,OAAO,MAAM,GAAG,GAClB,OAAO,IAAIC,eAAAA,SAAS,sBAAsB,KAAK,SAAS;CAG1D,OAAO;AACT;;;ACjBA,SAAS,2BAA2B,MAAc,OAAuB;CACvE,IAAI,OAAO,UAAU,UACnB,MAAM,IAAIC,eAAAA,SAAS,gCAAgC,KAAK,iBAAiB;CAG3E,MAAM,MAAM,OAAO,SAAS,MAAM,KAAK;CAEvC,IAAI,OAAO,MAAM,GAAG,GAClB,MAAM,IAAIA,eAAAA,SAAS,+BAA+B,KAAK,SAAS;CAGlE,OAAO;AACT;AAcA,SAAgB,aAAa,GAAG,MAA0B;CACxD,OAAOC,cAAAA,MAAM,4BAA4B,IAAI;AAC/C;;;;;;;;;;;;ACtBA,SAAgB,QAAQ,MAAwB;CAC9C,OAAO,KAAK,QAAQ,GAAG,MAAM,IAAI,GAAG,CAAC;AACvC;;;ACTA,SAAS,uBAAuB,MAAc,OAAuB;CACnE,OAAO,OAAO;AAChB;AAaA,SAAgB,SAAS,GAAG,MAA0B;CACpD,OAAOC,cAAAA,MAAM,wBAAwB,IAAI;AAC3C;;;;;;;;;;;;ACVA,SAAgB,IAAI,MAAwB;CAC1C,OAAO,KAAK,QAAQ,GAAG,MAAM,IAAI,GAAG,CAAC;AACvC"}

package/dist/number/index.d.cts

@@ -1,43 +1,102 @@
 import { n as NaNError } from "../errors-CJsLpYo9.cjs";
 import { i as NarrowedTo } from "../types-D8f67ZCe.cjs";
-import { i as Order } from "../order.constants-BWSCg3C7.cjs";
+import { i as Order } from "../order.constants-DpGY-EDp.cjs";
 
 //#region src/number/_globalAliases.d.ts
+/**
+ * Number predicates from the global `Number` object: `isFinite`, `isInteger`, and `isSafeInteger`.
+ * @function
+ *
+ * @example
+ * ```ts
+ * isFinite(42); // true
+ * isInteger(3.14); // false
+ * isSafeInteger(Number.MAX_SAFE_INTEGER); // true
+ * ```
+ */
 declare const isFinite: (number: unknown) => boolean, isInteger: (number: unknown) => boolean, isSafeInteger: (number: unknown) => boolean;
-declare const numberConstructor: NumberConstructor;
+/**
+ * Alias of the built-in number constructor. `new Number() === new Number.Ctor()`
+ * @function
+ */
+declare const Ctor: NumberConstructor;
 //#endregion
 //#region src/number/add.d.ts
+/**
+ * Adds two numbers together.
+ *
+ * @example
+ * ```ts
+ * add(1, 2); // 3
+ * add(2)(1); // 3
+ * ```
+ */
 declare function add(right: number): (left: number) => number;
 declare function add(left: number, right: number): number;
 //#endregion
 //#region src/number/compare.d.ts
+/**
+ * Compares two numbers and returns their ordering.
+ *
+ * @example
+ * ```ts
+ * compare(1, 2); // -1
+ * compare(2, 2); // 0
+ * compare(3, 2); // 1
+ * ```
+ */
 declare function compare(left: number, right: number): Order;
 //#endregion
 //#region src/number/decrement.d.ts
+/**
+ * Returns the number decremented by one.
+ *
+ * @example
+ * ```ts
+ * decrement(5); // 4
+ * ```
+ */
 declare function decrement(num: number): number;
 //#endregion
 //#region src/number/divide.d.ts
+/**
+ * Divides one number by another.
+ *
+ * @example
+ * ```ts
+ * divide(10, 2); // 5
+ * divide(2)(10); // 5
+ * ```
+ */
 declare function divide(right: number): (left: number) => number;
 declare function divide(left: number, right: number): number;
 //#endregion
 //#region src/number/increment.d.ts
+/**
+ * Returns the number incremented by one.
+ *
+ * @example
+ * ```ts
+ * increment(5); // 6
+ * ```
+ */
 declare function increment(num: number): number;
 //#endregion
 //#region src/number/isNaN.d.ts
 /**
+ * Checks whether a number is `NaN`.
  *
- * @param num
- * @returns
+ * @example
+ * ```ts
+ * isNaN(NaN); // true
+ * isNaN(0); // false
+ * ```
  */
 declare function isNaN(num: number): boolean;
 //#endregion
 //#region src/number/isNil.d.ts
 /**
- * Check whether a value is nullish (`null` or `undefined`)
- *
- * @category Guard
- * @param value - The value to check.
- * @returns `true` if `value` is `null` or `undefined`; otherwise `false`.
+ * Checks whether a value is nullish (`null` or `undefined`).
  *
  * @example
  * ```ts
@@ -50,19 +109,19 @@ declare function isNil<T>(value: T): value is T & (null | undefined);
 //#endregion
 //#region src/number/isNotNaN.d.ts
 /**
+ * Checks whether a number is not `NaN`.
  *
- * @param num
- * @returns
+ * @example
+ * ```ts
+ * isNotNaN(0); // true
+ * isNotNaN(NaN); // false
+ * ```
  */
 declare function isNotNaN(num: number): boolean;
 //#endregion
 //#region src/number/isNumber.d.ts
 /**
- * Check whether a value is a number (primitive `number`, not `NaN`).
- *
- * @category Guard
- * @param data - The value to check.
- * @returns `true` if `data` is a number; otherwise `false`.
+ * Checks whether a value is a primitive `number`.
  *
  * @example
  * ```ts
@@ -75,38 +134,94 @@ declare function isNotNaN(num: number): boolean;
 declare function isNumber<T>(data: T | number): data is NarrowedTo<T, number>;
 //#endregion
 //#region src/number/multiply.d.ts
+/**
+ * Multiplies two numbers together.
+ *
+ * @example
+ * ```ts
+ * multiply(3, 4); // 12
+ * multiply(4)(3); // 12
+ * ```
+ */
 declare function multiply(right: number): (left: number) => number;
 declare function multiply(left: number, right: number): number;
 //#endregion
 //#region src/number/parseFloat.d.ts
 /**
+ * Parses a floating-point number from a string.
+ * Returns a NaN error when the input is not a valid number.
  *
+ * @example
+ * ```ts
+ * parseFloat('3.14'); // 3.14
+ * parseFloat('abc'); // NaNError
+ * ```
  */
 declare function parseFloat(data: string): NaNError | number;
 //#endregion
 //#region src/number/parseInt.d.ts
 /**
- * @throws {NanError}
+ * Parses a base-10 integer from a string.
+ * Returns a NaN error when the input is not a valid integer.
+ *
+ * @example
+ * ```ts
+ * parseInt('42'); // 42
+ * parseInt('abc'); // NaNError
+ * ```
  */
 declare function parseInt(data: string): NaNError | number;
 //#endregion
 //#region src/number/parseIntBase.d.ts
 /**
+ * Parses an integer from a string in the given radix.
+ * Throws a NaN error when the radix is invalid or parsing fails.
  *
- * @throws {NaNError}
+ * @example
+ * ```ts
+ * parseIntBase('ff', 16); // 255
+ * parseIntBase(16)('ff'); // 255
+ * ```
  */
 declare function parseIntBase(radix: number): (data: string) => number;
 declare function parseIntBase(data: string, radix: number): number;
 //#endregion
 //#region src/number/product.d.ts
+/**
+ * Multiplies all numbers in an array.
+ *
+ * @example
+ * ```ts
+ * product([2, 3, 4]); // 24
+ * product([]); // 1
+ * ```
+ */
 declare function product(data: number[]): number;
 //#endregion
 //#region src/number/subtract.d.ts
+/**
+ * Subtracts one number from another.
+ *
+ * @example
+ * ```ts
+ * subtract(10, 3); // 7
+ * subtract(3)(10); // 7
+ * ```
+ */
 declare function subtract(right: number): (left: number) => number;
 declare function subtract(left: number, right: number): number;
 //#endregion
 //#region src/number/sum.d.ts
+/**
+ * Sums all numbers in an array.
+ *
+ * @example
+ * ```ts
+ * sum([1, 2, 3]); // 6
+ * sum([]); // 0
+ * ```
+ */
 declare function sum(data: number[]): number;
 //#endregion
-export { numberConstructor as Number, add, compare, decrement, divide, increment, isFinite, isInteger, isNaN, isNil, isNotNaN, isNumber, isSafeInteger, multiply, parseFloat, parseInt, parseIntBase, product, subtract, sum };
+export { Ctor, add, compare, decrement, divide, increment, isFinite, isInteger, isNaN, isNil, isNotNaN, isNumber, isSafeInteger, multiply, parseFloat, parseInt, parseIntBase, product, subtract, sum };
 //# sourceMappingURL=index.d.cts.map

package/dist/number/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/number/_globalAliases.ts","../../src/number/add.ts","../../src/number/compare.ts","../../src/number/decrement.ts","../../src/number/divide.ts","../../src/number/increment.ts","../../src/number/isNaN.ts","../../src/number/isNil.ts","../../src/number/isNotNaN.ts","../../src/number/isNumber.ts","../../src/number/multiply.ts","../../src/number/parseFloat.ts","../../src/number/parseInt.ts","../../src/number/parseIntBase.ts","../../src/number/product.ts","../../src/number/subtract.ts","../../src/number/sum.ts"],"mappings":";;;;;cAAe,QAAA,GAAQ,MAAA,mCAAW,MAAA,uCAAe,MAAA;AAAA,cAE3C,iBAAA,EAAiB,iBAAS;;;iBCIhB,GAAA,CAAI,KAAA,YAAiB,IAAY;AAAA,iBACjC,GAAA,CAAI,IAAA,UAAc,KAAa;;;iBCJ/B,OAAA,CAAQ,IAAA,UAAc,KAAA,WAAgB,KAAK;;;iBCH3C,SAAA,CAAU,GAAW;;;iBCMrB,MAAA,CAAO,KAAA,YAAiB,IAAY;AAAA,iBACpC,MAAA,CAAO,IAAA,UAAc,KAAa;;;iBCPlC,SAAA,CAAU,GAAW;;;;;;;;iBCKrB,KAAA,CAAM,GAAW;;;;;;;;ANLjC;;;;;;;;AAAiD;iBOcjC,KAAA,IAAS,KAAA,EAAO,CAAA,GAAI,KAAA,IAAS,CAAC;;;;;;;;iBCT9B,QAAA,CAAS,GAAW;;;;;;;ARLpC;;;;;;;;AAAiD;;;iBSiBjC,QAAA,IAAY,IAAA,EAAM,CAAA,YAAa,IAAA,IAAQ,UAAA,CAAW,CAAA;;;iBCXlD,QAAA,CAAS,KAAA,YAAiB,IAAY;AAAA,iBACtC,QAAA,CAAS,IAAA,UAAc,KAAa;;;;;;iBCFpC,UAAA,CAAW,IAAA,WAAe,QAAQ;;;;;;iBCAlC,QAAA,CAAS,IAAA,WAAe,QAAQ;;;;;;;iBCgBhC,YAAA,CAAa,KAAA,YAAiB,IAAY;AAAA,iBAC1C,YAAA,CAAa,IAAA,UAAc,KAAa;;;iBCtBxC,OAAA,CAAQ,IAAc;;;iBCMtB,QAAA,CAAS,KAAA,YAAiB,IAAY;AAAA,iBACtC,QAAA,CAAS,IAAA,UAAc,KAAa;;;iBCPpC,GAAA,CAAI,IAAc"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/number/_globalAliases.ts","../../src/number/add.ts","../../src/number/compare.ts","../../src/number/decrement.ts","../../src/number/divide.ts","../../src/number/increment.ts","../../src/number/isNaN.ts","../../src/number/isNil.ts","../../src/number/isNotNaN.ts","../../src/number/isNumber.ts","../../src/number/multiply.ts","../../src/number/parseFloat.ts","../../src/number/parseInt.ts","../../src/number/parseIntBase.ts","../../src/number/product.ts","../../src/number/subtract.ts","../../src/number/sum.ts"],"mappings":";;;;;;;;;;AAWA;;;;;;cAAe,QAAA,GAAQ,MAAA,mCAAW,MAAA,uCAAe,MAAA;;AAAA;;;cAMpC,IAAA,EAAI,iBAAS;;;;;;;;AAN1B;;;;iBCIgB,GAAA,CAAI,KAAA,YAAiB,IAAY;AAAA,iBACjC,GAAA,CAAI,IAAA,UAAc,KAAa;;;;;;;ADL/C;;;;;;iBEEgB,OAAA,CAAQ,IAAA,UAAc,KAAA,WAAgB,KAAK;;;;;;;;AFF3D;;;iBGHgB,SAAA,CAAU,GAAW;;;;;;;;AHGrC;;;;iBIIgB,MAAA,CAAO,KAAA,YAAiB,IAAY;AAAA,iBACpC,MAAA,CAAO,IAAA,UAAc,KAAa;;;;;;;;AJLlD;;;iBKHgB,SAAA,CAAU,GAAW;;;;;;;;ALGrC;;;;iBMFgB,KAAA,CAAM,GAAW;;;;;;;;ANEjC;;;;;iBODgB,KAAA,IAAS,KAAA,EAAO,CAAA,GAAI,KAAA,IAAS,CAAC;;;;;;;;APC9C;;;;iBQFgB,QAAA,CAAS,GAAW;;;;;;;AREpC;;;;;;;iBSEgB,QAAA,IAAY,IAAA,EAAM,CAAA,YAAa,IAAA,IAAQ,UAAA,CAAW,CAAA;;;;;;;;ATFlE;;;;iBUIgB,QAAA,CAAS,KAAA,YAAiB,IAAY;AAAA,iBACtC,QAAA,CAAS,IAAA,UAAc,KAAa;;;;;;;AVLpD;;;;;;iBWCgB,UAAA,CAAW,IAAA,WAAe,QAAQ;;;;;;;AXDlD;;;;;;iBYCgB,QAAA,CAAS,IAAA,WAAe,QAAQ;;;;;;;;AZDhD;;;;;iBagBgB,YAAA,CAAa,KAAA,YAAiB,IAAY;AAAA,iBAC1C,YAAA,CAAa,IAAA,UAAc,KAAa;;;;;;;;AbjBxD;;;;iBcFgB,OAAA,CAAQ,IAAc;;;;;;;;AdEtC;;;;iBeIgB,QAAA,CAAS,KAAA,YAAiB,IAAY;AAAA,iBACtC,QAAA,CAAS,IAAA,UAAc,KAAa;;;;;;;;AfLpD;;;;iBgBFgB,GAAA,CAAI,IAAc"}