format | /fmt/bytes.ts | std@0.215.0

Deno standard library

The Standard Library has been moved to JSR. See the blog post for details.

function format

import { format } from "https://deno.land/std@0.215.0/fmt/bytes.ts";

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 "https://deno.land/std@0.215.0/fmt/bytes.ts";

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 = [UNSUPPORTED]

Returns

string