package compactnumber

Import Path
	github.com/nkall/compactnumber (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	  d formatter.go
		Package compactnumber allows for localized CLDR compact number formatting.

	  d forms.gen.go
		Code generated by https://github.com/nkall/compactnumber at 2019-10-20 13:43:16.072781 -0700 PDT m=+0.107571706. DO NOT EDIT.
		Based on https://github.com/unicode-cldr/cldr-numbers-modern version 36
		
		Do not edit this file manually! Instead, follow the "Generating Compact Forms" guide in the README.

	    models.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type CompactType string (basic type)
		CompactType is an enum used to specify compaction settings.

		As Inputs Of (at least one exported)
			func NewFormatter(lang string, compactType CompactType) Formatter
		As Types Of (total 3)
			const Long
			const None
			const Short

	 type Formatter (struct)
		Formatter is a struct containing a method to format an integer based on the specified language and compaction type.

		Methods (only one)
			(*Formatter) Format(n int, numOptions ...number.Option) (string, error)
				Format takes in an integer and options and formats it according to the formatter's locale and compaction settings.
				Note: this method truncates numbers and does not support fractions (e.g. 11.5M).
				
				Documented in CLDR spec: http://www.unicode.org/reports/tr35/tr35-numbers.html#Compact_Number_Formats

		Implements (at least one exported)
			*Formatter : FormatterAPI
		As Outputs Of (at least one exported)
			func NewFormatter(lang string, compactType CompactType) Formatter

	 type FormatterAPI (interface)
		FormatterAPI is an interface implemented by Formatter that can be used for mocking purposes

		Methods (only one)
			( FormatterAPI) Format(n int, numOptions ...number.Option) (string, error)
		Implemented By (at least one exported)
			*Formatter


Package-Level Functions (only one)

	 func NewFormatter(lang string, compactType CompactType) Formatter
		NewFormatter creates a new formatter based on the specified language and compaction type.


Package-Level Constants (total 3)

	const Long CompactType = "Long"
		Long-form compaction, e.g. 17 million.

	const None CompactType = "None"
		No compaction, e.g. 17,000,000.

	const Short CompactType = "Short"
		Short-form compaction, e.g. 17M.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.