Change default precision to 1

Author: izolate

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - Returns the original number if no unit is available.
+- Default precision to 1 instead of 2. (**BREAKING CHANGE**)
+- `Options` interface name to `MillifyOptions`. (**BREAKING CHANGE**)
 
 ### Removed
 - `base` from options. We only intend to support the common grouping base (1000). (**BREAKING CHANGE**)

README.md

@@ -22,19 +22,20 @@ npm install millify
 ### Command line
 
 ```bash
-millify 10000
-# 10K
+$ millify 12345
+12.3K
 ```
+
 See `millify --help` for options.
 
 ### Programmatically
 
-#### `millify(number, options)`
+#### `millify(value: number, options: MillifyOptions)`
 
 ```js
-import millify from 'millify';
+import millify from "millify";
 
-// For CommonJS: `const { millify } = require('millify');`
+// For CommonJS: `const { millify } = require("millify");`
 
 millify(2500); // 2.5K
 
@@ -46,12 +47,12 @@ millify(1024000, {
 
 millify(39500, {
   precision: 2,  
-  decimalSeparator: ','
+  decimalSeparator: ","
 });
 // 3,95K
 
 millify(1440000, {
-  units: ['B', 'KB', 'MB', 'GB'],
+  units: ["B", "KB", "MB", "GB", "TB"],
   space: true,
 });
 // 1.44 MB
@@ -61,7 +62,7 @@ millify(1440000, {
 
 Name | Type | Default | Description
 --- | --- | --- | ---
-`precision` | `number` | `2` | Number of significant figures to use
+`precision` | `number` | `1` | Number of decimal places to use
 `decimalSeparator` | `string` | `'.'` | Desired decimal separator (e.g. decimal point or comma)
 `lowercase` | `boolean` | `false` | Use lowercase abbreviations
 `space` | `boolean` | `false` | Add a space between number and abbreviation

bin/millify

@@ -12,10 +12,10 @@ require("yargs").command(
         type: "number",
       })
       .option("precision", {
-        describe: "Decimal places",
+        describe: "Number of decimal places",
         alias: "p",
         type: "number",
-        default: 2,
+        default: 1,
       })
       .option("decimal", {
         describe: "Decimal separator (mark)",

lib/millify.ts

@@ -1,4 +1,4 @@
-import { Options, defaultOptions } from "./options";
+import { MillifyOptions, defaultOptions } from "./options";
 import { parseValue, roundTo } from "./utils";
 
 // Most commonly used digit grouping base.
@@ -34,9 +34,9 @@ function* divider(value: number): IterableIterator<number> {
 /**
  * millify converts long numbers to human-readable strings.
  */
-function millify(value: number, options?: Partial<Options>): string {
+function millify(value: number, options?: Partial<MillifyOptions>): string {
   // Override default options with options supplied by user.
-  const opts: Options = options
+  const opts: MillifyOptions = options
     ? { ...defaultOptions, ...options }
     : defaultOptions;
 

lib/options.ts

@@ -1,7 +1,7 @@
 /**
  * Options used to configure Millify.
  */
-export interface Options {
+export interface MillifyOptions {
   /**
    * The number of significant figures.
    */
@@ -27,10 +27,10 @@ export interface Options {
 /**
  * Default options for Millify.
  */
-export const defaultOptions: Options = {
+export const defaultOptions: MillifyOptions = {
   decimalSeparator: ".",
   lowercase: false,
-  precision: 2,
+  precision: 1,
   space: false,
   units: [
     "",