gqlparser

package module
v2.5.20 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 26, 2024 License: MIT Imports: 5 Imported by: 2,912

README

gqlparser CircleCI Go Report Card Coverage Status

This is a parser for graphql, written to mirror the graphql-js reference implementation as closely while remaining idiomatic and easy to use.

spec target: June 2018 (Schema definition language, block strings as descriptions, error paths & extension)

This parser is used by gqlgen, and it should be reasonably stable.

Guiding principles:

  • maintainability: It should be easy to stay up to date with the spec
  • well tested: It shouldn't need a graphql server to validate itself. Changes to this repo should be self contained.
  • server agnostic: It should be usable by any of the graphql server implementations, and any graphql client tooling.
  • idiomatic & stable api: It should follow go best practices, especially around forwards compatibility.
  • fast: Where it doesn't impact on the above it should be fast. Avoid unnecessary allocs in hot paths.
  • close to reference: Where it doesn't impact on the above, it should stay close to the graphql/graphql-js reference implementation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func LoadQuery

func LoadQuery(schema *ast.Schema, str string) (*ast.QueryDocument, gqlerror.List)

func LoadSchema

func LoadSchema(str ...*ast.Source) (*ast.Schema, error)

func MustLoadQuery

func MustLoadQuery(schema *ast.Schema, str string) *ast.QueryDocument

func MustLoadSchema

func MustLoadSchema(str ...*ast.Source) *ast.Schema

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL