optionx

func EmptyEndDate ¶

func EmptyEndDate() validation.ErrorDetails

func EmptyOrderColumnMap ¶

func EmptyOrderColumnMap() validation.ErrorDetails

func EmptyStartDate ¶

func EmptyStartDate() validation.ErrorDetails

func InvalidLimit ¶

func InvalidLimit() validation.ErrorDetails

func InvalidOrdering ¶

func InvalidOrdering() validation.ErrorDetails

func Register ¶

func Register(columnToString map[types.Column]string, orderColumns map[string]types.Column)

Register accepts order columns map and column to string map. It assigns input arguments to private local variables. This function should be called in the init function to register the columns. Validations like pagination use these maps to validate the user inputs. This is an example how to use it. First create a *.go file in `common' package in your project and define columns like this:

    package common

    import (
       "bitbucket.org/ouadreams/common/types"
       "bitbucket.org/ouadreams/common/optionx"
    )

    const (
        _ types.Column = iota
	       createdAtColumn
	       symbolColumn
	       statusColumn
    )

    func init() {
	       columnToStringTest := map[types.Column]string{
		       createdAtColumn: "created_at",
		       symbolColumn:    "symbol",
		       statusColumn:    "status",
	       }
	       orderColumnsTest := map[string]types.Column{
		       "created_at": createdAtColumn,
	       }
	       optionx.Register(columnToStringTest, orderColumnsTest)
    }

Then you should import this package in you main file to inject to register columns:

package main

import _ "bitbucket.org/ouadreams/[your-repo-name]/internal/common"

This is you need to do to register your columns in optionx package.