@pawover/kit 0.0.0-alpha.2 → 0.0.0-alpha.20

package/dist/index.d.ts

@@ -0,0 +1,382 @@
+import { Class, NonEmptyObject, Replace, SetOptional, UnionToTuple, ValueOf } from "type-fest";
+import { assign } from "radashi";
+
+//#region src/utils/array/arrayCast.d.ts
+
+/**
+ * 构造数组
+ * @param candidate 待构造项
+ * @param checkEmpty 是否检查 `undefined` 和 `null`
+ */
+declare function arrayCast<T>(candidate: T | T[], checkEmpty?: boolean): T[];
+//#endregion
+//#region src/utils/array/arrayCompete.d.ts
+/**
+ * 数组竞争
+ * - 返回在匹配函数的比较条件中获胜的最终项目，适用于更复杂的最小值/最大值计算
+ *
+ * @param initialList 数组
+ * @param match 匹配函数
+ */
+declare function arrayCompete<T>(initialList: readonly T[], match: (a: T, b: T) => T): T | null;
+//#endregion
+//#region src/utils/array/arrayCounting.d.ts
+/**
+ * 统计数组的项目出现次数
+ * - 通过给定的标识符匹配函数，返回一个对象，其中键是回调函数返回的 key 值，每个值是一个整数，表示该 key 出现的次数
+ *
+ * @param initialList 初始数组
+ * @param match 匹配函数
+ */
+declare function arrayCounting<T, K extends PropertyKey>(initialList: readonly T[], match: (row: T) => K): Record<string, number>;
+//#endregion
+//#region src/utils/array/arrayDifference.d.ts
+/**
+ * 求数组差集
+ *
+ * @param initialList 初始数组
+ * @param diffList 对比数组
+ * @param match 匹配函数
+ */
+declare function arrayDifference<T>(initialList: readonly T[], diffList: readonly T[], match?: (row: T) => unknown): T[];
+//#endregion
+//#region src/utils/array/arrayFirst.d.ts
+/**
+ * 获取数组第一项
+ *
+ * @param initialList 初始数组
+ * @param saveValue 安全值
+ */
+declare function arrayFirst<T>(initialList: readonly T[], saveValue?: T): T | undefined;
+//#endregion
+//#region src/utils/array/arrayFork.d.ts
+/**
+ * 数组分组过滤
+ * - 给定一个数组和一个条件，返回一个由两个数组组成的元组，其中第一个数组包含所有满足条件的项，第二个数组包含所有不满足条件的项
+ *
+ * @param initialList 初始数组
+ * @param match 条件匹配函数
+ */
+declare function arrayFork<T>(initialList: readonly T[], match: (item: T) => boolean): [T[], T[]];
+//#endregion
+//#region src/utils/array/arrayIntersection.d.ts
+/**
+ * 求数组交集
+ *
+ * @param initialList 初始数组
+ * @param diffList 对比数组
+ * @param match 匹配函数
+ */
+declare function arrayIntersection<T>(initialList: readonly T[], diffList: readonly T[], match?: (row: T) => unknown): T[];
+//#endregion
+//#region src/utils/array/arrayLast.d.ts
+/**
+ * 获取数组最后一项
+ *
+ * @param initialList 初始数组
+ * @param saveValue 安全值
+ */
+declare function arrayLast<T>(initialList: readonly T[], saveValue?: T): T | undefined;
+//#endregion
+//#region src/utils/array/arrayMerge.d.ts
+/**
+ * 数组合并
+ * - 通过给定的标识符匹配函数，用第二个数组中的匹配项替换第一个数组中匹配项的所有内容
+ *
+ * @param initialList 初始数组
+ * @param mergeList 待合并数组
+ * @param match 匹配函数
+ */
+declare function arrayMerge<T>(initialList: readonly T[], mergeList: readonly T[], match?: (item: T) => unknown): T[];
+//#endregion
+//#region src/utils/array/arrayPick.d.ts
+/**
+ * 数组选择
+ * - 一次性应用 `filter` 和 `map` 操作
+ *
+ * @param initialList 初始数组
+ * @param filter filter 函数
+ * @param mapper map 函数
+ */
+declare function arrayPick<T, K = T>(initialList: readonly T[], filter: (row: T, index: number) => boolean, mapper?: ((row: T, index: number) => K) | undefined): T[] | K[];
+//#endregion
+//#region src/utils/array/arrayReplace.d.ts
+/**
+ * 数组项替换
+ * - 在给定的数组中，替换符合匹配函数结果的项目。只替换第一个匹配项。始终返回原始数组的副本。
+ *
+ * @param initialList 初始数组
+ * @param newItem 替换项
+ * @param match 匹配函数
+ */
+declare function arrayReplace<T>(initialList: readonly T[], newItem: T, match: (row: T, index: number) => boolean): T[];
+//#endregion
+//#region src/utils/array/arraySplit.d.ts
+/**
+ * 数组切分
+ * - 将数组以指定的长度切分后，组合在高维数组中
+ *
+ * @param initialList 初始数组
+ * @param size 分割尺寸，默认 `10`
+ */
+declare function arraySplit<T>(initialList: readonly T[], size?: number): T[][];
+//#endregion
+//#region src/utils/function/to.d.ts
+/**
+ * @param promise
+ * @param errorExt - 可以传递给err对象的其他信息
+ */
+declare function to<T, U = Error>(promise: Readonly<Promise<T>>, errorExt?: UnknownObject): Promise<[U, undefined] | [null, T]>;
+//#endregion
+//#region src/utils/object/cloneDeep.d.ts
+interface CloningStrategy {
+  cloneMap: <K, V>(parent: Map<K, V>, track: (newParent: Map<K, V>) => Map<K, V>, clone: <T>(value: T) => T) => Map<K, V> | null;
+  cloneSet: <T>(parent: Set<T>, track: (newParent: Set<T>) => Set<T>, clone: <T>(value: T) => T) => Set<T> | null;
+  cloneArray: <T>(parent: readonly T[], track: (newParent: T[]) => T[], clone: <T>(value: T) => T) => T[] | null;
+  cloneObject: <T extends AnyObject>(parent: T, track: (newParent: T) => T, clone: <T>(value: T) => T) => T | null;
+  cloneOther: <T>(parent: T, track: (newParent: T) => T, clone: <T>(value: T) => T) => T | null;
+}
+/**
+ * cloneDeep
+ * @reference https://github.com/radashi-org/radashi/blob/main/src/object/cloneDeep.ts
+ */
+declare function cloneDeep<T extends AnyObject>(root: T, customStrategy?: Partial<CloningStrategy>): T;
+//#endregion
+//#region src/utils/object/enumEntries.d.ts
+/**
+ * 返回枚举的属性的键/值数组
+ *
+ * @param enumeration 枚举
+ */
+declare function enumEntries<E extends AnyObject>(enumeration: NonEmptyObject<E>): [keyof E, E[keyof E]][];
+//#endregion
+//#region src/utils/object/enumKeys.d.ts
+/**
+ * 获取枚举所有属性的键
+ *
+ * @param enumeration 枚举
+ */
+declare function enumKeys<E extends AnyObject>(enumeration: NonEmptyObject<E>): [keyof E, ...(keyof E)[]];
+//#endregion
+//#region src/utils/object/enumTypeCheck.d.ts
+declare function enumTypeCheck<E extends AnyObject>(enumeration: E): E;
+//#endregion
+//#region src/utils/object/enumValues.d.ts
+/**
+ * 获取枚举所有属性的值
+ *
+ * @param enumeration 枚举
+ */
+declare function enumValues<E extends AnyObject>(enumeration: NonEmptyObject<E>): UnionToTuple<ValueOf<E>>;
+//#endregion
+//#region src/utils/object/mapEntries.d.ts
+declare function mapEntries<TKey extends PropertyKey, TValue, TNewKey extends PropertyKey, TNewValue>(obj: UnknownObject<TKey, TValue>, toEntry: (key: TKey, value: TValue) => [TNewKey, TNewValue]): UnknownObject<TNewKey, TNewValue>;
+//#endregion
+//#region src/utils/object/objectAssign.d.ts
+declare const objectAssign: typeof assign;
+//#endregion
+//#region src/utils/object/objectEntries.d.ts
+/**
+ * 返回对象的可枚举属性的键/值数组
+ *
+ * @param obj 对象
+ */
+declare function objectEntries<O extends AnyObject>(obj: O): [string & keyof O, O[keyof O]][];
+//#endregion
+//#region src/utils/object/objectKeys.d.ts
+/**
+ * 返回对象的可枚举属性和方法的名称
+ * - `Object.keys` 始终返回 `string[]` 类型，此函数可以返回具体类型
+ *
+ * @param obj 对象
+ */
+declare function objectKeys<O extends AnyObject>(obj: O): (keyof O)[];
+//#endregion
+//#region src/utils/object/objectPick.d.ts
+declare function objectPick<O extends AnyObject, K extends keyof O>(obj: O, keys: readonly K[]): Pick<O, K>;
+//#endregion
+//#region src/utils/object/objectSwitch.d.ts
+/**
+ * 对象反转
+ * - 返回交换了对象的可枚举属性的值/键对象
+ *
+ * @param obj 对象
+ */
+declare function objectSwitch<O extends AnyObject>(obj: NonEmptyObject<O>): Record<O[keyof O], keyof O>;
+//#endregion
+//#region src/utils/object/objectValues.d.ts
+/**
+ * 返回对象的可枚举属性的值数组
+ *
+ * @param obj 对象
+ */
+declare function objectValues<O extends AnyObject>(obj: O): UnionToTuple<ValueOf<O>>;
+//#endregion
+//#region src/utils/string/stringInitialCase.d.ts
+/**
+ * 首字母大小写
+ */
+declare function stringInitialCase(value: string, type: "lower" | "upper"): string;
+//#endregion
+//#region src/utils/string/stringReplace.d.ts
+declare function stringReplace<I extends string, S extends string, R extends string>(input: I, search: S, replacement: R): Replace<I, S, R>;
+//#endregion
+//#region src/utils/string/stringToJson.d.ts
+declare function stringToJson<R extends AnyObject = AnyObject, D extends R = R>(data: string | null | undefined, safeValue: D): R;
+//#endregion
+//#region src/utils/string/stringToValues.d.ts
+declare function stringToValues<T extends number | string = number>(data: string | null | undefined, valueType?: "number" | "string", splitSymbol?: string): T[];
+//#endregion
+//#region src/utils/tree/types.d.ts
+type RowKey = "id";
+type ParentIdKey = "parentId";
+type ChildrenKey = "children";
+type Strategy = "pre" | "post" | "breadth";
+interface BaseCallbackMeta<T> {
+  depth: number;
+  parents?: T[];
+}
+interface BaseOptions<T, CK extends string> {
+  childrenKey?: CK;
+  strategy?: Strategy;
+  getChildrenKey?: (row: T, meta: BaseCallbackMeta<T>) => CK | undefined;
+}
+//#endregion
+//#region src/utils/tree/treeFilter.d.ts
+type TreeFilterOptions<T extends AnyObject, CK extends string = ChildrenKey> = BaseOptions<T, CK>;
+type TreeFilterCallback<T extends AnyObject> = (row: T, meta: BaseCallbackMeta<T>) => boolean;
+declare function treeFilter<T extends AnyObject, CK extends string = ChildrenKey>(tree: T[], callback: TreeFilterCallback<T>, options?: TreeFilterOptions<T, CK>): T[];
+declare function treeFilter<T extends AnyObject, CK extends string = ChildrenKey>(tree: T, callback: TreeFilterCallback<T>, options?: TreeFilterOptions<T, CK>): T;
+//#endregion
+//#region src/utils/tree/treeFind.d.ts
+type TreeFindOptions<T extends AnyObject, CK extends string = ChildrenKey> = BaseOptions<T, CK>;
+type TreeFindCallback<T extends AnyObject> = (row: T, meta: BaseCallbackMeta<T>) => boolean;
+/**
+ * 查找树节点，找到第一个返回非空值的节点
+ */
+declare function treeFind<T extends AnyObject, CK extends string = ChildrenKey>(tree: T | T[], callback: TreeFindCallback<T>, options?: TreeFindOptions<T, CK>): T | undefined;
+//#endregion
+//#region src/utils/tree/treeForEach.d.ts
+type TreeForeachOptions<T extends AnyObject, CK extends string = ChildrenKey> = BaseOptions<T, CK>;
+type TreeForeachCallback<T extends AnyObject> = (row: T, meta: BaseCallbackMeta<T>) => void;
+declare function treeForEach<T extends AnyObject, CK extends string = ChildrenKey>(tree: T | T[], callback: TreeForeachCallback<T>, options?: TreeForeachOptions<T, CK>): void;
+//#endregion
+//#region src/utils/tree/treeMap.d.ts
+type TreeMapOptions<T extends AnyObject, CK extends string> = BaseOptions<T, CK>;
+type TreeMapCallback<R extends AnyObject, T extends AnyObject> = (row: T, meta: BaseCallbackMeta<T>) => R;
+declare function treeMap<R extends AnyObject, T extends AnyObject, CK extends string = ChildrenKey>(tree: T[], callback: TreeMapCallback<R, T>, options?: TreeMapOptions<T, CK>): TreeLike<R, CK>[];
+declare function treeMap<R extends AnyObject, T extends AnyObject, CK extends string = ChildrenKey>(tree: T, callback: TreeMapCallback<R, T>, options?: TreeMapOptions<T, CK>): TreeLike<R, CK>;
+//#endregion
+//#region src/utils/tree/rowsToTree.d.ts
+interface RowsToTreeOptions<RK extends string = RowKey, PK extends string = ParentIdKey, CK extends string = ChildrenKey> {
+  rowKey?: RK;
+  parentIdKey?: PK;
+  childrenKey?: CK;
+}
+/**
+ * 行结构 转 树结构
+ */
+declare function rowsToTree<T extends AnyObject = AnyObject, CK extends string = ChildrenKey, R = TreeLike<T, CK>, RK extends string = RowKey, PK extends string = ParentIdKey>(rows: T[], options?: RowsToTreeOptions<RK, PK, CK> | undefined): R[];
+//#endregion
+//#region src/utils/tree/treeToRows.d.ts
+type TreeToRowsOptions<T extends AnyObject, CK extends string = ChildrenKey> = TreeForeachOptions<T, CK>;
+/**
+ * 树结构 转 行结构
+ */
+declare function treeToRows<T extends AnyObject, CK extends string = ChildrenKey, R extends AnyObject = SetOptional<T, CK>>(tree: T | T[], options?: TreeToRowsOptions<T, CK>): R[];
+//#endregion
+//#region src/utils/typeof/isArray.d.ts
+declare function isArray<T extends unknown[]>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isAsyncFunction.d.ts
+declare function isAsyncFunction<T extends AsyncFunc>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isBigInt.d.ts
+declare function isBigInt<T extends bigint>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isBoolean.d.ts
+declare function isBoolean<T extends boolean>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isClass.d.ts
+declare function isClass<T extends Class<AnyObject>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isDate.d.ts
+declare function isDate<T extends Date>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isEqual.d.ts
+/**
+ * 判断给定的值是否相等
+ * @reference https://github.com/radashi-org/radashi/blob/main/src/typed/isEqual.ts
+ *
+ * @param {T} x
+ * @param {T} y
+ */
+declare function isEqual<T>(x: T, y: T): boolean;
+//#endregion
+//#region src/utils/typeof/isError.d.ts
+declare function isError<T extends Error>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isFile.d.ts
+declare function isFile<T extends File>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isFunction.d.ts
+declare function isFunction<T extends Func>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isGeneratorFunction.d.ts
+declare function isGeneratorFunction<T extends Func>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isInteger.d.ts
+declare function isInteger<T extends number>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isIterable.d.ts
+declare function isIterable<T extends Iterable<unknown>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isMap.d.ts
+declare function isMap<T extends Map<unknown, unknown>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isNull.d.ts
+declare function isNull<T extends null>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isNumber.d.ts
+declare function isNumber<T extends number>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isObject.d.ts
+declare function isObject<T extends Record<PropertyKey, unknown>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isPromise.d.ts
+declare function isPromise<T extends Promise<unknown>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isPromiseLike.d.ts
+declare function isPromiseLike<T extends PromiseLike<unknown>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isRegExp.d.ts
+declare function isRegExp<T extends RegExp>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isSet.d.ts
+declare function isSet<T extends Set<unknown>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isString.d.ts
+declare function isString<T extends string>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isSymbol.d.ts
+declare function isSymbol<T extends symbol>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isUndefined.d.ts
+declare function isUndefined<T extends undefined>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isURLSearchParams.d.ts
+declare function isURLSearchParams<T extends Window>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isWeakMap.d.ts
+declare function isWeakMap<T extends WeakMap<AnyObject, unknown>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isWeakSet.d.ts
+declare function isWeakSet<T extends WeakSet<AnyObject>>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isWebSocket.d.ts
+declare function isWebSocket<T extends WebSocket>(value: unknown): value is T;
+//#endregion
+//#region src/utils/typeof/isWindow.d.ts
+declare function isWindow<T extends Window>(value: unknown): value is T;
+//#endregion
+export { arrayCast, arrayCompete, arrayCounting, arrayDifference, arrayFirst, arrayFork, arrayIntersection, arrayLast, arrayMerge, arrayPick, arrayReplace, arraySplit, cloneDeep, enumEntries, enumKeys, enumTypeCheck, enumValues, isArray, isAsyncFunction, isBigInt, isBoolean, isClass, isDate, isEqual, isError, isFile, isFunction, isGeneratorFunction, isInteger, isIterable, isMap, isNull, isNumber, isObject, isPromise, isPromiseLike, isRegExp, isSet, isString, isSymbol, isURLSearchParams, isUndefined, isWeakMap, isWeakSet, isWebSocket, isWindow, mapEntries, objectAssign, objectEntries, objectKeys, objectPick, objectSwitch, objectValues, rowsToTree, stringInitialCase, stringReplace, stringToJson, stringToValues, to, treeFilter, treeFind, treeForEach, treeMap, treeToRows };