class GraphQL::Relay::ConnectionField
Provided a GraphQL
field which returns a collection of items, `ConnectionField.create` modifies that field to expose those items as a collection.
The original resolve proc is used to fetch items, then a connection implementation is fetched with {BaseConnection.connection_for_items}.
Constants
- ARGUMENT_DEFINITIONS
- DEFAULT_ARGUMENTS
Public Class Methods
Turn A GraphQL::Field into a connection by:
-
Merging in the default arguments
-
Transforming its resolve function to return a connection object
@param [GraphQL::Field] A field which returns items to be wrapped as a connection @param max_page_size [Integer] The maximum number of items which may be requested (if a larger page is requested, it is limited to this number) @return [GraphQL::Field] A field which serves a connections
# 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 = get_connection_resolve(underlying_field.name, original_resolve, max_page_size: max_page_size) underlying_field end
Private Class Methods
Wrap the original resolve proc so you capture its value, then wrap it in a connection implementation
# File lib/graphql/relay/connection_field.rb, line 45 def self.get_connection_resolve(field_name, underlying_resolve, max_page_size: nil) -> (obj, args, ctx) { items = underlying_resolve.call(obj, args, ctx) connection_class = GraphQL::Relay::BaseConnection.connection_for_items(items) connection_class.new(items, args, max_page_size: max_page_size, parent: obj) } end