pagi

Documentation

Overview

Package pagi provides utilities for implementing pagination in Go applications. It includes structures and methods for calculating page numbers, limits, and offsets based on total item counts and user-defined page sizes. This package aims to simplify the process of adding pagination to data-driven applications, ensuring efficient data retrieval and presentation.

Index

• func WithInterceptor[T any](query T, opts ...InterceptorOption) T
• type InterceptorOption
  • func WithFilter(filterExp string, filterArgs []interface{}) InterceptorOption
  • func WithLimitOffset(limit int, offset int) InterceptorOption
  • func WithSelect(selects ...string) InterceptorOption
  • func WithSort(sort ...string) InterceptorOption
• type Meta
• type Param
• type Response

Functions

func WithInterceptor

func WithInterceptor[T any](query T, opts ...InterceptorOption) T

Types

type InterceptorOption

type InterceptorOption func(*sql.Selector)

func WithFilter

func WithFilter(filterExp string, filterArgs []interface{}) InterceptorOption

func WithLimitOffset

func WithLimitOffset(limit int, offset int) InterceptorOption

func WithSelect

func WithSelect(selects ...string) InterceptorOption

func WithSort

func WithSort(sort ...string) InterceptorOption

type Meta

type Meta struct {
	Limit  int  `json:"limit"`
	Offset int  `json:"offset"`
	Total  *int `json:"total"`
}

type Param

type Param struct {
	Limit  int            `json:"limit"`
	Offset int            `json:"offset"`
	Filter map[string]any `json:"filter"`
	Sort   []string       `json:"sort"`
}

type Response

type Response[T any] struct {
	Data []T   `json:"data"`
	Meta *Meta `json:"meta"`
}