commons

Documentation

Index

• Constants
• Variables
• func ComputePage(first *int, last *int, after *string, before *string, total int) (offset int, limit int, err error)
• func ConfigureLog(level slog.Leveler)
• func DecodeCursor(base64Cursor string, total int) (int, error)
• func EncodeCursor(offset int) string
• type PageResult

Constants

const DefaultPaginationLimit = 1000

Variables

var ErrInvalidCursor = errors.New("invalid pagination cursor")

var ErrInvalidLimit = errors.New("limit cannot be negative")

var ErrMixedPagination = errors.New(
	"cannot mix forward pagination (first, after) with backward pagination (last, before)")

Functions

func ComputePage

func ComputePage(
	first *int, last *int, after *string, before *string, total int,
) (offset int, limit int, err error)

Compute the pagination parameters given the GraphQL connection parameters.

func ConfigureLog

func ConfigureLog(level slog.Leveler)

func DecodeCursor

func DecodeCursor(base64Cursor string, total int) (int, error)

Decode the integer offset from a base64 string.

func EncodeCursor

func EncodeCursor(offset int) string

Encode the integer offset into a base64 string.

Types

type PageResult

type PageResult[T any] struct {
	Total  uint64
	Offset uint64
	Rows   []T
}