moderndash 3.3.1 → 3.4.0

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { Call, Tuples, Objects } from 'hotscript';
+
 /**
  * Creates an array of elements split into groups the length of size. If array can't be split evenly, the final chunk will be the remaining elements.
  *
@@ -50,7 +52,7 @@ declare function count<TElem, TKey extends PropertyKey>(array: readonly TElem[],
  * @template TElem The type of the array elements.
  * @template TMinLength The minimum length of the array.
  */
-type ArrayMinLength<TElem, TMinLenght extends number> = BuildArrayMinLength<TElem, TMinLenght, []>;
+type ArrayMinLength<TElem, TMinLength extends number> = BuildArrayMinLength<TElem, TMinLength, []>;
 type BuildArrayMinLength<TElem, TMinLength extends number, Current extends TElem[]> = Current["length"] extends TMinLength ? [...Current, ...TElem[]] : BuildArrayMinLength<TElem, TMinLength, [...Current, TElem]>;
 
 type CompareFunction<TArrays extends ArrayMinLength<unknown[], 2>> = (a: TArrays[0][number], b: ArrayTail<TArrays>[number][number]) => boolean;
@@ -86,7 +88,7 @@ declare function difference<TArrays extends ArrayMinLength<unknown[], 2>>(...arr
 
 /**
  * Creates a slice of `array` excluding elements dropped from the end.
- * Elements are dropped until `predicate` returns falsey.
+ * Elements are dropped until `predicate` returns falsy.
  *
  * @example
  * const users = [
@@ -106,7 +108,7 @@ declare function dropRightWhile<TElem>(array: readonly TElem[], predicate: (valu
 
 /**
  * Creates a slice of `array` excluding elements dropped from the beginning.
- * Elements are dropped until `predicate` returns falsey.
+ * Elements are dropped until `predicate` returns falsy.
  *
  * @example
  * const users = [
@@ -233,7 +235,7 @@ declare function sort<TElem>(array: readonly TElem[], ...orders: {
 
 /**
  * Creates a slice of `array` with elements taken from the end.
- * Elements are taken until `predicate` returns falsey.
+ * Elements are taken until `predicate` returns falsy.
  *
  * @example
  * const users = [
@@ -253,7 +255,7 @@ declare function takeRightWhile<TElem>(array: readonly TElem[], predicate: (elem
 
 /**
  * Creates a slice of `array` with elements taken from the beginning.
- * Elements are taken until `predicate` returns falsey.
+ * Elements are taken until `predicate` returns falsy.
  *
  * @example
  * const users = [
@@ -431,7 +433,7 @@ declare function randomInt(min: number, max: number): number;
 declare function randomString(length: number, charSet?: string): string;
 
 /**
- * Debouces the decorated function. Only calling it after a specified amount of time has passed without any new calls.
+ * Debounces the decorated function. Only calling it after a specified amount of time has passed without any new calls.
  *
  * Look at {@link debounce} for the non-decorator version.
  *
@@ -453,7 +455,7 @@ declare function randomString(length: number, charSet?: string): string;
  * ```
  * @param wait Milliseconds to wait before invoking the decorated function after the last invocation.
  */
-declare function decDebounce(wait: number): (target: unknown, key: string, descriptor: PropertyDescriptor) => void;
+declare function decDebounce(wait: number): (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;
 
 /**
  * Only invokes the decorated function as long as it's called `<= n` times.
@@ -479,7 +481,7 @@ declare function decDebounce(wait: number): (target: unknown, key: string, descr
  * ```
  * @param n The number of calls before the cached result is returned.
  */
-declare function decMaxCalls(n: number): (target: unknown, key: string, descriptor: PropertyDescriptor) => void;
+declare function decMaxCalls(n: number): (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;
 
 type GenericFunction<TFunc extends (...args: any) => any> = (...args: Parameters<TFunc>) => ReturnType<TFunc>;
 
@@ -566,7 +568,7 @@ declare function memoize<TFunc extends GenericFunction<TFunc>, Cache extends Map
  * @param options.resolver - A function that determines the cache key for storing the result based on the arguments provided.
  * @param options.ttl - The time to live for the cache in milliseconds.
  */
-declare function decMemoize(options?: Parameters<typeof memoize>[1]): (target: unknown, key: string, descriptor: PropertyDescriptor) => void;
+declare function decMemoize(options?: Parameters<typeof memoize>[1]): (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;
 
 /**
  * Only invokes the decorated function after it's called more than `n` times.
@@ -589,7 +591,7 @@ declare function decMemoize(options?: Parameters<typeof memoize>[1]): (target: u
  * ```
  * @param n The number of calls before the decorated function is invoked.
  */
-declare function decMinCalls(n: number): (target: unknown, key: string, descriptor: PropertyDescriptor) => void;
+declare function decMinCalls(n: number): (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;
 
 /**
  * The decorated function is invoked at most once per every `wait` milliseconds.
@@ -613,7 +615,7 @@ declare function decMinCalls(n: number): (target: unknown, key: string, descript
  * ```
  * @param wait The number of milliseconds to wait between invocations.
  */
-declare function decThrottle(wait: number): (target: unknown, key: string, descriptor: PropertyDescriptor) => void;
+declare function decThrottle(wait: number): (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;
 
 type Tail<T extends unknown[]> = T extends [infer _Head, ...infer Tail] ? Tail : never;
 /**
@@ -644,7 +646,7 @@ type Tail<T extends unknown[]> = T extends [infer _Head, ...infer Tail] ? Tail :
  * @param func The function to transform.
  * @returns A decorator function that can be used to decorate a method.
  */
-declare function toDecorator<TFunc extends GenericFunction<TFunc>>(func: TFunc): (...args: Tail<Parameters<TFunc>>) => (target: unknown, key: string, descriptor: PropertyDescriptor) => void;
+declare function toDecorator<TFunc extends GenericFunction<TFunc>>(func: TFunc): (...args: Tail<Parameters<TFunc>>) => (_target: unknown, _key: string, descriptor: PropertyDescriptor) => void;
 
 /**
  * Creates a debounced version of a function. Only calling it after a specified amount of time has passed without any new calls.
@@ -795,7 +797,8 @@ declare function round(number: number, precision?: number): number;
  * @param numbers The input array of numbers
  * @returns The sum of the input array
  */
-declare function sum(numbers: readonly number[]): number;
+declare function sum(numbers: number[]): number;
+declare function sum<TNum extends readonly number[]>(numbers: TNum): Call<Tuples.Sum, TNum>;
 
 /**
  * The type of a plain object.
@@ -811,6 +814,8 @@ declare function sum(numbers: readonly number[]): number;
  */
 type PlainObject = Record<PropertyKey, unknown>;
 
+type StringIfNever<Type> = [Type] extends [never] ? string : Type;
+type Paths$1<TObj> = StringIfNever<Call<Objects.AllPaths, TObj>>;
 /**
  * Flattens an object into a single level object.
  *
@@ -823,7 +828,7 @@ type PlainObject = Record<PropertyKey, unknown>;
  * @template TObj The type of the object to flatten.
  * @returns A new object with flattened keys.
  */
-declare function flatKeys<TObj extends PlainObject>(obj: TObj): Record<string, unknown>;
+declare function flatKeys<TObj extends PlainObject>(obj: TObj): Record<Paths$1<TObj>, unknown>;
 
 /**
  * This function combines two or more objects into a single new object. Arrays and other types are overwritten.
@@ -890,6 +895,8 @@ declare function omit<TObj extends PlainObject, Key extends keyof TObj>(object:
  */
 declare function pick<TObj extends PlainObject, Key extends keyof TObj>(object: TObj, keysToPick: Key[]): Pick<TObj, Key>;
 
+type Paths<TObj> = Call<Objects.AllPaths, TObj> | string & {};
+type UpdateObj<TObj extends PlainObject, TPath extends string, TVal> = Call<Objects.Update<TPath, TVal>, TObj>;
 /**
  * Sets the value at path of object. If a portion of path doesn’t exist, it’s created.
  *
@@ -914,9 +921,11 @@ declare function pick<TObj extends PlainObject, Key extends keyof TObj>(object:
  * @param path The path of the property to set.
  * @param value The value to set.
  * @template TObj The type of the object.
+ * @template TPath The type of the object path.
+ * @template TVal The type of the value to set.
  * @returns The modified object.
  */
-declare function set(obj: PlainObject, path: string, value: unknown): PlainObject;
+declare function set<TObj extends PlainObject, TPath extends Paths<TObj>, TVal>(obj: TObj, path: TPath, value: TVal): UpdateObj<TObj, TPath, TVal>;
 
 /**
  * A class for managing a queue of async functions that runs a set number concurrently.
@@ -961,9 +970,9 @@ declare class Queue {
      */
     constructor(maxConcurrent: number);
     /**
-     * Add aync functions or an array of async functions to the queue.
+     * Add async functions or an array of async functions to the queue.
      *
-     * @param asyncFn The aync function(s) to add to the queue.
+     * @param asyncFn The async function(s) to add to the queue.
      * @returns A promise that resolves when the added function(s) finishes.
      */
     add<TProm, TAsyncFn extends () => Promise<TProm>>(asyncFn: TAsyncFn): Promise<TProm>;

package/dist/index.js

@@ -263,7 +263,7 @@ function randomString(length, charSet = DEFAULT_CHARSET) {
 // src/decorator/toDecorator.ts
 function toDecorator(func) {
   return function(...args) {
-    return function(target, key, descriptor) {
+    return function(_target, _key, descriptor) {
       const creatorArgs = [descriptor.value, ...args];
       descriptor.value = func(...creatorArgs);
     };
@@ -468,7 +468,7 @@ function omit(object, keysToOmit) {
 }
 
 // src/object/set.ts
-var validPathRegex = /^(?:[^.[\]]+(?:\[\d+])*(?:\.|\[\d+]))+(?:[^.[\]]+(?:\[\d+])*)+$/;
+var validPathRegex = /^[^.[\]]+(?:\.[^.[\]]+)*(?:\[\d+])*(?:\.[^.[\]]+(?:\[\d+])*)*$/;
 var pathSplitRegex = /\.|(?=\[)/g;
 var matchBracketsRegex = /[[\]]/g;
 function set(obj, path, value) {
@@ -646,7 +646,7 @@ async function tryCatch(promise) {
 }
 
 // src/string/splitWords.ts
-var wordsRegex = /(\d*[a-z]+)|([A-Z][a-z]+)|(\d*[A-Z]+(?=[^a-z]|$))|(\d+)/g;
+var wordsRegex = /(?:\d*[a-z]+)|(?:[A-Z][a-z]+)|(?:\d*[A-Z]+(?=[^a-z]|$))|\d+/g;
 function splitWords(str) {
   return str.match(wordsRegex) ?? [];
 }
@@ -687,9 +687,9 @@ function escapeHtml(str) {
 }
 
 // src/string/escapeRegExp.ts
-var escapleCharsRegex = /[$()*+.?[\\\]^{|}]/g;
+var escapeCharsRegex = /[$()*+.?[\\\]^{|}]/g;
 function escapeRegExp(str) {
-  return str.replace(escapleCharsRegex, "\\$&");
+  return str.replace(escapeCharsRegex, "\\$&");
 }
 
 // src/string/kebabCase.ts