222 lines
13 KiB
HTML
222 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: services/text-formatters.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: services/text-formatters.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Commonly-used functions for formatting text in badge labels. Includes
|
|
* ordinal numbers, currency codes, star ratings, versions, etc.
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
/**
|
|
* Creates a string of stars and empty stars based on the rating.
|
|
* The number of stars is determined by the integer part of the rating.
|
|
* An additional star or a three-quarter star or a half star or a quarter star is added based on the decimal part of the rating.
|
|
* The remaining stars are empty stars until the maximum number of stars is reached.
|
|
*
|
|
* @param {number} rating - Current rating
|
|
* @param {number} [max] - Maximum rating
|
|
* @returns {string} A string of stars and empty stars
|
|
*/
|
|
function starRating(rating, max = 5) {
|
|
const flooredRating = Math.floor(rating)
|
|
let stars = ''
|
|
while (stars.length < flooredRating) {
|
|
stars += '★'
|
|
}
|
|
const decimal = rating - flooredRating
|
|
if (decimal >= 0.875) {
|
|
stars += '★'
|
|
} else if (decimal >= 0.625) {
|
|
stars += '¾'
|
|
} else if (decimal >= 0.375) {
|
|
stars += '½'
|
|
} else if (decimal >= 0.125) {
|
|
stars += '¼'
|
|
}
|
|
|
|
while (stars.length < max) {
|
|
stars += '☆'
|
|
}
|
|
return stars
|
|
}
|
|
|
|
/**
|
|
* Converts the ISO 4217 code to the corresponding currency symbol.
|
|
* If the the symbol for the code is not found, then the code itself is returned.
|
|
*
|
|
* @param {string} code - ISO 4217 code
|
|
* @returns {string} Currency symbol for the code
|
|
*/
|
|
function currencyFromCode(code) {
|
|
return (
|
|
{
|
|
CNY: '¥',
|
|
EUR: '€',
|
|
GBP: '₤',
|
|
USD: '$',
|
|
}[code] || code
|
|
)
|
|
}
|
|
|
|
/**
|
|
* Calculates the ordinal number of the given number.
|
|
* For example, if the input is 1, the output is “1ˢᵗ”.
|
|
*
|
|
* @param {number} n - Input number
|
|
* @returns {string} Ordinal number of the input number
|
|
*/
|
|
function ordinalNumber(n) {
|
|
const s = ['ᵗʰ', 'ˢᵗ', 'ⁿᵈ', 'ʳᵈ']
|
|
const v = n % 100
|
|
return n + (s[(v - 20) % 10] || s[v] || s[0])
|
|
}
|
|
|
|
const metricPrefix = ['k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y']
|
|
const metricPower = metricPrefix.map((a, i) => Math.pow(1000, i + 1))
|
|
|
|
/**
|
|
* Given a number (positive or negative), returns a string with appropriate unit in the metric system, SI.
|
|
* Note: numbers beyond the peta- cannot be represented as integers in JS.
|
|
* For example, if you call metric(1000), it will return "1k", which means one kilo or one thousand.
|
|
*
|
|
* @param {number} n - Input number
|
|
* @returns {string} String with appropriate unit in the metric system, SI
|
|
*/
|
|
function metric(n) {
|
|
for (let i = metricPrefix.length - 1; i >= 0; i--) {
|
|
const limit = metricPower[i]
|
|
const absN = Math.abs(n)
|
|
if (absN >= limit) {
|
|
const scaledN = absN / limit
|
|
if (scaledN < 10) {
|
|
// For "small" numbers, display one decimal digit unless it is 0.
|
|
const oneDecimalN = scaledN.toFixed(1)
|
|
if (oneDecimalN.charAt(oneDecimalN.length - 1) !== '0') {
|
|
const res = `${oneDecimalN}${metricPrefix[i]}`
|
|
return n > 0 ? res : `-${res}`
|
|
}
|
|
}
|
|
const roundedN = Math.round(scaledN)
|
|
if (roundedN < 1000) {
|
|
const res = `${roundedN}${metricPrefix[i]}`
|
|
return n > 0 ? res : `-${res}`
|
|
} else {
|
|
const res = `1${metricPrefix[i + 1]}`
|
|
return n > 0 ? res : `-${res}`
|
|
}
|
|
}
|
|
}
|
|
return `${n}`
|
|
}
|
|
|
|
/**
|
|
* Remove the starting v in a string if it exists.
|
|
* For example, omitv("v1.2.3") returns "1.2.3", but omitv("hello") returns "hello".
|
|
*
|
|
* @param {string} version - Version string
|
|
* @returns {string} Version string without the starting v
|
|
*/
|
|
function omitv(version) {
|
|
if (version.charCodeAt(0) === 118) {
|
|
return version.slice(1)
|
|
}
|
|
return version
|
|
}
|
|
|
|
const ignoredVersionPatterns =
|
|
/^[^0-9]|[0-9]{4}-[0-9]{2}-[0-9]{2}|^[a-f0-9]{7,40}$/
|
|
|
|
/**
|
|
* Add a starting v to the version unless it doesn't starts with a digit, is a date (yyyy-mm-dd), or is a commit hash.
|
|
* For example, addv("1.2.3") returns "v1.2.3", but addv("hello"), addv("2021-10-31"), addv("abcdef1"), returns "hello", "2021-10-31", and "abcdef1" respectively.
|
|
*
|
|
* @param {string} version - Version string
|
|
* @returns {string} Version string with the starting v
|
|
*/
|
|
function addv(version) {
|
|
version = `${version}`
|
|
if (version.startsWith('v') || ignoredVersionPatterns.test(version)) {
|
|
return version
|
|
} else {
|
|
return `v${version}`
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a string that is either the singular or the plural form of a word,
|
|
* depending on the length of the countable parameter.
|
|
*
|
|
* @param {string} singular - Singular form of the word
|
|
* @param {string[]} countable - Array of values you want to count
|
|
* @param {string} plural - Plural form of the word
|
|
* @returns {string} Singular or plural form of the word
|
|
*/
|
|
function maybePluralize(singular, countable, plural) {
|
|
plural = plural || `${singular}s`
|
|
|
|
if (countable && countable.length === 1) {
|
|
return singular
|
|
} else {
|
|
return plural
|
|
}
|
|
}
|
|
|
|
export {
|
|
starRating,
|
|
currencyFromCode,
|
|
ordinalNumber,
|
|
metric,
|
|
omitv,
|
|
addv,
|
|
maybePluralize,
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-badge-maker.html">badge-maker</a></li><li><a href="module-badge-maker_lib_xml.html">badge-maker/lib/xml</a></li><li><a href="module-core_base-service_base.html">core/base-service/base</a></li><li><a href="module-core_base-service_base-graphql.html">core/base-service/base-graphql</a></li><li><a href="module-core_base-service_base-json.html">core/base-service/base-json</a></li><li><a href="module-core_base-service_base-svg-scraping.html">core/base-service/base-svg-scraping</a></li><li><a href="module-core_base-service_base-toml.html">core/base-service/base-toml</a></li><li><a href="module-core_base-service_base-xml.html">core/base-service/base-xml</a></li><li><a href="module-core_base-service_base-yaml.html">core/base-service/base-yaml</a></li><li><a href="module-core_base-service_errors.html">core/base-service/errors</a></li><li><a href="module-core_base-service_graphql.html">core/base-service/graphql</a></li><li><a href="module-core_base-service_openapi.html">core/base-service/openapi</a></li><li><a href="module-core_base-service_resource-cache.html">core/base-service/resource-cache</a></li><li><a href="module-core_base-service_service-definitions.html">core/base-service/service-definitions</a></li><li><a href="module-core_server_server.html">core/server/server</a></li><li><a href="module-core_service-test-runner_create-service-tester.html">core/service-test-runner/create-service-tester</a></li><li><a href="module-core_service-test-runner_icedfrisby-shields.html">core/service-test-runner/icedfrisby-shields</a></li><li><a href="module-core_service-test-runner_runner.html">core/service-test-runner/runner</a></li><li><a href="module-core_service-test-runner_service-tester.html">core/service-test-runner/service-tester</a></li><li><a href="module-core_service-test-runner_services-for-title.html">core/service-test-runner/services-for-title</a></li><li><a href="module-core_token-pooling_token-pool.html">core/token-pooling/token-pool</a></li><li><a href="module-services_build-status.html">services/build-status</a></li><li><a href="module-services_color-formatters.html">services/color-formatters</a></li><li><a href="module-services_contributor-count.html">services/contributor-count</a></li><li><a href="module-services_date.html">services/date</a></li><li><a href="module-services_downloads.html">services/downloads</a></li><li><a href="module-services_dynamic-common.html">services/dynamic-common</a></li><li><a href="module-services_dynamic_json-path.html">services/dynamic/json-path</a></li><li><a href="module-services_endpoint-common.html">services/endpoint-common</a></li><li><a href="module-services_licenses.html">services/licenses</a></li><li><a href="module-services_package-json-helpers.html">services/package-json-helpers</a></li><li><a href="module-services_php-version.html">services/php-version</a></li><li><a href="module-services_pipenv-helpers.html">services/pipenv-helpers</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_size.html">services/size</a></li><li><a href="module-services_steam_steam-base.html">services/steam/steam-base</a></li><li><a href="module-services_text-formatters.html">services/text-formatters</a></li><li><a href="module-services_validators.html">services/validators</a></li><li><a href="module-services_version.html">services/version</a></li><li><a href="module-services_website-status.html">services/website-status</a></li><li><a href="module-services_winget_version.html">services/winget/version</a></li></ul><h3>Classes</h3><ul><li><a href="BaseThunderstoreService.html">BaseThunderstoreService</a></li><li><a href="module-badge-maker_lib_xml-ElementList.html">ElementList</a></li><li><a href="module-badge-maker_lib_xml-XmlElement.html">XmlElement</a></li><li><a href="module-core_base-service_base-graphql-BaseGraphqlService.html">BaseGraphqlService</a></li><li><a href="module-core_base-service_base-json-BaseJsonService.html">BaseJsonService</a></li><li><a href="module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html">BaseSvgScrapingService</a></li><li><a href="module-core_base-service_base-toml-BaseTomlService.html">BaseTomlService</a></li><li><a href="module-core_base-service_base-xml-BaseXmlService.html">BaseXmlService</a></li><li><a href="module-core_base-service_base-yaml-BaseYamlService.html">BaseYamlService</a></li><li><a href="module-core_base-service_base-BaseService.html">BaseService</a></li><li><a href="module-core_base-service_errors-Deprecated.html">Deprecated</a></li><li><a href="module-core_base-service_errors-ImproperlyConfigured.html">ImproperlyConfigured</a></li><li><a href="module-core_base-service_errors-Inaccessible.html">Inaccessible</a></li><li><a href="module-core_base-service_errors-InvalidParameter.html">InvalidParameter</a></li><li><a href="module-core_base-service_errors-InvalidResponse.html">InvalidResponse</a></li><li><a href="module-core_base-service_errors-NotFound.html">NotFound</a></li><li><a href="module-core_base-service_errors-ShieldsRuntimeError.html">ShieldsRuntimeError</a></li><li><a href="module-core_server_server-Server.html">Server</a></li><li><a href="module-core_service-test-runner_runner-Runner.html">Runner</a></li><li><a href="module-core_service-test-runner_service-tester-ServiceTester.html">ServiceTester</a></li><li><a href="module-core_token-pooling_token-pool-Token.html">Token</a></li><li><a href="module-core_token-pooling_token-pool-TokenPool.html">TokenPool</a></li><li><a href="module-services_route-builder.html">services/route-builder</a></li><li><a href="module-services_steam_steam-base-BaseSteamAPI.html">BaseSteamAPI</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-TUTORIAL.html">TUTORIAL</a></li><li><a href="tutorial-adding-new-config-values.html">adding-new-config-values</a></li><li><a href="tutorial-authentication.html">authentication</a></li><li><a href="tutorial-badge-urls.html">badge-urls</a></li><li><a href="tutorial-code-walkthrough.html">code-walkthrough</a></li><li><a href="tutorial-deprecating-badges.html">deprecating-badges</a></li><li><a href="tutorial-input-validation.html">input-validation</a></li><li><a href="tutorial-json-format.html">json-format</a></li><li><a href="tutorial-performance-testing.html">performance-testing</a></li><li><a href="tutorial-production-hosting.html">production-hosting</a></li><li><a href="tutorial-releases.html">releases</a></li><li><a href="tutorial-self-hosting.html">self-hosting</a></li><li><a href="tutorial-server-secrets.html">server-secrets</a></li><li><a href="tutorial-service-tests.html">service-tests</a></li><li><a href="tutorial-static-badges.html">static-badges</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createNumRequestCounter">createNumRequestCounter</a></li><li><a href="global.html#fakeJwtToken">fakeJwtToken</a></li><li><a href="global.html#generateFakeConfig">generateFakeConfig</a></li><li><a href="global.html#getBadgeExampleCall">getBadgeExampleCall</a></li><li><a href="global.html#getServiceClassAuthOrigin">getServiceClassAuthOrigin</a></li><li><a href="global.html#isMetricWithPattern">isMetricWithPattern</a></li><li><a href="global.html#testAuth">testAuth</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sun Mar 02 2025 11:21:42 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|