Formater

Formater is a minimalist JavaScript library that provide some format helpers functions.

• 💪 Immutable
• 📦 No dependancies
• 👫 All browsers supported
• ✅ Fully tested
• 😎 100% covered

Getting Started

Installation

npm install @erniamor/formater

Usage

1. Import function from package

import { formatBytes } from '@erniamor/formater';

2. Call function with expected arguments

formatBytes(1024000, 2); // return "1.02 MB"

API

It's easy to use Formater APIs to format some special usecase.

formatBytes

Format a number of bytes to a string with unit and decimals.

Arguments

bytes (number) : the number to process decimals (number) : the number of decimals - default : 0

Return

(string) : the formated value

Example

formatBytes(1024000, 2); // return "1.02 MB"

Notes

All this units are available : 'Byte', 'Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'

Tests

• Run tests with npm test command

npm run test

• Run covered tests with npm test-coverage command

npm run test-coverage

• Open coverage HTML report

npx http-server ./coverage

And open your browser at http://127.0.0.1:8080

License

Formater is licensed under a MIT License.