Categorygithub.com/thefabric-io/tokcursor
modulepackage
1.2.1
Repository: https://github.com/thefabric-io/tokcursor.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
5
Dependents
0
Files
121 SLOC

# README

Tokenised cursor implementation

Tokcursor is a golang pagination token cursor utility to help on managing cursor pagination.

This utility provides an interface you can implement to create other encoded token. For now, only key:value encoded cursor is implemented.

# Functions

NewB64Cursor returns a base64 key:value cursor implementation.

# Variables

ErrPageSizeInvalid is returned if the page size is strictly inferior to 1.
ErrTokenFormatIncorrect is returned when the key:value element in a token decoded string is incorrect i.e "key:value:key, key2:value2" is incorrect because of the incorrect format of the first element "key:value:key".

# Structs

B64Cursor represents a base64 key:value cursor implementation.

# Interfaces

Cursor is a cursor interface representing a pagination cursor.