utils

Documentation

Index

• func Clone[T any](fromValue T) (toValue T)
• func CorsHeaders() map[string]string
• func DeepCopy(fromValue interface{}) (toValue interface{})
• func DetermineDaysLeft(fromDateLocal time.Time, toDateLocal time.Time) int
• func EscapeOpenSearchSearchString(str string) string
• func FormatPhoneNumber(phoneNumber string) string
• func GetEnv(name string, def string) (env string)
• func IsEqual(expected interface{}, actual interface{}) bool
• func IsUrlStrict(str string) bool
• func IsValidUsername(str string) bool
• func NormalizeEmail(email string) string
• func PointerToValue[V any](value *V) V
• func RemoveUrlScheme(str string) string
• func SplitAndCleanEmailAddresses(emails string) []string
• func StandardisePhoneNumber(number string) string
• func StripEmail(email string) (strippedEmail string, strippedDomain string)
• func StripQueryString(inputUrl string) (string, error)
• func ValidateEmailAddress(email string, options ...map[string]string) (string, error)
• func ValidateIPAddress(ipAddress string) (cleanedIPAddress string, err error)
• func ValueToPointer[V any](value V) *V

Functions

func Clone

func Clone[T any](fromValue T) (toValue T)

func CorsHeaders

func CorsHeaders() map[string]string

CorsHeaders returns a map to allow Cors

func DeepCopy

func DeepCopy(fromValue interface{}) (toValue interface{})

func DetermineDaysLeft

func DetermineDaysLeft(fromDateLocal time.Time, toDateLocal time.Time) int

func EscapeOpenSearchSearchString

func EscapeOpenSearchSearchString(str string) string

EscapeOpenSearchSearchString See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters

func FormatPhoneNumber

func FormatPhoneNumber(phoneNumber string) string

func GetEnv

func GetEnv(name string, def string) (env string)

GetEnv is a helper function for getting environment variables with a default

func IsEqual

func IsEqual(expected interface{}, actual interface{}) bool

IsEqual returns if the two objects are equal

func IsUrlStrict

func IsUrlStrict(str string) bool

IsUrlStrict Returns whether a URL is valid in a strict way (Must have scheme and host)

func IsValidUsername

func IsValidUsername(str string) bool

func NormalizeEmail

func NormalizeEmail(email string) string

func PointerToValue

func PointerToValue[V any](value *V) V

func RemoveUrlScheme

func RemoveUrlScheme(str string) string

RemoveUrlScheme Removes http:// or https:// from a URL

func SplitAndCleanEmailAddresses

func SplitAndCleanEmailAddresses(emails string) []string

func StandardisePhoneNumber

func StandardisePhoneNumber(number string) string

StandardisePhoneNumber standardises phone numbers with +27 instead of 0 prefix

func StripEmail

func StripEmail(email string) (strippedEmail string, strippedDomain string)

func StripQueryString

func StripQueryString(inputUrl string) (string, error)

StripQueryString - Strips the query parameters from a URL

func ValidateEmailAddress

func ValidateEmailAddress(email string, options ...map[string]string) (string, error)

func ValidateIPAddress

func ValidateIPAddress(ipAddress string) (cleanedIPAddress string, err error)

func ValueToPointer

func ValueToPointer[V any](value V) *V