sprout

package module

Go to main page

Versions in this module

v0

v0.6.0

Sep 16, 2024

Changes in this version

+ var ErrConvertFailed = errors.New("failed to convert")

+ func AddNotice(notices *[]FunctionNotice, notice *FunctionNotice)

+ func AssignNotices(h Handler)

+ func AssignSafeFuncs(handler Handler)

+ func ErrRecoverPanic(err *error, errMessage string)

+ func NewErrConvertFailed(typ string, value any, err error) error

type DefaultHandler

+ func (dh *DefaultHandler) Notices() []FunctionNotice

+ func (dh *DefaultHandler) RawAliases() FunctionAliasMap

+ func (dh *DefaultHandler) RawFunctions() FunctionMap

+ type FunctionNotice struct

+ FunctionNames []string

+ Kind NoticeKind

+ Message string

+ func NewDebugNotice(functionName, message string) *FunctionNotice

+ func NewDeprecatedNotice(functionName, message string) *FunctionNotice

+ func NewInfoNotice(functionName, message string) *FunctionNotice

+ func NewNotice(kind NoticeKind, functionNames []string, message string) *FunctionNotice

type Handler

+ Notices func() []FunctionNotice

+ RawAliases func() FunctionAliasMap

+ RawFunctions func() FunctionMap

type HandlerOption

+ func WithNotices(notices ...*FunctionNotice) HandlerOption[*DefaultHandler]

+ func WithRegistries(registries ...Registry) HandlerOption[*DefaultHandler]

+ func WithSafeFuncs(enabled bool) HandlerOption[*DefaultHandler]

+ type NoticeKind int

+ const NoticeKindDebug

+ const NoticeKindDeprecated

+ const NoticeKindInfo

+ type RegistryWithNotice interface

+ RegisterNotices func(notices *[]FunctionNotice) error

v0.6.0-rc1

Sep 8, 2024

v0.5.1

Aug 18, 2024

v0.5.0

Aug 15, 2024

Changes in this version

+ func AddAlias(aliasMap FunctionAliasMap, originalFunction string, aliases ...string)

+ func AddFunction(funcsMap FunctionMap, name string, function any)

+ func AssignAliases(h Handler)

+ type DefaultHandler struct

+ ErrHandling ErrHandling

+ func New(opts ...HandlerOption[*DefaultHandler]) *DefaultHandler

+ func (dh *DefaultHandler) AddRegistries(registries ...Registry) error

+ func (dh *DefaultHandler) AddRegistry(reg Registry) error

+ func (dh *DefaultHandler) Aliases() FunctionAliasMap

+ func (dh *DefaultHandler) Build() FunctionMap

+ func (dh *DefaultHandler) Functions() FunctionMap

+ func (dh *DefaultHandler) Logger() *slog.Logger

+ type FunctionMap = template.FuncMap

+ type Handler interface

+ AddRegistries func(registries ...Registry) error

+ AddRegistry func(registry Registry) error

+ Aliases func() FunctionAliasMap

+ Build func() FunctionMap

+ Functions func() FunctionMap

+ Logger func() *slog.Logger

+ type HandlerOption func(T)

+ func WithHandler(new Handler) HandlerOption[*DefaultHandler]

+ type Registry interface

+ LinkHandler func(fh Handler) error

+ RegisterFunctions func(fnMap FunctionMap) error

+ Uid func() string

+ type RegistryWithAlias interface

+ RegisterAliases func(aliasMap FunctionAliasMap) error

v0.4.1

Jun 17, 2024

v0.4.0

May 16, 2024

Changes in this version

+ func GenericFuncMap(opts ...FunctionHandlerOption) map[string]interface

+ func HermeticHtmlFuncMap(opts ...FunctionHandlerOption) htemplate.FuncMap

+ func HermeticTxtFuncMap(opts ...FunctionHandlerOption) ttemplate.FuncMap

