Skip to main content

link

API_GROUPS​

const API_GROUPS: Required<ApiGroupOverrideType>;

Defined in: link.ts:46

getCategoryLocale()​

function getCategoryLocale(type): Maybe<TypeLocale>

Defined in: link.ts:84

Parameters​

type​

unknown

Returns​

Maybe<TypeLocale>

getLinkApiGroupFolder()​

function getLinkApiGroupFolder(type, groups?): string

Defined in: link.ts:144

Parameters​

type​

unknown

groups?​

Maybe<boolean | ApiGroupOverrideType>

Returns​

string

getLinkCategoryFolder()​

function getLinkCategoryFolder(type, operationLocale?): Maybe<string>

Defined in: link.ts:106

Parameters​

type​

unknown

operationLocale?​

Maybe<TypeLocale>

Returns​

Maybe<string>

getLinkDeprecatedFolder()​

function getLinkDeprecatedFolder(type, option): string

Defined in: link.ts:155

Parameters​

type​

unknown

option​

Maybe<TypeDeprecatedOption>

Returns​

string

function getRelationLink(
   category, 
   type, 
options): Maybe<TypeLink>

Defined in: link.ts:232

Parameters​

category​

Maybe<TypeLocale>

type​

unknown

options​

PrintLinkOptions

Returns​

Maybe<TypeLink>

hasOptionParentType()​

function hasOptionParentType(options): boolean

Defined in: link.ts:135

Parameters​

options​

PrintLinkOptions

Returns​

boolean

hasOptionWithAttributes()​

function hasOptionWithAttributes(options): boolean

Defined in: link.ts:131

Parameters​

options​

PrintLinkOptions

Returns​

boolean

hasPrintableDirective()​

function hasPrintableDirective(type, options?): boolean

Defined in: link.ts:51

Parameters​

type​

unknown

options?​

Pick<PrintTypeOptions, "deprecated" | "onlyDocDirectives" | "skipDocDirectives">

Returns​

boolean

function printLink(type, options): string

Defined in: link.ts:275

Parameters​

type​

unknown

options​

PrintLinkOptions

Returns​

string

printLinkAttributes()​

function printLinkAttributes(type, text): string

Defined in: link.ts:248

Parameters​

type​

unknown

text​

Maybe<string> = ""

Returns​

string

function printParentLink(type, options): string | MDXString

Defined in: link.ts:299

Parameters​

type​

unknown

options​

PrintLinkOptions

Returns​

string | MDXString

function toLink(
   type, 
   name, 
   operation, 
   options): TypeLink

Defined in: link.ts:169

Parameters​

type​

unknown

name​

string

operation​

Maybe<TypeLocale>

options​

PrintLinkOptions

Returns​

TypeLink