graphqexl v0.1.0-alpha-rc.9 Graphqexl.Schema

Structured representation of a GraphQL schema, either built dynamically or parsed from a JSON document or GQL string.

Link to this section Summary

Types

gql()

json()

t()

Functions

gql(str)

Parses a json map into a %Graphqexl.Schema{}.

register(schema, component)

Registers the given component on the given schema.

Link to this section Types

component()

component() ::
  Graphqexl.Schema.TEnum.t()
  | Graphqexl.Schema.Interface.t()
  | Graphqexl.Schema.Mutation.t()
  | Graphqexl.Schema.Query.t()
  | Graphqexl.Schema.Subscription.t()
  | Graphqexl.Schema.Type.t()
  | Graphqexl.Schema.Union.t()

gql()

gql() :: String.t()

json()

json() :: Map.t()

t()

t() :: %Graphqexl.Schema{
  enums: [Graphqexl.Schema.TEnum.t()],
  interfaces: [Graphqexl.Schema.Interface.t()],
  mutations: [Graphqexl.Schema.Mutation.t()],
  queries: [Queries.t()],
  str: gql(),
  subscriptions: [Graphqexl.Schema.Subscription.t()],
  types: [Graphqexl.Schema.Type.t()],
  unions: [Graphqexl.Schema.Union.t()]
}

Link to this section Functions

gql(str)

gql(gql() | json()) :: %Graphqexl.Schema{
  enums: term(),
  interfaces: term(),
  mutations: term(),
  queries: term(),
  str: term(),
  subscriptions: term(),
  types: term(),
  unions: term()
}

Parses a json map into a %Graphqexl.Schema{}.

Returns %Graphqexl.Schema{}

register(schema, component)

register(GraphqexlSchema.t(), component()) :: Graphqexl.Schema.t()

Registers the given component on the given schema.

Returns %Graphqexl.Schema{}