+ func HtmlFuncMap(opts ...FunctionHandlerOption) htemplate.FuncMap

+ func TxtFuncMap(opts ...FunctionHandlerOption) ttemplate.FuncMap

type FunctionHandler

+ func (fh *FunctionHandler) FromYAML(str string) any

+ func (fh *FunctionHandler) MustFromYAML(v string) (any, error)

+ func (fh *FunctionHandler) MustToYAML(v any) (string, error)

+ func (fh *FunctionHandler) ToBool(v any) bool

+ func (fh *FunctionHandler) ToUint(v any) uint

+ func (fh *FunctionHandler) ToUint64(v any) uint64

+ func (fh *FunctionHandler) ToYAML(v any) string

v0.3.0

May 9, 2024

Changes in this version

+ func FuncMap(opts ...FunctionHandlerOption) template.FuncMap

+ type DSAKeyFormat struct

+ G *big.Int

+ P *big.Int

+ Q *big.Int

+ Version int

+ X *big.Int

+ Y *big.Int

+ type ErrHandling int

+ const ErrHandlingErrorChannel

+ const ErrHandlingPanic

+ const ErrHandlingReturnDefaultValue

+ type FunctionAliasMap map[string][]string

+ type FunctionHandler struct

+ ErrHandling ErrHandling

+ Logger *slog.Logger

+ func NewFunctionHandler(opts ...FunctionHandlerOption) *FunctionHandler

+ func (fh *FunctionHandler) Add(values ...any) any

+ func (fh *FunctionHandler) Add1(x any) any

+ func (fh *FunctionHandler) Adler32sum(input string) string

+ func (fh *FunctionHandler) All(values ...any) bool

+ func (fh *FunctionHandler) Any(values ...any) bool

+ func (fh *FunctionHandler) Append(list any, v any) []any

+ func (fh *FunctionHandler) Base32Decode(s string) string

+ func (fh *FunctionHandler) Base32Encode(s string) string

+ func (fh *FunctionHandler) Base64Decode(s string) string

+ func (fh *FunctionHandler) Base64Encode(s string) string

+ func (fh *FunctionHandler) Bcrypt(input string) string

+ func (fh *FunctionHandler) BuildCustomCertificate(b64cert string, b64key string) (certificate, error)

+ func (fh *FunctionHandler) Cat(values ...any) string

+ func (fh *FunctionHandler) Ceil(num any) float64

+ func (fh *FunctionHandler) Chunk(size int, list any) [][]any

+ func (fh *FunctionHandler) Coalesce(values ...any) any

+ func (fh *FunctionHandler) Compact(list any) []any

+ func (fh *FunctionHandler) Concat(lists ...any) any

+ func (fh *FunctionHandler) Contains(substring string, str string) bool

+ func (fh *FunctionHandler) Date(fmt string, date any) string

+ func (fh *FunctionHandler) DateAgo(date any) string

+ func (fh *FunctionHandler) DateInZone(fmt string, date any, zone string) string

+ func (fh *FunctionHandler) DateModify(fmt string, date time.Time) time.Time

+ func (fh *FunctionHandler) DecryptAES(password string, crypt64 string) (string, error)

+ func (fh *FunctionHandler) DeepCopy(element any) any

+ func (fh *FunctionHandler) DeepEqual(x, y any) bool

+ func (fh *FunctionHandler) Default(defaultValue any, given ...any) any

+ func (fh *FunctionHandler) DerivePassword(counter uint32, passwordType, password, user, site string) string

+ func (fh *FunctionHandler) Dict(values ...any) map[string]any

+ func (fh *FunctionHandler) Dig(args ...any) (any, error)

+ func (fh *FunctionHandler) DivInt(values ...any) int64

+ func (fh *FunctionHandler) Divf(values ...any) any

+ func (fh *FunctionHandler) Duration(sec any) string

+ func (fh *FunctionHandler) DurationRound(duration any) string

+ func (fh *FunctionHandler) Ellipsis(maxWidth int, str string) string

