zhiaiwan-utils 1.0.3

package/dist/types/object/invert.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 反转 object 的键值；重复值时后者覆盖前者。
+ *
+ * @param object - 源对象
+ * @returns 键值反转后的新对象
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.invert({ a: 1, b: 2, c: 1 });
+ * // => { '1': 'c', '2': 'b' }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function invert(object: object | null | undefined): Record<string, string>;

package/dist/types/object/keys.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 返回 object 的自有可枚举属性名数组；数组与类数组返回下标字符串。
+ *
+ * @param object - 要查询的对象或集合
+ * @returns 属性名数组
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.keys({ a: 1, b: 2 });
+ * // => ['a', 'b']
+ *
+ * zhiaiwanUtils.keys([1, 2, 3]);
+ * // => ['0', '1', '2']
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function keys(object: unknown): string[];

package/dist/types/object/mapKeys.d.ts

@@ -0,0 +1,18 @@
+import { type IterateeShorthand } from '../_internal/baseIteratee';
+/**
+ * 遍历 object 自有属性并生成新键名。
+ *
+ * @param object - 源对象
+ * @param iteratee - 生成新键名的函数或简写
+ * @returns 键名映射后的新对象
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.mapKeys({ a: 1, b: 2 }, (value, key) => key + value);
+ * // => { a1: 1, b2: 2 }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function mapKeys<T extends object>(object: T, iteratee?: IterateeShorthand): Record<string, unknown>;

package/dist/types/object/mapValues.d.ts

@@ -0,0 +1,18 @@
+import { type IterateeShorthand } from '../_internal/baseIteratee';
+/**
+ * 遍历 object 自有属性并生成新值。
+ *
+ * @param object - 源对象
+ * @param iteratee - 生成新值的函数或简写
+ * @returns 值映射后的新对象
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.mapValues({ a: 1, b: 2 }, (n) => (n as number) * 3);
+ * // => { a: 3, b: 6 }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function mapValues<T extends object>(object: T, iteratee?: IterateeShorthand): Record<string, unknown>;

package/dist/types/object/merge.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 递归合并 sources 到 object。普通对象深合并，数组合并按索引覆盖。
+ * 若 object 为 null 或 undefined，会创建并返回新对象。
+ *
+ * @param object - 目标对象
+ * @param sources - 一个或多个源对象
+ * @returns 合并后的 object
+ *
+ * @example
+ * ```ts
+ * const object = { a: [{ b: 2 }, { d: 4 }] };
+ * const other = { a: [{ c: 3 }, { e: 5 }] };
+ * zhiaiwanUtils.merge(object, other);
+ * // => { a: [{ b: 2, c: 3 }, { d: 4, e: 5 }] }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function merge<T>(object: T, ...sources: unknown[]): T;

package/dist/types/object/mergeWith.d.ts

@@ -0,0 +1,27 @@
+import type { MergeCustomizer } from '../_internal/baseMerge';
+/**
+ * 与 merge 相同，但允许通过 customizer 定制合并结果。
+ * customizer 返回 undefined 时回退到默认合并逻辑。
+ *
+ * @param object - 目标对象
+ * @param sources - 一个或多个源对象
+ * @param customizer - 自定义合并函数
+ * @returns 合并后的 object
+ *
+ * @example
+ * ```ts
+ * const object = { users: [{ name: 'a' }] };
+ * const other = { users: [{ name: 'b' }] };
+ * zhiaiwanUtils.mergeWith(object, other, (obj, src) => {
+ *   if (Array.isArray(obj)) {
+ *     return obj.concat(src);
+ *   }
+ * });
+ * // => { users: [{ name: 'a' }, { name: 'b' }] }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function mergeWith<T>(object: T, ...args: unknown[]): T;
+export type { MergeCustomizer };

package/dist/types/object/omit.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 从 object 中排除指定路径上的自有属性，返回深拷贝后的新对象。
+ *
+ * @param object - 源对象
+ * @param paths - 要排除的属性路径，支持 `'a.b'` 字符串、键数组或混合传入
+ * @returns 排除指定属性后的新对象
+ *
+ * @example
+ * ```ts
+ * const obj = { a: { b: 1, c: 2 }, d: 3 };
+ * zhiaiwanUtils.omit(obj, 'a.b');
+ * // => { a: { c: 2 }, d: 3 }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function omit<T extends object>(object: T, ...paths: Array<PropertyKey | ReadonlyArray<PropertyKey>>): Partial<T>;

package/dist/types/object/omitBy.d.ts

@@ -0,0 +1,18 @@
+import { type IterateeShorthand } from '../_internal/baseIteratee';
+/**
+ * 返回 object 中 predicate 不为真值的属性组成的新对象。
+ *
+ * @param object - 源对象
+ * @param predicate - 每次属性检查调用的函数或简写
+ * @returns 排除后的新对象
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.omitBy({ a: 1, b: '2', c: 3 }, (value) => typeof value === 'number');
+ * // => { b: '2' }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function omitBy<T extends object>(object: T, predicate?: IterateeShorthand): Partial<T>;

package/dist/types/object/pick.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 从 object 中选取指定路径上的自有属性，组成新对象。
+ *
+ * @param object - 源对象
+ * @param paths - 要选取的属性路径，支持 `'a.b'` 字符串、键数组或混合传入
+ * @returns 由选取属性组成的新对象
+ *
+ * @example
+ * ```ts
+ * const obj = { a: { b: 1 }, c: 3 };
+ * zhiaiwanUtils.pick(obj, 'a.b', 'c');
+ * // => { a: { b: 1 }, c: 3 }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function pick<T extends object>(object: T, ...paths: Array<PropertyKey | ReadonlyArray<PropertyKey>>): Partial<T>;

package/dist/types/object/pickBy.d.ts

@@ -0,0 +1,18 @@
+import { type IterateeShorthand } from '../_internal/baseIteratee';
+/**
+ * 返回 object 中 predicate 为真值的属性组成的新对象。
+ *
+ * @param object - 源对象
+ * @param predicate - 每次属性检查调用的函数或简写
+ * @returns 筛选后的新对象
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.pickBy({ a: 1, b: '2', c: 3 }, (value) => typeof value === 'number');
+ * // => { a: 1, c: 3 }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function pickBy<T extends object>(object: T, predicate?: IterateeShorthand): Partial<T>;

package/dist/types/object/set.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 设置 object 上 path 路径对应的值。若中间路径不存在会自动创建对象或数组
+ * （下一级为数字下标时创建数组）；当 object 为 null 或 undefined 时会创建并返回新对象。
+ *
+ * @param object - 要修改的对象
+ * @param path - 属性路径，支持 `'a.b[0].c'` 字符串或键数组
+ * @param value - 要设置的值
+ * @returns 修改后的 object（可能与入参为同一引用）
+ *
+ * @example
+ * ```ts
+ * const obj = { a: [{ b: 2 }] };
+ * set(obj, 'a[0].b', 3);
+ * // => { a: [{ b: 3 }] }
+ *
+ * set({}, 'a.b.c', 4);
+ * // => { a: { b: { c: 4 } } }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function set<T extends object>(object: T, path: string | ReadonlyArray<string | number>, value: unknown): T;

package/dist/types/object/unset.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 删除 object 上 path 路径对应的属性。
+ *
+ * @param object - 要修改的对象
+ * @param path - 属性路径，支持 `'a.b[0].c'` 字符串或键数组
+ * @returns 删除成功返回 true，路径不存在或无法到达时返回 false
+ *
+ * @example
+ * ```ts
+ * const obj = { a: [{ b: 2 }, { b: 3 }] };
+ * zhiaiwanUtils.unset(obj, 'a[0].b');
+ * // => true
+ * // obj => { a: [{}, { b: 3 }] }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function unset(object: unknown, path: string | ReadonlyArray<string | number>): boolean;

package/dist/types/object/update.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 按 path 更新 object 上的值，updater 接收当前值并返回新值。
+ *
+ * @param object - 待修改对象
+ * @param path - 属性路径
+ * @param updater - 更新函数
+ * @returns 修改后的 object
+ *
+ * @example
+ * ```ts
+ * const object = { a: [{ b: 1 }] };
+ * zhiaiwanUtils.update(object, 'a[0].b', (n) => (n as number) * 2);
+ * // object.a[0].b => 2
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function update<T extends object>(object: T | null | undefined, path: string | ReadonlyArray<string | number>, updater: (value: unknown) => unknown): T | null | undefined;

package/dist/types/object/updateWith.d.ts

@@ -0,0 +1,21 @@
+export type UpdateCustomizer = (objValue: unknown, key: string, object: object) => unknown;
+/**
+ * 类似 update，但允许 customizer 控制中间路径节点的创建。
+ *
+ * @param object - 待修改对象
+ * @param path - 属性路径
+ * @param updater - 更新函数
+ * @param customizer - 路径节点创建函数
+ * @returns 修改后的 object
+ *
+ * @example
+ * ```ts
+ * const object = {};
+ * zhiaiwanUtils.updateWith(object, '[0][1]', () => 'a', Object);
+ * // => { '0': { '1': 'a' } }
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function updateWith<T extends object>(object: T | null | undefined, path: string | ReadonlyArray<string | number>, updater: (value: unknown) => unknown, customizer?: UpdateCustomizer): T | null | undefined;

package/dist/types/object/values.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 返回 object 的自有可枚举属性值数组。
+ *
+ * @param object - 要查询的对象或集合
+ * @returns 属性值数组
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.values({ a: 1, b: 2 });
+ * // => [1, 2]
+ *
+ * zhiaiwanUtils.values([1, 2, 3]);
+ * // => [1, 2, 3]
+ * ```
+ *
+ * @since 1.0.0
+ * @category Object
+ */
+export default function values(object: unknown): unknown[];

