Class: GraphQL::ListType
- Includes:
- BaseType::ModifiesAnotherType
- Defined in:
- lib/graphql/list_type.rb
Overview
A list type modifies another type.
List types can be created with the type helper (types[InnerType]
)
or BaseType#to_list_type (InnerType.to_list_type
)
For return types, it says that the returned value will be a list of the modified.
For input types, it says that the incoming value will be a list of the modified type.
Given a list type, you can always get the underlying type with BaseType::ModifiesAnotherType#unwrap.
Instance Attribute Summary collapse
-
#of_type ⇒ Object
readonly
Returns the value of attribute of_type.
Attributes inherited from BaseType
Instance Method Summary collapse
- #coerce_non_null_input(value) ⇒ Object
- #coerce_result(value) ⇒ Object
-
#initialize(of_type:) ⇒ ListType
constructor
A new instance of ListType.
- #kind ⇒ Object
- #to_s ⇒ Object
- #validate_non_null_input(value, warden) ⇒ Object
Methods included from BaseType::ModifiesAnotherType
Methods inherited from BaseType
#==, #coerce_input, #connection_type, #define_connection, #define_edge, #edge_type, #get_field, resolve_related_type, #resolve_type, #to_list_type, #to_non_null_type, #unwrap, #valid_input?, #validate_input
Methods included from Define::InstanceDefinable
Methods included from Define::NonNullWithBang
Constructor Details
#initialize(of_type:) ⇒ ListType
Returns a new instance of ListType.
29 30 31 |
# File 'lib/graphql/list_type.rb', line 29 def initialize(of_type:) @of_type = of_type end |
Instance Attribute Details
#of_type ⇒ Object (readonly)
Returns the value of attribute of_type.
28 29 30 |
# File 'lib/graphql/list_type.rb', line 28 def of_type @of_type end |
Instance Method Details
#coerce_non_null_input(value) ⇒ Object
54 55 56 |
# File 'lib/graphql/list_type.rb', line 54 def coerce_non_null_input(value) ensure_array(value).map { |item| of_type.coerce_input(item) } end |
#coerce_result(value) ⇒ Object
58 59 60 |
# File 'lib/graphql/list_type.rb', line 58 def coerce_result(value) ensure_array(value).map { |item| item.nil? ? nil : of_type.coerce_result(item) } end |
#kind ⇒ Object
33 34 35 |
# File 'lib/graphql/list_type.rb', line 33 def kind GraphQL::TypeKinds::LIST end |
#to_s ⇒ Object
37 38 39 |
# File 'lib/graphql/list_type.rb', line 37 def to_s "[#{of_type.to_s}]" end |
#validate_non_null_input(value, warden) ⇒ Object
41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/graphql/list_type.rb', line 41 def validate_non_null_input(value, warden) result = GraphQL::Query::InputValidationResult.new ensure_array(value).each_with_index do |item, index| item_result = of_type.validate_input(item, warden) if !item_result.valid? result.merge_result!(index, item_result) end end result end |