Skip to main content

printer

Printer​

Implements​

  • IPrinter

Constructors​

new Printer()​

new Printer(): Printer
Returns​

Printer

Properties​

options​

static options: Readonly<Maybe<PrintTypeOptions>>;
Defined in​

printer.ts:66

printCustomDirectives()​

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

• type: unknown

• options: PrintTypeOptions

Returns​

string

Defined in​

printer.ts:70

printCustomTags()​

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

• type: unknown

• options: PrintTypeOptions

Returns​

string | MDXString

Defined in​

printer.ts:72

printDescription()​

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

• type: unknown

• options?: PrintTypeOptions

• noText?: string

Returns​

string | MDXString

Defined in​

printer.ts:68

Methods​

init()​

static init(
   schema, 
   baseURL, 
   linkRoot, 
   __namedParameters): void
Parameters​

• schema: Maybe<GraphQLSchema>

• baseURL: Maybe<string> = "schema"

• linkRoot: Maybe<string> = "/"

• __namedParameters = ...

• __namedParameters.customDirectives?: CustomDirectiveMap

• __namedParameters.deprecated?: TypeDeprecatedOption

• __namedParameters.groups?: Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>

• __namedParameters.metatags?: Record<string, string>[]

• __namedParameters.onlyDocDirectives?: GraphQLDirective[]

• __namedParameters.printTypeOptions?: PrinterConfigPrintTypeOptions

• __namedParameters.skipDocDirectives?: GraphQLDirective[]

Returns​

void

Defined in​

printer.ts:74

printCode()​

readonly static printCode(type, options): string
Parameters​

• type: unknown

• options: PrintTypeOptions

Returns​

string

Defined in​

printer.ts:141

printExample()​

readonly static printExample(type, options): string
Parameters​

• type: unknown

• options: PrintTypeOptions

Returns​

string

Defined in​

printer.ts:186

printHeader()​

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

• id: string

• title: string

• options: PrintTypeOptions

Returns​

string

Defined in​

printer.ts:131

printMetaTags()​

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

• _type: unknown

• __namedParameters: PrintTypeOptions

Returns​

string | MDXString

Defined in​

printer.ts:246

printRelations()​

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

• type: unknown

• options: PrintTypeOptions

Returns​

string | MDXString

Defined in​

printer.ts:236

printType()​

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

• name: Maybe<string>

• type: unknown

• options?: Maybe<Partial<PrintTypeOptions>>

Returns​

Maybe<MDXString>

Defined in​

printer.ts:265

printTypeMetadata()​

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

• type: unknown

• options: PrintTypeOptions

Returns​

string | MDXString

Defined in​

printer.ts:207