scalar
Provides utility functions for handling GraphQL scalar types in markdown generation.
printCodeScalar()β
function printCodeScalar(type, options?): string
Defined in: graphql/scalar.ts:57
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): string | MDXString
Defined in: graphql/scalar.ts:44
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β
string
| MDXString
Markdown string containing the scalar metadata
printSpecification()β
function printSpecification(type, options): string | MDXString
Defined in: graphql/scalar.ts:18
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β
string
| MDXString
Markdown string containing the specification link, or empty string if no URL exists