package/dist/types/string/camelCase.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 将字符串转换为 camelCase。
+ *
+ * @param string - 待转换的字符串
+ * @returns camelCase 字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.camelCase('Foo Bar');
+ * // => 'fooBar'
+ *
+ * zhiaiwanUtils.camelCase('__FOO_BAR__');
+ * // => 'fooBar'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function camelCase(string?: unknown): string;

package/dist/types/string/capitalize.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 首字母大写，其余小写。
+ *
+ * @param string - 待转换字符串
+ * @returns 首字母大写后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.capitalize('FRED');
+ * // => 'Fred'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function capitalize(string?: unknown): string;

package/dist/types/string/endsWith.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 检查字符串是否以 target 结尾。
+ *
+ * @param value - 待检查的字符串
+ * @param target - 要匹配的后缀
+ * @param position - 检索结束位置，默认为字符串长度
+ * @returns 若匹配返回 true，否则返回 false
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.endsWith('abc', 'c');
+ * // => true
+ *
+ * zhiaiwanUtils.endsWith('abc', 'b');
+ * // => false
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function endsWith(value: unknown, target: unknown, position?: number): boolean;

package/dist/types/string/escape.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 将字符串中的 `&`、`<`、`>`、`"`、`'` 转为对应 HTML 实体。
+ *
+ * @param value - 待转义的值
+ * @returns 转义后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.escape('fred, barney, & pebbles');
+ * // => 'fred, barney, &amp; pebbles'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function escape(value: unknown): string;

