Skip to main content

common

formatDescription()​

function formatDescription(type, replacement): string | MDXString

Defined in: common.ts:50

Parameters​

type​

unknown

replacement​

Maybe<string> = NO_DESCRIPTION_TEXT

Returns​

string | MDXString

printCustomDirectives()​

function printCustomDirectives(type, options?): string

Defined in: common.ts:17

Parameters​

type​

unknown

options?​

PrintTypeOptions

Returns​

string

printDeprecation()​

function printDeprecation(type, options?): string

Defined in: common.ts:85

Parameters​

type​

unknown

options?​

PrintTypeOptions

Returns​

string

printDescription()​

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

Defined in: common.ts:101

Parameters​

type​

unknown

options?​

PrintTypeOptions

noText?​

string

Returns​

string | MDXString

printWarning()​

function printWarning(
   text?, 
   title?, 
   options?): string

Defined in: common.ts:65

Parameters​

text?​

string

title?​

string

options?​

PrintTypeOptions

Returns​

string