View Source GraphQLDocument.Directive (GraphQLDocument v0.2.2)

Directives provide a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

A Directive might be simply a name, or it can have arguments. See render/1 for examples.

Link to this section Summary

t()

A GraphQL directive.

render(directives)

Returns a list of directives as iodata to be inserted into a Document.

@type t() ::
  GraphQLDocument.Name.t()
  | {GraphQLDocument.Name.t(), [GraphQLDocument.Argument.t()]}

A GraphQL directive.

:debug
[log: [level: "warn"]]

@spec render([Directive.t()]) :: iolist()

Returns a list of directives as iodata to be inserted into a Document.

iex> render([log: [level: "warn"]]) |> IO.iodata_to_binary()
" @log(level: \"warn\")"

iex> render([:debug]) |> IO.iodata_to_binary()
" @debug"