-
-
Notifications
You must be signed in to change notification settings - Fork 745
Closed
Milestone
Description
Search terms
externalSymbolLinkMappings to TypeScript resolved link
Expected Behavior
Given the following, TypeDoc should produce a link to example.com, and not produce any warnings.
import * as random from "@pulumi/random";
/**
* Blah blah {@link random.RandomPassword}.
*/
export function someFunction() {}
Config:
/** @type {Partial<import('typedoc').TypeDocOptions>} */
const config = {
...,
externalSymbolLinkMappings: {
"@pulumi/random": {
"*": "https://example.com"
}
},
};
export default config;
Actual Behavior
TypeDoc produces a warning:
[warning] Failed to resolve link to "random.RandomPassword" in comment for someFunction
Environment
- Typedoc version: 0.26.8
- TypeScript version: any
- Node.js version: any
- OS: any