@ntnyq/utils 0.4.2 → 0.4.4

package/dist/index.cjs

@@ -38,8 +38,10 @@ __export(index_exports, {
   getObjectType: () => getObjectType,
   hasOwn: () => hasOwn,
   hours: () => hours,
+  interopDefault: () => interopDefault,
   isArray: () => isArray,
   isArrayEqual: () => isArrayEqual,
+  isBigInt: () => isBigInt,
   isBoolean: () => isBoolean,
   isBrowser: () => isBrowser,
   isDeepEqual: () => isDeepEqual,
@@ -47,6 +49,7 @@ __export(index_exports, {
   isEmptyObject: () => isEmptyObject,
   isEmptyString: () => isEmptyString,
   isEmptyStringOrWhitespace: () => isEmptyStringOrWhitespace,
+  isError: () => isError,
   isFunction: () => isFunction,
   isInteger: () => isInteger,
   isNaN: () => isNaN,
@@ -77,6 +80,7 @@ __export(index_exports, {
   pascalCase: () => pascalCase,
   pick: () => pick,
   rAF: () => rAF,
+  resolveSubOptions: () => resolveSubOptions,
   seconds: () => seconds,
   slash: () => slash,
   snakeCase: () => snakeCase,
@@ -162,6 +166,9 @@ function isNumbericString(value) {
 function isInteger(value) {
   return Number.isInteger(value);
 }
+function isBigInt(value) {
+  return typeof value === "bigint";
+}
 function isBoolean(value) {
   return typeof value === "boolean";
 }
@@ -183,6 +190,9 @@ function isEmptyObject(value) {
 function isRegExp(value) {
   return getObjectType(value) === "RegExp";
 }
+function isError(value) {
+  return getObjectType(value) === "Error";
+}
 function isSet(value) {
   return getObjectType(value) === "Set";
 }
@@ -614,6 +624,17 @@ function titleCase(str, opts) {
 
 // src/vendor/scule.ts
 var capitalize = upperFirst;
+
+// src/module/interopDefault.ts
+async function interopDefault(mod) {
+  const resolved = await mod;
+  return resolved.default || resolved;
+}
+
+// src/module/resolveSubOptions.ts
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   NOOP,
@@ -634,8 +655,10 @@ var capitalize = upperFirst;
   getObjectType,
   hasOwn,
   hours,
+  interopDefault,
   isArray,
   isArrayEqual,
+  isBigInt,
   isBoolean,
   isBrowser,
   isDeepEqual,
@@ -643,6 +666,7 @@ var capitalize = upperFirst;
   isEmptyObject,
   isEmptyString,
   isEmptyStringOrWhitespace,
+  isError,
   isFunction,
   isInteger,
   isNaN,
@@ -673,6 +697,7 @@ var capitalize = upperFirst;
   pascalCase,
   pick,
   rAF,
+  resolveSubOptions,
   seconds,
   slash,
   snakeCase,

package/dist/index.d.cts

@@ -29,6 +29,7 @@ declare function isWhitespaceString(value: unknown): value is Whitespace;
 declare function isEmptyStringOrWhitespace(value: unknown): value is '' | Whitespace;
 declare function isNumbericString(value: unknown): value is `${number}`;
 declare function isInteger(value: unknown): value is number;
+declare function isBigInt(value: unknown): value is bigint;
 declare function isBoolean(value: unknown): value is boolean;
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
@@ -36,6 +37,7 @@ declare function isEmptyArray(value: unknown): value is [];
 declare function isObject(value: unknown): value is object;
 declare function isEmptyObject(value: unknown): value is {};
 declare function isRegExp(value: unknown): value is RegExp;
+declare function isError(value: unknown): value is Error;
 declare function isSet<Value = unknown>(value: unknown): value is Set<Value>;
 declare function isNativePromise<T = unknown>(value: unknown): value is Promise<T>;
 declare function isPromise<T = unknown>(value: unknown): value is Promise<T>;
@@ -375,4 +377,49 @@ declare function sortObject<T extends Record<string, any>>(obj: T, options?: Sor
  */
 declare const capitalize: typeof upperFirst;
 
-export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+/**
+ * Interop default export from a module
+ *
+ * @param mod - The module
+ * @returns The default export
+ *
+ * @example
+ *
+ * ```ts
+ * import { interopDefault } from '@ntnyq/utils'
+ *
+ * const { unindent } = await interopDefault(import('@ntnyq/utils'))
+ * ```
+ */
+declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
+
+/**
+ * Resolve sub options `boolean | Options` to `Options`
+ * @param options - core options
+ * @param key - sub options key
+ * @returns resolved sub options
+ *
+ * @example
+ *
+ * ```ts
+ * import { resolveSubOptions } from '@ntnyq/utils'
+ *
+ * interface Options {
+ *   compile?: boolean | {
+ *     include?: string[]
+ *     exclude?: string[]
+ *   }
+ * }
+ *
+ * const options: Options = {
+ *   compile: true
+ * }
+ *
+ * console.log(resolveSubOptions(options, 'compile'))
+ *
+ * // => {}
+ * ```
+ */
+declare function resolveSubOptions<T extends Record<string, any>, K extends keyof T>(options: T, key: K): Partial<ResolvedOptions<T[K]>>;
+
+export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, resolveSubOptions, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -29,6 +29,7 @@ declare function isWhitespaceString(value: unknown): value is Whitespace;
 declare function isEmptyStringOrWhitespace(value: unknown): value is '' | Whitespace;
 declare function isNumbericString(value: unknown): value is `${number}`;
 declare function isInteger(value: unknown): value is number;
+declare function isBigInt(value: unknown): value is bigint;
 declare function isBoolean(value: unknown): value is boolean;
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
@@ -36,6 +37,7 @@ declare function isEmptyArray(value: unknown): value is [];
 declare function isObject(value: unknown): value is object;
 declare function isEmptyObject(value: unknown): value is {};
 declare function isRegExp(value: unknown): value is RegExp;
+declare function isError(value: unknown): value is Error;
 declare function isSet<Value = unknown>(value: unknown): value is Set<Value>;
 declare function isNativePromise<T = unknown>(value: unknown): value is Promise<T>;
 declare function isPromise<T = unknown>(value: unknown): value is Promise<T>;
@@ -375,4 +377,49 @@ declare function sortObject<T extends Record<string, any>>(obj: T, options?: Sor
  */
 declare const capitalize: typeof upperFirst;
 
-export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+/**
+ * Interop default export from a module
+ *
+ * @param mod - The module
+ * @returns The default export
+ *
+ * @example
+ *
+ * ```ts
+ * import { interopDefault } from '@ntnyq/utils'
+ *
+ * const { unindent } = await interopDefault(import('@ntnyq/utils'))
+ * ```
+ */
+declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
+
+/**
+ * Resolve sub options `boolean | Options` to `Options`
+ * @param options - core options
+ * @param key - sub options key
+ * @returns resolved sub options
+ *
+ * @example
+ *
+ * ```ts
+ * import { resolveSubOptions } from '@ntnyq/utils'
+ *
+ * interface Options {
+ *   compile?: boolean | {
+ *     include?: string[]
+ *     exclude?: string[]
+ *   }
+ * }
+ *
+ * const options: Options = {
+ *   compile: true
+ * }
+ *
+ * console.log(resolveSubOptions(options, 'compile'))
+ *
+ * // => {}
+ * ```
+ */
+declare function resolveSubOptions<T extends Record<string, any>, K extends keyof T>(options: T, key: K): Partial<ResolvedOptions<T[K]>>;
+
+export { type AnyFn, type Arrayable, type Awaitable, type Callable, type CleanObjectOptions, type InteropModuleDefault, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type MayBe, NOOP, type NonEmptyString, type Nullable, type Overwrite, type Prettify, type PrettifyV2, type PrimitiveType, type ResolvedOptions, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, cleanObject, days, debounce, ensurePrefix, ensureSuffix, escapeHtml, flattenArrayable, getObjectType, hasOwn, hours, interopDefault, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isEmptyArray, isEmptyObject, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isInteger, isNaN, isNativePromise, isNil, isNonEmptyString, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, resolveSubOptions, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -64,6 +64,9 @@ function isNumbericString(value) {
 function isInteger(value) {
   return Number.isInteger(value);
 }
+function isBigInt(value) {
+  return typeof value === "bigint";
+}
 function isBoolean(value) {
   return typeof value === "boolean";
 }
@@ -85,6 +88,9 @@ function isEmptyObject(value) {
 function isRegExp(value) {
   return getObjectType(value) === "RegExp";
 }
+function isError(value) {
+  return getObjectType(value) === "Error";
+}
 function isSet(value) {
   return getObjectType(value) === "Set";
 }
@@ -516,6 +522,17 @@ function titleCase(str, opts) {
 
 // src/vendor/scule.ts
 var capitalize = upperFirst;
+
+// src/module/interopDefault.ts
+async function interopDefault(mod) {
+  const resolved = await mod;
+  return resolved.default || resolved;
+}
+
+// src/module/resolveSubOptions.ts
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
 export {
   NOOP,
   at,
@@ -535,8 +552,10 @@ export {
   getObjectType,
   hasOwn,
   hours,
+  interopDefault,
   isArray,
   isArrayEqual,
+  isBigInt,
   isBoolean,
   isBrowser,
   isDeepEqual,
@@ -544,6 +563,7 @@ export {
   isEmptyObject,
   isEmptyString,
   isEmptyStringOrWhitespace,
+  isError,
   isFunction,
   isInteger,
   isNaN,
@@ -574,6 +594,7 @@ export {
   pascalCase,
   pick,
   rAF,
+  resolveSubOptions,
   seconds,
   slash,
   snakeCase,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -40,7 +40,7 @@
     "scule": "^1.3.0"
   },
   "devDependencies": {
-    "@ntnyq/eslint-config": "^3.10.2",
+    "@ntnyq/eslint-config": "^3.10.4",
     "@ntnyq/prettier-config": "^1.22.0",
     "@vitest/coverage-v8": "^3.0.0-beta.3",
     "bumpp": "^9.9.2",