pagination

Documentation

Index

• type Page
  • func (p Page) IsZero() bool
  • func (p Page) Limit() int
  • func (p Page) Offset() int
• type PagedResponse
  • func (p PagedResponse[T]) MarshalJSON() ([]byte, error)
• type Paginator

Types

type Page

type Page struct {
	PageSize   int `json:"pageSize"`
	PageNumber int `json:"page"`
}

func (Page) IsZero

func (p Page) IsZero() bool

func (Page) Limit

func (p Page) Limit() int

func (Page) Offset

func (p Page) Offset() int

type PagedResponse

type PagedResponse[T any] struct {
	Page       Page `json:"-"`
	TotalCount int  `json:"totalCount"`
	Items      []T  `json:"items"`
}

func (PagedResponse[T]) MarshalJSON

func (p PagedResponse[T]) MarshalJSON() ([]byte, error)

Implement json.Marshaler interface to flatten the Page struct

type Paginator

type Paginator[T any] interface {
	Paginate(ctx context.Context, page Page) (PagedResponse[T], error)
}