Skip to content

nsuite v2.2.1


nsuite / getReadableFileSize

Function: getReadableFileSize()

getReadableFileSize(size, options?): string

Defined in: UtilsFile.ts:179

converts file size in bytes to human-readable string

Parameters

size

string | number

options?

CustomFilesizeOptions

Returns

string

Example

ts
import { getReadableFileSize } from "nsuite";

getReadableFileSize(0); // "0 B"

// 1024-based, with { standard: "jedec" }
getReadableFileSize(1024, { standard: "jedec" }); // "1 KB"
getReadableFileSize(1024 * 1024, { standard: "jedec" }); // "1 MB"
getReadableFileSize(1024 * 1024 * 1024, { standard: "jedec" }); // "1 GB"

// 1000-based, default
getReadableFileSize(1000); // "1 kB"
getReadableFileSize(1001); // "1 kB"
getReadableFileSize(1010); // "1.01 kB"
getReadableFileSize(1100); // 1.1 kB"
getReadableFileSize(1024); // "1.02 kB"
getReadableFileSize(1024 * 1000); // "1.02 MB"
// 1024 * 1024 = 1048576
getReadableFileSize(1024 * 1024); // "1.05 MB"
// 1024 * 1024 * 1024 = 1073741824
getReadableFileSize(1024 * 1024 * 1024); // "1.07 GB"

Released under the Apache-2.0 License.