![]() |
||
---|---|---|
.. | ||
.travis.yml | ||
LICENSE | ||
README.markdown | ||
big.go | ||
bigbytes.go | ||
bigbytes_test.go | ||
bytes.go | ||
bytes_test.go | ||
comma.go | ||
comma_test.go | ||
commaf.go | ||
commaf_test.go | ||
common_test.go | ||
ftoa.go | ||
ftoa_test.go | ||
humanize.go | ||
number.go | ||
number_test.go | ||
ordinals.go | ||
ordinals_test.go | ||
si.go | ||
si_test.go | ||
times.go | ||
times_test.go |
README.markdown
Humane Units
![GoDoc](https://godoc.org/github.com/dustin/go-humanize?status.svg)
Just a few functions for helping humanize times and sizes.
go get
it as github.com/dustin/go-humanize
, import it as
"github.com/dustin/go-humanize"
, use it as humanize
.
See godoc for complete documentation.
Sizes
This lets you take numbers like 82854982
and convert them to useful
strings like, 83 MB
or 79 MiB
(whichever you prefer).
Example:
fmt.Printf("That file is %s.", humanize.Bytes(82854982)) // That file is 83 MB.
Times
This lets you take a time.Time
and spit it out in relative terms.
For example, 12 seconds ago
or 3 days from now
.
Example:
fmt.Printf("This was touched %s.", humanize.Time(someTimeInstance)) // This was touched 7 hours ago.
Thanks to Kyle Lemons for the time implementation from an IRC conversation one day. It's pretty neat.
Ordinals
From a mailing list discussion where a user wanted to be able to label ordinals.
0 -> 0th
1 -> 1st
2 -> 2nd
3 -> 3rd
4 -> 4th
[...]
Example:
fmt.Printf("You're my %s best friend.", humanize.Ordinal(193)) // You are my 193rd best friend.
Commas
Want to shove commas into numbers? Be my guest.
0 -> 0
100 -> 100
1000 -> 1,000
1000000000 -> 1,000,000,000
-100000 -> -100,000
Example:
fmt.Printf("You owe $%s.\n", humanize.Comma(6582491)) // You owe $6,582,491.
Ftoa
Nicer float64 formatter that removes trailing zeros.
fmt.Printf("%f", 2.24) // 2.240000
fmt.Printf("%s", humanize.Ftoa(2.24)) // 2.24
fmt.Printf("%f", 2.0) // 2.000000
fmt.Printf("%s", humanize.Ftoa(2.0)) // 2
SI notation
Format numbers with SI notation.
Example:
humanize.SI(0.00000000223, "M") // 2.23 nM