pagination

Documentation

Index

• Variables
• func EncodeCursor(cursor string, direction Direction) string
• type Cursor
  • func NewCursor[Records any](entries []Records, isFirstPage bool, limit int, cursorStructField string) (Cursor, []Records)
• type Direction
  • func DecodeCursor(pageCursor string) (dir Direction, cursor string, err error)
  • func (d Direction) IsValid() bool
  • func (d Direction) String() string

Variables

var (
	SettingsCursorSeperator = ":"
	ErrCursorInvalid        = fmt.Errorf("invalid cursor: should be 'direction%sindex'", SettingsCursorSeperator)
	ErrDirectionInvalid     = fmt.Errorf("invalid direction: should be 'next' or 'prev'")
)

Functions

func EncodeCursor

func EncodeCursor(cursor string, direction Direction) string

Types

type Cursor

type Cursor struct {
	Total       int
	HasPrevPage bool
	HasNextPage bool
	Start       any
	End         any
}

Cursor holds pointers to the first and last items on a page.

func NewCursor

func NewCursor[Records any](entries []Records, isFirstPage bool, limit int, cursorStructField string) (Cursor, []Records)

type Direction

type Direction string

const (
	DirectionNext Direction = "next"
	DirectionPrev Direction = "prev"
)

func DecodeCursor

func DecodeCursor(pageCursor string) (dir Direction, cursor string, err error)

func (Direction) IsValid

func (d Direction) IsValid() bool

func (Direction) String

func (d Direction) String() string