section
Module responsible for generating Markdown sections for GraphQL schema documentation. Handles the printing of section items, metadata, and structured documentation content.
printMetadataSection()
function printMetadataSection<T, V>(
type,
values,
section,
options,
): Maybe<PageSection>;
Defined in: printer-legacy/src/section.ts:195
Prints a metadata section with special handling for deprecated items.
Type Parameters
T
T
Type of the parent element
V
V
Type of the values being printed
Parameters
type
T
The parent type containing the metadata
values
V | V[] | readonly V[]
Values to include in the metadata section
section
string
Section title/header
options
PrintTypeOptions
Configuration options for printing
Returns
Maybe<PageSection>
Formatted MDX string containing the metadata section
printSection()
function printSection<V>(values, section, options): Maybe<PageSection>;
Defined in: printer-legacy/src/section.ts:140
Prints a complete section with title and content.
Type Parameters
V
V
Type of the values being printed
Parameters
values
V[] | readonly V[]
Array of values to include in the section
section
string
Section title/header
options
PrintTypeOptions
Configuration options for printing
Returns
Maybe<PageSection>
Formatted MDX string containing the complete section
printSectionItem()
function printSectionItem<T>(type, options): string | MDXString;
Defined in: printer-legacy/src/section.ts:46
Prints a single section item with its associated metadata.
Type Parameters
T
T
Type of the GraphQL element being printed
Parameters
type
T
The GraphQL type or field to print
options
PrintTypeOptions
Configuration options for printing
Returns
string | MDXString
Formatted MDX string containing the section item
printSectionItems()
function printSectionItems<V>(values, options): string | MDXString;
Defined in: printer-legacy/src/section.ts:108
Prints an array of section items with consistent formatting.
Type Parameters
V
V
Type of the values being printed
Parameters
values
V | V[]
Single value or array of values to print as section items
options
PrintTypeOptions
Configuration options for printing
Returns
string | MDXString
Formatted MDX string containing all section items