Go Humans! (formatters for units to human friendly sizes)
Go
Switch branches/tags
Nothing to show
Latest commit 259d2a1 Feb 28, 2017 @shurcooL shurcooL committed with Add space between numbers and units in README, package documentation.
When we added space between numbers and units in 64dbdae,
the README and package documentation weren't updated. This fixes that.

Also fix various other minor issues in documentation that I found.
Use single space between sentences in README, to follow Go style.

Follows 64dbdae.
Helps #21.
Permalink
Failed to load latest commit information.
.gitignore Coding for humanity. Jan 13, 2012
.travis.yml Remove go 1.4.3 Jun 3, 2016
LICENSE Added license. Dec 29, 2012
README.markdown Add space between numbers and units in README, package documentation. Feb 28, 2017
big.go Refactored common big stuff into big.go Oct 25, 2013
bigbytes.go Add space between numbers and units in README, package documentation. Feb 28, 2017
bigbytes_test.go Handle commas in bytes parsing. Sep 23, 2016
bytes.go Add space between numbers and units in README, package documentation. Feb 28, 2017
bytes_test.go Handle commas in bytes parsing. Sep 23, 2016
comma.go Special case Comma(math.MinInt64). Jan 6, 2017
comma_test.go Special case Comma(math.MinInt64). Jan 6, 2017
commaf.go Make commaf only apply to go 1.6+ Jun 3, 2016
commaf_test.go Make commaf only apply to go 1.6+ Jun 3, 2016
common_test.go Added quotes around expected/actual output Apr 22, 2014
ftoa.go Get rid of regex and fmt from Ftoa Jul 8, 2014
ftoa_test.go Add space between the numbers and units. Nov 9, 2015
humanize.go Add space between numbers and units in README, package documentation. Feb 28, 2017
number.go Handle formatting floats on 32-bit systems Jan 10, 2017
number_test.go Handle formatting floats on 32-bit systems Jan 10, 2017
ordinals.go Doc cleanup Jul 9, 2014
ordinals_test.go Convert all the asserts to test tables Aug 21, 2013
si.go Add space between numbers and units in README, package documentation. Feb 28, 2017
si_test.go SI: handle negative numbers May 10, 2016
times.go Remove unnecessary caching of slice length Dec 5, 2016
times_test.go Fix panicking `CustomRelTime` when magnitude list is incomplete Dec 1, 2016

README.markdown

Humane Units Build Status GoDoc

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