format

import { format } from "jsr:@ende/fmt/bytes";

function

function format(num: number, options: FormatOptions = [UNSUPPORTED]): string

Convert bytes to a human-readable string: 1337 → 1.34 kB

Based on pretty-bytes. A utility for displaying file sizes for humans.

num: number: The bytes value to format
options: FormatOptions = [UNSUPPORTED]: The options for formatting

Returns

The formatted string

Example: Basic usage

import { format } from "@ende/fmt/bytes";
import { assertEquals } from "@ende/assert";

assertEquals(format(1337), "1.34 kB");
assertEquals(format(100), "100 B");

Example: Include bits representation

import { format } from "@ende/fmt/bytes";
import { assertEquals } from "@ende/assert";

assertEquals(format(1337, { bits: true }), "1.34 kbit");

Example: Include sign

import { format } from "@ende/fmt/bytes";
import { assertEquals } from "@ende/assert";

assertEquals(format(42, { signed: true }), "+42 B");
assertEquals(format(-42, { signed: true }), "-42 B");

Example: Change locale

import { format } from "@ende/fmt/bytes";
import { assertEquals } from "@ende/assert";

assertEquals(format(1337, { locale: "de" }), "1,34 kB");

Source