Absinthe.Type.Enum.Value (absinthe v1.6.0) View Source

A possible value for an enum.

See Absinthe.Type.Enum and Absinthe.Schema.Notation.value/1.

Link to this section Summary



A defined enum value entry.

Link to this section Types


t() :: %{
  name: binary(),
  description: binary(),
  value: any(),
  enum_identifier: atom(),
  deprecation: Absinthe.Type.Deprecation.t() | nil,
  __reference__: Absinthe.Type.Reference.t()

A defined enum value entry.

Generally defined using Absinthe.Schema.Notation.value/2 as part of a schema.

  • :name - The name of the value. This is also the incoming, external value that will be provided by query documents.
  • :description - A nice description for introspection.
  • :value - The raw, internal value that :name map to. This will be provided as the argument value to resolve functions.
  • :deprecation - Deprecation information for a value, usually set-up using the Absinthe.Schema.Notation.deprecate/1 convenience function.