absinthe
absinthe v1.7.0

View Source Absinthe.Blueprint (absinthe v1.7.0)

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

flags_t()
node_t()
result_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

Link to this type

flags_t()

View Source

Specs

flags_t() :: %{required(atom()) => module()}
Link to this type

node_t()

View Source

Specs

node_t() ::
  t()
  | Absinthe.Blueprint.Directive.t()
  | Absinthe.Blueprint.Document.t()
  | Absinthe.Blueprint.Schema.t()
  | Absinthe.Blueprint.Input.t()
  | Absinthe.Blueprint.TypeReference.t()
Link to this type

result_t()

View Source

Specs

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

t()

View Source

Specs

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()
}
Link to this type

use_t()

View Source

Specs

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

Link to this section Functions

Link to this function

add_field(blueprint, type_def_name, new_field)

View Source
Link to this function

current_operation(blueprint)

View Source

Specs

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

Get the currently selected operation.

Link to this function

extend_fields(blueprint, ext_blueprint)

View Source

Append the given field or fields to the given type

Link to this function

find(blueprint, fun)

View Source
Link to this function

find_field(map, name)

View Source
Link to this function

flagged?(node, flag)

View Source

Specs

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

Determine whether a flag has been set on a node.

Link to this function

fragment(blueprint, name)

View Source

Specs

fragment(t(), String.t()) ::
  nil | Absinthe.Blueprint.Document.Fragment.Named.t()
Link to this function

postwalk(blueprint, fun)

View Source

See Absinthe.Blueprint.Transform.postwalk/2.

Link to this function

postwalk(blueprint, acc, fun)

View Source

See Absinthe.Blueprint.Transform.postwalk/3.

Link to this function

prewalk(blueprint, fun)

View Source

See Absinthe.Blueprint.Transform.prewalk/2.

Link to this function

prewalk(blueprint, acc, fun)

View Source

See Absinthe.Blueprint.Transform.prewalk/3.

Link to this function

put_flag(node, flag, mod)

View Source

Specs

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

Add a flag to a node.

Link to this function

types_by_name(blueprint)

View Source

Index the types by their name

Link to this function

update_current(blueprint, change)

View Source

Specs

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

Update the current operation.