sort

Documentation

Index

• Constants
• type Ordering
  • func UnmarshalSort(input jsoniter.RawMessage) (*Ordering, error)
• type SortField

Constants

const (
	ASC  = "$asc"
	DESC = "$desc"
)

Types

type Ordering

type Ordering = []SortField

func UnmarshalSort

func UnmarshalSort(input jsoniter.RawMessage) (*Ordering, error)

UnmarshalSort expects a json array input. Examples:

[{"field_1": "$asc"}, {"field_2": "$desc"}]
[]

type SortField

type SortField struct {
	// Required; Name of field to enable sorting for
	Name string
	// Required; True if ascending order is requested, False for descending
	Ascending bool
	// Optional; True if missing/empty/null values to be presented at the top of sort order,
	// else they are sorted to the end by default
	MissingValuesFirst bool
}