+ func (fh *FunctionHandler) EllipsisBoth(offset int, maxWidth int, str string) string

+ func (fh *FunctionHandler) Empty(given any) bool

+ func (fh *FunctionHandler) EncryptAES(password string, plaintext string) (string, error)

+ func (fh *FunctionHandler) Env(key string) string

+ func (fh *FunctionHandler) ExpandEnv(str string) string

+ func (fh *FunctionHandler) Fail(message string) (*uint, error)

+ func (fh *FunctionHandler) First(list any) any

+ func (fh *FunctionHandler) Floor(num any) float64

+ func (fh *FunctionHandler) FromJson(v string) any

+ func (fh *FunctionHandler) GenerateCertificateAuthority(cn string, daysValid int) (certificate, error)

+ func (fh *FunctionHandler) GenerateCertificateAuthorityWithKeyInternal(cn string, daysValid int, priv crypto.PrivateKey) (certificate, error)

+ func (fh *FunctionHandler) GenerateCertificateAuthorityWithPEMKey(cn string, daysValid int, privPEM string) (certificate, error)

+ func (fh *FunctionHandler) GeneratePrivateKey(typ string) string

+ func (fh *FunctionHandler) GenerateSelfSignedCertificate(cn string, ips []interface{}, alternateDNS []interface{}, daysValid int) (certificate, error)

+ func (fh *FunctionHandler) GenerateSelfSignedCertificateWithKeyInternal(cn string, ips []interface{}, alternateDNS []interface{}, daysValid int, ...) (certificate, error)

+ func (fh *FunctionHandler) GenerateSelfSignedCertificateWithPEMKey(cn string, ips []interface{}, alternateDNS []interface{}, daysValid int, ...) (certificate, error)

+ func (fh *FunctionHandler) GenerateSignedCertificate(cn string, ips []interface{}, alternateDNS []interface{}, daysValid int, ...) (certificate, error)

+ func (fh *FunctionHandler) GenerateSignedCertificateWithKeyInternal(cn string, ips []interface{}, alternateDNS []interface{}, daysValid int, ...) (certificate, error)

+ func (fh *FunctionHandler) GenerateSignedCertificateWithPEMKey(cn string, ips []interface{}, alternateDNS []interface{}, daysValid int, ...) (certificate, error)

+ func (fh *FunctionHandler) Get(dict map[string]any, key string) any

+ func (fh *FunctionHandler) GetAlternateDNSStrs(alternateDNS []interface{}) ([]string, error)

+ func (fh *FunctionHandler) GetBaseCertTemplate(cn string, ips []interface{}, alternateDNS []interface{}, daysValid int) (*x509.Certificate, error)

+ func (fh *FunctionHandler) GetCertAndKey(template *x509.Certificate, signeeKey crypto.PrivateKey, ...) (string, string, error)

+ func (fh *FunctionHandler) GetHostByName(name string) string

+ func (fh *FunctionHandler) GetNetIPs(ips []interface{}) ([]net.IP, error)

+ func (fh *FunctionHandler) GetPublicKey(priv crypto.PrivateKey) (crypto.PublicKey, error)

+ func (fh *FunctionHandler) Has(element any, list any) bool

+ func (fh *FunctionHandler) HasKey(dict map[string]any, key string) bool

+ func (fh *FunctionHandler) HasPrefix(prefix string, str string) bool

+ func (fh *FunctionHandler) HasSuffix(suffix string, str string) bool

+ func (fh *FunctionHandler) Hello() string

+ func (fh *FunctionHandler) HtmlDate(date any) string

+ func (fh *FunctionHandler) HtmlDateInZone(date any, zone string) string

+ func (fh *FunctionHandler) Htpasswd(username string, password string) string

+ func (fh *FunctionHandler) InList(haystack []any, needle any) bool

+ func (fh *FunctionHandler) Indent(spaces int, str string) string

