paging

package

v0.0.0-...-c2300e3 Latest Latest Go to latest Published: Dec 28, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nhaancs/bhms

Documentation ¶

Overview ¶

Package paging provides support for query paging.

Index ¶

type Page
- func ParseRequest(r *http.Request) (Page, error)
type Response
- func NewResponse[T any](items []T, total int, page int, rowsPrePage int) Response[T]

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Page ¶

type Page struct {
	Number      int
	RowsPerPage int
}

Page represents the requested page and rows per page.

func ParseRequest ¶

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

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

type Response ¶

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

Response is what is returned when a query call is performed.

func NewResponse ¶

func NewResponse[T any](items []T, total int, page int, rowsPrePage int) Response[T]

NewResponse constructs a response value for a web response.

Source Files ¶

View all Source files

paging.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL