example

Module providing utilities for handling GraphQL example directives and printing example values.

getDirectiveExampleOption()

function getDirectiveExampleOption(options): Maybe<TypeDirectiveExample>;

Defined in: printer-legacy/src/example.ts:44

Retrieves directive example options from the provided print type options.

PrintTypeOptions

Configuration options

Maybe<TypeDirectiveExample>

The directive example configuration if valid, otherwise undefined

function printExample(type, options): Maybe<string>;

Defined in: printer-legacy/src/example.ts:247

Prints an example value for a given GraphQL type or operation.

unknown

The GraphQL type or operation to generate an example for

PrintTypeOptions

Configuration options for printing the example

Maybe<string>

Stringified example if available, otherwise undefined

const example = printExample(type, { schema, exampleSection });
if (example) {
  console.log(example);
}