@newdash/newdash/types.d.ts

javascript/typescript utility library

/**
 * possible values of `typeof object`
 */
export type JSType = "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
export type AdvancedType = "async_function" | "date";
/**
 * @internal
 */
export type PromiseExecutor<T = any> = (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void;
export type Predicate<T> = (value?: T, index?: any, collection?: any) => boolean;
/**
 * Convert Array To Tuple (with order)
 *
 * @private
 * @internal
 * @ignore
 */
export type Tuple<T extends Array<any>> = {
    [K in keyof T]: T[K];
};
/**
 * Convert values of object to array
 */
export type Values<T> = Array<T[keyof T]>;
/**
 * @ignore
 */
export type Collection<T = any> = Array<T> | Record<string, T>;
/**
 * @ignore
 */
export type PlainObject<T = any> = Record<string, T>;
/**
 * @ignore
 */
interface Iteratee<T, R> {
    (value?: T, key?: number, ref?: Array<T>): R;
    (value?: T, key?: string, ref?: Record<string, T>): R;
}
/**
 * @ignore
 */
interface AccumulatorIteratee<T, R> {
    (accumulator?: R, value?: T, key?: number): R | void;
    (accumulator?: R, value?: T, key?: string): R | void;
}
/**
 * @ignore
 * @template T item type
 * @template R return type
 */
export type CollectionIteratee<T = any, R = any> = Iteratee<T, R>;
/**
 * @ignore
 */
export type ArrayIteratee<T, R = any> = (value?: T, key?: number, ref?: Array<T>) => R;
/**
 * @ignore
 */
export type RecordIteratee<T, R = any> = (value?: T, key?: string, ref?: Record<string, T>) => R;
/**
 * @ignore
 */
export type AccCollectionIteratee<T = any, R = any> = AccumulatorIteratee<T, R>;
/**
 * @ignore
 */
export type KeyIteratee = string | number;
/**
 * @ignore
 */
export type Entry<T = any> = [string, T];
/**
 * @ignore
 */
export type ArrayAble<T> = T | Array<T>;
/**
 * @ignore
 */
type NumPath = number;
/**
 * @ignore
 */
type StringPath = string;
/**
 * @ignore
 */
type ArrayPath = ArrayAble<StringPath | NumPath>;
/**
 * path type
 *
 * @ignore
 */
export type Path = ArrayPath;
/**
 * comparator
 * @ignore
 */
export interface Comparator<T = any> {
    (v1?: T, v2?: T): boolean;
}
/**
 * Unwrap Promise Generic Type
 */
export type UnwrapPromise<T> = T extends PromiseLike<infer U> ? U : T;
/**
 * first element type of array types
 */
export type FirstElement<T extends ArrayLike<any>> = T extends [infer U, ...any[]] ? U : any;
/**
 * general function in typescript
 */
export type GeneralFunction<Args extends any[] = any[], ReturnType extends any = any> = (...args: Args) => ReturnType;
/**
 * keys of object
 */
export type Keys<T> = keyof T;
/**
 * Same as Partial<T> but goes deeper and makes Partial<T> all its properties and sub-properties.
 */
export type DeepPartial<T> = {
    [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]>;
};
/**
 * Partial Object
 */
export type Partial<T> = {
    [P in keyof T]?: T[P];
};
/**
 * optional version of Parameters
 */
export type OptionalParameters<T extends Function> = T extends (...args: infer P) => any ? {
    [K in keyof P]?: P[K];
} : never;
/**
 * Class constructor
 */
export type Class<T = any> = new (...args: any[]) => T;
/**
 * async function
 */
export type AsyncFunction<P extends any[] = any[], R = any> = (...args: P) => Promise<R>;
/**
 * return type of function
 */
export type ReturnType<T> = T extends (...args: any) => infer R ? R : any;
type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
export type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends () => (infer R) ? R : never;
export type Push<T extends any[], V> = [...T, V];
export type TupleUnion<T, L = LastOf<T>, N = [T] extends [never] ? true : false> = true extends N ? [] : Push<TupleUnion<Exclude<T, L>>, L>;
export {};