validators

Documentation

Index

• Variables
• func APIKey(input string) error
• func APIKeyNotRestricted(input string) error
• func Account(account string) error
• func CallNonEmpty(validator ArgValidator, value string) error
• func CallNonEmptyArray(validator ArgValidator, values []string) error
• func ExactArgs(num int) cobra.PositionalArgs
• func HTTPMethod(method string) error
• func MaximumNArgs(num int) cobra.PositionalArgs
• func NoArgs(cmd *cobra.Command, args []string) error
• func RequestSource(source string) error
• func RequestStatus(status string) error
• func StatusCode(code string) error
• func StatusCodeType(code string) error
• type ArgValidator

Variables

var (
	// ErrAPIKeyNotConfigured is the error returned when the loaded profile is missing the api key property
	ErrAPIKeyNotConfigured = errors.New("you have not configured API keys yet")
	// ErrDeviceNameNotConfigured is the error returned when the loaded profile is missing the device name property
	ErrDeviceNameNotConfigured = errors.New("you have not configured your device name yet")
)

Functions

func APIKey

func APIKey(input string) error

APIKey validates that a string looks like an API key.

func APIKeyNotRestricted

func APIKeyNotRestricted(input string) error

APIKeyNotRestricted validates that a string looks like a secret API key and is not a restricted key.

func Account

func Account(account string) error

Account validates that a string is an acceptable account filter.

func CallNonEmpty

func CallNonEmpty(validator ArgValidator, value string) error

CallNonEmpty calls an argument validator on a string if the string is not empty.

func CallNonEmptyArray

func CallNonEmptyArray(validator ArgValidator, values []string) error

CallNonEmptyArray calls an argument validator on all non-empty elements of a string array.

func ExactArgs

func ExactArgs(num int) cobra.PositionalArgs

ExactArgs is a validator for commands to print an error when the number provided is different than the arguments passed in

func HTTPMethod

func HTTPMethod(method string) error

HTTPMethod validates that a string is an acceptable HTTP method.

func MaximumNArgs

func MaximumNArgs(num int) cobra.PositionalArgs

MaximumNArgs is a validator for commands to print an error when the provided args are greater than the maximum amount

func NoArgs

func NoArgs(cmd *cobra.Command, args []string) error

NoArgs is a validator for commands to print an error when an argument is provided

func RequestSource

func RequestSource(source string) error

RequestSource validates that a string is an acceptable request source.

func RequestStatus

func RequestStatus(status string) error

RequestStatus validates that a string is an acceptable request status.

func StatusCode

func StatusCode(code string) error

StatusCode validates that a provided status code is within the range of those used in the Hookdeck API.

func StatusCodeType

func StatusCodeType(code string) error

StatusCodeType validates that a provided status code type is one of those used in the Hookdeck API.

Types

type ArgValidator

type ArgValidator func(string) error

ArgValidator is an argument validator. It accepts a string and returns an error if the string is invalid, or nil otherwise.