utils

README

Go-Utils

Utility package for Internal Portalnesia

This package converted from Javascript Version of Portalnesia Utils

Install

go get github.com/portalnesia/go-utils

Example

package main

import (
  utils "github.com/portalnesia/go-utils"
  "fmt"
)

func main() {
  text := "Hello World"

  slug := utils.Slug(text)
  fmt.Printf("Slugify Format: %s",slug)
}

Go References

pkg.go.dev/github.com/portalnesia/go-utils

Documentation

Index

• func Clean(s string) string
• func CleanAndTruncate(s string, max int) string
• func FirstLetter(s string, max int) string
• func FirstToUpper(text string) string
• func IsTrue(value interface{}) bool
• func IsTwitterUrl(twitterUrl string) bool
• func IsUrl(stringUrl string) bool
• func NanoId(length ...int) string
• func NewGoment(args ...interface{}) *goment.PortalnesiaGoment
• func NumberSize(bytes float64, precision int) string
• func ParseUrl(s string) (string, error)
• func SeparateNumber(number int64) string
• func Slug(s string) string
• func TimeAgo(seconds int64) string
• func Truncate(s string, max int) string
• func Ucwords(s string) string
• func ValidateEmail(e string) bool
• type NumberFormatType
  • func NumberFormatShort(n int64) NumberFormatType

Functions

func Clean

func Clean(s string) string

Clean html format in string

func CleanAndTruncate

func CleanAndTruncate(s string, max int) string

Clean HTML format and truncate string

func FirstLetter

func FirstLetter(s string, max int) string

Parse string to first letter uppercase

Example: "Hello world" => "HM"

If max is less than 1, function return all first letter of strings

func FirstToUpper

func FirstToUpper(text string) string

Capitalize first characters in word

Example: "hello world" => "Hello world"

func IsTrue

func IsTrue(value interface{}) bool

Check if variable is true

func IsTwitterUrl

func IsTwitterUrl(twitterUrl string) bool

Validate Twitter URL

func IsUrl

func IsUrl(stringUrl string) bool

ValidateURL

func NanoId

func NanoId(length ...int) string

Generate random ID

func NewGoment

func NewGoment(args ...interface{}) *goment.PortalnesiaGoment

New goment instance

Alias of goment.Must

func NumberSize

func NumberSize(bytes float64, precision int) string

Format bytes to human readable string

Example: 50486525485 => "5.05 GB"

func ParseUrl

func ParseUrl(s string) (string, error)

Parse raw URL to clean URL

Example: "https://portalnesia.com/contact" => "portalnesia.com/contact"

func SeparateNumber

func SeparateNumber(number int64) string

Comma separate integer

Example: 5000 => "5,000"

func Slug

func Slug(s string) string

Slugify format of string

Example: "hello world" => "hello-world"

func TimeAgo

func TimeAgo(seconds int64) string

Format second integer to human readable `timeago` format

Example: `11 minutes ago`

Deprecated: use the goment.PortalnesiaGoment.TimeAgo instead

Will be removed in the next minor updates

func Truncate

func Truncate(s string, max int) string

Truncate string

Example: "lorem ipsum lorem ipsum lorem ipsum" => "lorem ipsum lor..."

func Ucwords

func Ucwords(s string) string

Capitalize each words in string

Example: "Hello world" => "Hello World"

func ValidateEmail

func ValidateEmail(e string) bool

Validate email

Types

type NumberFormatType

type NumberFormatType struct {
	Number int64  `json:"number"`
	Format string `json:"format"`
}

func NumberFormatShort

func NumberFormatShort(n int64) NumberFormatType

Format integer to K,M,B,T format

Example: 64768456 => "64.77 M"