utils

Documentation

Index

• Variables
• func AllNameGenderDescriptions() ([]string, error)
• func AllNameGenderDescriptionsWithKeys() ([]string, error)
• func AllNameGenderKeys() ([]string, error)
• func FormatNumberWithDelimiter(num int, delimiter string) string
• func GeneratePassword(passwordLength int) string
• func IntRangeFromString(input string, min int, max int) (int, int, error)
• func OpenFile(filepath string) error
• func ProperNounCase(input string) string
• func RandStringBytesMaskImprSrc(n int) string
• func RandomColour() string
• func RandomColours(n int) []string
• func RandomHex(length int) (string, error)
• func RandomItemFromList[T any](items []T) (*T, error)
• func RandomNumberBetweenRange(min int, max int) int
• func TrimEmptyLines(input string) string
• func WithFemaleNamesList(namesList string) func(*nameService)
• func WithLastNamesList(namesList string) func(*nameService)
• func WithMaleNamesList(namesList string) func(*nameService)
• func WithUnisexNamesList(namesList string) func(*nameService)
• type NameGender
  • func NameGenderFromString(value string) NameGender
  • func (g NameGender) Description() (string, error)
  • func (g NameGender) DescriptionWithKey() (string, error)
  • func (g NameGender) Key() (string, error)
• type NameService
  • func NewNameService(options ...func(*nameService)) NameService
  • func NewPopulatedService(options ...func(*nameService)) NameService

Variables

var SupportedGenders = []NameGender{
	NameGenderUnisex,
	NameGenderFemale,
	NameGenderMale,
	NameGenderAny,
}

Functions

func AllNameGenderDescriptions

func AllNameGenderDescriptions() ([]string, error)

func AllNameGenderDescriptionsWithKeys

func AllNameGenderDescriptionsWithKeys() ([]string, error)

func AllNameGenderKeys

func AllNameGenderKeys() ([]string, error)

func FormatNumberWithDelimiter

func FormatNumberWithDelimiter(num int, delimiter string) string

func GeneratePassword

func GeneratePassword(passwordLength int) string

PasswordGenerator Source: https://www.twilio.com/en-us/blog/generate-passwords-go

func IntRangeFromString

func IntRangeFromString(input string, min int, max int) (int, int, error)

func OpenFile

func OpenFile(filepath string) error

func ProperNounCase

func ProperNounCase(input string) string

ProperNounCase changes the case to use proper noun case in English, e.g. JOHN -> John, sally -> Sally

func RandStringBytesMaskImprSrc

func RandStringBytesMaskImprSrc(n int) string

func RandomColour

func RandomColour() string

func RandomColours

func RandomColours(n int) []string

func RandomHex

func RandomHex(length int) (string, error)

func RandomItemFromList

func RandomItemFromList[T any](items []T) (*T, error)

RandomItemFromList

func RandomNumberBetweenRange

func RandomNumberBetweenRange(min int, max int) int

func TrimEmptyLines

func TrimEmptyLines(input string) string

func WithFemaleNamesList

func WithFemaleNamesList(namesList string) func(*nameService)

func WithLastNamesList

func WithLastNamesList(namesList string) func(*nameService)

func WithMaleNamesList

func WithMaleNamesList(namesList string) func(*nameService)

func WithUnisexNamesList

func WithUnisexNamesList(namesList string) func(*nameService)

Types

type NameGender

type NameGender int

const (
	NameGenderUnisex NameGender = iota
	NameGenderFemale
	NameGenderMale
	NameGenderAny
)

func NameGenderFromString

func NameGenderFromString(value string) NameGender

func (NameGender) Description

func (g NameGender) Description() (string, error)

func (NameGender) DescriptionWithKey

func (g NameGender) DescriptionWithKey() (string, error)

func (NameGender) Key

func (g NameGender) Key() (string, error)

type NameService

type NameService interface {
	GetFirstNamesFemale() []string
	GetFirstNamesMale() []string
	GetFirstNamesUnisex() []string
	GetLastNames() []string

	RandomFirstNameFemale() (string, error)
	RandomFirstNameMale() (string, error)
	RandomFirstNameUnisex() (string, error)
	RandomFirstNameAny() (string, error)
	RandomFirstName(NameGender) (string, error)
	RandomLastName() (string, error)
}

func NewNameService

func NewNameService(options ...func(*nameService)) NameService

func NewPopulatedService

func NewPopulatedService(options ...func(*nameService)) NameService