gotk

README

GoTK

The awesome GoTK library for Golang, aims to bring developer friendliness to just about every project.

Getting Started

Visit GoTK wiki page for more info

License

Released under the MIT License

Documentation

Index

• Variables
• func Get[T any](g Getter, key string) (value T, err error)
• func IsDir(file string) bool
• func IsFile(file string) bool
• func Join[T SetConstraint](entries []T, delim string) (value string, err error)
• func ParseJSON(data []byte, v any) (err error)
• func Path(paths ...string) string
• func PathFromExecutable(paths ...string) (file string, err error)
• func Split[T SetConstraint](data string, delim string) (value []T, err error)
• func ToJSON(v any) (value []byte, err error)
• func UUID() (value string, err error)
• type Array
  • func NewArray[T comparable](data ...T) Array[T]
• type ArrayCallback
• type ArrayPredicate
• type Getter
• type JSONEngine
  • func NewJSON(validatorTagName ...string) JSONEngine
• type PathFn
• type SetConstraint
• type Validator
  • func NewValidator(tagName ...string) Validator

Variables

var JSON jsonEngine

Functions

func Get

func Get[T any](g Getter, key string) (value T, err error)

func IsDir

func IsDir(file string) bool

func IsFile

func IsFile(file string) bool

func Join

func Join[T SetConstraint](entries []T, delim string) (value string, err error)

func ParseJSON

func ParseJSON(data []byte, v any) (err error)

func Path

func Path(paths ...string) string

func PathFromExecutable

func PathFromExecutable(paths ...string) (file string, err error)

func Split

func Split[T SetConstraint](data string, delim string) (value []T, err error)

func ToJSON

func ToJSON(v any) (value []byte, err error)

func UUID

func UUID() (value string, err error)

Types

type Array

type Array[T comparable] interface {
	First() T
	Last() T
	At(i int) T
	Get(i int) T
	Take(i int) T
	Push(v ...T) int
	Pop() T
	Slice(start int, stop ...int) Array[T]
	Splice(offset int, length int, v ...T) Array[T]
	Contains(v T) bool
	IndexOf(v T) int
	Length() int
	Find(fn ArrayPredicate[T]) T
	Filter(fn ArrayPredicate[T]) []T
	ForEach(fn ArrayCallback[T])
}

func NewArray

func NewArray[T comparable](data ...T) Array[T]

type ArrayCallback

type ArrayCallback[T comparable] func(value T, index int)

type ArrayPredicate

type ArrayPredicate[T comparable] func(value T) bool

type Getter

type Getter interface {
	Get(key string) (value any, exists bool)
}

type JSONEngine

type JSONEngine interface {
	Decode(data []byte, v any) (err error)
	Encode(v any) (value []byte, err error)
}

func NewJSON

func NewJSON(validatorTagName ...string) JSONEngine

type PathFn

type PathFn func() (path string, err error)

type SetConstraint

type SetConstraint interface {
	constraints.Integer | constraints.Float | ~string
}

type Validator

type Validator interface {
	Validate(data any, rules ...any) (err error)
}

func NewValidator

func NewValidator(tagName ...string) Validator