superbytes
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

Superbytes

Superbytes is a Node.js library for converting bytes to human readable string format


npm npm NPM GitHub Workflow Status (with event) GitHub contributors

Description

Superbytes will help you convert bytes into other units understandable for humans. The library automatically converts bytes and returns a string with the most optimal unit representation. The library also allows you to set the precision of numbers following the decimal point and choose the output metric in the form of either the IEC standard (1024 bytes = 1 kibibyte) or SI (1000 bytes = 1 kilobyte).

By default superbytes converts to IEC units.

The current version supports loading library using both CommonJS and ESModules.

Installation

Latest version:

npm i superbytes@latest

Usage

Loading using CommonJS

const { superbytes } = require('superbytes');

superbytes(423551030);
// returns '403.93 MiB'
superbytes(423551030, 3);
// returns '403.930 MiB'
superbytes(72355103011, { metric: 'si'});
// returns '72.36 GB'
superbytes(3123123, { precision: 5});
// returns '2.97844 MiB'
superbytes(912839123, { metric: 'si', precision: 5});
// returns '912.83912 MB'

Loading using ES modules

import { superbytes } from 'superbytes';

superbytes(423551030);
// returns '403.93 MiB'
superbytes(423551030, 3);
// returns '403.930 MiB'
superbytes(72355103011, { metric: 'si'});
// returns '72.36 GB'
superbytes(3123123, { precision: 5});
// returns '2.97844 MiB'
superbytes(912839123, { metric: 'si', precision: 5});
// returns '912.83912 MB'

License

MIT © Damian Polak

Readme

Keywords

none

Package Sidebar

Install

npm i superbytes

Weekly Downloads

233

Version

2.0.1

License

MIT

Unpacked Size

43.4 kB

Total Files

9

Last publish

Collaborators

  • damianpolak