Skip to content

Link is generated for external symbol if set to link to "#" in externalSymbolLinkMappings #2921

@dev7355608

Description

@dev7355608

Search terms

externalSymbolLinkMappings

Expected Behavior

https://typedoc.org/documents/Options.Comments.html#externalsymbollinkmappings:

The string "#" may also be specified to indicate to TypeDoc that the type should be marked as resolved but no link should be created.

No link is generated if link is set of "#" in externalSymbolLinkMappings.

Actual Behavior

A link is generated.

<a href="#">!Promise</a>

Steps to reproduce the bug

// typedoc.json
{
    "externalSymbolLinkMappings": {
        // used by {@link !Promise}
        "global": {
            "Promise": "#"
        }
    }
}

Environment

  • Typedoc version: 0.27.9
  • TypeScript version:
  • Node.js version: v22.12.0
  • OS: Windows 11

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions