module GraphQR::Pagination - RDoc Documentation

This module adds the GraphQL pagination types.

When a field is paginated, the field page_info is always included with some pagination information.

To use this module use extend GraphQR::Pagination on the GraphQL::Schema::Object you want it, or in your BaseObject

Public Instance Methods

pagination_type() click to toggle source

# File lib/graphqr/pagination.rb, line 12
def pagination_type
  @pagination_type ||= begin
    conn_name = "#{graphql_name}Pagination"
    edge_type_class = edge_type

    Class.new(connection_type_class) do
      graphql_name(conn_name)
      edge_type(edge_type_class)

      field :page_info, Pagination::Types::PaginationPageInfoType, null: false,
                                                                   description: 'Information to aid in pagination.'
    end
  end
end