value.ex (1197B)
1 defmodule Absinthe.Type.Enum.Value do 2 @moduledoc """ 3 A possible value for an enum. 4 5 See `Absinthe.Type.Enum` and `Absinthe.Schema.Notation.value/1`. 6 """ 7 8 alias Absinthe.Type 9 10 @typedoc """ 11 A defined enum value entry. 12 13 Generally defined using `Absinthe.Schema.Notation.value/2` as 14 part of a schema. 15 16 * `:name` - The name of the value. This is also the incoming, external 17 value that will be provided by query documents. 18 * `:description` - A nice description for introspection. 19 * `:value` - The raw, internal value that `:name` map to. This will be 20 provided as the argument value to `resolve` functions. 21 * `:deprecation` - Deprecation information for a value, usually 22 set-up using the `Absinthe.Schema.Notation.deprecate/1` convenience 23 function. 24 """ 25 @type t :: %{ 26 name: binary, 27 description: binary, 28 value: any, 29 enum_identifier: atom, 30 deprecation: Type.Deprecation.t() | nil, 31 __reference__: Type.Reference.t() 32 } 33 defstruct name: nil, 34 description: nil, 35 value: nil, 36 deprecation: nil, 37 enum_identifier: nil, 38 __reference__: nil 39 end