pagination

Sep 12, 2024

Changes in this version

+ const DefaultLimitMultiplier

type PageableType

+ GetCursor func(Key) Cursor

type Paginator

+ func (p Paginator) GetLimitMultiplier() int

+ func (p Paginator) GetSortKey() Key

Jul 30, 2024

Changes in this version

type KeyType

+ const NullableBoolKeyType

+ const NullableIntKeyType

+ const NullableStringKeyType

+ const NullableTimestampKeyType

+ const NullableUUIDKeyType

Apr 9, 2024

Changes in this version

type KeyType

+ const ArrayKeyType

type QueryParams

+ func QueryParamsFromRequest(r *http.Request) QueryParams

Oct 31, 2023

retracted

Changes in this version

type Paginator

+ func (p Paginator) IsCachable() bool

Oct 2, 2023

retracted

Changes in this version

type KeyType

+ const UUIDArrayKeyType

Aug 15, 2023

retracted

Changes in this version

type KeyType

+ const IntKeyType

Jul 27, 2023

retracted

Changes in this version

+ type Query interface

+ type QueryParams struct

+ EndingBefore *string

+ Filter *string

+ Limit *string

+ SortKey *string

+ SortOrder *string

+ StartingAfter *string

+ Version *string

Apr 11, 2023

retracted

Changes in this version

+ type FilterQuery struct

+ func CreateFilterQuery(s string) (*FilterQuery, error)

+ func (fq *FilterQuery) IsValid(supportedKeys KeyTypes) error

Apr 11, 2023

retracted

Changes in this version

+ const TimestampKeyTypeLayout

+ type KeyType string

+ const BoolKeyType

+ const StringKeyType

+ const TimestampKeyType

+ const UUIDKeyType

+ func (kt KeyType) Validate() error

+ type KeyTypes map[string]KeyType

+ func (kt KeyTypes) Validate() error

type Option

+ func Filter(filter string) Option

+ type PageableType interface

+ GetPaginationKeys func() KeyTypes

type Version

+ const Version3

Mar 2, 2023

retracted

Changes in this version

type Paginator

+ func NewPaginatorFromRequest(r *http.Request, defaultOptions ...Option) (*Paginator, error)

Jan 16, 2023

retracted

Changes in this version

type Direction

+ const DirectionBackward

+ type KeyValueValidator func(string) bool

type Option

+ func EndingBefore(cursor Cursor) Option

type Order

+ const OrderDescending

+ func (o Order) Validate() error

+ type Paginator struct

+ func NewPaginatorFromQuery(query url.Values, defaultOptions ...Option) (*Paginator, error)

+ func (p *Paginator) AdvanceCursor(rf ResponseFields) bool

+ func (p Paginator) GetCursor() Cursor

+ func (p Paginator) GetLimit() int

+ func (p Paginator) GetOptions() []Option

+ func (p Paginator) GetVersion() Version

+ func (p Paginator) HasResultType() bool

+ func (p Paginator) IsForward() bool

+ func (p Paginator) Query() url.Values

+ func (p Paginator) Validate() error

+ func (p Paginator) ValidateCursor(c Cursor) error

+ type SortableKeys map[string]KeyValueValidator

+ type Version int

+ const Version1

+ const Version2

+ func (v Version) Validate() error

Nov 30, 2022

retracted

Changes in this version

+ const DefaultLimit

+ const MaxLimit

+ var StartingID = uuid.Nil

+ func ParseQuery(query url.Values) (uuid.UUID, int, error)

+ type Cursor string

+ const CursorBegin

+ const CursorEnd

+ type Direction int

+ const DirectionForward

+ type Key string

+ const KeyDefault

+ type Option interface

+ func Limit(limit int) Option

+ func NewOptionsFromQuery(query url.Values) ([]Option, error)

+ func SortKey(key Key) Option

+ func SortOrder(order Order) Option

+ func StartingAfter(cursor Cursor) Option

+ type Options struct

+ func ApplyOptions(os []Option) Options

+ func (opts Options) LimitCOMPAT() int

+ func (opts Options) Query() url.Values

+ func (opts Options) StartingAfterCOMPAT() string

+ type Order int

+ const OrderAscending

+ type ResponseFields struct

+ HasNext bool

+ HasPrev bool

+ Next Cursor

+ Prev Cursor