Options
All
  • Public
  • Public/Protected
  • All
Menu

TypeDoc Documentation - v0.22.15

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

DeclarationOption

DeclarationOption: StringDeclarationOption | NumberDeclarationOption | BooleanDeclarationOption | MixedDeclarationOption | MapDeclarationOption<unknown> | ArrayDeclarationOption | FlagsDeclarationOption<Record<string, boolean>>

DeclarationOptionToOptionType

DeclarationOptionToOptionType<T>: T extends MapDeclarationOption<infer U> ? U : T extends FlagsDeclarationOption<infer U> ? U : ParameterTypeToOptionTypeMap[Exclude<T["type"], undefined>]

Type parameters

KeyToDeclaration

KeyToDeclaration<K>: TypeDocOptionMap[K] extends boolean ? BooleanDeclarationOption : TypeDocOptionMap[K] extends string ? StringDeclarationOption : TypeDocOptionMap[K] extends number ? NumberDeclarationOption : TypeDocOptionMap[K] extends string[] ? ArrayDeclarationOption : unknown extends TypeDocOptionMap[K] ? MixedDeclarationOption : TypeDocOptionMap[K] extends Record<string, boolean> ? FlagsDeclarationOption<TypeDocOptionMap[K]> : TypeDocOptionMap[K] extends Record<string | number, infer U> ? MapDeclarationOption<U> : never

Converts a given TypeDoc option key to the type of the declaration expected.

Type parameters

RenderTemplate

RenderTemplate<T>: (data: T) => Element | string

Type parameters

  • T

Type declaration

SomeType

SomeType: TypeKindMap[keyof TypeKindMap]

SortStrategy

SortStrategy: typeof SORT_STRATEGIES[number]

TypeDocOptionValues

TypeDocOptionValues: { [ K in keyof TypeDocOptionMap]: unknown extends TypeDocOptionMap[K] ? unknown : TypeDocOptionMap[K] extends string | string[] | number | boolean | Record<string, boolean> ? TypeDocOptionMap[K] : TypeDocOptionMap[K][keyof TypeDocOptionMap[K]] }

Describes all TypeDoc specific options as returned by Options.getValue, this is slightly more restrictive than the TypeDocOptions since it does not allow both keys and values for mapped option types, and does nto allow partials of flag values.

TypeDocOptions

TypeDocOptions: { [ K in keyof TypeDocOptionMap]: unknown extends TypeDocOptionMap[K] ? unknown : TypeDocOptionMap[K] extends string | string[] | number | boolean ? TypeDocOptionMap[K] : TypeDocOptionMap[K] extends Record<string, boolean> ? Partial<TypeDocOptionMap[K]> | boolean : keyof TypeDocOptionMap[K] | TypeDocOptionMap[K][keyof TypeDocOptionMap[K]] }

An interface describing all TypeDoc specific options. Generated from a map which contains more information about each option for better types when defining said options.

TypeKind

TypeKind: keyof TypeKindMap

TypeVisitor

TypeVisitor<T>: { [ K in TypeKind]: (type: TypeKindMap[K]) => T }

Type parameters

  • T = void

ValidationOptions

ValidationOptions: { invalidLink: boolean; notDocumented: boolean; notExported: boolean }

Type declaration

  • invalidLink: boolean

    If set, TypeDoc will produce warnings about {&link} tags which will produce broken links.

  • notDocumented: boolean

    If set, TypeDoc will produce warnings about declarations that do not have doc comments

  • notExported: boolean

    If set, TypeDoc will produce warnings when a symbol is referenced by the documentation, but is not included in the documentation.

Functions

BindOption

  • Binds an option to the given property. Does not register the option.

    since

    v0.16.3

    Type parameters

    Parameters

    • name: K

    Returns <IK>(target: ({ application: Application } | { options: Options }) & { [ K2 in IK]: TypeDocOptionValues[K] }, key: IK) => void

  • Binds an option to the given property. Does not register the option.

    since

    v0.16.3

    privateremarks

    This overload is intended for plugin use only with looser type checks. Do not use internally.

    Parameters

    • name: string

    Returns (target: { application: Application } | { options: Options }, key: PropertyKey) => void

      • Binds an option to the given property. Does not register the option.

        since

        v0.16.3

        privateremarks

        This overload is intended for plugin use only with looser type checks. Do not use internally.

        Parameters

        Returns void

makeRecursiveVisitor

normalizePath

  • normalizePath(path: string): string

  • Normalize the given path.

    Parameters

    • path: string

      The path that should be normalized.

    Returns string

    The normalized path.

resetReflectionID

  • resetReflectionID(): void

splitUnquotedString

  • splitUnquotedString(input: string, delimiter: string): string[]

Generated using TypeDoc