Skip to main content
Home
Browse packagesDocs
Sign In with GitHubSign In with GitLab

@std/fmt@0.215.0

latest
Works with
It is unknown whether this package works with Browsers, Deno, Node.js, Cloudflare Workers, Bun
It is unknown whether this package works with Browsers
It is unknown whether this package works with Deno
It is unknown whether this package works with Node.js
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Bun
•JSR Score58%•
Published2 years ago (0.215.0)
function format
format(
num: number,
options?: FormatOptions
): string

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

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

This module is browser compatible.

Examples

Example 1

import { format } from "@std/fmt/bytes";

format(1337);
//=> '1.34 kB'

format(100);
//=> '100 B'

// Display with units of bits
format(1337, { bits: true });
//=> '1.34 kbit'

// Display file size differences
format(42, { signed: true });
//=> '+42 B'

// Localized output using German locale
format(1337, { locale: "de" });
//=> '1,34 kB'

Parameters

num: number
optional
options: FormatOptions

Return Type

string

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/fmt

Import symbol

import { format } from "@std/fmt/bytes";
or

Import directly with a jsr specifier

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