absinthe v1.5.0 Absinthe.Phase behaviour View Source

Behaviour for Absinthe Phases.

A phase takes an Absinthe.Blueprint document and returns another blueprint document. All validation, resolution, and result building happens via phases. See Absinthe.Pipeline for information on how to run phases. See the code under this namespace for information on individual phases.

Link to this section Summary

Types

result_t()

t()

Functions

any_invalid?(nodes)

put_error(node, error)

Callbacks

run(any, any)

Link to this section Types

result_t()

result_t() ::
  {:ok, any()}
  | {:jump, any(), t()}
  | {:insert, any(), t() | [t()]}
  | {:replace, any(), t() | [t()]}
  | {:error, any()}
  | {:record_phases, any(), (any(), any() -> any())}

t()

t() :: module()

Link to this section Functions

any_invalid?(nodes)

put_error(node, error)

put_error(Absinthe.Blueprint.node_t(), Absinthe.Phase.Error.t()) ::
  Absinthe.Blueprint.node_t()

Link to this section Callbacks

run(any, any)

run(any(), any()) :: result_t()