class GraphQL::Schema::List

Represents a list type in the schema. Wraps a {Schema::Member} as a list type. @see {Schema::Member::TypeSystemHelpers#to_list_type}

Public Instance Methods

coerce_input(value, ctx) click to toggle source
# File lib/graphql/schema/list.rb, line 39
def coerce_input(value, ctx)
  if value.nil?
    nil
  else
    coerced = ensure_array(value).map { |item| item.nil? ? item : of_type.coerce_input(item, ctx) }
    ctx.schema.after_any_lazies(coerced, &:itself)
  end
end
coerce_result(value, ctx) click to toggle source
# File lib/graphql/schema/list.rb, line 35
def coerce_result(value, ctx)
  value.map { |i| i.nil? ? nil : of_type.coerce_result(i, ctx) }
end
description() click to toggle source

Also for implementing introspection

# File lib/graphql/schema/list.rb, line 31
def description
  nil
end
graphql_name() click to toggle source

This is for introspection, where it’s expected the name will be ‘null`

# File lib/graphql/schema/list.rb, line 26
def graphql_name
  nil
end
kind() click to toggle source

@return [GraphQL::TypeKinds::LIST]

# File lib/graphql/schema/list.rb, line 12
def kind
  GraphQL::TypeKinds::LIST
end
list?() click to toggle source

@return [true]

# File lib/graphql/schema/list.rb, line 17
def list?
  true
end
to_type_signature() click to toggle source
# File lib/graphql/schema/list.rb, line 21
def to_type_signature
  "[#{@of_type.to_type_signature}]"
end
validate_non_null_input(value, ctx) click to toggle source
# File lib/graphql/schema/list.rb, line 48
def validate_non_null_input(value, ctx)
  result = nil
  ensure_array(value).each_with_index do |item, index|
    item_result = of_type.validate_input(item, ctx)
    if !item_result.valid?
      result ||= GraphQL::Query::InputValidationResult.new
      result.merge_result!(index, item_result)
    end
  end
  result
end

Private Instance Methods

ensure_array(value) click to toggle source
# File lib/graphql/schema/list.rb, line 62
def ensure_array(value)
  # `Array({ a: 1 })` makes `[[:a, 1]]`, so do it manually
  if value.is_a?(Array)
    value
  else
    [value]
  end
end