@ntnyq/utils 0.1.3 → 0.2.0

package/dist/index.cjs

@@ -27,11 +27,15 @@ __export(src_exports, {
   chunk: () => chunk,
   clamp: () => clamp,
   days: () => days,
+  debounce: () => debounce,
+  ensurePrefix: () => ensurePrefix,
+  ensureSuffix: () => ensureSuffix,
   flatCase: () => flatCase,
   getObjectType: () => getObjectType,
-  hasOwnProperty: () => hasOwnProperty,
+  hasOwn: () => hasOwn,
   hours: () => hours,
   isArray: () => isArray,
+  isArrayEqual: () => isArrayEqual,
   isBoolean: () => isBoolean,
   isBrowser: () => isBrowser,
   isFunction: () => isFunction,
@@ -49,15 +53,19 @@ __export(src_exports, {
   minutes: () => minutes,
   noop: () => noop,
   omit: () => omit,
+  once: () => once,
   pascalCase: () => pascalCase,
   pick: () => pick,
   rAF: () => rAF,
   seconds: () => seconds,
+  slash: () => slash,
   snakeCase: () => snakeCase,
   splitByCase: () => splitByCase,
+  throttle: () => throttle,
   titleCase: () => titleCase,
   toArray: () => toArray,
   trainCase: () => trainCase,
+  unindent: () => unindent,
   unique: () => unique,
   uniqueBy: () => uniqueBy,
   upperFirst: () => upperFirst,
@@ -110,6 +118,19 @@ var noop = () => {
 };
 var NOOP = noop;
 
+// src/fn/once.ts
+function once(func) {
+  let called = false;
+  return function(...args) {
+    if (called) {
+      return false;
+    }
+    called = true;
+    func.apply(this, args);
+    return true;
+  };
+}
+
 // src/env/isBrowser.ts
 var isBrowser = () => typeof document !== "undefined";
 
@@ -247,6 +268,53 @@ function waitFor(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
+// src/misc/throttle.ts
+function throttle(delay, callback, options = {}) {
+  const { isDebounce } = options;
+  let lastExec = 0;
+  let cancelled = false;
+  let timeoutId;
+  function clearExistingTimeout() {
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+  }
+  function cancel() {
+    clearExistingTimeout();
+    cancelled = true;
+  }
+  function wrapper(...args) {
+    if (cancelled) return;
+    const _this = this;
+    const now = Date.now();
+    const elapsed = now - lastExec;
+    function clear() {
+      timeoutId = void 0;
+    }
+    function exec(cur) {
+      lastExec = cur || Date.now();
+      callback.apply(_this, args);
+    }
+    if (isDebounce && !timeoutId) {
+      exec(now);
+    }
+    clearExistingTimeout();
+    if (!isDebounce && elapsed > delay) {
+      exec(now);
+    } else {
+      timeoutId = setTimeout(isDebounce ? clear : exec, isDebounce ? delay : delay - elapsed);
+    }
+  }
+  wrapper.cancel = cancel;
+  return wrapper;
+}
+function debounce(delay, callback, options = {}) {
+  return throttle(delay, callback, {
+    ...options,
+    isDebounce: true
+  });
+}
+
 // src/misc/warnOnce.ts
 var warned = /* @__PURE__ */ new Set();
 var warnOnce = (message) => {
@@ -286,6 +354,14 @@ function toArray(array) {
   return Array.isArray(array) ? array : [array];
 }
 
+// src/array/isArrayEqual.ts
+function isArrayEqual(array1, array2) {
+  if (array1.length !== array2.length) {
+    return false;
+  }
+  return array1.every((item, idx) => item === array2[idx]);
+}
+
 // src/string/join.ts
 function join(array, options = {}) {
   const { separator = "" } = options;
@@ -293,14 +369,52 @@ function join(array, options = {}) {
   return array.filter((v) => Boolean(v) || v === 0).join(separator);
 }
 
+// src/string/slash.ts
+function slash(input) {
+  return input.replace(/\\/g, "/");
+}
+
+// src/string/unindent.ts
+var _RE_FULL_WS = /^\s*$/;
+function unindent(input) {
+  const lines = (typeof input === "string" ? input : input[0]).split("\n");
+  const whitespaceLines = lines.map((line) => _RE_FULL_WS.test(line));
+  const commonIndent = lines.reduce((min, line, idx) => {
+    if (!whitespaceLines[idx]) {
+      return min;
+    }
+    const indent = line.match(/^\s/)?.[0].length;
+    return indent === void 0 ? min : Math.min(min, indent);
+  }, Number.POSITIVE_INFINITY);
+  let emptylinesHead = 0;
+  while (emptylinesHead < lines.length && whitespaceLines[emptylinesHead]) {
+    emptylinesHead++;
+  }
+  let emptylinesTail = 0;
+  while (emptylinesTail < lines.length && whitespaceLines[lines.length - emptylinesTail - 1]) {
+    emptylinesTail++;
+  }
+  return lines.slice(emptylinesHead, lines.length - emptylinesTail).map((line) => line.slice(commonIndent)).join("\n");
+}
+
+// src/string/ensurePrefix.ts
+function ensurePrefix(input, prefix) {
+  return input.startsWith(prefix) ? input : `${prefix}${input}`;
+}
+
+// src/string/ensureSuffix.ts
+function ensureSuffix(input, suffix) {
+  return input.endsWith(suffix) ? input : `${input}${suffix}`;
+}
+
 // src/object/omit.ts
 function omit(object, ...keys) {
   keys.forEach((key) => delete object[key]);
   return object;
 }
 
-// src/object/hasOwnProperty.ts
-function hasOwnProperty(object, key) {
+// src/object/hasOwn.ts
+function hasOwn(object, key) {
   return Object.prototype.hasOwnProperty.call(object, key);
 }
 
@@ -309,7 +423,7 @@ function pick(object, keys) {
   return Object.assign(
     {},
     ...keys.map((key) => {
-      if (object && hasOwnProperty(object, key)) {
+      if (object && hasOwn(object, key)) {
         return { [key]: object[key] };
       }
     })
@@ -324,11 +438,15 @@ function pick(object, keys) {
   chunk,
   clamp,
   days,
+  debounce,
+  ensurePrefix,
+  ensureSuffix,
   flatCase,
   getObjectType,
-  hasOwnProperty,
+  hasOwn,
   hours,
   isArray,
+  isArrayEqual,
   isBoolean,
   isBrowser,
   isFunction,
@@ -346,15 +464,19 @@ function pick(object, keys) {
   minutes,
   noop,
   omit,
+  once,
   pascalCase,
   pick,
   rAF,
   seconds,
+  slash,
   snakeCase,
   splitByCase,
+  throttle,
   titleCase,
   toArray,
   trainCase,
+  unindent,
   unique,
   uniqueBy,
   upperFirst,

package/dist/index.d.cts

@@ -27,6 +27,8 @@ declare const noop: () => void;
  */
 declare const NOOP: () => void;
 
+declare function once<T extends unknown[]>(func: (...args: T) => void): (this: unknown, ...args: T) => boolean;
+
 /**
  * @file env.ts
  */
@@ -98,6 +100,27 @@ declare function clamp(value: number, min?: number, max?: number): number;
  */
 declare function waitFor(ms: number): Promise<unknown>;
 
+interface ThrottleDebounceOptions {
+    /**
+     * @default false
+     */
+    isDebounce?: boolean;
+}
+/**
+ * Throttle a function to limit its execution to a maximum of once per a specified time interval.
+ *
+ * @param delay - Zero or greater delay in milliseconds
+ * @param callback - A function to be throttled
+ * @param options - throttle options
+ * @returns A throttled function
+ */
+declare function throttle<T extends ((...args: any[]) => undefined | void) | undefined | null>(delay: number, callback: Exclude<T, undefined | null>, options?: ThrottleDebounceOptions): T & {
+    cancel: () => void;
+};
+declare function debounce<T extends ((...args: any[]) => undefined | void) | undefined | null>(delay: number, callback: Exclude<T, undefined | null>, options?: ThrottleDebounceOptions): T & {
+    cancel: () => void;
+};
+
 declare const warnOnce: (message: string) => void;
 
 /**
@@ -127,7 +150,11 @@ type MayBe<T> = T | undefined;
 type AnyFn<T = any, R = any> = (...args: T[]) => R;
 type Arrayable<T> = T | T[];
 type Awaitable<T> = T | Promise<T>;
-type Prettify<T> = Omit<T, never>;
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type PrettifyV2<T> = Omit<T, never>;
+type PrimitiveType = number | bigint | string | boolean | symbol | null | undefined;
 
 /**
  * Converts a value to an array.
@@ -136,10 +163,12 @@ type Prettify<T> = Omit<T, never>;
  */
 declare function toArray<T>(array?: Nullable<Arrayable<T>>): T[];
 
+declare function isArrayEqual(array1: unknown[], array2: unknown[]): boolean;
+
 type JoinableValue = string | number | null | undefined;
 interface JoinOptions {
     /**
-     * @default '''
+     * @default ''
      */
     separator?: string;
 }
@@ -151,10 +180,36 @@ interface JoinOptions {
  */
 declare function join(array: JoinableValue[], options?: JoinOptions): string;
 
+/**
+ * Replace backslash to slash
+ */
+declare function slash(input: string): string;
+
+/**
+ * Remove leading whitespace from a template string
+ * Empty lines at the beginning and end of the template string are also removed.
+ * @param input template string
+ *
+ * @example
+ *
+ * ```ts
+ * const str = unindent`
+ *   if (foo) {
+ *     bar()
+ *   }
+ * `
+ * ```
+ */
+declare function unindent(input: TemplateStringsArray | string): string;
+
+declare function ensurePrefix(input: string, prefix: string): string;
+
+declare function ensureSuffix(input: string, suffix: string): string;
+
 declare function omit<T, K extends keyof T>(object: T, ...keys: K[]): Omit<T, K>;
 
 declare function pick<T, K extends keyof T>(object: T, keys: K[]): Pick<T, K>;
 
-declare function hasOwnProperty<T, K extends keyof T>(object: T, key: K): boolean;
+declare function hasOwn<T, K extends keyof T>(object: T, key: K): boolean;
 
-export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type Nullable, type Prettify, cAF, capitalize, chunk, clamp, days, getObjectType, hasOwnProperty, hours, isArray, isBoolean, isBrowser, isFunction, isInteger, isNativePromise, isNull, isNumber, isPromise, isString, isUndefined, join, minutes, noop, omit, pick, rAF, seconds, toArray, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type Nullable, type Prettify, type PrettifyV2, type PrimitiveType, type ThrottleDebounceOptions, cAF, capitalize, chunk, clamp, days, debounce, ensurePrefix, ensureSuffix, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isFunction, isInteger, isNativePromise, isNull, isNumber, isPromise, isString, isUndefined, join, minutes, noop, omit, once, pick, rAF, seconds, slash, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -27,6 +27,8 @@ declare const noop: () => void;
  */
 declare const NOOP: () => void;
 
+declare function once<T extends unknown[]>(func: (...args: T) => void): (this: unknown, ...args: T) => boolean;
+
 /**
  * @file env.ts
  */
@@ -98,6 +100,27 @@ declare function clamp(value: number, min?: number, max?: number): number;
  */
 declare function waitFor(ms: number): Promise<unknown>;
 
+interface ThrottleDebounceOptions {
+    /**
+     * @default false
+     */
+    isDebounce?: boolean;
+}
+/**
+ * Throttle a function to limit its execution to a maximum of once per a specified time interval.
+ *
+ * @param delay - Zero or greater delay in milliseconds
+ * @param callback - A function to be throttled
+ * @param options - throttle options
+ * @returns A throttled function
+ */
+declare function throttle<T extends ((...args: any[]) => undefined | void) | undefined | null>(delay: number, callback: Exclude<T, undefined | null>, options?: ThrottleDebounceOptions): T & {
+    cancel: () => void;
+};
+declare function debounce<T extends ((...args: any[]) => undefined | void) | undefined | null>(delay: number, callback: Exclude<T, undefined | null>, options?: ThrottleDebounceOptions): T & {
+    cancel: () => void;
+};
+
 declare const warnOnce: (message: string) => void;
 
 /**
@@ -127,7 +150,11 @@ type MayBe<T> = T | undefined;
 type AnyFn<T = any, R = any> = (...args: T[]) => R;
 type Arrayable<T> = T | T[];
 type Awaitable<T> = T | Promise<T>;
-type Prettify<T> = Omit<T, never>;
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type PrettifyV2<T> = Omit<T, never>;
+type PrimitiveType = number | bigint | string | boolean | symbol | null | undefined;
 
 /**
  * Converts a value to an array.
@@ -136,10 +163,12 @@ type Prettify<T> = Omit<T, never>;
  */
 declare function toArray<T>(array?: Nullable<Arrayable<T>>): T[];
 
+declare function isArrayEqual(array1: unknown[], array2: unknown[]): boolean;
+
 type JoinableValue = string | number | null | undefined;
 interface JoinOptions {
     /**
-     * @default '''
+     * @default ''
      */
     separator?: string;
 }
@@ -151,10 +180,36 @@ interface JoinOptions {
  */
 declare function join(array: JoinableValue[], options?: JoinOptions): string;
 
+/**
+ * Replace backslash to slash
+ */
+declare function slash(input: string): string;
+
+/**
+ * Remove leading whitespace from a template string
+ * Empty lines at the beginning and end of the template string are also removed.
+ * @param input template string
+ *
+ * @example
+ *
+ * ```ts
+ * const str = unindent`
+ *   if (foo) {
+ *     bar()
+ *   }
+ * `
+ * ```
+ */
+declare function unindent(input: TemplateStringsArray | string): string;
+
+declare function ensurePrefix(input: string, prefix: string): string;
+
+declare function ensureSuffix(input: string, suffix: string): string;
+
 declare function omit<T, K extends keyof T>(object: T, ...keys: K[]): Omit<T, K>;
 
 declare function pick<T, K extends keyof T>(object: T, keys: K[]): Pick<T, K>;
 
-declare function hasOwnProperty<T, K extends keyof T>(object: T, key: K): boolean;
+declare function hasOwn<T, K extends keyof T>(object: T, key: K): boolean;
 
-export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type Nullable, type Prettify, cAF, capitalize, chunk, clamp, days, getObjectType, hasOwnProperty, hours, isArray, isBoolean, isBrowser, isFunction, isInteger, isNativePromise, isNull, isNumber, isPromise, isString, isUndefined, join, minutes, noop, omit, pick, rAF, seconds, toArray, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type Nullable, type Prettify, type PrettifyV2, type PrimitiveType, type ThrottleDebounceOptions, cAF, capitalize, chunk, clamp, days, debounce, ensurePrefix, ensureSuffix, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isFunction, isInteger, isNativePromise, isNull, isNumber, isPromise, isString, isUndefined, join, minutes, noop, omit, once, pick, rAF, seconds, slash, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -41,6 +41,19 @@ var noop = () => {
 };
 var NOOP = noop;
 
+// src/fn/once.ts
+function once(func) {
+  let called = false;
+  return function(...args) {
+    if (called) {
+      return false;
+    }
+    called = true;
+    func.apply(this, args);
+    return true;
+  };
+}
+
 // src/env/isBrowser.ts
 var isBrowser = () => typeof document !== "undefined";
 
@@ -178,6 +191,53 @@ function waitFor(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
+// src/misc/throttle.ts
+function throttle(delay, callback, options = {}) {
+  const { isDebounce } = options;
+  let lastExec = 0;
+  let cancelled = false;
+  let timeoutId;
+  function clearExistingTimeout() {
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+  }
+  function cancel() {
+    clearExistingTimeout();
+    cancelled = true;
+  }
+  function wrapper(...args) {
+    if (cancelled) return;
+    const _this = this;
+    const now = Date.now();
+    const elapsed = now - lastExec;
+    function clear() {
+      timeoutId = void 0;
+    }
+    function exec(cur) {
+      lastExec = cur || Date.now();
+      callback.apply(_this, args);
+    }
+    if (isDebounce && !timeoutId) {
+      exec(now);
+    }
+    clearExistingTimeout();
+    if (!isDebounce && elapsed > delay) {
+      exec(now);
+    } else {
+      timeoutId = setTimeout(isDebounce ? clear : exec, isDebounce ? delay : delay - elapsed);
+    }
+  }
+  wrapper.cancel = cancel;
+  return wrapper;
+}
+function debounce(delay, callback, options = {}) {
+  return throttle(delay, callback, {
+    ...options,
+    isDebounce: true
+  });
+}
+
 // src/misc/warnOnce.ts
 var warned = /* @__PURE__ */ new Set();
 var warnOnce = (message) => {
@@ -217,6 +277,14 @@ function toArray(array) {
   return Array.isArray(array) ? array : [array];
 }
 
+// src/array/isArrayEqual.ts
+function isArrayEqual(array1, array2) {
+  if (array1.length !== array2.length) {
+    return false;
+  }
+  return array1.every((item, idx) => item === array2[idx]);
+}
+
 // src/string/join.ts
 function join(array, options = {}) {
   const { separator = "" } = options;
@@ -224,14 +292,52 @@ function join(array, options = {}) {
   return array.filter((v) => Boolean(v) || v === 0).join(separator);
 }
 
+// src/string/slash.ts
+function slash(input) {
+  return input.replace(/\\/g, "/");
+}
+
+// src/string/unindent.ts
+var _RE_FULL_WS = /^\s*$/;
+function unindent(input) {
+  const lines = (typeof input === "string" ? input : input[0]).split("\n");
+  const whitespaceLines = lines.map((line) => _RE_FULL_WS.test(line));
+  const commonIndent = lines.reduce((min, line, idx) => {
+    if (!whitespaceLines[idx]) {
+      return min;
+    }
+    const indent = line.match(/^\s/)?.[0].length;
+    return indent === void 0 ? min : Math.min(min, indent);
+  }, Number.POSITIVE_INFINITY);
+  let emptylinesHead = 0;
+  while (emptylinesHead < lines.length && whitespaceLines[emptylinesHead]) {
+    emptylinesHead++;
+  }
+  let emptylinesTail = 0;
+  while (emptylinesTail < lines.length && whitespaceLines[lines.length - emptylinesTail - 1]) {
+    emptylinesTail++;
+  }
+  return lines.slice(emptylinesHead, lines.length - emptylinesTail).map((line) => line.slice(commonIndent)).join("\n");
+}
+
+// src/string/ensurePrefix.ts
+function ensurePrefix(input, prefix) {
+  return input.startsWith(prefix) ? input : `${prefix}${input}`;
+}
+
+// src/string/ensureSuffix.ts
+function ensureSuffix(input, suffix) {
+  return input.endsWith(suffix) ? input : `${input}${suffix}`;
+}
+
 // src/object/omit.ts
 function omit(object, ...keys) {
   keys.forEach((key) => delete object[key]);
   return object;
 }
 
-// src/object/hasOwnProperty.ts
-function hasOwnProperty(object, key) {
+// src/object/hasOwn.ts
+function hasOwn(object, key) {
   return Object.prototype.hasOwnProperty.call(object, key);
 }
 
@@ -240,7 +346,7 @@ function pick(object, keys) {
   return Object.assign(
     {},
     ...keys.map((key) => {
-      if (object && hasOwnProperty(object, key)) {
+      if (object && hasOwn(object, key)) {
         return { [key]: object[key] };
       }
     })
@@ -254,11 +360,15 @@ export {
   chunk,
   clamp,
   days,
+  debounce,
+  ensurePrefix,
+  ensureSuffix,
   flatCase,
   getObjectType,
-  hasOwnProperty,
+  hasOwn,
   hours,
   isArray,
+  isArrayEqual,
   isBoolean,
   isBrowser,
   isFunction,
@@ -276,15 +386,19 @@ export {
   minutes,
   noop,
   omit,
+  once,
   pascalCase,
   pick,
   rAF,
   seconds,
+  slash,
   snakeCase,
   splitByCase,
+  throttle,
   titleCase,
   toArray,
   trainCase,
+  unindent,
   unique,
   uniqueBy,
   upperFirst,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -40,7 +40,7 @@
     "scule": "^1.3.0"
   },
   "devDependencies": {
-    "@ntnyq/eslint-config": "^3.0.0-beta.19",
+    "@ntnyq/eslint-config": "^3.0.0-beta.20",
     "@ntnyq/prettier-config": "^1.21.3",
     "@vitest/coverage-v8": "^2.1.2",
     "bumpp": "^9.7.1",