pagination

README

pagination

A simple helper for dealing with pagination.

go get github.com/ory/pagination

Example

package main

import (
	"github.com/ory/pagination"
    "net/http"
    "net/url"
    "fmt"
)

func main() {
	u, _ := url.Parse("http://localhost/foo?offset=0&limit=10")
    limit, offset := pagination.Parse(&http.Request{URL: u}, 5, 5, 10)

    items := []string{"a", "b", "c", "d"}
    start, end := pagination.Index(limit, offset, len(items))
    fmt.Printf("Got items: %v", items[start:end])
}

Documentation

Overview

Package pagination provides helpers for dealing with pagination.

Index

• func Header(w http.ResponseWriter, u *url.URL, total int, limit, offset int)
• func HeaderWithFormatter(w http.ResponseWriter, u *url.URL, total int64, page, itemsPerPage int, ...)
• func Index(limit, offset, length int) (start, end int)
• func MaxItemsPerPage(max, is int) int
• func Parse(r *http.Request, defaultLimit, defaultOffset, maxLimit int) (int, int)

Functions

func Header

func Header(w http.ResponseWriter, u *url.URL, total int, limit, offset int)

Header adds an http header for pagination using a responsewriter where backwards compatibility is required. The header will contain links any combination of the first, last, next, or previous (prev) pages in a paginated list (given a limit and an offset, and optionally a total). If total is not set, then no "last" page will be calculated. If no limit is provided, then it will default to 1.

func HeaderWithFormatter

func HeaderWithFormatter(w http.ResponseWriter, u *url.URL, total int64, page, itemsPerPage int, f formatter)

HeaderWithFormatter adds an HTTP header for pagination which uses a custom formatter for generating the URL links.

func Index

func Index(limit, offset, length int) (start, end int)

Index uses limit, offset, and a slice's length to compute start and end indices for said slice.

func MaxItemsPerPage

func MaxItemsPerPage(max, is int) int

MaxItemsPerPage is used to prevent DoS attacks against large lists by limiting the items per page to 500.

func Parse

func Parse(r *http.Request, defaultLimit, defaultOffset, maxLimit int) (int, int)

Parse parses limit and offset from *http.Request with given limits and defaults.