Registry / devops / bytes-formatter

bytes-formatter

library21.6.15jsnpmunverified

A lightweight JavaScript/TypeScript library for converting byte values into human-readable strings with units (bytes, KB, MB, GB, TB, PB). Version 21.6.15 is stable and actively maintained (no recent releases). It follows IEEE 1541 (binary prefix) standard: 1 KB = 1024 bytes. Ships TypeScript definitions. Differentiators: zero dependencies, simple API, focus on binary units (as opposed to metric in 'pretty-bytes').

devops

npm install bytes-formatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · BYTES-FORMATTER

bytes-formatter

devopsjavascriptv21.6.15

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

formatBytes

✓ import { formatBytes } from 'bytes-formatter'

✗ const { formatBytes } = require('bytes-formatter')

The package is ESM-only; CommonJS require will fail. TypeScript types are included.

default import

✓ import { formatBytes } from 'bytes-formatter'

✗ import formatBytes from 'bytes-formatter'

The library exports only a named export, not a default export.

type

✓ import type { FormatBytesOptions } from 'bytes-formatter'

✗ import { FormatBytesOptions } from 'bytes-formatter'

TypeScript users should use `import type` to avoid runtime inclusion. Only the function is exported at runtime.

Shows basic formatting of byte values to human-readable strings using the formatBytes function.

import { formatBytes } from 'bytes-formatter'; console.log(formatBytes(1000)); // "1000 bytes" console.log(formatBytes(1024)); // "1.00 KB" console.log(formatBytes(1000000)); // "976.56 KB" console.log(formatBytes(2000000)); // "1.91 MB" console.log(formatBytes(2000000000)); // "1.86 GB"

Debug

Known issues

gotchaUses binary units (1 KB = 1024 bytes). If you need metric units (1 KB = 1000 bytes), use a different library.

fix

Check your expected unit system. For metric, consider 'filesize' or 'humanize-plus'.

affects: >=0.0.0

gotchaInput must be a number. Non-numeric values (string, null, undefined) may produce unexpected results or NaN.

fix

Ensure input is a number: formatBytes(Number(value))

affects: >=0.0.0

gotchaOutput precision is fixed to two decimal places for KB and above (e.g., '1.00 KB'). No configuration for decimal places.

fix

If you need custom precision, post-process the string or choose an alternative library.

affects: >=0.0.0

breakingVersion 21.6.15 is the current version. There is no changelog; assume any minor version bump could be breaking. The package uses semantic versioning but hasn't released a major version bump.

fix

Pin exact version in package.json if stability is critical.

affects: >=0.0.0

Errors

Common errors & fixes

Cannot find module 'bytes-formatter'

The package is not installed or is named incorrectly in the import.

fix

Run `npm install bytes-formatter` and ensure import path is exactly 'bytes-formatter'.

Uncaught TypeError: formatBytes is not a function

Trying to use default import instead of named import.

fix

Use `import { formatBytes } from 'bytes-formatter'` instead of `import formatBytes from 'bytes-formatter'`.

require() of ES Module not supported

Using CommonJS `require` with an ESM-only package.

fix

Switch to ES module import syntax or use a bundler that can handle ESM. Alternatively, use `await import('bytes-formatter')` if using dynamic import.

Upgrade

Version history

21.6.15latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/vpodk/bytes-formatter ↗

packagebytes-formatter ↗

homepagehttps://vpodk.com/bytes-formatter/ ↗