pagination

package

v0.0.0-...-1f1dc5f Latest Latest Go to latest Published: Jun 30, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Package pagination normalizes bounded offset pagination.

This section is empty.

View Source

var ErrInvalid = errors.New("invalid pagination")

ErrInvalid reports invalid or overflowing pagination input.

func Bounds(total, offset, limit int) (start, end int, ok bool, err error)

Bounds converts validated offset pagination into safe slice indexes.

type Options struct {
	DefaultPageSize int
	MaxPageSize     int
}

Options defines the pagination policy for one list endpoint.

type Window struct {
	Page     int
	PageSize int
	Offset   int
	Limit    int
}

Window is a validated page request translated into store-facing bounds.

func Normalize(page, pageSize int, options Options) (Window, error)

Normalize applies defaults, validates bounds, and rejects offset overflow.