UNPKG

byte-human

Version:

Convert byte size to human-readable size

github.com/hyperz111/byte-human

hyperz111/byte-human

67 lines (38 loc) • 995 B
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
58
59
60
61
62
63
64
65
66
67
# byte-human Convert byte size to human-readable size ## Install ```sh $ npm install byte-human ``` ## Usage ```js import byteHuman from 'byte-human'; byteHuman(2324606976); // => 2.32 GB ``` ## API ### `byteHuman(bytes, opts?)` Return: `string` Convert byte size to human-readable size. #### `bytes` Type: `number` #### `opts?` Type: `Object` Options you can configure. ##### `separator?` Type: `string | undefined` Separator between number and unit, default is space. ```js import byteHuman from 'byte-human'; byteHuman(2324606976); // => 2.32 GB byteHuman(2324606976, { separator: "_" }); // => 2.32_GB ``` ##### `fixed?` Type: `number | undefined` For `Number#toFixed`, default is `2`. ```js import byteHuman from 'byte-human'; byteHuman(2324606976); // => 2.32 GB byteHuman(2324606976, { fixed: 1 }); // => 2.3 GB ``` ## Copyright Copyright © 2025-Present [Hyper-Z11](https://github.com/hyperz111/). Licensed under [ISC License](https://www.isc.org/licenses/).