absinthe v1.5.0 Absinthe.Type.Directive View Source

Used by the GraphQL runtime as a way of modifying execution behavior.

Type system creators will usually not create these directly.

Link to this section Summary

Types

location()

t()

A defined directive.

Functions

kind()

Callback implementation for c:Absinthe.Introspection.Kind.kind/0.

Link to this section Types

location()

location() ::
  :query
  | :mutation
  | :field
  | :fragment_definition
  | :fragment_spread
  | :inline_fragment

t()

t() :: %{
  name: binary(),
  description: binary(),
  identifier: atom(),
  args: map(),
  locations: [location()],
  expand: (map(), Absinthe.Blueprint.node_t() -> atom()),
  definition: module(),
  __private__: Keyword.t(),
  __reference__: Absinthe.Type.Reference.t()
}

A defined directive.

:name - The name of the directivee. Should be a lowercase binary. Set automatically.
:description - A nice description for introspection.
:args - A map of Absinthe.Type.Argument structs. See Absinthe.Schema.Notation.arg/2.
:locations - A list of places the directives can be used.

The :__reference__ key is for internal use.

Link to this section Functions

kind()

Callback implementation for c:Absinthe.Introspection.Kind.kind/0.