tsu 1.1.2 → 1.2.0

package/dist/index.d.ts

@@ -60,7 +60,7 @@ declare function min(array: readonly number[]): number | undefined;
  *
  * @param filter - The predicate function.
  * @param array - The array.
- * @returns The array split in two.
+ * @returns The tuple of values that satisfy the predicate and those that don't.
  */
 declare function partition<T>(filter: (x: T, idx: number, a: readonly T[]) => boolean, array: readonly T[]): [T[], T[]];
 /**
@@ -68,11 +68,11 @@ declare function partition<T>(filter: (x: T, idx: number, a: readonly T[]) => bo
  *
  * @param i - The position to split at.
  * @param array - The array.
- * @returns The array split in two.
+ * @returns The tuple of values before and after the split.
  */
 declare function splitAt<T>(i: number, array: readonly T[]): [T[], T[]];
 /**
- * Returns the sum of the numbers of an array.
+ * Returns the sum of an array of numbers.
  *
  * @param array - The array of numbers.
  * @returns The sum.
@@ -123,6 +123,13 @@ declare function debounce(fn: Fn, delay: number): VoidFn;
  * @returns The memoized function.
  */
 declare function memoize<T>(fn: Fn<T>): Fn<T>;
+/**
+ * Enforces that a function is only callable one time.
+ *
+ * @param fn - The function.
+ * @returns The one-time callable function.
+ */
+declare function once(fn: Fn): VoidFn;
 /**
  * Prevents a function from running for some time period after it was last called.
  *
@@ -147,9 +154,9 @@ declare function isArray(val: unknown): val is any[];
  */
 declare function isBoolean(val: unknown): val is boolean;
 /**
- * Identifies if the code is being run in the browser.
+ * Identifies if the code is being run in a browser.
  *
- * @returns If the code is being run on a browser.
+ * @returns If the code is being run in a browser.
  */
 declare function isBrowser(): boolean;
 /**
@@ -159,6 +166,13 @@ declare function isBrowser(): boolean;
  * @returns If the value is defined.
  */
 declare function isDefined<T = unknown>(val?: T): val is T;
+/**
+ * Identifies if a value is an empty object.
+ *
+ * @param val - The value.
+ * @returns If the value is an empty object.
+ */
+declare function isEmptyObject(val: unknown): val is Record<string, never>;
 /**
  * Identifies if a value is a function.
  *
@@ -284,9 +298,10 @@ declare function scroll({ to, offset, duration, container }: ScrollConfig): void
  *
  * @param str - The string.
  * @param allWords - If all words should be capitalised.
+ * @param delimiter - The delimiter to split the string by.
  * @returns The capitalised string.
  */
-declare function capitalise(str: string, allWords?: boolean): string;
+declare function capitalise(str: string, allWords?: boolean, delimiter?: string): string;
 /**
  * Separates a string into an array of characters.
  *
@@ -329,6 +344,13 @@ declare function toKebab(str: string): string;
  * @returns The number.
  */
 declare function toNumber(str: string): number;
+/**
+ * Adds the respective ordinal suffix (-st, -nd, -rd or -th) to a number.
+ *
+ * @param n - The number.
+ * @returns The number with the ordinal suffix appended.
+ */
+declare function toOrdinal(n: number | string): string;
 /**
  * Truncates a string to a provided length.
  *
@@ -339,4 +361,4 @@ declare function toNumber(str: string): number;
  */
 declare function truncate(str: string, length: number, truncateStr?: string): string;
 
-export { Arrayable, Fn, Nullable, Obj, VoidFn, capitalise, chars, debounce, deepMerge, drop, groupsOf, head, init, isArray, isBlank, isBoolean, isBrowser, isDefined, isEmpty, isEven, isFunction, isNumber, isObject, isOdd, isString, isTouchDevice, isWindow, last, max, memoize, min, modulo, noop, partition, randomChance, randomNumber, scroll, sleep, splitAt, sum, tail, take, throttle, toArray, toCamel, toKebab, toNumber, truncate, uniq };
+export { Arrayable, Fn, Nullable, Obj, VoidFn, capitalise, chars, debounce, deepMerge, drop, groupsOf, head, init, isArray, isBlank, isBoolean, isBrowser, isDefined, isEmpty, isEmptyObject, isEven, isFunction, isNumber, isObject, isOdd, isString, isTouchDevice, isWindow, last, max, memoize, min, modulo, noop, once, partition, randomChance, randomNumber, scroll, sleep, splitAt, sum, tail, take, throttle, toArray, toCamel, toKebab, toNumber, toOrdinal, truncate, uniq };

package/dist/index.js