+ func (fh *FunctionHandler) Initial(list any) []any

+ func (fh *FunctionHandler) Initials(str string) string

+ func (fh *FunctionHandler) Join(sep string, v any) string

+ func (fh *FunctionHandler) Keys(dicts ...map[string]any) []string

+ func (fh *FunctionHandler) KindIs(target string, src any) bool

+ func (fh *FunctionHandler) KindOf(src any) string

+ func (fh *FunctionHandler) Last(list any) any

+ func (fh *FunctionHandler) List(values ...any) []any

+ func (fh *FunctionHandler) Max(a any, i ...any) int64

+ func (fh *FunctionHandler) Maxf(a any, i ...any) float64

+ func (fh *FunctionHandler) Merge(dest map[string]any, srcs ...map[string]any) any

+ func (fh *FunctionHandler) MergeOverwrite(dest map[string]any, srcs ...map[string]any) any

+ func (fh *FunctionHandler) Min(a any, i ...any) int64

+ func (fh *FunctionHandler) Minf(a any, i ...any) float64

+ func (fh *FunctionHandler) Mod(x, y any) any

+ func (fh *FunctionHandler) MulInt(values ...any) int64

+ func (fh *FunctionHandler) Mulf(values ...any) any

+ func (fh *FunctionHandler) MustAppend(list any, v any) ([]any, error)

+ func (fh *FunctionHandler) MustChunk(size int, list any) ([][]any, error)

+ func (fh *FunctionHandler) MustCompact(list any) ([]any, error)

+ func (fh *FunctionHandler) MustDateModify(fmt string, date time.Time) (time.Time, error)

+ func (fh *FunctionHandler) MustDeepCopy(element any) (any, error)

+ func (fh *FunctionHandler) MustFirst(list any) (any, error)

+ func (fh *FunctionHandler) MustFromJson(v string) (any, error)

+ func (fh *FunctionHandler) MustHas(element any, list any) (bool, error)

+ func (fh *FunctionHandler) MustInitial(list any) ([]any, error)

+ func (fh *FunctionHandler) MustLast(list any) (any, error)

+ func (fh *FunctionHandler) MustMerge(dest map[string]any, srcs ...map[string]any) (any, error)

+ func (fh *FunctionHandler) MustMergeOverwrite(dest map[string]any, srcs ...map[string]any) (any, error)

+ func (fh *FunctionHandler) MustPrepend(list any, v any) ([]any, error)

+ func (fh *FunctionHandler) MustRegexFind(regex string, s string) (string, error)

+ func (fh *FunctionHandler) MustRegexFindAll(regex string, s string, n int) ([]string, error)

+ func (fh *FunctionHandler) MustRegexMatch(regex string, s string) (bool, error)

+ func (fh *FunctionHandler) MustRegexReplaceAll(regex string, s string, repl string) (string, error)

+ func (fh *FunctionHandler) MustRegexReplaceAllLiteral(regex string, s string, repl string) (string, error)

+ func (fh *FunctionHandler) MustRegexSplit(regex string, s string, n int) ([]string, error)

+ func (fh *FunctionHandler) MustRest(list any) ([]any, error)

+ func (fh *FunctionHandler) MustReverse(list any) ([]any, error)

+ func (fh *FunctionHandler) MustSlice(list any, indices ...any) (any, error)

+ func (fh *FunctionHandler) MustToDate(fmt, str string) (time.Time, error)

+ func (fh *FunctionHandler) MustToJson(v any) (string, error)

+ func (fh *FunctionHandler) MustToPrettyJson(v any) (string, error)

+ func (fh *FunctionHandler) MustToRawJson(v any) (string, error)

+ func (fh *FunctionHandler) MustUniq(list any) ([]any, error)

+ func (fh *FunctionHandler) MustWithout(list any, omit ...any) ([]any, error)

+ func (fh *FunctionHandler) Nindent(spaces int, str string) string

+ func (fh *FunctionHandler) Nospace(str string) string

