pagination

Documentation

Index

• Constants
• type OptionPaginator
  • func OptionKey(s *schema.Schema, key string) OptionPaginator
  • func OptionLimit(limit uint64) OptionPaginator
  • func OptionOffset(offset uint64) OptionPaginator
  • func OptionOrder(order string) OptionPaginator
• type Paginator
  • func FromURLQuery(s *schema.Schema, values url.Values) (pg *Paginator, err error)
  • func NewPaginator(options ...OptionPaginator) (*Paginator, error)

Constants

const (
	//ASC ascending order
	ASC = "asc"
	//DESC descending order
	DESC = "desc"
)

Types

type OptionPaginator

type OptionPaginator func(*Paginator) error

func OptionKey

func OptionKey(s *schema.Schema, key string) OptionPaginator

func OptionLimit

func OptionLimit(limit uint64) OptionPaginator

func OptionOffset

func OptionOffset(offset uint64) OptionPaginator

func OptionOrder

func OptionOrder(order string) OptionPaginator

type Paginator

type Paginator struct {
	Key    string
	Order  string
	Limit  uint64
	Offset uint64
}

Paginator stores pagination data

func FromURLQuery

func FromURLQuery(s *schema.Schema, values url.Values) (pg *Paginator, err error)

FromURLQuery create Paginator from Query params

func NewPaginator

func NewPaginator(options ...OptionPaginator) (*Paginator, error)

NewPaginator create Paginator