scalar
Provides utility functions for handling GraphQL scalar types in markdown generation.
printCodeScalar()
function printCodeScalar(type, options?): string;
Defined in: printer-legacy/src/graphql/scalar.ts:60
Generates the GraphQL SDL representation of a scalar type.
Parameters
type
unknown
The GraphQL scalar type object
options?
PrintTypeOptions
Options for printing type information (unused)
Returns
string
SDL string representation of the scalar type
printScalarMetadata()
function printScalarMetadata(type, options): Maybe<PageSection>;
Defined in: printer-legacy/src/graphql/scalar.ts:47
Prints metadata information for a scalar type. Currently only includes the specification URL if available.
Parameters
type
unknown
The GraphQL scalar type object
options
PrintTypeOptions
Options for printing type information
Returns
Maybe<PageSection>
A scalar metadata PageSection, or undefined when not available
printSpecification()
function printSpecification(type, options): Maybe<PageSection>;
Defined in: printer-legacy/src/graphql/scalar.ts:19
Generates markdown documentation for a scalar type's specification URL.
Parameters
type
unknown
The GraphQL scalar type object
options
PrintTypeOptions
Options for printing type information
Returns
Maybe<PageSection>
A specification PageSection, or undefined when no URL exists