Go Humans! (formatters for units to human friendly sizes)
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
english Adds commas to number formatting in english.Plural. Jul 13, 2018
.travis.yml Travis: Use latest patch versions. Aug 28, 2017
LICENSE Added license. Dec 29, 2012
README.markdown Adds package humanize/english for English-word manipulations. Nov 1, 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 Add a few methods for limiting the number of decimal places outputted. Apr 21, 2018
comma_test.go Add a few methods for limiting the number of decimal places outputted. Apr 21, 2018
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 Add a few methods for limiting the number of decimal places outputted. Apr 21, 2018
ftoa_test.go Added a quickcheck test for stripTrailingDigits Apr 21, 2018
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 a few methods for limiting the number of decimal places outputted. Apr 21, 2018
si_test.go Add a few methods for limiting the number of decimal places outputted. Apr 21, 2018
times.go Fix for reported off-by-one (nanosecond) error in RelTime Nov 11, 2017
times_test.go Fix for reported off-by-one (nanosecond) error in RelTime Nov 11, 2017

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

English-specific functions

The following functions are in the humanize/english subpackage.

Plurals

Simple English pluralization

english.PluralWord(1, "object", "") // object
english.PluralWord(42, "object", "") // objects
english.PluralWord(2, "bus", "") // buses
english.PluralWord(99, "locus", "loci") // loci

english.Plural(1, "object", "") // 1 object
english.Plural(42, "object", "") // 42 objects
english.Plural(2, "bus", "") // 2 buses
english.Plural(99, "locus", "loci") // 99 loci

Word series

Format comma-separated words lists with conjuctions:

english.WordSeries([]string{"foo"}, "and") // foo
english.WordSeries([]string{"foo", "bar"}, "and") // foo and bar
english.WordSeries([]string{"foo", "bar", "baz"}, "and") // foo, bar and baz

english.OxfordWordSeries([]string{"foo", "bar", "baz"}, "and") // foo, bar, and baz