paginators

Documentation

Overview

Package paginators handles pagination logic

Index

• type PaginatedResponse
• type Paginator
  • func NewPaginator(queryCallback func(ctx context.Context, after *string) (interface{}, error)) Paginator
  • func (p *Paginator) HasMore() bool
  • func (p *Paginator) Next(ctx context.Context) (interface{}, error)

Types

type PaginatedResponse

type PaginatedResponse interface {
	GetPageInfo() *types.PageInfo
}

PaginatedResponse interface helps the generic paginator to get information from a resource-specific paginator.

type Paginator

type Paginator struct {
	NextCursor *string // nil means no next page unless hasDoneQuery is false
	// contains filtered or unexported fields
}

Paginator is the generic paginator struct with methods.

One quirk of the go-graphql-client is it requires a _FRESH_ query structure for each page. Otherwise, the second page panics in reflect with a slice index out of range.

func NewPaginator

func NewPaginator(queryCallback func(ctx context.Context, after *string) (interface{}, error)) Paginator

NewPaginator creates a brand-new paginator.

func (*Paginator) HasMore

func (p *Paginator) HasMore() bool

HasMore tells whether a paginator has more pages to read. If no page has not yet been read, it will return true, even if the page will be empty.

func (*Paginator) Next

func (p *Paginator) Next(ctx context.Context) (interface{}, error)

Next returns the next page of results.