@ntnyq/utils 0.6.2 → 0.6.3

package/README.md

@@ -3,7 +3,6 @@
 [![CI](https://github.com/ntnyq/utils/workflows/CI/badge.svg)](https://github.com/ntnyq/utils/actions)
 [![NPM VERSION](https://img.shields.io/npm/v/@ntnyq/utils.svg)](https://www.npmjs.com/package/@ntnyq/utils)
 [![NPM DOWNLOADS](https://img.shields.io/npm/dy/@ntnyq/utils.svg)](https://www.npmjs.com/package/@ntnyq/utils)
-[![CODECOV](https://codecov.io/github/ntnyq/utils/branch/main/graph/badge.svg)](https://codecov.io/github/ntnyq/utils)
 [![LICENSE](https://img.shields.io/github/license/ntnyq/utils.svg)](https://github.com/ntnyq/utils/blob/main/LICENSE)
 
 > Common used utils.

package/dist/index.cjs

@@ -25,6 +25,7 @@ __export(index_exports, {
   RE_BLOCK_COMMENT: () => RE_BLOCK_COMMENT,
   RE_COMMENTS: () => RE_COMMENTS,
   RE_LINE_COMMENT: () => RE_LINE_COMMENT,
+  SPECIAL_CHAR: () => SPECIAL_CHAR,
   at: () => at,
   cAF: () => cAF,
   chunk: () => chunk,
@@ -86,6 +87,7 @@ __export(index_exports, {
   noop: () => noop,
   omit: () => omit,
   once: () => once,
+  openExternalURL: () => openExternalURL,
   pick: () => pick,
   rAF: () => rAF,
   randomHexColor: () => randomHexColor,
@@ -279,6 +281,13 @@ function scrollElementIntoView(element, options = {}) {
   }
 }
 
+// src/dom/openExternalURL.ts
+function openExternalURL(url, options = {}) {
+  const { target = "_blank" } = options;
+  const proxy = window.open(url, target);
+  return proxy;
+}
+
 // src/dom/isVisibleInViewport.ts
 function isElementVisibleInViewport(element, targetWindow = window) {
   const { top, left, bottom, right } = element.getBoundingClientRect();
@@ -808,6 +817,11 @@ function sortObject(obj, options = {}) {
   return sortKeys(obj);
 }
 
+// src/constants/char.ts
+var SPECIAL_CHAR = {
+  newline: "\n"
+};
+
 // src/constants/regexp.ts
 var RE_COMMENTS = /(?:<!--|\/\*)([\s\S]*?)(?:-->|\*\/)/g;
 var RE_LINE_COMMENT = /\/\/.*/;
@@ -819,6 +833,7 @@ var RE_BLOCK_COMMENT = /\/\*[\s\S]*?\*\//g;
   RE_BLOCK_COMMENT,
   RE_COMMENTS,
   RE_LINE_COMMENT,
+  SPECIAL_CHAR,
   at,
   cAF,
   chunk,
@@ -880,6 +895,7 @@ var RE_BLOCK_COMMENT = /\/\*[\s\S]*?\*\//g;
   noop,
   omit,
   once,
+  openExternalURL,
   pick,
   rAF,
   randomHexColor,

package/dist/index.d.cts

@@ -71,6 +71,83 @@ interface Options extends ScrollIntoViewOptions {
  */
 declare function scrollElementIntoView(element: HTMLElement, options?: Options): void;
 
+type JsonArray = JsonValue[] | readonly JsonValue[];
+type JsonObject = {
+    [Key in string]: JsonValue;
+} & {
+    [Key in string]?: JsonValue | undefined;
+};
+type JsonPrimitive = boolean | number | string | null;
+/**
+ * @copyright {@link https://github.com/sindresorhus/type-fest/blob/main/source/basic.d.ts}
+ */
+type JsonValue = JsonArray | JsonObject | JsonPrimitive;
+
+/**
+ * A literal type that supports custom further strings but preserves autocompletion in IDEs.
+ *
+ * @see https://github.com/microsoft/TypeScript/issues/29729#issuecomment-471566609
+ */
+type LiteralUnion<Union extends Base, Base = string> = Union | (Base & {
+    zz_IGNORE_ME?: never;
+});
+/**
+ * Non empty object `{}`
+ */
+type NonEmptyObject<T> = T extends Record<string, never> ? never : T;
+
+/**
+ * interop module
+ */
+type InteropModuleDefault<T> = T extends {
+    default: infer U;
+} ? U : T;
+
+type AnyFn<T = any, R = any> = (...args: T[]) => R;
+type Arrayable<T> = T | T[];
+type Awaitable<T> = Promise<T> | T;
+type Callable<T> = AnyFn<any, T> | T;
+type MayBe<T> = T | undefined;
+type Nullable<T> = T | null;
+/**
+ * Overwrite some keys type
+ */
+type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
+/**
+ * Prettify object type
+ */
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type PrettifyV2<T> = Omit<T, never>;
+type PrimitiveType = bigint | boolean | number | string | symbol | null | undefined;
+/**
+ * Resolve `boolean | Record<string, any>` to `Record<string, any>`
+ */
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+
+interface OpenExternalURLOptions {
+    /**
+     * open target
+     *
+     * @default `_blank`
+     */
+    target?: LiteralUnion<'_self' | '_top' | '_blank' | '_parent'>;
+}
+/**
+ * Open external url
+ * @param url - URL to open
+ * @param options - open options
+ * @returns window proxy
+ */
+declare function openExternalURL(url: string | URL, options?: OpenExternalURLOptions): WindowProxy | null;
+
+/**
+ * Check if element is in viewport
+ * @param element - checked element
+ * @param targetWindow - window
+ * @returns true if element is in viewport, false otherwise
+ */
 declare function isElementVisibleInViewport(element: HTMLElement, targetWindow?: Window): boolean;
 
 /**
@@ -208,61 +285,6 @@ declare function unique<T>(array: T[]): T[];
  */
 declare function uniqueBy<T>(array: T[], equalFn: (a: T, b: T) => boolean): T[];
 
-type JsonArray = JsonValue[] | readonly JsonValue[];
-type JsonObject = {
-    [Key in string]: JsonValue;
-} & {
-    [Key in string]?: JsonValue | undefined;
-};
-type JsonPrimitive = boolean | number | string | null;
-/**
- * @copyright {@link https://github.com/sindresorhus/type-fest/blob/main/source/basic.d.ts}
- */
-type JsonValue = JsonArray | JsonObject | JsonPrimitive;
-
-/**
- * A literal type that supports custom further strings but preserves autocompletion in IDEs.
- *
- * @see https://github.com/microsoft/TypeScript/issues/29729#issuecomment-471566609
- */
-type LiteralUnion<Union extends Base, Base = string> = Union | (Base & {
-    zz_IGNORE_ME?: never;
-});
-/**
- * Non empty object `{}`
- */
-type NonEmptyObject<T> = T extends Record<string, never> ? never : T;
-
-/**
- * interop module
- */
-type InteropModuleDefault<T> = T extends {
-    default: infer U;
-} ? U : T;
-
-type AnyFn<T = any, R = any> = (...args: T[]) => R;
-type Arrayable<T> = T | T[];
-type Awaitable<T> = Promise<T> | T;
-type Callable<T> = AnyFn<any, T> | T;
-type MayBe<T> = T | undefined;
-type Nullable<T> = T | null;
-/**
- * Overwrite some keys type
- */
-type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
-/**
- * Prettify object type
- */
-type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-type PrettifyV2<T> = Omit<T, never>;
-type PrimitiveType = bigint | boolean | number | string | symbol | null | undefined;
-/**
- * Resolve `boolean | Record<string, any>` to `Record<string, any>`
- */
-type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
-
 /**
  * Converts a value to an array.
  * @param array - The value to convert.
@@ -564,6 +586,13 @@ declare function ensurePrefix(input: string, prefix: string): string;
 
 declare function ensureSuffix(input: string, suffix: string): string;
 
+/**
+ * Special chars
+ */
+declare const SPECIAL_CHAR: {
+    newline: string;
+};
+
 /**
  * 注释正则
  *
@@ -579,4 +608,4 @@ declare const RE_LINE_COMMENT: RegExp;
  */
 declare const RE_BLOCK_COMMENT: RegExp;
 
-export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, Color, type CreatePadStringOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type LiteralUnion, type MayBe, NOOP, type NonEmptyObject, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, type RamdomNumberOptions, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, Color, type CreatePadStringOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type LiteralUnion, type MayBe, NOOP, type NonEmptyObject, type NonEmptyString, type Nullable, type OpenExternalURLOptions, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, type RamdomNumberOptions, type ResolvedOptions, SPECIAL_CHAR, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -71,6 +71,83 @@ interface Options extends ScrollIntoViewOptions {
  */
 declare function scrollElementIntoView(element: HTMLElement, options?: Options): void;
 
+type JsonArray = JsonValue[] | readonly JsonValue[];
+type JsonObject = {
+    [Key in string]: JsonValue;
+} & {
+    [Key in string]?: JsonValue | undefined;
+};
+type JsonPrimitive = boolean | number | string | null;
+/**
+ * @copyright {@link https://github.com/sindresorhus/type-fest/blob/main/source/basic.d.ts}
+ */
+type JsonValue = JsonArray | JsonObject | JsonPrimitive;
+
+/**
+ * A literal type that supports custom further strings but preserves autocompletion in IDEs.
+ *
+ * @see https://github.com/microsoft/TypeScript/issues/29729#issuecomment-471566609
+ */
+type LiteralUnion<Union extends Base, Base = string> = Union | (Base & {
+    zz_IGNORE_ME?: never;
+});
+/**
+ * Non empty object `{}`
+ */
+type NonEmptyObject<T> = T extends Record<string, never> ? never : T;
+
+/**
+ * interop module
+ */
+type InteropModuleDefault<T> = T extends {
+    default: infer U;
+} ? U : T;
+
+type AnyFn<T = any, R = any> = (...args: T[]) => R;
+type Arrayable<T> = T | T[];
+type Awaitable<T> = Promise<T> | T;
+type Callable<T> = AnyFn<any, T> | T;
+type MayBe<T> = T | undefined;
+type Nullable<T> = T | null;
+/**
+ * Overwrite some keys type
+ */
+type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
+/**
+ * Prettify object type
+ */
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type PrettifyV2<T> = Omit<T, never>;
+type PrimitiveType = bigint | boolean | number | string | symbol | null | undefined;
+/**
+ * Resolve `boolean | Record<string, any>` to `Record<string, any>`
+ */
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+
+interface OpenExternalURLOptions {
+    /**
+     * open target
+     *
+     * @default `_blank`
+     */
+    target?: LiteralUnion<'_self' | '_top' | '_blank' | '_parent'>;
+}
+/**
+ * Open external url
+ * @param url - URL to open
+ * @param options - open options
+ * @returns window proxy
+ */
+declare function openExternalURL(url: string | URL, options?: OpenExternalURLOptions): WindowProxy | null;
+
+/**
+ * Check if element is in viewport
+ * @param element - checked element
+ * @param targetWindow - window
+ * @returns true if element is in viewport, false otherwise
+ */
 declare function isElementVisibleInViewport(element: HTMLElement, targetWindow?: Window): boolean;
 
 /**
@@ -208,61 +285,6 @@ declare function unique<T>(array: T[]): T[];
  */
 declare function uniqueBy<T>(array: T[], equalFn: (a: T, b: T) => boolean): T[];
 
-type JsonArray = JsonValue[] | readonly JsonValue[];
-type JsonObject = {
-    [Key in string]: JsonValue;
-} & {
-    [Key in string]?: JsonValue | undefined;
-};
-type JsonPrimitive = boolean | number | string | null;
-/**
- * @copyright {@link https://github.com/sindresorhus/type-fest/blob/main/source/basic.d.ts}
- */
-type JsonValue = JsonArray | JsonObject | JsonPrimitive;
-
-/**
- * A literal type that supports custom further strings but preserves autocompletion in IDEs.
- *
- * @see https://github.com/microsoft/TypeScript/issues/29729#issuecomment-471566609
- */
-type LiteralUnion<Union extends Base, Base = string> = Union | (Base & {
-    zz_IGNORE_ME?: never;
-});
-/**
- * Non empty object `{}`
- */
-type NonEmptyObject<T> = T extends Record<string, never> ? never : T;
-
-/**
- * interop module
- */
-type InteropModuleDefault<T> = T extends {
-    default: infer U;
-} ? U : T;
-
-type AnyFn<T = any, R = any> = (...args: T[]) => R;
-type Arrayable<T> = T | T[];
-type Awaitable<T> = Promise<T> | T;
-type Callable<T> = AnyFn<any, T> | T;
-type MayBe<T> = T | undefined;
-type Nullable<T> = T | null;
-/**
- * Overwrite some keys type
- */
-type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
-/**
- * Prettify object type
- */
-type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-type PrettifyV2<T> = Omit<T, never>;
-type PrimitiveType = bigint | boolean | number | string | symbol | null | undefined;
-/**
- * Resolve `boolean | Record<string, any>` to `Record<string, any>`
- */
-type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
-
 /**
  * Converts a value to an array.
  * @param array - The value to convert.
@@ -564,6 +586,13 @@ declare function ensurePrefix(input: string, prefix: string): string;
 
 declare function ensureSuffix(input: string, suffix: string): string;
 
+/**
+ * Special chars
+ */
+declare const SPECIAL_CHAR: {
+    newline: string;
+};
+
 /**
  * 注释正则
  *
@@ -579,4 +608,4 @@ declare const RE_LINE_COMMENT: RegExp;
  */
 declare const RE_BLOCK_COMMENT: RegExp;
 
-export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, Color, type CreatePadStringOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type LiteralUnion, type MayBe, NOOP, type NonEmptyObject, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, type RamdomNumberOptions, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, Color, type CreatePadStringOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type LiteralUnion, type MayBe, NOOP, type NonEmptyObject, type NonEmptyString, type Nullable, type OpenExternalURLOptions, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, type RamdomNumberOptions, type ResolvedOptions, SPECIAL_CHAR, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -166,6 +166,13 @@ function scrollElementIntoView(element, options = {}) {
   }
 }
 
+// src/dom/openExternalURL.ts
+function openExternalURL(url, options = {}) {
+  const { target = "_blank" } = options;
+  const proxy = window.open(url, target);
+  return proxy;
+}
+
 // src/dom/isVisibleInViewport.ts
 function isElementVisibleInViewport(element, targetWindow = window) {
   const { top, left, bottom, right } = element.getBoundingClientRect();
@@ -695,6 +702,11 @@ function sortObject(obj, options = {}) {
   return sortKeys(obj);
 }
 
+// src/constants/char.ts
+var SPECIAL_CHAR = {
+  newline: "\n"
+};
+
 // src/constants/regexp.ts
 var RE_COMMENTS = /(?:<!--|\/\*)([\s\S]*?)(?:-->|\*\/)/g;
 var RE_LINE_COMMENT = /\/\/.*/;
@@ -705,6 +717,7 @@ export {
   RE_BLOCK_COMMENT,
   RE_COMMENTS,
   RE_LINE_COMMENT,
+  SPECIAL_CHAR,
   at,
   cAF,
   chunk,
@@ -766,6 +779,7 @@ export {
   noop,
   omit,
   once,
+  openExternalURL,
   pick,
   rAF,
   randomHexColor,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -37,28 +37,26 @@
   ],
   "sideEffects": false,
   "devDependencies": {
-    "@ntnyq/eslint-config": "^4.0.2",
+    "@ntnyq/eslint-config": "^4.0.3",
     "@ntnyq/prettier-config": "^2.0.0",
-    "@vitest/coverage-v8": "^3.0.9",
     "bumpp": "^10.1.0",
-    "eslint": "^9.23.0",
+    "eslint": "^9.24.0",
     "husky": "^9.1.7",
     "nano-staged": "^0.8.0",
     "npm-run-all2": "^7.0.2",
     "prettier": "^3.5.3",
     "tsup": "^8.4.0",
-    "typescript": "^5.8.2",
-    "vitest": "^3.0.9"
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1"
   },
   "engines": {
     "node": ">=18.18.0"
   },
   "nano-staged": {
-    "*.{js,ts,mjs,cjs,md,yml,yaml,json}": "eslint --fix"
+    "*.{js,ts,mjs,cjs,md,yml,yaml,toml,json}": "eslint --fix"
   },
   "scripts": {
     "build": "tsup",
-    "coverage": "vitest --coverage",
     "dev": "tsup --watch src",
     "lint": "eslint",
     "release": "run-s release:check release:version release:publish",