module GraphQL::Relay::ConnectionType
Attributes
bidirectional_pagination[RW]
@return [Boolean] If true, connections check for reverse-direction `has*Page` values
default_nodes_field[RW]
@return [Boolean] If true, connection types get a `nodes` shortcut field
Public Class Methods
create_type(wrapped_type, edge_type: nil, edge_class: GraphQL::Relay::Edge, nodes_field: ConnectionType.default_nodes_field, &block)
click to toggle source
Create a connection which exposes edges of this type
# File lib/graphql/relay/connection_type.rb, line 15 def self.create_type(wrapped_type, edge_type: nil, edge_class: GraphQL::Relay::Edge, nodes_field: ConnectionType.default_nodes_field, &block) custom_edge_class = edge_class # Any call that would trigger `wrapped_type.ensure_defined` # must be inside this lazy block, otherwise we get weird # cyclical dependency errors :S ObjectType.define do type_name = wrapped_type.is_a?(GraphQL::BaseType) ? wrapped_type.name : wrapped_type.graphql_name edge_type ||= wrapped_type.edge_type name("#{type_name}Connection") description("The connection type for #{type_name}.") field :edges, types[edge_type], "A list of edges.", edge_class: custom_edge_class, property: :edge_nodes if nodes_field field :nodes, types[wrapped_type], "A list of nodes.", property: :edge_nodes end field :pageInfo, !PageInfo, "Information to aid in pagination.", property: :page_info relay_node_type(wrapped_type) block && instance_eval(&block) end end