1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
x1 x1 x1 x1 x1 |
import type { FormatOptions as _interface_FormatOptions } from "jsr:@std/[email protected]/bytes"
/**
* Options for {@linkcode format}.
*/
interface FormatOptions extends _interface_FormatOptions {}
export type { FormatOptions }
import { format as _function_format } from "jsr:@std/[email protected]/bytes"
/**
* Convert bytes to a human-readable string: 1337 → 1.34 kB
*
* Based on {@link https://github.com/sindresorhus/pretty-bytes | pretty-bytes}.
* A utility for displaying file sizes for humans.
*
* @param num The bytes value to format
* @param options The options for formatting
* @return The formatted string
*
* @example Basic usage
* ```ts
* import { format } from "@std/fmt/bytes";
* import { assertEquals } from "@std/assert";
*
* assertEquals(format(1337), "1.34 kB");
* assertEquals(format(100), "100 B");
* ```
*
* @example Include bits representation
*
* ```ts
* import { format } from "@std/fmt/bytes";
* import { assertEquals } from "@std/assert";
*
* assertEquals(format(1337, { bits: true }), "1.34 kbit");
* ```
*
* @example Include sign
*
* ```ts
* import { format } from "@std/fmt/bytes";
* import { assertEquals } from "@std/assert";
*
* assertEquals(format(42, { signed: true }), "+42 B");
* assertEquals(format(-42, { signed: true }), "-42 B");
* ```
*
* @example Change locale
*
* ```ts
* import { format } from "@std/fmt/bytes";
* import { assertEquals } from "@std/assert";
*
* assertEquals(format(1337, { locale: "de" }), "1,34 kB");
* ```
*/
const format = _function_format as typeof _function_format
export { format }
|