module GraphQL::Schema::Member::HasFields

Shared code for Objects, Interfaces, Mutations, Subscriptions

Public Instance Methods

field(Symbol name_positional, Class | GraphQL::BaseType | Array type_positional, String desc_positional, Hash **kwargs, Proc &definition_block) → GraphQL::Schema::Field

Source

# File lib/graphql/schema/member/has_fields.rb, line 78
def field(name_positional = nil, type_positional = nil, desc_positional = nil, **kwargs, &definition_block)
  resolver = kwargs.delete(:resolver)
  mutation = kwargs.delete(:mutation)
  subscription = kwargs.delete(:subscription)
  if (resolver_class = resolver || mutation || subscription)
    # Add a reference to that parent class
    kwargs[:resolver_class] = resolver_class
  end

  kwargs[:name] ||= name_positional
  if !type_positional.nil?
    if desc_positional
      if kwargs[:description]
        raise ArgumentError, "Provide description as a positional argument or `description:` keyword, but not both (#{desc_positional.inspect}, #{kwargs[:description].inspect})"
      end

      kwargs[:description] = desc_positional
      kwargs[:type] = type_positional
    elsif (resolver || mutation) && type_positional.is_a?(String)
      # The return type should be copied from the resolver, and the second positional argument is the description
      kwargs[:description] = type_positional
    else
      kwargs[:type] = type_positional
    end

    if type_positional.is_a?(Class) && type_positional < GraphQL::Schema::Mutation
      raise ArgumentError, "Use `field #{name_positional.inspect}, mutation: Mutation, ...` to provide a mutation to this field instead"
    end
  end

  kwargs[:owner] = self
  field_defn = field_class.new(**kwargs, &definition_block)
  add_field(field_defn)
  field_defn
end

Add a field to this object or interface with the given definition

Parameters

name_positional (Symbol) — The underscore-cased version of this field name (will be camelized for the GraphQL API); name: keyword is also accepted
type_positional (Class, GraphQL::BaseType, Array) — The return type of this field; type: keyword is also accepted
desc_positional (String) — Field description; description: keyword is also accepted
kwargs (Hash) — Keywords for defining the field. Any not documented here will be passed to your base field class where they must be handled.
definition_block (Proc) — an additional block for configuring the field. Receive the field as a block param, or, if no block params are defined, then the block is instance_eval‘d on the new Field.

Options

kwargs.:name (Symbol) — The underscore-cased version of this field name (will be camelized for the GraphQL API); positional argument also accepted
kwargs.:type (Class, GraphQL::BaseType, Array) — The return type of this field; positional argument is also accepted
kwargs.:null (Boolean) — (defaults to true) true if this field may return null, false if it is never null
kwargs.:description (String) — Field description; positional argument also accepted
kwargs.:comment (String) — Field comment
kwargs.:deprecation_reason (String) — If present, the field is marked “deprecated” with this message
kwargs.:method (Symbol) — The method to call on the underlying object to resolve this field (defaults to name)
kwargs.:hash_key (String, Symbol) — The hash key to lookup on the underlying object (if its a Hash) to resolve this field (defaults to name or name.to_s)
kwargs.:dig (Array<String, Symbol>) — The nested hash keys to lookup on the underlying hash to resolve this field using dig
kwargs.:resolver_method (Symbol, true) — The method on the type to call to resolve this field (defaults to name)
kwargs.:resolve_static (Symbol, true) — Used by Schema.execute_next to produce a single value, shared by all objects which resolve this field. Called on the owner type class with context, **arguments
kwargs.:resolve_batch (Symbol, true) — Used by Schema.execute_next map objects to a same-sized Array of results. Called on the owner type class with objects, context, **arguments.
kwargs.:resolve_each (Symbol, true) — Used by Schema.execute_next to get a value value for each item. Called on the owner type class with object, context, **arguments.
kwargs.:resolve_legacy_instance_method (Symbol, true) — Used by Schema.execute_next to get a value value for each item. Calls an instance method on the object type class.
kwargs.:connection (Boolean) — true if this field should get automagic connection behavior; default is to infer by *Connection in the return type name
kwargs.:connection_extension (Class) — The extension to add, to implement connections. If nil, no extension is added.
kwargs.:max_page_size (Integer, nil) — For connections, the maximum number of items to return from this field, or nil to allow unlimited results.
kwargs.:default_page_size (Integer, nil) — For connections, the default number of items to return from this field, or nil to return unlimited results.
kwargs.:introspection (Boolean) — If true, this field will be marked as #introspection? and the name may begin with __
kwargs.:arguments ({String=>GraphQL::Schema::Argument, Hash}) — Arguments for this field (may be added in the block, also)
kwargs.:camelize (Boolean) — If true, the field name will be camelized when building the schema
kwargs.:complexity (Numeric) — When provided, set the complexity for this field
kwargs.:scope (Boolean) — If true, the return type’s .scope_items method will be called on the return value
kwargs.:subscription_scope (Symbol, String) — A key in context which will be used to scope subscription payloads
kwargs.:extensions (Array<Class, Hash<Class => Object>>) — Named extensions to apply to this field (see also Field#extension)
kwargs.:directives (Hash{Class => Hash}) — Directives to apply to this field
kwargs.:trace (Boolean) — If true, a GraphQL::Tracing tracer will measure this scalar field
kwargs.:broadcastable (Boolean) — Whether or not this field can be distributed in subscription broadcasts
kwargs.:ast_node (Language::Nodes::FieldDefinition, nil) — If this schema was parsed from definition, this AST node defined the field
kwargs.:method_conflict_warning (Boolean) — If false, skip the warning if this field’s method conflicts with a built-in method
kwargs.:validates (Array<Hash>) — Configurations for validating this field
kwargs.:fallback_value (Object) — A fallback value if the method is not defined
kwargs.:mutation (Class<GraphQL::Schema::Mutation>)
kwargs.:resolver (Class<GraphQL::Schema::Resolver>)
kwargs.:subscription (Class<GraphQL::Schema::Subscription>)
kwargs.:dynamic_introspection (Boolean) — (Private, used by GraphQL-Ruby)
kwargs.:relay_node_field (Boolean) — (Private, used by GraphQL-Ruby)
kwargs.:relay_nodes_field (Boolean) — (Private, used by GraphQL-Ruby)
kwargs.:dataload (Class, Hash) — Shorthand for dataloader lookups
kwargs.:extras (Array<:ast_node, :parent, :lookahead, :owner, :execution_errors, :graphql_name, :argument_details, Symbol>) — Extra arguments to be injected into the resolver for this field

Yields

field (GraphQL::Schema::Field) — The newly-created field instance
void

Returns

GraphQL::Schema::Field