cursor

Dec 16, 2025

Changes in this version

type Paginator

+ func (p *Paginator[T]) Paginate(ctx context.Context, args *paging.PageArgs, opts ...paging.PaginateOption) (*paging.Page[T], error)

Dec 14, 2025

Changes in this version

+ func BuildConnection[From any, To any](paginator Paginator, items []From, transform func(From) (To, error)) (*paging.Connection[To], error)

+ func BuildFetchParams[T any](page PageArgs, schema *Schema[T]) (paging.FetchParams, error)

+ func NewCompositeCursorEncoder[T any](extractor func(T) map[string]any) paging.CursorEncoder[T]

+ type CompositeCursorEncoder struct

+ func (e *CompositeCursorEncoder[T]) Decode(cursor string) (*paging.CursorPosition, error)

+ func (e *CompositeCursorEncoder[T]) Encode(item T) (*string, error)

+ type Direction bool

+ const ASC

+ const DESC

+ type PageArgs interface

+ GetAfter func() *string

+ GetFirst func() *int

+ GetSortBy func() []paging.Sort

+ type Paginator struct

+ PageInfo paging.PageInfo

+ func New[T any](page PageArgs, schema *Schema[T], items []T, defaultLimit ...*int) (Paginator, error)

+ func (p *Paginator) GetCursor() *paging.CursorPosition

+ func (p *Paginator) GetLimit() int

+ func (p *Paginator) GetOrderBy() []paging.Sort

+ func (p *Paginator) GetPageInfo() paging.PageInfo

+ type Schema struct

+ func NewSchema[T any]() *Schema[T]

+ func (s *Schema[T]) BuildOrderBy(userSorts []paging.Sort) []paging.Sort

+ func (s *Schema[T]) EncoderFor(pageArgs PageArgs) (paging.CursorEncoder[T], error)

+ func (s *Schema[T]) Field(name, cursorKey string, extractor func(T) any) *Schema[T]

+ func (s *Schema[T]) FixedField(name string, direction Direction, cursorKey string, extractor func(T) any) *Schema[T]

+ type Spec struct

+ func (s *Spec[T]) Decode(cursor string) (*paging.CursorPosition, error)

+ func (s *Spec[T]) Encode(item T) (*string, error)