typedoc/dist/lib/utils/general.d.ts

Create api documentation for TypeScript projects.

/**
 * This type provides a flag that can be used to turn off more lax overloads intended for
 * plugin use only to catch type errors in the TypeDoc codebase. The prepublishOnly npm
 * script will be used to switch this flag to false when publishing, then immediately back
 * to true after a successful publish.
 */
type InternalOnly = false;
/**
 * Helper type to convert `T` to `F` if compiling TypeDoc with stricter types.
 *
 * Can be used in overloads to map a parameter type to `never`. For example, the
 * following function will work with any string argument, but to improve the type safety
 * of internal code, we only ever want to pass 'a' or 'b' to it. Plugins on the other
 * hand need to be able to pass any string to it. Overloads similar to this are used
 * in the {@link Options} class.
 *
 * This is also used to prevent TypeDoc code from using deprecated methods which will
 * be removed in a future release.
 *
 * ```ts
 * function over(flag: 'a' | 'b'): string
 * // deprecated
 * function over(flag: IfInternal<never, string>): string
 * function over(flag: string): string { return flag }
 * ```
 */
export type IfInternal<T, F> = InternalOnly extends true ? T : F;
/**
 * Helper type to convert `T` to `never` if compiling TypeDoc with stricter types.
 *
 * See {@link IfInternal} for the rationale.
 */
export type NeverIfInternal<T> = IfInternal<never, T>;
/**
 * Resolves a string type into a union of characters, `"ab"` turns into `"a" | "b"`.
 */
export type Chars<T extends string> = T extends `${infer C}${infer R}` ? C | Chars<R> : never;
/**
 * Utility to help type checking ensure that there is no uncovered case.
 */
export declare function assertNever(x: never): never;
export declare function escapeRegExp(s: string): string;
export declare function editDistance(s: string, t: string): number;
export declare function getSimilarValues(values: Iterable<string>, compareTo: string): string[];
export declare function NonEnumerable(_cls: unknown, context: ClassFieldDecoratorContext): void;
export declare const TYPEDOC_ROOT: string;
export declare function hasBeenLoadedMultipleTimes(): boolean;
export declare function getLoadedPaths(): string[];
export {};