@ntnyq/utils 0.1.0 → 0.1.1

package/dist/index.cjs

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  NOOP: () => NOOP,
   cAF: () => cAF,
   camelCase: () => camelCase,
   capitalize: () => capitalize,
@@ -28,9 +29,11 @@ __export(src_exports, {
   hours: () => hours,
   isBrowser: () => isBrowser,
   isUppercase: () => isUppercase,
+  join: () => join,
   kebabCase: () => kebabCase,
   lowerFirst: () => lowerFirst,
   minutes: () => minutes,
+  noop: () => noop,
   pascalCase: () => pascalCase,
   rAF: () => rAF,
   seconds: () => seconds,
@@ -40,6 +43,7 @@ __export(src_exports, {
   toArray: () => toArray,
   trainCase: () => trainCase,
   unique: () => unique,
+  uniqueBy: () => uniqueBy,
   upperFirst: () => upperFirst,
   waitFor: () => waitFor,
   warnOnce: () => warnOnce,
@@ -47,6 +51,11 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/fn/noop.ts
+var noop = () => {
+};
+var NOOP = noop;
+
 // src/env/isBrowser.ts
 var isBrowser = () => typeof document !== "undefined";
 
@@ -190,17 +199,34 @@ var warnOnce = (message) => {
 };
 
 // src/array/unique.ts
-function unique(val) {
-  return Array.from(new Set(val));
+function unique(array) {
+  return Array.from(new Set(array));
+}
+function uniqueBy(array, equalFn) {
+  return array.reduce((acc, cur) => {
+    const idx = acc.findIndex((item) => equalFn(item, cur));
+    if (idx === -1) {
+      acc.push(cur);
+    }
+    return acc;
+  }, []);
 }
 
 // src/array/toArray.ts
-function toArray(val) {
-  val = val ?? [];
-  return Array.isArray(val) ? val : [val];
+function toArray(array) {
+  array = array ?? [];
+  return Array.isArray(array) ? array : [array];
+}
+
+// src/string/join.ts
+function join(array, options = {}) {
+  const { separator = "" } = options;
+  if (!Array.isArray(array) || !array.length) return "";
+  return array.filter((v) => Boolean(v) || v === 0).join(separator);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  NOOP,
   cAF,
   camelCase,
   capitalize,
@@ -209,9 +235,11 @@ function toArray(val) {
   hours,
   isBrowser,
   isUppercase,
+  join,
   kebabCase,
   lowerFirst,
   minutes,
+  noop,
   pascalCase,
   rAF,
   seconds,
@@ -221,6 +249,7 @@ function toArray(val) {
   toArray,
   trainCase,
   unique,
+  uniqueBy,
   upperFirst,
   waitFor,
   warnOnce,

package/dist/index.d.cts

@@ -1,6 +1,15 @@
 import { upperFirst } from 'scule';
 export * from 'scule';
 
+/**
+ * A function that does nothing.
+ */
+declare const noop: () => void;
+/**
+ * Alias of {@link noop}.
+ */
+declare const NOOP: () => void;
+
 /**
  * @file env.ts
  */
@@ -65,7 +74,19 @@ declare function waitFor(ms: number): Promise<unknown>;
 
 declare const warnOnce: (message: string) => void;
 
-declare function unique<T>(val: T[]): T[];
+/**
+ * Returns a new array with unique values.
+ * @param array - The array to process.
+ * @returns The new array.
+ */
+declare function unique<T>(array: T[]): T[];
+/**
+ * Returns a new array with unique values.
+ * @param array - The array to process.
+ * @param equalFn - The function to compare values.
+ * @returns The new array.
+ */
+declare function uniqueBy<T>(array: T[], equalFn: (a: T, b: T) => boolean): T[];
 
 type Nullable<T> = T | null;
 type MayBe<T> = T | undefined;
@@ -74,6 +95,26 @@ type Arrayable<T> = T | T[];
 type Awaitable<T> = T | Promise<T>;
 type Prettify<T> = Omit<T, never>;
 
-declare function toArray<T>(val?: Nullable<Arrayable<T>>): Arrayable<T>;
+/**
+ * Converts a value to an array.
+ * @param array - The value to convert.
+ * @returns The array.
+ */
+declare function toArray<T>(array?: Nullable<Arrayable<T>>): T[];
+
+type JoinableValue = string | number | null | undefined;
+interface JoinOptions {
+    /**
+     * @default '''
+     */
+    separator?: string;
+}
+/**
+ * Joins an array of strings or numbers into a single string.
+ * @param array - An array of strings or numbers.
+ * @param options - An object of options.
+ * @returns A string.
+ */
+declare function join(array: JoinableValue[], options?: JoinOptions): string;
 
-export { type AnyFn, type Arrayable, type Awaitable, type MayBe, type Nullable, type Prettify, cAF, capitalize, days, hours, isBrowser, minutes, rAF, seconds, toArray, unique, waitFor, warnOnce, weeks };
+export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type Nullable, type Prettify, cAF, capitalize, days, hours, isBrowser, join, minutes, noop, rAF, seconds, toArray, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -1,6 +1,15 @@
 import { upperFirst } from 'scule';
 export * from 'scule';
 
+/**
+ * A function that does nothing.
+ */
+declare const noop: () => void;
+/**
+ * Alias of {@link noop}.
+ */
+declare const NOOP: () => void;
+
 /**
  * @file env.ts
  */
@@ -65,7 +74,19 @@ declare function waitFor(ms: number): Promise<unknown>;
 
 declare const warnOnce: (message: string) => void;
 
-declare function unique<T>(val: T[]): T[];
+/**
+ * Returns a new array with unique values.
+ * @param array - The array to process.
+ * @returns The new array.
+ */
+declare function unique<T>(array: T[]): T[];
+/**
+ * Returns a new array with unique values.
+ * @param array - The array to process.
+ * @param equalFn - The function to compare values.
+ * @returns The new array.
+ */
+declare function uniqueBy<T>(array: T[], equalFn: (a: T, b: T) => boolean): T[];
 
 type Nullable<T> = T | null;
 type MayBe<T> = T | undefined;
@@ -74,6 +95,26 @@ type Arrayable<T> = T | T[];
 type Awaitable<T> = T | Promise<T>;
 type Prettify<T> = Omit<T, never>;
 
-declare function toArray<T>(val?: Nullable<Arrayable<T>>): Arrayable<T>;
+/**
+ * Converts a value to an array.
+ * @param array - The value to convert.
+ * @returns The array.
+ */
+declare function toArray<T>(array?: Nullable<Arrayable<T>>): T[];
+
+type JoinableValue = string | number | null | undefined;
+interface JoinOptions {
+    /**
+     * @default '''
+     */
+    separator?: string;
+}
+/**
+ * Joins an array of strings or numbers into a single string.
+ * @param array - An array of strings or numbers.
+ * @param options - An object of options.
+ * @returns A string.
+ */
+declare function join(array: JoinableValue[], options?: JoinOptions): string;
 
-export { type AnyFn, type Arrayable, type Awaitable, type MayBe, type Nullable, type Prettify, cAF, capitalize, days, hours, isBrowser, minutes, rAF, seconds, toArray, unique, waitFor, warnOnce, weeks };
+export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type Nullable, type Prettify, cAF, capitalize, days, hours, isBrowser, join, minutes, noop, rAF, seconds, toArray, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -1,3 +1,8 @@
+// src/fn/noop.ts
+var noop = () => {
+};
+var NOOP = noop;
+
 // src/env/isBrowser.ts
 var isBrowser = () => typeof document !== "undefined";
 
@@ -141,16 +146,33 @@ var warnOnce = (message) => {
 };
 
 // src/array/unique.ts
-function unique(val) {
-  return Array.from(new Set(val));
+function unique(array) {
+  return Array.from(new Set(array));
+}
+function uniqueBy(array, equalFn) {
+  return array.reduce((acc, cur) => {
+    const idx = acc.findIndex((item) => equalFn(item, cur));
+    if (idx === -1) {
+      acc.push(cur);
+    }
+    return acc;
+  }, []);
 }
 
 // src/array/toArray.ts
-function toArray(val) {
-  val = val ?? [];
-  return Array.isArray(val) ? val : [val];
+function toArray(array) {
+  array = array ?? [];
+  return Array.isArray(array) ? array : [array];
+}
+
+// src/string/join.ts
+function join(array, options = {}) {
+  const { separator = "" } = options;
+  if (!Array.isArray(array) || !array.length) return "";
+  return array.filter((v) => Boolean(v) || v === 0).join(separator);
 }
 export {
+  NOOP,
   cAF,
   camelCase,
   capitalize,
@@ -159,9 +181,11 @@ export {
   hours,
   isBrowser,
   isUppercase,
+  join,
   kebabCase,
   lowerFirst,
   minutes,
+  noop,
   pascalCase,
   rAF,
   seconds,
@@ -171,6 +195,7 @@ export {
   toArray,
   trainCase,
   unique,
+  uniqueBy,
   upperFirst,
   waitFor,
   warnOnce,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -40,15 +40,15 @@
     "scule": "^1.3.0"
   },
   "devDependencies": {
-    "@ntnyq/eslint-config": "^3.0.0-beta.13",
+    "@ntnyq/eslint-config": "^3.0.0-beta.17",
     "@ntnyq/prettier-config": "^1.21.3",
     "@vitest/coverage-v8": "^2.1.1",
     "bumpp": "^9.5.2",
-    "eslint": "^9.10.0",
+    "eslint": "^9.11.1",
     "husky": "^9.1.6",
     "nano-staged": "^0.8.0",
     "npm-run-all2": "^6.2.3",
-    "pnpm": "^9.10.0",
+    "pnpm": "^9.11.0",
     "prettier": "^3.3.3",
     "tsup": "^8.3.0",
     "typescript": "^5.6.2",