Method: GraphQL::Relay::ConnectionField.create

Defined in:
lib/graphql/relay/connection_field.rb

.create(underlying_field, max_page_size: nil) ⇒ GraphQL::Field

Turn A GraphQL::Field into a connection by:

  • Merging in the default arguments

  • Transforming its resolve function to return a connection object

Parameters:

  • A (GraphQL::Field) —

    field which returns nodes to be wrapped as a connection

  • max_page_size (Integer) (defaults to: nil) —

    The maximum number of nodes which may be requested (if a larger page is requested, it is limited to this number)

Returns:

  • (GraphQL::Field) —

    The same field, modified to resolve to a connection object



33
34
35
36
37
38
 
# File 'lib/graphql/relay/connection_field.rb', line 33

def self.create(underlying_field, max_page_size: nil)
  underlying_field.arguments = DEFAULT_ARGUMENTS.merge(underlying_field.arguments)
  original_resolve = underlying_field.resolve_proc
  underlying_field.resolve = GraphQL::Relay::ConnectionResolve.new(underlying_field, original_resolve, max_page_size: max_page_size)
  underlying_field
end