Contents

# frozen_string_literal: true

module GraphQL
  module Types
    module Relay
      # Use this to implement Relay connections, or take it as inspiration
      # for Relay classes in your own app.
      #
      # You may wish to copy this code into your own base class,
      # so you can extend your own `BaseObject` instead of `GraphQL::Schema::Object`.
      #
      # @example Implementation a connection and edge
      #   # Given some object in your app ...
      #   class Types::Post < BaseObject
      #   end
      #
      #   # Make a couple of base classes:
      #   class Types::BaseEdge < GraphQL::Types::Relay::BaseEdge; end
      #   class Types::BaseConnection < GraphQL::Types::Relay::BaseConnection; end
      #
      #   # Then extend them for the object in your app
      #   class Types::PostEdge < Types::BaseEdge
      #     node_type(Types::Post)
      #   end
      #   class Types::PostConnection < Types::BaseConnection
      #     edge_type(Types::PostEdge)
      #   end
      #
      # @see Relay::BaseEdge for edge types
      class BaseConnection < Schema::Object
        include ConnectionBehaviors
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
graphql-1.12.6	lib/graphql/types/relay/base_connection.rb
graphql-1.12.5	lib/graphql/types/relay/base_connection.rb
graphql-1.12.4	lib/graphql/types/relay/base_connection.rb
graphql-1.12.3	lib/graphql/types/relay/base_connection.rb
graphql-1.12.2	lib/graphql/types/relay/base_connection.rb
graphql-1.12.1	lib/graphql/types/relay/base_connection.rb
graphql-1.12.0	lib/graphql/types/relay/base_connection.rb