Isomorphic function to convert a bytes value (e.g. 3456) to a human-readable string ('3.5 kB')
MIT License
Whether this is a breaking change or not is debatable so it has been released as a major version just in case.
These changes affect the output only, there are no changes to the API or minimum supported Node version (still v12.17).
byteSize(1000).toString()
now returns 1 kB
instead of 1.0 kB
, removing the superfluous one decimal place of precision.byteSize(1500000, { precision: 5 }).toString()
now returns 1.5 MB
instead of 1.50000 MB
, again removing superfluous precision.byteSize(1500010, { precision: 5 }).toString()
will return 1.50001 MB
as there is meaningful, non-zero precision to display.Published by 75lb about 3 years ago
exports
, conditional exports and exports patterns have been retro-fitted into v12 (see the Package module history)Users of Node.js v12.17 and above may now use the latest version (previously, you needed a minimum of node v14). There are no further changes.
Published by 75lb over 3 years ago
Byte-size now supports localised number formatting using your system locale by default (#9). For example, if you're in Deutschland you'll now see your native numeric formatting:
> byteSize(1000)
ByteSize { value: '1,0', unit: 'kB', long: 'kilobytes' }
Or you can set the locale manually:
> byteSize(1000, { locale: 'en-GB' })
ByteSize { value: '1.0', unit: 'kB', long: 'kilobytes' }
Published by 75lb over 4 years ago
Published by 75lb about 5 years ago
byteSize
will now throw if you specify an invalid options.units
value.long
unit names (e.g. kilobytes
) to the output.Published by 75lb about 5 years ago
Users of node v8 and above can safely upgrade to byte-size v6.0.0. There have been no changes to the byte-size source code or API, only to the dev dependencies and test suite.
Published by 75lb almost 6 years ago
Support for Node.js versions less than v6 has been dropped. Technically, this is not a breaking change since byte-size v5.0.0 still works with node v4 (the byte-size API and code has not changed) but future releases will be tested in node v6 and above only.
This library is now compatible with Node.js, the Web and any style of module loader. See the readme for examples.
If you're using Node.js v6 or above, since there have been no API changes to byte-size you can safely upgrade to v5.0.0.
Published by 75lb about 6 years ago
Support was removed for versions of Node.js older than v4.0.0.
Published by 75lb about 8 years ago
The library no longer assumes you require a formatted string (e.g. '2.4 Kib'
) . It returns an object containing the raw values (e.g. { value: '1.6', unit: 'ko' }
and you can format them however you please.
@adrai added support for the octet unit.