package formatter

import "github.com/vektah/gqlparser/v2/formatter"

Index ¶

• type Formatter
• func NewFormatter(w io.Writer, options ...FormatterOption) Formatter
• type FormatterOption
• func WithBuiltin() FormatterOption
• func WithComments() FormatterOption
• func WithCompacted() FormatterOption
• func WithIndent(indent string) FormatterOption
• func WithoutDescription() FormatterOption

Types ¶

type Formatter ¶

type Formatter interface {
	FormatSchema(schema *ast.Schema)
	FormatSchemaDocument(doc *ast.SchemaDocument)
	FormatQueryDocument(doc *ast.QueryDocument)
}

func NewFormatter ¶

func NewFormatter(w io.Writer, options ...FormatterOption) Formatter

type FormatterOption ¶

type FormatterOption func(*formatter)

func WithBuiltin ¶

func WithBuiltin() FormatterOption

WithBuiltin includes builtin fields/directives/etc from the source/AST in the formatted output.

func WithComments ¶

func WithComments() FormatterOption

WithComments includes comments from the source/AST in the formatted output.

func WithCompacted ¶

func WithCompacted() FormatterOption

WithCompacted enables compacted output, which removes all unnecessary whitespace.

func WithIndent ¶

func WithIndent(indent string) FormatterOption

WithIndent uses the given string for indenting block bodies in the output, instead of the default, `"\t"`.

func WithoutDescription ¶

func WithoutDescription() FormatterOption

WithoutDescription excludes GQL description from the source/AST in the formatted output.

Source Files ¶

formatter.go