page

Documentation

Overview

Package page provides support for query paging.

Index

• type Document
  • func NewDocument[T any](items []T, total int, page int, rowsPerPage int) Document[T]
• type Page
  • func Parse(r *http.Request) (Page, error)

Types

type Document

type Document[T any] struct {
	Items       []T `json:"items"`
	Total       int `json:"total"`
	Page        int `json:"page"`
	RowsPerPage int `json:"rowsPerPage"`
}

Document is the form used for API responses from query API calls.

func NewDocument

func NewDocument[T any](items []T, total int, page int, rowsPerPage int) Document[T]

NewDocument constructs a response value for a web paging trusted.

type Page

type Page struct {
	Number      int
	RowsPerPage int
}

Page represents the requested page and rows per page.

func Parse

func Parse(r *http.Request) (Page, error)

Parse parses the request for the page and rows query string. The defaults are provided as well.