Skip to main content

common

formatDescription()​

function formatDescription(type, replacement): string | MDXString

Parameters​

• type: unknown

• replacement: Maybe<string> = NO_DESCRIPTION_TEXT

Returns​

string | MDXString

Defined in​

common.ts:56

hasPrintableDirective()​

function hasPrintableDirective(type, options?): boolean

Parameters​

• type: unknown

• options?: Pick<PrintTypeOptions, "deprecated" | "onlyDocDirectives" | "skipDocDirectives">

Returns​

boolean

Defined in​

common.ts:107

printCustomDirectives()​

function printCustomDirectives(type, options?): string

Parameters​

• type: unknown

• options?: PrintTypeOptions

Returns​

string

Defined in​

common.ts:23

printDeprecation()​

function printDeprecation(type): string

Parameters​

• type: unknown

Returns​

string

Defined in​

common.ts:83

printDescription()​

function printDescription(
   type, 
   options?, 
   noText?): string | MDXString

Parameters​

• type: unknown

• options?: PrintTypeOptions

• noText?: string

Returns​

string | MDXString

Defined in​

common.ts:96

printWarning()​

function printWarning(text?, title?): string

Parameters​

• text?: string

• title?: string

Returns​

string

Defined in​

common.ts:71