@antfu/utils - npm Package Compare versions

Comparing version 0.7.10 to 8.0.0

dist/index.d.ts

@@ -151,2 +151,24 @@ /**
 /**
+ * Call every function in an array
+ */
+declare function batchInvoke(functions: Nullable<Fn>[]): void;
+/**
+ * Call the function
+ */
+declare function invoke(fn: Fn): void;
+/**
+ * Pass the value through the callback, and return the value
+ *
+ * @example
+ * ```
+ * function createUser(name: string): User {
+ *   return tap(new User, user => {
+ *     user.name = name
+ *   })
+ * }
+ * ```
+ */
+declare function tap<T>(value: T, callback: (value: T) => void): T;
+
+/**
  * Type guard to filter out null-ish values
@@ -220,103 +242,2 @@ *
 /**
- * Replace backslash to slash
- *
- * @category String
- */
-declare function slash(str: string): string;
-/**
- * Ensure prefix of a string
- *
- * @category String
- */
-declare function ensurePrefix(prefix: string, str: string): string;
-/**
- * Ensure suffix of a string
- *
- * @category String
- */
-declare function ensureSuffix(suffix: string, str: string): string;
-/**
- * Dead simple template engine, just like Python's `.format()`
- * Support passing variables as either in index based or object/name based approach
- * While using object/name based approach, you can pass a fallback value as the third argument
- *
- * @category String
- * @example
- * ```
- * const result = template(
- *   'Hello {0}! My name is {1}.',
- *   'Inès',
- *   'Anthony'
- * ) // Hello Inès! My name is Anthony.
- * ```
- *
- * ```
- * const result = namedTemplate(
- *   '{greet}! My name is {name}.',
- *   { greet: 'Hello', name: 'Anthony' }
- * ) // Hello! My name is Anthony.
- * ```
- *
- * const result = namedTemplate(
- *   '{greet}! My name is {name}.',
- *   { greet: 'Hello' }, // name isn't passed hence fallback will be used for name
- *   'placeholder'
- * ) // Hello! My name is placeholder.
- * ```
- */
-declare function template(str: string, object: Record<string | number, any>, fallback?: string | ((key: string) => string)): string;
-declare function template(str: string, ...args: (string | number | bigint | undefined | null)[]): string;
-/**
- * Generate a random string
- * @category String
- */
-declare function randomStr(size?: number, dict?: string): string;
-/**
- * First letter uppercase, other lowercase
- * @category string
- * @example
- * ```
- * capitalize('hello') => 'Hello'
- * ```
- */
-declare function capitalize(str: string): string;
-/**
- * Remove common leading whitespace from a template string.
- * Will also remove empty lines at the beginning and end.
- * @category string
- * @example
- * ```ts
- * const str = unindent`
- *   if (a) {
- *     b()
- *   }
- * `
- */
-declare function unindent(str: TemplateStringsArray | string): string;
-
-declare const timestamp: () => number;
-
-/**
- * Call every function in an array
- */
-declare function batchInvoke(functions: Nullable<Fn>[]): void;
-/**
- * Call the function
- */
-declare function invoke(fn: Fn): void;
-/**
- * Pass the value through the callback, and return the value
- *
- * @example
- * ```
- * function createUser(name: string): User {
- *   return tap(new User, user => {
- *     user.name = name
- *   })
- * }
- * ```
- */
-declare function tap<T>(value: T, callback: (value: T) => void): T;
-
-/**
  * Map key/value pairs for an object, and construct a new one
@@ -363,3 +284,3 @@ *
  */
-declare function objectKeys<T extends object>(obj: T): (`${keyof T & undefined}` | `${keyof T & null}` | `${keyof T & string}` | `${keyof T & number}` | `${keyof T & false}` | `${keyof T & true}`)[];
+declare function objectKeys<T extends object>(obj: T): Array<`${keyof T & (string | number | boolean | null | undefined)}`>;
 /**
@@ -370,3 +291,3 @@ * Strict typed `Object.entries`
  */
