absinthe v1.4.0-rc.0 Absinthe.Type.Enum.Value View Source
A possible value for an enum.
See Absinthe.Type.Enum
and Absinthe.Schema.Notation.value/1
.
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t() :: %{name: binary, description: binary, value: any, 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. toresolve
functions:deprecation
- Deprecation information for a value, usually set-up using theAbsinthe.Schema.Notation.deprecate/2
convenience function.