@@ -38,6 +38,7 @@ __export(src_exports, {
   isBrowser: () => isBrowser,
   isDefined: () => isDefined,
   isEmpty: () => isEmpty,
+  isEmptyObject: () => isEmptyObject,
   isEven: () => isEven,
   isFunction: () => isFunction,
   isNumber: () => isNumber,
@@ -52,6 +53,7 @@ __export(src_exports, {
   min: () => min,
   modulo: () => modulo,
   noop: () => noop,
+  once: () => once,
   partition: () => partition,
   randomChance: () => randomChance,
   randomNumber: () => randomNumber,
@@ -66,6 +68,7 @@ __export(src_exports, {
   toCamel: () => toCamel,
   toKebab: () => toKebab,
   toNumber: () => toNumber,
+  toOrdinal: () => toOrdinal,
   truncate: () => truncate,
   uniq: () => uniq
 });
@@ -79,7 +82,7 @@ function drop(n, array) {
 }
 function groupsOf(s, array) {
   if (s <= 0) {
-    throw new Error("[tsu] Invalid group size");
+    throw new Error("[tsu] Invalid group size. Is it greater than 0?");
   }
   if (s >= array.length) {
     return [[...array]];
@@ -173,6 +176,15 @@ function memoize(fn) {
     return result;
   };
 }
+function once(fn) {
+  let run = false;
+  return (...args) => {
+    if (!run) {
+      fn(...args);
+      run = true;
+    }
+  };
+}
 function throttle(fn, limit) {
   let isWaiting = false;
   return function(...args) {
@@ -199,6 +211,15 @@ function isBrowser() {
 function isDefined(val) {
   return typeof val !== "undefined";
 }
+function isEmptyObject(val) {
+  if (!isObject(val)) {
+    return false;
+  }
+  for (const _ in val) {
+    return false;
+  }
+  return true;
+}
 function isFunction(val) {
   return typeof val === "function";
 }
@@ -297,11 +318,11 @@ function getElTop(element, start) {
 }
 
 // src/string.ts
-function capitalise(str, allWords = false) {
-  if (!allWords) {
-    return str.charAt(0).toUpperCase() + str.slice(1);
+function capitalise(str, allWords = false, delimiter = " ") {
+  if (allWords) {
+    return str.split(delimiter).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(delimiter);
   }
-  return str.split(" ").map((s) => s.charAt(0).toUpperCase() + s.slice(1)).join(" ");
+  return str.charAt(0).toUpperCase() + str.slice(1);
 }
 function chars(str) {
   return str.split("");
@@ -326,6 +347,15 @@ function toNumber(str) {
   }
   return Number(str.replace(/[#£€$,%]/g, ""));
 }
+function toOrdinal(n) {
+  const invalidString = typeof n === "string" && (n.trim() === "" || isNaN(parseFloat(n)));
+  if (invalidString) {
+    throw new Error("[tsu] invalid string. Does it contain only a number?");
+  }
+  const suffixes = ["st", "nd", "rd"];
+  const suffix = suffixes[(Number(n) / 10 % 10 ^ 1 && Number(n) % 10) - 1] || "th";
+  return `${n}${suffix}`;
+}
 function truncate(str, length, truncateStr = "...") {
   if (length <= 0) {
     return truncateStr;
@@ -349,6 +379,7 @@ module.exports = __toCommonJS(src_exports);
   isBrowser,
   isDefined,
   isEmpty,
+  isEmptyObject,
   isEven,
   isFunction,
   isNumber,
@@ -363,6 +394,7 @@ module.exports = __toCommonJS(src_exports);
   min,
   modulo,
   noop,
+  once,
   partition,
   randomChance,
   randomNumber,
@@ -377,6 +409,7 @@ module.exports = __toCommonJS(src_exports);
   toCamel,
   toKebab,
   toNumber,
+  toOrdinal,
   truncate,
   uniq
 });

package/dist/index.mjs

@@ -7,7 +7,7 @@ function drop(n, array) {
 }
 function groupsOf(s, array) {
   if (s <= 0) {
-    throw new Error("[tsu] Invalid group size");
+    throw new Error("[tsu] Invalid group size. Is it greater than 0?");
   }
   if (s >= array.length) {
     return [[...array]];
@@ -101,6 +101,15 @@ function memoize(fn) {
     return result;
   };
 }
+function once(fn) {
+  let run = false;
+  return (...args) => {
+    if (!run) {
+      fn(...args);
+      run = true;
+    }
+  };
+}
 function throttle(fn, limit) {
   let isWaiting = false;
   return function(...args) {
@@ -127,6 +136,15 @@ function isBrowser() {
 function isDefined(val) {
   return typeof val !== "undefined";
 }
+function isEmptyObject(val) {
+  if (!isObject(val)) {
+    return false;
+  }
+  for (const _ in val) {
+    return false;
+  }
+  return true;
+}
 function isFunction(val) {
   return typeof val === "function";
 }
@@ -225,11 +243,11 @@ function getElTop(element, start) {
 }
 
 // src/string.ts
-function capitalise(str, allWords = false) {
-  if (!allWords) {
-    return str.charAt(0).toUpperCase() + str.slice(1);
+function capitalise(str, allWords = false, delimiter = " ") {
+  if (allWords) {
+    return str.split(delimiter).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(delimiter);
   }
-  return str.split(" ").map((s) => s.charAt(0).toUpperCase() + s.slice(1)).join(" ");
+  return str.charAt(0).toUpperCase() + str.slice(1);
 }
 function chars(str) {
   return str.split("");
@@ -254,6 +272,15 @@ function toNumber(str) {
   }
   return Number(str.replace(/[#£€$,%]/g, ""));
 }
+function toOrdinal(n) {
+  const invalidString = typeof n === "string" && (n.trim() === "" || isNaN(parseFloat(n)));
+  if (invalidString) {
+    throw new Error("[tsu] invalid string. Does it contain only a number?");
+  }
+  const suffixes = ["st", "nd", "rd"];
+  const suffix = suffixes[(Number(n) / 10 % 10 ^ 1 && Number(n) % 10) - 1] || "th";
+  return `${n}${suffix}`;
+}
 function truncate(str, length, truncateStr = "...") {
   if (length <= 0) {
     return truncateStr;
@@ -275,6 +302,7 @@ export {
   isBrowser,
   isDefined,
   isEmpty,
+  isEmptyObject,
   isEven,
   isFunction,
   isNumber,
@@ -289,6 +317,7 @@ export {
   min,
   modulo,
   noop,
+  once,
   partition,
   randomChance,
   randomNumber,
@@ -303,6 +332,7 @@ export {
   toCamel,
   toKebab,
   toNumber,
+  toOrdinal,
   truncate,
   uniq
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsu",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "A collection of TypeScript utilities.",
   "author": "eb3n",
   "repository": {