sortopts

Documentation

Index

• Variables
• func ParseSortQueryParam(param string) ([]model.SortOption, error)
• type Sorter
  • func (s Sorter) OrderBy() string

Variables

var (
	// SortOptionsByQueryParam is a map to translate the "sort" query param values to SortOption(s)
	SortOptionsByQueryParam = map[string]model.SortOption{
		"userAgent-asc":  newSortOption("user_agent", false, 0),
		"userAgent-desc": newSortOption("user_agent", true, 0),
		"updatedAt-asc":  newTimeSortOption("updated_at", false, 1),
		"updatedAt-desc": newTimeSortOption("updated_at", true, 2),
	}

	ErrorUnknownSortingOption = errutil.BadRequest("unknown sorting option")
)

Functions

func ParseSortQueryParam

func ParseSortQueryParam(param string) ([]model.SortOption, error)

ParseSortQueryParam parses the "sort" query param and returns an ordered list of SortOption(s)

Types

type Sorter

type Sorter struct {
	Field         string
	LowerCase     bool
	Descending    bool
	WithTableName bool
}

func (Sorter) OrderBy

func (s Sorter) OrderBy() string