absinthe

v0.4.6

absinthe v0.4.6 Absinthe.Type.Enum.Value

A possible value for an enum.

See Absinthe.Type.Enum and Absinthe.Type.Definitions.values/1.

Summary

Types

t()

A defined enum value entry

Types 

t :: %{name: binary, description: binary, value: any, deprecation: Absinthe.Type.Deprecation.t | nil}

A defined enum value entry.

Generally defined using Absinthe.Type.Definitions.values/1 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. to resolve functions
  • :deprecation - Deprecation information for a value, usually set-up using the Absinthe.Type.Definitions.deprecate/2 convenience function.