package/dist/types/string/index.d.ts

@@ -0,0 +1,17 @@
+export { default as trim } from './trim';
+export { default as trimStart } from './trimStart';
+export { default as trimEnd } from './trimEnd';
+export { default as startsWith } from './startsWith';
+export { default as endsWith } from './endsWith';
+export { default as pad } from './pad';
+export { default as padStart } from './padStart';
+export { default as padEnd } from './padEnd';
+export { default as escape } from './escape';
+export { default as unescape } from './unescape';
+export { default as repeat } from './repeat';
+export { default as camelCase } from './camelCase';
+export { default as kebabCase } from './kebabCase';
+export { default as snakeCase } from './snakeCase';
+export { default as capitalize } from './capitalize';
+export { default as lowerCase } from './lowerCase';
+export { default as upperFirst } from './upperFirst';

package/dist/types/string/kebabCase.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 将字符串转换为 kebab-case。
+ *
+ * @param string - 待转换的字符串
+ * @returns kebab-case 字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.kebabCase('Foo Bar');
+ * // => 'foo-bar'
+ *
+ * zhiaiwanUtils.kebabCase('fooBar');
+ * // => 'foo-bar'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+declare const _default: (string?: unknown) => string;
+export default _default;

package/dist/types/string/lowerCase.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 将字符串按单词拆分为空格分隔的小写形式。
+ *
+ * @param string - 待转换字符串
+ * @returns 小写空格分隔字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.lowerCase('--Foo-Bar--');
+ * // => 'foo bar'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+declare const _default: (string?: unknown) => string;
+export default _default;

package/dist/types/string/pad.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 将字符串填充到指定长度，默认用空格在两端补齐，多余填充优先加在右侧。
+ *
+ * @param value - 待处理的值
+ * @param length - 目标长度
+ * @param chars - 填充字符，默认为空格
+ * @returns 填充后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.pad('abc', 8);
+ * // => '  abc   '
+ *
+ * zhiaiwanUtils.pad('abc', 8, '_-');
+ * // => '_-abc_-_'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function pad(value: unknown, length: number, chars?: string): string;

