num2words

Overview

Converts a number to its English counterpart.

Usage

Installation can be achieved via:

go get -u github.com/jtpeller/num2words

Then, import it:

import "github.com/jtpeller/num2words"

You can test the package by running the following command. It will give a short pass or fail result.

go test ./num2words_test

Alternatively, for a more verbose output, use:

go test ./num2words_test -v

It also wouldn't hurt to add a -timeout 30 to prevent hanging on a test for too long.

Contents

• num2words_test
  • num2words_test.go -- holds all test functions for the package
• bignum.go -- holds needed wrappers for the big number package. Utilizes my repo at gobig
• go.mod -- manages the module
• go.sum -- manages any dependencies (which itself is managed by go.mod)
• num2words.go -- implementation for converting numbers to their word representation (e.g. 5 => five)
• README.md -- the file you're reading