Skip to main content

link

API_GROUPS​

const API_GROUPS: Required<ApiGroupOverrideType>;

Defined in​

link.ts:46

getCategoryLocale()​

function getCategoryLocale(type): Maybe<TypeLocale>

Parameters​

type​

unknown

Returns​

Maybe<TypeLocale>

Defined in​

link.ts:84

getLinkApiGroupFolder()​

function getLinkApiGroupFolder(type, groups?): string

Parameters​

type​

unknown

groups?​

Maybe<boolean | ApiGroupOverrideType>

Returns​

string

Defined in​

link.ts:144

getLinkCategoryFolder()​

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

Parameters​

type​

unknown

operationLocale?​

Maybe<TypeLocale>

Returns​

Maybe<string>

Defined in​

link.ts:106

getLinkDeprecatedFolder()​

function getLinkDeprecatedFolder(type, option): string

Parameters​

type​

unknown

option​

Maybe<TypeDeprecatedOption>

Returns​

string

Defined in​

link.ts:155

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

Parameters​

category​

Maybe<TypeLocale>

type​

unknown

options​

PrintLinkOptions

Returns​

Maybe<TypeLink>

Defined in​

link.ts:232

hasOptionParentType()​

function hasOptionParentType(options): boolean

Parameters​

options​

PrintLinkOptions

Returns​

boolean

Defined in​

link.ts:135

hasOptionWithAttributes()​

function hasOptionWithAttributes(options): boolean

Parameters​

options​

PrintLinkOptions

Returns​

boolean

Defined in​

link.ts:131

hasPrintableDirective()​

function hasPrintableDirective(type, options?): boolean

Parameters​

type​

unknown

options?​

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

Returns​

boolean

Defined in​

link.ts:51

function printLink(type, options): string

Parameters​

type​

unknown

options​

PrintLinkOptions

Returns​

string

Defined in​

link.ts:275

printLinkAttributes()​

function printLinkAttributes(type, text): string

Parameters​

type​

unknown

text​

Maybe<string> = ""

Returns​

string

Defined in​

link.ts:248

function printParentLink(type, options): string | MDXString

Parameters​

type​

unknown

options​

PrintLinkOptions

Returns​

string | MDXString

Defined in​

link.ts:299

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

Parameters​

type​

unknown

name​

string

operation​

Maybe<TypeLocale>

options​

PrintLinkOptions

Returns​

TypeLink

Defined in​

link.ts:169