Skip to content

valentinkononov/ts-num-short

Repository files navigation

ts-num-short

Typescript based number shortener

Build Status codecov npm npm bundle size npm NPM

Mission

TS-num-short allows showing approximate number information in a short manner - 1K, 1M, 1B, 1T.

Useful for table columns, labels and other UI places, where UX capacity is critical.

Tool rounds numbers, so that 999 gives 1K as result of shortening.

Our mission is to provide simple library specifically for TypeScript usage. So that developers can have standard import constructions fokr regular typeScript projects.

Library is covered with tests. Code is simple and readable, so that you can easily copy and modify it if needed.

Function numShort does shortening as well as rounding of numbers so that you can

Usage

Install package

    npm install ts-num-short --save

Use numShort function:

    import { numShort } from 'ts-num-short';

    numShort(1_000); // 1K
    numShort(999_000); // 999K
    numShort(999_999); // 1M
    numShort(1_000_000_000); // 1B
    numShort(1_000_000_000_000); // 1T

Stay in Touch

Thanks for using it! Enjoy coding!

About

Typescript based number shortener

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published