params

Documentation

Index

• Constants
• func EncodeCursor(t time.Time, id string) string
• func URLID(ctx context.Context) (string, error)
• type Cursor
  • func DecodeCursor(encodedCursor string) (Cursor, error)
• type Query
  • func ParseQuery(rawQuery string, obj obj) (Query, error)

Constants

const (
	User obj = iota
	Shop
	Product
	Review
	Order
)

Object types

Functions

func EncodeCursor

func EncodeCursor(t time.Time, id string) string

EncodeCursor encodes time and id with base64.

func URLID

func URLID(ctx context.Context) (string, error)

URLID returns the id parsed from the url.

Types

type Cursor

type Cursor struct {
	// Used defines if the client used a cursor or not
	Used      bool
	CreatedAt time.Time
	ID        string
}

Cursor contains the values used for pagination.

func DecodeCursor

func DecodeCursor(encodedCursor string) (Cursor, error)

DecodeCursor decodes de cursor and returns both it and time

type Query

type Query struct {
	Cursor Cursor
	Limit  string
}

Query contains the request parameters provided by the client.

TODO: include order field to let clients change the objects' order (DESC/ASC)

func ParseQuery

func ParseQuery(rawQuery string, obj obj) (Query, error)

ParseQuery returns the url params received after validating them.