short-scale-units v1.2.0

Short Scale Units

A simple package providing helper functions for matching numbers with their short scale unit.

Table of Context

• Installation
• Import/Require
• API
  • unitNameFromNumber
  • numberFromUnitName
  • trimNumber
  • trimName
  • getUnitPower
  • getPower
• Supported Units

Installation

npm install short-scale-units

Import/Require

// TypeScript
import * as ssu from "short-scale-units";

// JavaScript
const ssu = require("short-scale-units");

API

unitNameFromNumber

Provides the English unit name for the given number.

const name = ssu.unitNameFromNumber(17388);
// name = "thousand"

numberFromUnitName

Provides the base unit number for the given unit name.

const integer = ssu.numberFromUnitName("thousand");
const notation = ssu.numberFromUnitName("sextillion");
const raw = ssu.numberFromUnitName("sextillion", true);
// number = 1000
// notation = 1e+21
// raw = "1000000000000000000000"

trimNumber

Provides the short-hand abbreviation of a number, relative to its unit.

const trimmed = ssu.trimNumber(17388);
// trimmed = 17 (because 17388 is 17 thousands)

trimName

Provides an abbreviation of the unit name;

const abbreviation = trimName("thousand");
// abbreviation = "K"

getUnitPower

Provides the power for the given number, relative to its unit.

• If you want the numbers real power use getPower.

const unitPower = ssu.getUnitPower(17388);
// unitPower = 3

getPower

Provides the power for the given number.

• If you want the power relative the its unit use getUnitPower.

const powerRound = ssu.getPower(17388, true);
const power = ssu.getPower(17388);
// powerRound = 4
// power = 4.240249631518799

Supported Units