paging

Documentation

Index

• Variables
• func DecodeCursor(cursor string) (string, int64, error)
• func EncodeCursor(value string) string
• type CursorProvider
• type PagingFunc
• type Params
  • func NormalizeParams(params Params) Params
• type Result
  • func Paginate[T CursorProvider](params Params, paginateFunc PagingFunc[T]) (Result[T], error)

Variables

var (
	ErrInvalidCursor = fmt.Errorf("invalid cursor")
)

Functions

func DecodeCursor

func DecodeCursor(cursor string) (string, int64, error)

func EncodeCursor

func EncodeCursor(value string) string

Types

type CursorProvider

type CursorProvider interface {
	GetCursorValue() string
}

type PagingFunc

type PagingFunc[T CursorProvider] func(cursor string, limit int, direction string) (items []T, total int, err error)

type Params

type Params struct {
	Cursor    string `json:"cursor"`
	Limit     int    `json:"limit"`
	Direction string `json:"direction"` // "forward" or "backward"
}

func NormalizeParams

func NormalizeParams(params Params) Params

type Result

type Result[T CursorProvider] struct {
	Items      []T    `json:"items"`
	Total      int    `json:"total"`
	Cursor     string `json:"cursor,omitempty"`
	NextCursor string `json:"next_cursor,omitempty"`
	PrevCursor string `json:"prev_cursor,omitempty"`
	HasNext    bool   `json:"has_next"`
	HasPrev    bool   `json:"has_prev"`
}

func Paginate

func Paginate[T CursorProvider](params Params, paginateFunc PagingFunc[T]) (Result[T], error)