package/dist/types/string/padEnd.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 在字符串末尾填充到指定长度，默认使用空格。
+ *
+ * @param value - 待处理的值
+ * @param length - 目标长度
+ * @param chars - 填充字符，默认为空格
+ * @returns 填充后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.padEnd('abc', 6);
+ * // => 'abc   '
+ *
+ * zhiaiwanUtils.padEnd('abc', 6, '_-');
+ * // => 'abc_-_'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function padEnd(value: unknown, length: number, chars?: string): string;

package/dist/types/string/padStart.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 在字符串开头填充到指定长度，默认使用空格。
+ *
+ * @param value - 待处理的值
+ * @param length - 目标长度
+ * @param chars - 填充字符，默认为空格
+ * @returns 填充后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.padStart('abc', 6);
+ * // => '   abc'
+ *
+ * zhiaiwanUtils.padStart('abc', 6, '_-');
+ * // => '_-_abc'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function padStart(value: unknown, length: number, chars?: string): string;

package/dist/types/string/repeat.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 将字符串重复 n 次；n 小于 1 时返回空字符串。
+ *
+ * @param value - 待重复的值
+ * @param n - 重复次数
+ * @returns 重复后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.repeat('*', 3);
+ * // => '***'
+ *
+ * zhiaiwanUtils.repeat('abc', 2);
+ * // => 'abcabc'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function repeat(value: unknown, n: number): string;

package/dist/types/string/snakeCase.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 将字符串转换为 snake_case。
+ *
+ * @param string - 待转换的字符串
+ * @returns snake_case 字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.snakeCase('Foo Bar');
+ * // => 'foo_bar'
+ *
+ * zhiaiwanUtils.snakeCase('fooBar');
+ * // => 'foo_bar'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+declare const _default: (string?: unknown) => string;
+export default _default;

package/dist/types/string/startsWith.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 检查字符串是否以 target 开头。
+ *
+ * @param value - 待检查的字符串
+ * @param target - 要匹配的前缀
+ * @param position - 开始匹配的位置，默认为 0
+ * @returns 若匹配返回 true，否则返回 false
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.startsWith('abc', 'a');
+ * // => true
+ *
+ * zhiaiwanUtils.startsWith('abc', 'b');
+ * // => false
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function startsWith(value: unknown, target: unknown, position?: number): boolean;

package/dist/types/string/trim.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 移除字符串两端的空白字符，或移除两端在 chars 中出现的字符。
+ *
+ * @param value - 待处理的值
+ * @param chars - 要移除的字符集合；省略时移除空白字符
+ * @returns 裁剪后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.trim('  abc  ');
+ * // => 'abc'
+ *
+ * zhiaiwanUtils.trim('-_-abc-_-', '_-');
+ * // => 'abc'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function trim(value: unknown, chars?: string): string;

package/dist/types/string/trimEnd.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 移除字符串末尾的空白字符，或移除末尾在 chars 中出现的字符。
+ *
+ * @param value - 待处理的值
+ * @param chars - 要移除的字符集合；省略时移除空白字符
+ * @returns 裁剪后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.trimEnd('  abc  ');
+ * // => '  abc'
+ *
+ * zhiaiwanUtils.trimEnd('-_-abc-_-', '_-');
+ * // => '-_-abc'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function trimEnd(value: unknown, chars?: string): string;

package/dist/types/string/trimStart.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 移除字符串开头的空白字符，或移除开头在 chars 中出现的字符。
+ *
+ * @param value - 待处理的值
+ * @param chars - 要移除的字符集合；省略时移除空白字符
+ * @returns 裁剪后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.trimStart('  abc  ');
+ * // => 'abc  '
+ *
+ * zhiaiwanUtils.trimStart('-_-abc-_-', '_-');
+ * // => 'abc-_-'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function trimStart(value: unknown, chars?: string): string;

package/dist/types/string/unescape.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 将 HTML 实体还原为对应字符。
+ *
+ * @param value - 待反转义的值
+ * @returns 反转义后的字符串
+ *
+ * @example
+ * ```ts
+ * zhiaiwanUtils.unescape('fred, barney, & pebbles');
+ * // => 'fred, barney, & pebbles'
+ * ```
+ *
+ * @since 1.0.0
+ * @category String
+ */
+export default function unescape(value: unknown): string;