GraphQL v0.3.0 API Reference

Modules

An Elixir implementation of Facebook’s GraphQL

Ddefines the structure of a GraphQL document after it has been parsed

Represents the data structure for a single error

Represents a set of errors that have occured

A CompositeVisitor composes two Visitor implementations into a single Visitor

A ParallelVisitor runs all child visitors in parallel instead of serially like the CompositeVisitor

TypeInfo maintains type metadata pertaining to the current node of a query AST, and is generated by the TypeInfoVistor

A Visitor implementation that adds type information to the accumulator, so that subsequent visitors can use the information to perform validations

GraphQL lexer implemented with leex

GraphQL parser implemented with yecc

Provides get_field and get_fields accessors for composite types. This abstacts over the fields key being a map or a function that returns a map

Directives currently supported are @skip and @include

A Stack implementation. push and pop return a new Stack. peek returns the top element

Helpers that are useful within validation rules

Exceptions

An error raised when the syntax in a GraphQL query is incorrect

Protocols

A Visitor that implements this protocol will have the opportunity to perform some initialisation and set up the accumulator before AST traversal is started

A Visitor that implements this protocol will have the opportunity to transform the accumulator into something more consumer friendly. It can often be the case that the working form of the accumulator is not what should be returned from ASTReducer.reduce/3

Implementations of Visitor are used by the ASTReducer to transform a GraphQL AST into an arbitrary value