paginator

Documentation

Index

• Constants
• func CreateCursor(created uint64, object interface{}) string
• func LogRequest(prefix string, params *Params)
• func ParseCursor(cursor string, object interface{}) (uint64, error)
• func ValidateFirstAndLast(first, last *int) (count int, valid bool, err error)
• type BatchInfo
  • func Validate(prefix string, params *Params) (info *BatchInfo, err error)
• type Params

Constants

const (
	ErrorFirstLastMissing = "you must provide a `first` or `last` value to properly paginate the objects"
	ErrorFirstLastInvalid = "you must provide a valid `first` or `last` value in range 1-100"
	ErrorCursorInvalid    = "cursor value is invalid"
)

Functions

func CreateCursor

func CreateCursor(created uint64, object interface{}) string

func LogRequest

func LogRequest(prefix string, params *Params)

func ParseCursor

func ParseCursor(cursor string, object interface{}) (uint64, error)

func ValidateFirstAndLast

func ValidateFirstAndLast(first, last *int) (count int, valid bool, err error)

Types

type BatchInfo

type BatchInfo struct {
	Count  int
	Tail   bool
	Before uint64
	After  uint64
}

func Validate

func Validate(prefix string, params *Params) (info *BatchInfo, err error)

type Params

type Params struct {
	First  *int
	Last   *int
	Before *string
	After  *string
	Object interface{}
}