obsidian-dev-utils/dist/lib/esm/Type.d.mts

This is the collection of useful functions that you can use for your Obsidian plugin development

/**
 * @packageDocumentation
 *
 * Type utilities.
 */
/**
 * A type that represents a return value that may be `void`.
 *
 * @typeParam T - The type of the value that may be returned.
 */
export type MaybeReturn<T> = T | void;
/**
 * A type that represents the values of an object.
 *
 * @typeParam T - The type of the object.
 */
export type PropertyValues<T extends object> = T[StringKeys<T>];
/**
 * A type that represents the keys of an object as strings.
 *
 * @typeParam T - The type of the object.
 */
export type StringKeys<T extends object> = Extract<keyof T, string>;
type ExactKeys<Type extends object, Keys extends readonly string[]> = Exclude<Keys[number], keyof Type> extends never ? Exclude<keyof Type, Keys[number]> extends never ? Keys : `ERROR: Missing keys: ${TupleToString<UnionToTuple<Exclude<keyof Type, Keys[number]> & string>>}` : `ERROR: Invalid keys: ${TupleToString<UnionToTuple<Exclude<Keys[number], keyof Type> & string>>}`;
type LastInUnion<Union> = UnionToIntersection<Union extends unknown ? () => Union : never> extends () => infer Last ? Last : never;
type TupleToString<Tuple extends readonly unknown[]> = Tuple extends readonly [infer First, ...infer Rest] ? First extends string ? Rest extends readonly unknown[] ? Rest['length'] extends 0 ? First : `${First},${TupleToString<Rest>}` : never : never : '';
type UnionToIntersection<Union> = (Union extends unknown ? (key: Union) => void : never) extends (key: infer Intersection) => void ? Intersection : never;
type UnionToTuple<Union, Last = LastInUnion<Union>> = [Union] extends [never] ? [] : [...UnionToTuple<Exclude<Union, Last>>, Last];
/**
 * Asserts that all keys of a type are present in a list of keys.
 *
 * @typeParam Type - The type to assert the keys of.
 * @typeParam Keys - The list of keys to assert.
 * @param _type - The type to assert the keys of.
 * @param keys - The list of keys to assert.
 * @returns The list of keys.
 *
 * @remarks If the incorrect keys are provided, the function has a compile-time error.
 */
export declare function assertAllTypeKeys<Type extends object, const Keys extends readonly string[]>(_type: Type, keys: ExactKeys<Type, Keys>): readonly (keyof Type)[];
/**
 * Converts a type to a dummy parameter.
 *
 * @typeParam T - The type to convert.
 * @returns A dummy parameter of the type.
 *
 * @remarks The result should be used only for type inference. The value should not be used directly.
 */
export declare function typeToDummyParam<T>(): T;
export {};