order

Documentation

Overview

Package order provides support for describing the ordering of data.

Index

• Constants
• type By
  • func NewBy(field string, direction string) By
  • func Parse(fieldMappings map[string]string, orderBy string, defaultOrder By) (By, error)

Constants

const (
	ASC  = "ASC"
	DESC = "DESC"
)

Set of directions for data ordering.

Types

type By

type By struct {
	Field     string
	Direction string
}

By represents a field used to order by and direction.

func NewBy

func NewBy(field string, direction string) By

NewBy constructs a new By value with no checks.

func Parse

func Parse(fieldMappings map[string]string, orderBy string, defaultOrder By) (By, error)

Parse constructs a By value by parsing a string in the form of "field,direction" ie "user_id,ASC".