Type alias ExternalSymbolResolver

ExternalSymbolResolver: ((ref, refl, part, symbolId) => ExternalResolveResult | string | undefined)

Type declaration

    • (ref, refl, part, symbolId): 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: Models.Reflection

        Reflection that contains the resolved link

      • part: Readonly<Models.CommentDisplayPart> | undefined

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

      • symbolId: Models.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

Generated using TypeDoc