Skip to main content

common

Common printer utility functions for handling descriptions, directives, and warnings.

formatDescription()​

function formatDescription(type, replacement): string | MDXString

Defined in: common.ts:68

Formats a GraphQL type description or falls back to a default message.

Parameters​

type​

unknown

GraphQL type to get description from

replacement​

Maybe<string> = NO_DESCRIPTION_TEXT

Optional fallback text if no description exists

Returns​

string | MDXString

Formatted description string or MDX content

printCustomDirectives()​

function printCustomDirectives(type, options?): string

Defined in: common.ts:28

Prints documentation for custom directives applied to a type.

Parameters​

type​

unknown

GraphQL type to get directives from

options?​

PrintTypeOptions

Printer configuration options

Returns​

string

Formatted directive documentation string

printDeprecation()​

function printDeprecation(type, options): string

Defined in: common.ts:112

Prints deprecation information for a GraphQL type if it is deprecated.

Parameters​

type​

unknown

The GraphQL type to check for deprecation

options​

PrintTypeOptions

Configuration options for printing

Returns​

string

Formatted deprecation warning as MDX string, or empty string if not deprecated

printDescription()​

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

Defined in: common.ts:138

Prints the complete description for a GraphQL type, including deprecation warnings and custom directives.

Parameters​

type​

unknown

The GraphQL type to document

options​

PrintTypeOptions

Configuration options for printing

noText?​

string

Optional text to display when no description exists

Returns​

string | MDXString

Combined description, deprecation notices, and custom directives as MDX content

printWarning()​

function printWarning(param0, options): string

Defined in: common.ts:91

Generates a warning message block in MDX format.

Parameters​

param0​

Warning configuration object

text?​

string

The warning message text

title?​

string

Optional title for the warning block

options​

PrintTypeOptions

Configuration options for printing

Returns​

string

Formatted warning message as MDX string