ut2/types/internals/types.d.ts

一个现代 JavaScript 实用工具库。[点击查看在线文档]。

export type FunctionAny = (...args: any[]) => any;
export type SyncFn<P extends any[], R> = (...args: P) => R;
export type AsyncFn<P extends any[], R> = (...args: P) => Promise<R>;
export type SingleSyncFn<R> = () => R;
export type SingleAsyncFn<R> = () => Promise<R>;
export type TPath = string | symbol | number;
/**
 * 工具辅助类型
 */
export type Many<T> = T | T[];
export type WithNullable<T> = T | null | undefined;
export type PropertyName = string | number | symbol;
export type ObjectPredicate<T extends object, K extends keyof T = keyof T> = (value: T[K], key: K) => boolean;
export type MapValue<T extends Map<any, any>> = ReturnType<T['get']>;
export type MapKey<T extends Map<any, any>> = Parameters<T['get']>[0];
export type MapPredicate<T extends Map<any, any>> = (value: MapValue<T>, key: MapKey<T>) => boolean;
/**
 * 迭代参数
 */
export type IterateeParam<T> = ((value: T, ...args: any[]) => any) | PropertyName;
/**
 * 迭代方法
 */
export type StringIterator<R> = (char: string, index: number, string: string) => R;
export type ArrayIterator<T, R> = (item: T, index: number, list: T[]) => R;
export type ArrayLikeIterator<T, R> = (item: T, index: number, list: ArrayLike<T>) => R;
export type ObjectIterator<T, R> = (value: T[keyof T], key: keyof T, object: T) => R;
export type ReduceStringIterator<R> = (accumulator: R, currentValue: string, currentIndex: number, string: string) => R;
export type ReduceArrayIterator<T, R> = (accumulator: R, currentValue: T, currentIndex: number, list: T[]) => R;
export type ReduceArrayLikeIterator<T, R> = (accumulator: R, currentValue: T, currentIndex: number, list: ArrayLike<T>) => R;
export type ReduceObjectIterator<T, R> = (accumulator: R, currentValue: T[keyof T], currentKey: string, object: T) => R;
/**
 * 集合类数组
 */
export type CollectionList<T> = WithNullable<ArrayLike<T>>;
/**
 * 集合对象
 */
export type CollectionObject<T extends object> = WithNullable<T>;
/**
 * max、min方法
 */
export interface ExtremumFunction {
    <T extends object>(array: WithNullable<T[]>, iteratee?: ArrayIterator<T, any> | keyof T): T | undefined;
    <T>(array: WithNullable<T[]>, iteratee?: ArrayIterator<T, any> | PropertyName): T | undefined;
}