drivetribe-number-formatters

drivetribe-number-formatters

Collection of number formatter functions to change numbers for display purposes.

Install

Install the module directly from npm:

npm install drivetribe-number-formatters --save

Formatters

Approximate

Approximates large numbers, ie 6426 -> "6.4K".

approximate(quant: number||string): string

Example

import { approximate } from 'drivetribe-number-formatters';

approximate(5134924); // "5.1M"
approximate("5134924"); // "5.1M"

Rounds numbers greater than 1000, up to the millions.

Round to decimal place

Rounds a number to a given decimal place.

roundToDecimalPlace(quant: number, roundTo: number): number

Example

import { roundToDecimalPlace } from 'drivetribe-number-formatters';

roundToDecimalPlace(12.34567, 1); // 12.3
roundToDecimalPlace(12.34567, 2); // 12.35

Approximate distance

Approximates distances, ie 6426 -> "6.43 km".

approximateDistance(quant: number): string

Example

import { approximateDistance } from 'drivetribe-number-formatters';

approximateDistance(12.34567); // 12.35 m
approximateDistance(12000.00012); // 12 km

Distance from

Calculates the distance in a straight line between to points, using the Haversine formula.

distanceFrom(lat1: number, long1: number, lat2: number, long2: number): number

Example

import { distanceFrom } from 'drivetribe-number-formatters';

// 10 Downing Street
const TEST_DOWN_LAT = 51.5032510;
const TEST_DOWN_LONG = -0.1278950;

// DriveTribe Kings Cross Office
const TEST_KX_LAT = 51.5309667;
const TEST_KX_LONG = -0.1228197;

distanceFrom(TEST_DOWN_LAT, TEST_DOWN_LONG, TEST_KX_LAT, TEST_KX_LONG) // 3101.7896965117457