Function shortLink

shortLink(
    name: string,
    hierarchy: readonly TypeElementInSource[],
    codeStyle?: boolean,
    realNameWrapper?: string,
    fuzzy?: boolean,
    type?: TypeElementKind,
): string
Create a short link to a type in the documentation. If you create a wiki, please refer to the functions provided by the GeneralDocContext.
Parameters
- name: string
  The name of the type, e.g. MyType, may include a container, e.g.,MyContainer::MyType (this works with function nestings too) Use ::: if you want to access a scoped function, but the name should be displayed without the scope
- hierarchy: readonly TypeElementInSource[]
  The hierarchy of types to search in
- codeStyle: boolean = true
  Whether to use code style for the link
- realNameWrapper: string = 'b'
  How to highlight the function in name in the x::y format?
- Optionalfuzzy: boolean
  Whether to use fuzzy matching when searching for the type
- Optionaltype: TypeElementKind
  Optionally restrict to a certain type of element
Returns string
- Defined in src/documentation/doc-util/doc-types.ts:692