pagination

README

go-pagination

Go package implementing common interfaces for paginating queries and query results.

Important

This is work in progress. Things are starting to settle down but may still be subject to change.

Documentation

Documentation is incomplete at this time.

Documentation

Overview

package pagination provides common interfaces for paginating queries and query results.

Index

• func PagesForCount(opts Options, total_count int64) int64
• type Method
• type Options
• type Results

Functions

func PagesForCount

func PagesForCount(opts Options, total_count int64) int64

PagesForCount returns the number of pages that total_count will span using criteria defined in opts.

Types

type Method

type Method uint8

Method defines the type of pagination Options or Results.

const (
	// Countable is a page-based or numbered pagination implementation
	Countable Method = iota
	// Cursor is a token or cursor-based pagination implementation where the total number of results is unknown
	Cursor
)

type Options

type Options interface {
	// Get or set the number of results to return in a Results
	PerPage(...int64) int64
	// Get or set current page to return query results for
	Spill(...int64) int64
	// Get or set the name of the column to use when paginating results
	Column(...string) string
	// Get or set the pointer (page number or cursor) for the next set of query results
	Pointer(...interface{}) interface{}
	// Return the Method type associated with Options
	Method() Method
}

Options provides a common interface for criteria used to paginate a query.

type Results

type Results interface {
	// The total number of results for a query.
	Total() int64
	// The number of results per page for a query.
	PerPage() int64
	// The current page number (offset) for a paginated query response.
	Page() int64
	// The total number of pages for a paginated query response.
	Pages() int64
	// The value to use to advance to the next set of results in a query response.
	Next() interface{}
	// The value to use to rewind to the previous set of results in a query response.
	Previous() interface{}
	// The URL to the next set of results in a query response
	NextURL(t *uritemplates.UriTemplate) (string, error)
	// The URL to the previous set of results in a query response
	PreviousURL(*uritemplates.UriTemplate) (string, error)
	// Return the Method type associated with Results
	Method() Method
}

Results provides an interface for pagination information for a query response.