Skip to main content

interface

Contains utilities for printing GraphQL interface types as Markdown documentation.

printInterfaceMetadata()​

const printInterfaceMetadata: (type, options) => string = printObjectMetadata;

Defined in: graphql/interface.ts:14

Prints metadata for a GraphQL interface type. This is an alias for printObjectMetadata.

Prints the complete metadata section for a GraphQL object type

Parameters​

type​

unknown

The GraphQL type object to process

options​

PrintTypeOptions

Printing options

Returns​

string

Markdown formatted string containing fields and interfaces metadata


printCodeInterface()​

function printCodeInterface(type, options): string

Defined in: graphql/interface.ts:23

Generates a code block representation of a GraphQL interface type.

Parameters​

type​

unknown

The GraphQL interface type to print

options​

PrintTypeOptions

Configuration options for printing the type

Returns​

string

A string containing the Markdown code block representation