Skip to main content

printer

Printer​

Defined in: printer.ts:68

Implements​

  • IPrinter

Constructors​

new Printer()​

new Printer(): Printer
Returns​

Printer

Properties​

options​

static options: Readonly<Maybe<PrintTypeOptions>>;

Defined in: printer.ts:69

printCustomDirectives()​

readonly static printCustomDirectives: (type, options) => string;

Defined in: printer.ts:73

Parameters​
type​

unknown

options​

PrintTypeOptions

Returns​

string

printCustomTags()​

readonly static printCustomTags: (type, options) => string | MDXString;

Defined in: printer.ts:75

Parameters​
type​

unknown

options​

PrintTypeOptions

Returns​

string | MDXString

printDescription()​

readonly static printDescription: (type, options, noText?) => string | MDXString;

Defined in: printer.ts:71

Parameters​
type​

unknown

options​

PrintTypeOptions

noText?​

string

Returns​

string | MDXString

printMDXModule​

static printMDXModule: Readonly<MDXSupportType>;

Defined in: printer.ts:77

Methods​

init()​

static init(
   schema, 
   baseURL, 
   linkRoot, 
   __namedParameters, 
mdxParser?): Promise<void>

Defined in: printer.ts:79

Parameters​
schema​

Maybe<GraphQLSchema>

baseURL​

Maybe<string> = "schema"

linkRoot​

Maybe<string> = "/"

__namedParameters​
customDirectives?​

CustomDirectiveMap

deprecated?​

TypeDeprecatedOption

groups?​

Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>

meta?​

Maybe<MetaOptions>

metatags?​

Record<string, string>[]

onlyDocDirectives?​

GraphQLDirective[]

printTypeOptions?​

PrinterConfigPrintTypeOptions

skipDocDirectives?​

GraphQLDirective[]

mdxParser?​

Record<string, unknown>

Returns​

Promise<void>

printCode()​

readonly static printCode(type, options): string

Defined in: printer.ts:156

Parameters​
type​

unknown

options​

PrintTypeOptions

Returns​

string

printExample()​

readonly static printExample(type, options): string

Defined in: printer.ts:201

Parameters​
type​

unknown

options​

PrintTypeOptions

Returns​

string

printHeader()​

readonly static printHeader(
   id, 
   title, 
   options): string

Defined in: printer.ts:142

Parameters​
id​

string

title​

string

options​

PrintTypeOptions

Returns​

string

printMetaTags()​

readonly static printMetaTags(_type, __namedParameters): string | MDXString

Defined in: printer.ts:261

Parameters​
_type​

unknown

__namedParameters​

PrintTypeOptions

Returns​

string | MDXString

printRelations()​

readonly static printRelations(type, options): string | MDXString

Defined in: printer.ts:251

Parameters​
type​

unknown

options​

PrintTypeOptions

Returns​

string | MDXString

printType()​

readonly static printType(
   name, 
   type, 
options?): Maybe<MDXString>

Defined in: printer.ts:280

Parameters​
name​

Maybe<string>

type​

unknown

options?​

Maybe<Partial<PrintTypeOptions>>

Returns​

Maybe<MDXString>

printTypeMetadata()​

readonly static printTypeMetadata(type, options): string | MDXString

Defined in: printer.ts:222

Parameters​
type​

unknown

options​

PrintTypeOptions

Returns​

string | MDXString