Type Alias ExternalSymbolResolver

Type Declaration

• • (
        ref: DeclarationReference,
        refl: Reflection,
        part: Readonly<CommentDisplayPart> | undefined,
        symbolId: ReflectionSymbolId | undefined,
    ): ExternalResolveResult | string | undefined

  • Parameters

    • ref: DeclarationReference

      Parsed declaration reference to resolve. This may be created automatically for some symbol, or parsed from user input.

    • refl: Reflection

      Reflection that contains the resolved link

    • part: Readonly<CommentDisplayPart> | undefined

      If the declaration reference was created from a comment, the originating part.

    • symbolId: ReflectionSymbolId | undefined

      If the declaration reference was created from a symbol, or useTsLinkResolution is turned on and TypeScript resolved the link to some symbol, the ID of that symbol.

    Returns ExternalResolveResult | string | undefined