Documentation | Contributing | Code of Conduct
import "atomicgo.dev/utils"Package utils is a collection of useful, quickly accessible utility functions.
- func AppendToFile[T string | []byte](path string, content T) error
- func DownloadFile(url, path string) error
- func Fetch(url string) (string, error)
- func FileExists(path string) bool
- func PrettyJSON(inputJSON string, indent ...string) (string, error)
- func ReadFile(path string) (string, error)
- func Ternary[T any](condition bool, a, b T) T
- func ToInt[T string | constraints.Number](value T) int
- func ToJSON(v any) (string, error)
- func ToPrettyJSON(v any, indent ...string) (string, error)
- func ToString(v any) string
- func WriteFile[T string | []byte](path string, content T) error
func AppendToFile
func AppendToFile[T string | []byte](path string, content T) errorAppendToFile appends the given content to the given file. Accepts a string or a byte slice.
func DownloadFile
func DownloadFile(url, path string) errorDownloadFile downloads the given URL to the given path. If the file already exists, it will be overwritten.
func Fetch
func Fetch(url string) (string, error)Fetch returns the body of a GET request to the given URL.
func FileExists
func FileExists(path string) boolFileExists returns true if the given file exists.
func PrettyJSON
func PrettyJSON(inputJSON string, indent ...string) (string, error)PrettyJSON returns a pretty-printed JSON string. If indent is not provided, it defaults to " " (two spaces).
person := Person{Name: "John Doe", Age: 42}
json, _ := utils.ToJSON(person)
prettyJSON, _ := utils.PrettyJSON(json)
fmt.Println(prettyJSON)
// Output:
// {
// "Name": "John Doe",
// "Age": 42
// }{
"Name": "John Doe",
"Age": 42
}
func ReadFile
func ReadFile(path string) (string, error)ReadFile reads the given file and returns its content.
func Ternary
func Ternary[T any](condition bool, a, b T) TTernary is a ternary operator. It returns a if the condition is true, otherwise it returns b.
package main
import (
"fmt"
"atomicgo.dev/utils"
)
func main() {
fmt.Println(utils.Ternary(true, "a", "b"))
fmt.Println(utils.Ternary(false, "a", "b"))
}a
b
func ToInt
func ToInt[T string | constraints.Number](value T) intToInt converts the given value to an int. If the value is a float, it will be rounded to the nearest integer. (Rounds up if the decimal is 0.5 or higher)
package main
import (
"fmt"
"atomicgo.dev/utils"
)
func main() {
fmt.Println(utils.ToInt(1337))
fmt.Println(utils.ToInt(1337.4))
fmt.Println(utils.ToInt(1337.5))
fmt.Println(utils.ToInt(1337.6))
fmt.Println(utils.ToInt("1337"))
fmt.Println(utils.ToInt("1337.4"))
fmt.Println(utils.ToInt("1337.5"))
fmt.Println(utils.ToInt("1337.6"))
}1337
1337
1338
1338
1337
1337
1338
1338
func ToJSON
func ToJSON(v any) (string, error)ToJSON converts the given value to a JSON string.
package main
import (
"fmt"
"atomicgo.dev/utils"
)
type Person struct {
Name string
Age int
}
func main() {
person := Person{"John Doe", 42}
json, _ := utils.ToJSON(person)
fmt.Println(json)
}{"Name":"John Doe","Age":42}
func ToPrettyJSON
func ToPrettyJSON(v any, indent ...string) (string, error)package main
import (
"fmt"
"atomicgo.dev/utils"
)
type Person struct {
Name string
Age int
}
func main() {
person := Person{Name: "John Doe", Age: 42}
prettyJSON, _ := utils.ToPrettyJSON(person)
fmt.Println(prettyJSON)
}{
"Name": "John Doe",
"Age": 42
}
func ToString
func ToString(v any) stringToString converts the given value to a string.
package main
import (
"fmt"
"atomicgo.dev/utils"
)
type Person struct {
Name string
Age int
}
func main() {
person := Person{"John Doe", 42}
fmt.Println(utils.ToString(person))
}{John Doe 42}
func WriteFile
func WriteFile[T string | []byte](path string, content T) errorWriteFile writes the given content to the given file. Accepts a string or a byte slice.
Generated by gomarkdoc
AtomicGo.dev · with ❤️ by @MarvinJWendt | MarvinJWendt.com
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent