common
Common printer utility functions for handling descriptions, directives, and warnings.
formatDescription()
function formatDescription(type, replacement?): string | MDXString;
Defined in: printer-legacy/src/common.ts:73
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: printer-legacy/src/common.ts:33
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: printer-legacy/src/common.ts:114
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: printer-legacy/src/common.ts:140
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(warningConfig, options): string;
Defined in: printer-legacy/src/common.ts:93
Generates a warning message block in MDX format.
Parameters
warningConfig
Warning configuration object with text and optional title properties
text?
string
title?
string
options
PrintTypeOptions
Configuration options for printing
Returns
string
Formatted warning message as MDX string