mirror of
https://github.com/badges/shields.git
synced 2025-04-18 19:44:04 +03:00
151c70dd17
* add renderSizeBadge helper, use it everywhere - switch from pretty-bytes to byte-size - add renderSizeBadge() helper function - match upstream conventions for metric/IEC units - add new test helpers and use them in service tests * unrelated: fix npm unpacked size query param schema not strictly related to this PR but I noticed it was broken * chromewebstore: reformat size string, test against isIecFileSize
26 lines
747 B
JavaScript
26 lines
747 B
JavaScript
/**
|
|
* @module
|
|
*/
|
|
|
|
import byteSize from 'byte-size'
|
|
|
|
/**
|
|
* Creates a badge object that displays information about a size in bytes number.
|
|
* It should usually be used to output a size badge.
|
|
*
|
|
* @param {number} bytes - Raw number of bytes to be formatted
|
|
* @param {'metric'|'iec'} units - Either 'metric' (multiples of 1000) or 'iec' (multiples of 1024).
|
|
* This should align with how the upstream displays sizes.
|
|
* @param {string} [label='size'] - Custom label
|
|
* @returns {object} A badge object that has three properties: label, message, and color
|
|
*/
|
|
function renderSizeBadge(bytes, units, label = 'size') {
|
|
return {
|
|
label,
|
|
message: byteSize(bytes, { units }).toString(),
|
|
color: 'blue',
|
|
}
|
|
}
|
|
|
|
export { renderSizeBadge }
|