+ func (fh *FunctionHandler) Now() time.Time

+ func (fh *FunctionHandler) Omit(dict map[string]any, keys ...string) map[string]any

+ func (fh *FunctionHandler) OsBase(str string) string

+ func (fh *FunctionHandler) OsClean(str string) string

+ func (fh *FunctionHandler) OsDir(str string) string

+ func (fh *FunctionHandler) OsExt(str string) string

+ func (fh *FunctionHandler) OsIsAbs(str string) bool

+ func (fh *FunctionHandler) ParsePrivateKeyPEM(pemBlock string) (crypto.PrivateKey, error)

+ func (fh *FunctionHandler) PathBase(str string) string

+ func (fh *FunctionHandler) PathClean(str string) string

+ func (fh *FunctionHandler) PathDir(str string) string

+ func (fh *FunctionHandler) PathExt(str string) string

+ func (fh *FunctionHandler) PathIsAbs(str string) bool

+ func (fh *FunctionHandler) PemBlockForKey(priv interface{}) *pem.Block

+ func (fh *FunctionHandler) Pick(dict map[string]any, keys ...string) map[string]any

+ func (fh *FunctionHandler) Pluck(key string, dicts ...map[string]any) []any

+ func (fh *FunctionHandler) Plural(one, many string, count int) string

+ func (fh *FunctionHandler) Prepend(list any, v any) []any

+ func (fh *FunctionHandler) Quote(elements ...any) string

+ func (fh *FunctionHandler) RandAlpha(count int) string

+ func (fh *FunctionHandler) RandAlphaNumeric(count int) string

+ func (fh *FunctionHandler) RandAscii(count int) string

+ func (fh *FunctionHandler) RandBytes(count int) (string, error)

+ func (fh *FunctionHandler) RandInt(min, max int) int

+ func (fh *FunctionHandler) RandNumeric(count int) string

+ func (fh *FunctionHandler) RegexFind(regex string, s string) string

+ func (fh *FunctionHandler) RegexFindAll(regex string, s string, n int) []string

+ func (fh *FunctionHandler) RegexMatch(regex string, s string) bool

+ func (fh *FunctionHandler) RegexQuoteMeta(s string) string

+ func (fh *FunctionHandler) RegexReplaceAll(regex string, s string, repl string) string

+ func (fh *FunctionHandler) RegexReplaceAllLiteral(regex string, s string, repl string) string

+ func (fh *FunctionHandler) RegexSplit(regex string, s string, n int) []string

+ func (fh *FunctionHandler) Repeat(count int, str string) string

+ func (fh *FunctionHandler) Replace(old, new, src string) string

+ func (fh *FunctionHandler) Rest(list any) []any

+ func (fh *FunctionHandler) Reverse(list any) []any

+ func (fh *FunctionHandler) Round(num any, poww int, roundOpts ...float64) float64

+ func (fh *FunctionHandler) Semver(version string) (*sv2.Version, error)

+ func (fh *FunctionHandler) SemverCompare(constraint, version string) (bool, error)

+ func (fh *FunctionHandler) Seq(params ...int) string

+ func (fh *FunctionHandler) Set(dict map[string]any, key string, value any) map[string]any

+ func (fh *FunctionHandler) Sha1sum(input string) string

+ func (fh *FunctionHandler) Sha256sum(input string) string

+ func (fh *FunctionHandler) Shuffle(str string) string

+ func (fh *FunctionHandler) Slice(list any, indices ...any) any

+ func (fh *FunctionHandler) SortAlpha(list any) []string

+ func (fh *FunctionHandler) Split(sep, orig string) map[string]string

+ func (fh *FunctionHandler) SplitList(sep string, str string) []string

+ func (fh *FunctionHandler) Splitn(sep string, n int, orig string) map[string]string

+ func (fh *FunctionHandler) Squote(elements ...any) string

+ func (fh *FunctionHandler) StrSlice(value any) []string

