mirror of
https://github.com/badges/shields.git
synced 2025-09-18 05:05:28 +03:00
160 lines
12 KiB
HTML
160 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: services/date.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/date.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
* Commonly-used functions for rendering badges containing a date
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
import dayjs from 'dayjs'
|
|
import calendar from 'dayjs/plugin/calendar.js'
|
|
import customParseFormat from 'dayjs/plugin/customParseFormat.js'
|
|
import { colorScale } from './color-formatters.js'
|
|
import { InvalidResponse } from './index.js'
|
|
|
|
dayjs.extend(calendar)
|
|
dayjs.extend(customParseFormat)
|
|
|
|
/**
|
|
* Parse and validate a string date into a dayjs object. Use this helper
|
|
* in preference to invoking dayjs directly when parsing a date from string.
|
|
*
|
|
* @param {...any} args - Variadic: Arguments to pass through to dayjs
|
|
* @returns {dayjs} - Parsed object
|
|
* @throws {InvalidResponse} - Error if validation fails
|
|
* @see https://day.js.org/docs/en/parse/string
|
|
* @see https://day.js.org/docs/en/parse/string-format
|
|
* @see https://day.js.org/docs/en/parse/is-valid
|
|
* @example
|
|
* parseDate('2024-01-01')
|
|
* parseDate('31/01/2024', 'DD/MM/YYYY')
|
|
* parseDate('2018 Enero 15', 'YYYY MMMM DD', 'es')
|
|
*/
|
|
function parseDate(...args) {
|
|
let date
|
|
if (args.length >= 2) {
|
|
// always use strict mode if format arg is supplied
|
|
date = dayjs(...args, true)
|
|
} else {
|
|
date = dayjs(...args)
|
|
}
|
|
if (!date.isValid()) {
|
|
throw new InvalidResponse({ prettyMessage: 'invalid date' })
|
|
}
|
|
return date
|
|
}
|
|
|
|
/**
|
|
* Returns a formatted date string without the year based on the value of input date param d.
|
|
*
|
|
* @param {Date | string | number | dayjs } d JS Date object, string, unix timestamp or dayjs object
|
|
* @returns {string} Formatted date string
|
|
*/
|
|
function formatDate(d) {
|
|
const date = parseDate(d)
|
|
const dateString = date.calendar(null, {
|
|
lastDay: '[yesterday]',
|
|
sameDay: '[today]',
|
|
lastWeek: '[last] dddd',
|
|
sameElse: 'MMMM YYYY',
|
|
})
|
|
// Trim current year from date string
|
|
return dateString.replace(` ${dayjs().year()}`, '').toLowerCase()
|
|
}
|
|
|
|
/**
|
|
* Determines the color used for a badge according to the age.
|
|
* Age is calculated as days elapsed till current date.
|
|
* The color varies from bright green to red as the age increases
|
|
* or the other way around if `reverse` is given `true`.
|
|
*
|
|
* @param {Date | string | number | dayjs } date JS Date object, string, unix timestamp or dayjs object
|
|
* @param {boolean} reversed Reverse the color scale (the older, the better)
|
|
* @returns {string} Badge color
|
|
*/
|
|
function age(date, reversed = false) {
|
|
const colorByAge = colorScale([7, 30, 180, 365, 730], undefined, !reversed)
|
|
const daysElapsed = dayjs().diff(parseDate(date), 'days')
|
|
return colorByAge(daysElapsed)
|
|
}
|
|
|
|
/**
|
|
* Creates a badge object that displays a date
|
|
*
|
|
* @param {Date | string | number | dayjs } date JS Date object, string, unix timestamp or dayjs object
|
|
* @param {boolean} reversed Reverse the color scale (the older, the better)
|
|
* @returns {object} A badge object that has two properties: message, and color
|
|
*/
|
|
function renderDateBadge(date, reversed = false) {
|
|
const d = parseDate(date)
|
|
const color = age(d, reversed)
|
|
const message = formatDate(d)
|
|
return { message, color }
|
|
}
|
|
|
|
/**
|
|
* Returns a relative date from the input timestamp.
|
|
* For example, day after tomorrow's timestamp will return 'in 2 days'.
|
|
*
|
|
* @param {number | string} timestamp - Unix timestamp
|
|
* @returns {string} Relative date from the unix timestamp
|
|
*/
|
|
function formatRelativeDate(timestamp) {
|
|
const parsedDate = dayjs.unix(parseInt(timestamp, 10))
|
|
if (!parsedDate.isValid()) {
|
|
return 'invalid date'
|
|
}
|
|
return dayjs().to(parsedDate).toLowerCase()
|
|
}
|
|
|
|
export { parseDate, renderDateBadge, formatDate, formatRelativeDate, age }
|
|
</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 Sep 14 2025 11:22:58 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|