-declare function objectEntries<T extends object>(obj: T): [keyof T, T[keyof T]][];
+declare function objectEntries<T extends object>(obj: T): Array<[keyof T, T[keyof T]]>;
 /**
@@ -412,2 +333,43 @@ * Deep merge
 
+interface POptions {
+    /**
+     * How many promises are resolved at the same time.
+     */
+    concurrency?: number | undefined;
+}
+declare class PInstance<T = any> extends Promise<Awaited<T>[]> {
+    items: Iterable<T>;
+    options?: POptions | undefined;
+    private promises;
+    get promise(): Promise<Awaited<T>[]>;
+    constructor(items?: Iterable<T>, options?: POptions | undefined);
+    add(...args: (T | Promise<T>)[]): void;
+    map<U>(fn: (value: Awaited<T>, index: number) => U): PInstance<Promise<U>>;
+    filter(fn: (value: Awaited<T>, index: number) => boolean | Promise<boolean>): PInstance<Promise<T>>;
+    forEach(fn: (value: Awaited<T>, index: number) => void): Promise<void>;
+    reduce<U>(fn: (previousValue: U, currentValue: Awaited<T>, currentIndex: number, array: Awaited<T>[]) => U, initialValue: U): Promise<U>;
+    clear(): void;
+    then(fn?: () => PromiseLike<any>): Promise<any>;
+    catch(fn?: (err: unknown) => PromiseLike<any>): Promise<any>;
+    finally(fn?: () => void): Promise<Awaited<T>[]>;
+}
+/**
+ * Utility for managing multiple promises.
+ *
+ * @see https://github.com/antfu/utils/tree/main/docs/p.md
+ * @category Promise
+ * @example
+ * ```
+ * import { p } from '@antfu/utils'
+ *
+ * const items = [1, 2, 3, 4, 5]
+ *
+ * await p(items)
+ *   .map(async i => await multiply(i, 3))
+ *   .filter(async i => await isEven(i))
+ * // [6, 12]
+ * ```
+ */
+declare function p<T = any>(items?: Iterable<T>, options?: POptions): PInstance<T>;
+
 interface SingletonPromiseReturn<T> {
@@ -478,2 +440,81 @@ (): Promise<T>;
 
+/**
+ * Replace backslash to slash
+ *
+ * @category String
+ */
+declare function slash(str: string): string;
+/**
+ * Ensure prefix of a string
+ *
+ * @category String
+ */
+declare function ensurePrefix(prefix: string, str: string): string;
+/**
+ * Ensure suffix of a string
+ *
+ * @category String
+ */
+declare function ensureSuffix(suffix: string, str: string): string;
+/**
+ * Dead simple template engine, just like Python's `.format()`
+ * Support passing variables as either in index based or object/name based approach
+ * While using object/name based approach, you can pass a fallback value as the third argument
+ *
+ * @category String
+ * @example
+ * ```
+ * const result = template(
+ *   'Hello {0}! My name is {1}.',
+ *   'Inès',
+ *   'Anthony'
+ * ) // Hello Inès! My name is Anthony.
+ * ```
+ *
+ * ```
+ * const result = namedTemplate(
+ *   '{greet}! My name is {name}.',
+ *   { greet: 'Hello', name: 'Anthony' }
+ * ) // Hello! My name is Anthony.
+ * ```
+ *
+ * const result = namedTemplate(
+ *   '{greet}! My name is {name}.',
+ *   { greet: 'Hello' }, // name isn't passed hence fallback will be used for name
+ *   'placeholder'
+ * ) // Hello! My name is placeholder.
+ * ```
+ */
+declare function template(str: string, object: Record<string | number, any>, fallback?: string | ((key: string) => string)): string;
+declare function template(str: string, ...args: (string | number | bigint | undefined | null)[]): string;
+/**
+ * Generate a random string
+ * @category String
+ */
+declare function randomStr(size?: number, dict?: string): string;
+/**
+ * First letter uppercase, other lowercase
+ * @category string
+ * @example
+ * ```
+ * capitalize('hello') => 'Hello'
+ * ```
+ */
+declare function capitalize(str: string): string;
+/**
+ * Remove common leading whitespace from a template string.
+ * Will also remove empty lines at the beginning and end.
+ * @category string
+ * @example
+ * ```ts
+ * const str = unindent`
+ *   if (a) {
+ *     b()
+ *   }
+ * `
+ */
+declare function unindent(str: TemplateStringsArray | string): string;
+
+declare const timestamp: () => number;
+
 interface CancelOptions {
@@ -579,43 +620,2 @@ upcomingOnly?: boolean;
 
-interface POptions {
-    /**
-     * How many promises are resolved at the same time.
-     */
-    concurrency?: number | undefined;
-}
-declare class PInstance<T = any> extends Promise<Awaited<T>[]> {
-    items: Iterable<T>;
-    options?: POptions | undefined;
-    private promises;
-    get promise(): Promise<Awaited<T>[]>;
-    constructor(items?: Iterable<T>, options?: POptions | undefined);
-    add(...args: (T | Promise<T>)[]): void;
-    map<U>(fn: (value: Awaited<T>, index: number) => U): PInstance<Promise<U>>;
-    filter(fn: (value: Awaited<T>, index: number) => boolean | Promise<boolean>): PInstance<Promise<T>>;
-    forEach(fn: (value: Awaited<T>, index: number) => void): Promise<void>;
-    reduce<U>(fn: (previousValue: U, currentValue: Awaited<T>, currentIndex: number, array: Awaited<T>[]) => U, initialValue: U): Promise<U>;
-    clear(): void;
-    then(fn?: () => PromiseLike<any>): Promise<any>;
-    catch(fn?: (err: unknown) => PromiseLike<any>): Promise<any>;
-    finally(fn?: () => void): Promise<Awaited<T>[]>;
-}
-/**
- * Utility for managing multiple promises.
- *
- * @see https://github.com/antfu/utils/tree/main/docs/p.md
- * @category Promise
- * @example
- * ```
- * import { p } from '@antfu/utils'
- *
- * const items = [1, 2, 3, 4, 5]
- *
- * await p(items)
- *   .map(async i => await multiply(i, 3))
- *   .filter(async i => await isEven(i))
- * // [6, 12]
- * ```
- */
-declare function p<T = any>(items?: Iterable<T>, options?: POptions): PInstance<T>;
-
 export { type ArgumentsType, type Arrayable, type Awaitable, type Constructor, type ControlledPromise, type DeepMerge, type ElementOf, type Fn, type MergeInsertions, type Nullable, type PartitionFilter, type SingletonPromiseReturn, type UnionToIntersection, assert, at, batchInvoke, capitalize, clamp, clampArrayRange, clearUndefined, createControlledPromise, createPromiseLock, createSingletonPromise, debounce, deepMerge, deepMergeWithArray, ensurePrefix, ensureSuffix, flattenArrayable, getTypeName, hasOwnProperty, invoke, isBoolean, isBrowser, isDate, isDeepEqual, isDef, isFunction, isKeyOf, isNull, isNumber, isObject, isRegExp, isString, isTruthy, isUndefined, isWindow, last, lerp, mergeArrayable, move, noNull, noop, notNullish, notUndefined, objectEntries, objectKeys, objectMap, objectPick, p, partition, randomStr, range, remap, remove, sample, shuffle, slash, sleep, sum, tap, template, throttle, timestamp, toArray, toString, unindent, uniq, uniqueBy };

package.json

 {
   "name": "@antfu/utils",
   "type": "module",
-  "version": "0.7.10",
-  "packageManager": "pnpm@9.1.0",
+  "version": "8.0.0",
+  "packageManager": "pnpm@9.15.3",
   "description": "Opinionated collection of common JavaScript / TypeScript utils by @antfu",
@@ -46,23 +46,22 @@ "author": "Anthony Fu <[e-mail]>",
   "devDependencies": {
-    "@antfu/eslint-config": "^2.16.3",
-    "@antfu/ni": "^0.21.12",
-    "@rollup/plugin-alias": "^5.1.0",
-    "@rollup/plugin-commonjs": "^25.0.7",
+    "@antfu/eslint-config": "^3.12.2",
+    "@antfu/ni": "^0.23.2",
+    "@rollup/plugin-alias": "^5.1.1",
+    "@rollup/plugin-commonjs": "^28.0.2",
     "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@types/node": "^20.12.10",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@types/node": "^22.10.5",
     "@types/throttle-debounce": "^5.0.2",
-    "bumpp": "^9.4.1",
-    "eslint": "npm:eslint-ts-patch@8.55.0-1",
-    "eslint-ts-patch": "8.55.0-1",
-    "esno": "^4.7.0",
-    "p-limit": "^5.0.0",
-    "rollup": "^4.17.2",
-    "rollup-plugin-dts": "^6.1.0",
+    "bumpp": "^9.9.3",
+    "eslint": "^8.57.1",
+    "esno": "^4.8.0",
+    "p-limit": "^6.2.0",
+    "rollup": "^4.30.1",
+    "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-esbuild": "^6.1.1",
     "throttle-debounce": "5.0.0",
-    "typescript": "^5.4.5",
-    "vite": "^5.2.11",
-    "vitest": "^1.6.0"
+    "typescript": "^5.7.3",
+    "vite": "^6.0.7",
+    "vitest": "^2.1.8"
   }
 }

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

109464

1.26%

Dev dependency count

19

-5%

Lines of code

2138

2.59%

Number of low quality alerts

0

-100%

No dependency changes