absinthe v1.4.0-beta.1 Absinthe.Pipeline View Source

Execute a pipeline of phases.

A pipeline is merely a list of phases. This module contains functions for building, modifying, and executing pipelines of phases.

Link to this section Summary

Types

data_t()

phase_config_t()

t()

Functions

before(pipeline, phase)

Return the part of a pipeline before a specific phase

for_document(schema, options \\ [])

for_schema(prototype_schema, options \\ [])

from(pipeline, phase)

Return the part of a pipeline after (and including) a specific phase

insert_after(pipeline, phase, additional)

insert_before(pipeline, phase, additional)

reject(pipeline, pattern)

replace(pipeline, phase, replacement)

Replace a phase in a pipeline with another, supporting reusing the same options

run(input, pipeline)

run_phase(pipeline, input, done \\ [])

upto(pipeline, phase)

Return the part of a pipeline up to and including a specific phase

without(pipeline, phase)

Link to this section Types

data_t()

data_t() :: any

phase_config_t()

phase_config_t ::
  Absinthe.Phase.t |
  {Absinthe.Phase.t, Keyword.t}

t()

t() :: [phase_config_t | [phase_config_t]]

Link to this section Functions

before(pipeline, phase)

before(t, atom) :: t

Return the part of a pipeline before a specific phase.

for_document(schema, options \\ [])

for_document(Absinthe.Schema.t, Keyword.t) :: t

for_schema(prototype_schema, options \\ [])

for_schema(nil | Absinthe.Schema.t, Keyword.t) :: t

from(pipeline, phase)

from(t, atom) :: t

Return the part of a pipeline after (and including) a specific phase.

insert_after(pipeline, phase, additional)

insert_after(t, Absinthe.Phase.t, Absinthe.Phase.t | [Absinthe.Phase.t]) :: t

insert_before(pipeline, phase, additional)

insert_before(t, Absinthe.Phase.t, Absinthe.Phase.t | [Absinthe.Phase.t]) :: t

reject(pipeline, pattern)

reject(t, Regex.t) :: t

replace(pipeline, phase, replacement)

replace(t, Absinthe.Phase.t, phase_config_t) :: t

Replace a phase in a pipeline with another, supporting reusing the same options.

Examples

Replace a simple phase (without options):

iex> Pipeline.replace([A, B, C], B, X)
[A, X, C]

Replace a phase with options, retaining them:

iex> Pipeline.replace([A, {B, [name: "Thing]}, C], B, X)
[A, {X, [name: "Thing"]}, C]

Replace a phase with options, overriding them:

iex> Pipeline.replace([A, {B, [name: "Thing]}, C], B, {X, [name: "Nope"]})
[A, {X, [name: "Nope"]}, C]

run(input, pipeline)

run(data_t, t) ::
  {:ok, data_t, [Absinthe.Phase.t]} |
  {:error, String.t, [Absinthe.Phase.t]}

run_phase(pipeline, input, done \\ [])

run_phase(t, data_t, [Absinthe.Phase.t]) ::
  {:ok, data_t, [Absinthe.Phase.t]} |
  {:error, String.t, [Absinthe.Phase.t]}

upto(pipeline, phase)

upto(t, atom) :: t

Return the part of a pipeline up to and including a specific phase.

without(pipeline, phase)

without(t, Absinthe.Phase.t) :: t