nhb-toolbox/dist/dts/types/index.d.ts

A versatile collection of smart, efficient, and reusable utility functions and classes for everyday development needs.

import type { Chronos } from '../date/Chronos';
import type { DateLike } from '../date/types';
/** Uncontrolled any to use for edge cases */
export type Any = any;
declare const __brand: unique symbol;
type Brand<B> = {
    [__brand]: B;
};
/** Create a branded type. */
export type Branded<T, B> = T & Brand<B>;
/** Utility type to flatten Partial type */
export type FlattenPartial<T> = Partial<{
    [K in keyof T]: T[K];
}>;
/** Union of `number` and numeric string */
export type Numeric = number | `${number}`;
/** Union of All Primitive Types (i.e. `string | number | boolean | symbol | bigint | null | undefined`) */
export type Primitive = string | number | boolean | symbol | bigint | null | undefined;
/** Union of Normal Primitive Types (i.e. `string | number | boolean | null | undefined`) */
export type NormalPrimitive = string | number | boolean | null | undefined;
/** Extract normal primitive key(s) (i.e. `string | number | boolean | null | undefined`) from an object */
export type NormalPrimitiveKey<T> = {
    [K in keyof T]: T[K] extends NormalPrimitive ? K : never;
}[keyof T];
/**
 * * Keys of an object that are part of the object type itself.
 * This excludes keys that are inherited from the prototype chain.
 * This type is useful for extracting keys that are part of the object's own properties.
 * It is used in the `OwnKeys` type to filter out keys that are not part of the object properties.
 */
export type OwnKeys<T> = {
    [K in keyof T]: {} extends Pick<T, K> ? never : K;
}[keyof T];
/** Extract primitive (string, number or boolean) key(s) from an object */
export type NonNullishPrimitiveKey<T> = {
    [K in keyof T]: T[K] extends string | number | boolean ? K : never;
}[keyof T];
/** Falsy primitive type  */
export type FalsyPrimitive = false | 0 | '' | null | undefined;
/** A generic class constructor */
export type Constructor = new (...args: any[]) => unknown;
/** Generic function type */
export type GenericFn = (...args: unknown[]) => unknown;
/** Generic function type that returns `void` */
export type VoidFunction = (...args: any[]) => void;
/** Debounced function type after certain delay */
export type DelayedFn<T extends VoidFunction> = (...args: Parameters<T>) => void;
/** Throttled function type after specific delay */
export type ThrottledFn<T extends VoidFunction> = (...args: Parameters<T>) => void;
/** Asynchronous function type */
export type AsyncFunction<T> = (...args: unknown[]) => Promise<T>;
/** Advanced types to exclude from counting as object key */
export type AdvancedTypes = Array<unknown> | File | FileList | Chronos | DateLike | Blob | Date | RegExp | WeakMap<WeakKey, unknown> | WeakSet<WeakKey> | Map<unknown, unknown> | Set<unknown> | Function | GenericFn | VoidFunction | AsyncFunction<unknown> | Promise<unknown> | Error | EvalError | RangeError | ReferenceError | SyntaxError | TypeError | URIError | bigint | symbol;
/** Helper to detect if a type has methods */
export type HasMethods<T> = {
    [K in keyof T]: T[K] extends Function ? true : never;
}[keyof T] extends never ? false : true;
/** * Represents detailed information about a class's methods. */
export interface ClassDetails {
    /** * List of instance method names defined directly on the class prototype. */
    instanceMethods: string[];
    /** * List of static method names defined directly on the class constructor. */
    staticMethods: string[];
    /** * List of instance getter names defined directly on the class prototype. */
    instanceGetters: string[];
    /** * List of static getter names defined directly on the class constructor. */
    staticGetters: string[];
    /** * Number of instance methods. */
    instanceCount: number;
    /** * Number of static methods. */
    staticCount: number;
    /** * Total number of instance and static getters combined. */
    totalGetters: number;
    /** * Total number of instance and static methods combined. */
    totalMethods: number;
}
/** Literal type for `partial` and `required` */
export type PartialOrRequired = 'partial' | 'required';
export {};
//# sourceMappingURL=index.d.ts.map