+ func (fh *FunctionHandler) Sub(values ...any) any

+ func (fh *FunctionHandler) Substring(start, end int, str string) string

+ func (fh *FunctionHandler) SwapCase(str string) string

+ func (fh *FunctionHandler) Ternary(trueValue any, falseValue any, condition bool) any

+ func (fh *FunctionHandler) ToCamelCase(str string) string

+ func (fh *FunctionHandler) ToConstantCase(str string) string

+ func (fh *FunctionHandler) ToDate(fmt, str string) time.Time

+ func (fh *FunctionHandler) ToDotCase(str string) string

+ func (fh *FunctionHandler) ToDuration(v any) time.Duration

+ func (fh *FunctionHandler) ToFloat64(v any) float64

+ func (fh *FunctionHandler) ToInt(v any) int

+ func (fh *FunctionHandler) ToInt64(v any) int64

+ func (fh *FunctionHandler) ToJson(v any) string

+ func (fh *FunctionHandler) ToKebabCase(str string) string

+ func (fh *FunctionHandler) ToLower(str string) string

+ func (fh *FunctionHandler) ToOctal(v any) int64

+ func (fh *FunctionHandler) ToPascalCase(str string) string

+ func (fh *FunctionHandler) ToPathCase(str string) string

+ func (fh *FunctionHandler) ToPrettyJson(v any) string

+ func (fh *FunctionHandler) ToRawJson(v any) string

+ func (fh *FunctionHandler) ToSnakeCase(str string) string

+ func (fh *FunctionHandler) ToString(v any) string

+ func (fh *FunctionHandler) ToTitleCase(str string) string

+ func (fh *FunctionHandler) ToUpper(str string) string

+ func (fh *FunctionHandler) Trim(str string) string

+ func (fh *FunctionHandler) TrimAll(cutset string, str string) string

+ func (fh *FunctionHandler) TrimPrefix(prefix string, str string) string

+ func (fh *FunctionHandler) TrimSuffix(suffix string, str string) string

+ func (fh *FunctionHandler) Trunc(count int, str string) string

+ func (fh *FunctionHandler) TypeIs(target string, src any) bool

+ func (fh *FunctionHandler) TypeIsLike(target string, src any) bool

+ func (fh *FunctionHandler) TypeOf(src any) string

+ func (fh *FunctionHandler) Uniq(list any) []any

+ func (fh *FunctionHandler) UnixEpoch(date time.Time) string

+ func (fh *FunctionHandler) Unset(dict map[string]any, key string) map[string]any

+ func (fh *FunctionHandler) Until(count int) []int

+ func (fh *FunctionHandler) UntilStep(start, stop, step int) []int

+ func (fh *FunctionHandler) Untitle(str string) string

+ func (fh *FunctionHandler) UrlJoin(d map[string]any) string

+ func (fh *FunctionHandler) UrlParse(v string) map[string]any

+ func (fh *FunctionHandler) Uuidv4() string

+ func (fh *FunctionHandler) Values(dict map[string]any) []any

+ func (fh *FunctionHandler) Without(list any, omit ...any) []any

+ func (fh *FunctionHandler) WordWrap(wrapLength int, newLineCharacter string, wrapLongWords bool, str string) string

+ func (fh *FunctionHandler) Wrap(length int, str string) string

+ func (fh *FunctionHandler) WrapWith(length int, newLineCharacter string, str string) string

+ type FunctionHandlerOption func(*FunctionHandler)

+ func WithAlias(originalFunction string, aliases ...string) FunctionHandlerOption

+ func WithAliases(aliases FunctionAliasMap) FunctionHandlerOption

+ func WithErrHandling(eh ErrHandling) FunctionHandlerOption

+ func WithErrorChannel(ec chan error) FunctionHandlerOption

+ func WithFunctionHandler(new *FunctionHandler) FunctionHandlerOption

+ func WithLogger(l *slog.Logger) FunctionHandlerOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL