absinthe v1.5.0-rc.5 Absinthe.Blueprint View Source

Represents the graphql document to be executed.

Please see the code itself for more information on individual blueprint sub modules.

Link to this section Summary

Types

node_t()

t()

use_t()

Functions

add_field(blueprint, type_def_name, new_field)

current_operation(blueprint)

Get the currently selected operation.

extend_fields(blueprint, ext_blueprint)

Append the given field or fields to the given type

find(blueprint, fun)

find_field(map, name)

flagged?(node, flag)

Determine whether a flag has been set on a node.

fragment(blueprint, name)

postwalk(blueprint, fun)

See Absinthe.Blueprint.Transform.postwalk/2.

postwalk(blueprint, acc, fun)

See Absinthe.Blueprint.Transform.postwalk/3.

prewalk(blueprint, fun)

See Absinthe.Blueprint.Transform.prewalk/2.

prewalk(blueprint, acc, fun)

See Absinthe.Blueprint.Transform.prewalk/3.

put_flag(node, flag, mod)

Add a flag to a node.

types_by_name(blueprint)

Index the types by their name

update_current(blueprint, change)

Update the current operation.

Link to this section Types

flags_t()

flags_t() :: %{required(atom()) => module()}

node_t()

node_t() ::
  t()
  | Absinthe.Blueprint.Directive.t()
  | Absinthe.Blueprint.Document.t()
  | Absinthe.Blueprint.Schema.t()
  | Absinthe.Blueprint.Input.t()
  | Absinthe.Blueprint.TypeReference.t()

result_t()

result_t() :: %{
  optional(:data) => term(),
  optional(:errors) => [term()],
  optional(:extensions) => term()
}

t()

t() :: %Absinthe.Blueprint{
  adapter: nil | Absinthe.Adapter.t(),
  directives: [Absinthe.Blueprint.Schema.DirectiveDefinition.t()],
  errors: [Absinthe.Phase.Error.t()],
  execution: Absinthe.Blueprint.Execution.t(),
  flags: flags_t(),
  fragments: [Absinthe.Blueprint.Document.Fragment.Named.t()],
  initial_phases: [Absinthe.Phase.t()],
  input: nil | Absinthe.Language.Document.t(),
  name: nil | String.t(),
  operations: [Absinthe.Blueprint.Document.Operation.t()],
  prototype_schema: nil | Absinthe.Schema.t(),
  result: result_t(),
  schema: nil | Absinthe.Schema.t(),
  schema_definitions: [Absinthe.Blueprint.Schema.SchemaDefinition.t()],
  source: nil | String.t() | Absinthe.Language.Source.t(),
  telemetry: map()
}

use_t()

use_t() ::
  Absinthe.Blueprint.Document.Fragment.Named.Use.t()
  | Absinthe.Blueprint.Input.Variable.Use.t()

Link to this section Functions

add_field(blueprint, type_def_name, new_field)

current_operation(blueprint)

current_operation(t()) :: nil | Absinthe.Blueprint.Document.Operation.t()

Get the currently selected operation.

extend_fields(blueprint, ext_blueprint)

Append the given field or fields to the given type

find(blueprint, fun)

find_field(map, name)

flagged?(node, flag)

flagged?(node_t(), atom()) :: boolean()

Determine whether a flag has been set on a node.

fragment(blueprint, name)

fragment(t(), String.t()) ::
  nil | Absinthe.Blueprint.Document.Fragment.Named.t()

postwalk(blueprint, fun)

See Absinthe.Blueprint.Transform.postwalk/2.

postwalk(blueprint, acc, fun)

See Absinthe.Blueprint.Transform.postwalk/3.

prewalk(blueprint, fun)

See Absinthe.Blueprint.Transform.prewalk/2.

prewalk(blueprint, acc, fun)

See Absinthe.Blueprint.Transform.prewalk/3.

put_flag(node, flag, mod)

put_flag(node_t(), atom(), module()) :: node_t()

Add a flag to a node.

types_by_name(blueprint)

Index the types by their name

update_current(blueprint, change)

update_current(
  t(),
  (Absinthe.Blueprint.Document.Operation.t() ->
     Absinthe.Blueprint.Document.Operation.t())
) :: t()

Update the current operation.