temporalts

temporalts is a module that leverages Moment (apologies, Maggie!) and the schedule.json file published in the Node.js Release WG repo to generate temporal information about Node.js release lines.

Installation

npm install timelts

Usage

temporalts can pass all Node.js LTS release line temporal information, or the temporal information for a specific release line.

temporalts() (all release line temporal information)

This will return a Promise that resolves an object where each key is the name of a release line and the property of each key is an object that includes several instances of Moment and some additional useful information that is derived from those instances of Moment.

const temporalts = require('temporalts')

async function timeUntilEachLineGoesEOL() {
  const lts = await temporalts()

    for (let [key, ltsTime] of Object.entries(lts)) {
      console.log(`One percent of the Node.js ${key} LTS release line's lifespan is ${ltsTime.onePercentOfLTSLifeSpanInDays} days.`)
    }
}

timeUntilEachLineGoesEOL()

temporalts(version) (release line temporal information for version)

You can pass a version as an argument to temporalts() that will then only resolve the specific Node.js LTS release line you requested, rather than an object of all versions. There are a few caveats:

• You must only pass versions that map to an LTS release line. In Node.js, all even versions were, are, or will be LTS release lines.
• You must preface the version with a v. For example, v12, v6, v14.
• You must only pass versions that exist in the schedule.json file the Node.js Release WG maintains. Generally, it seems this is 1 LTS ahead of the currently published version that is or will be an LTS version.

const temporalts = require('../')

async function prettyPrint () {
  const version = 'v12'
    const data = await temporalts(version)

    console.log
    console.log(`We are ${data.currentPercentOfLTSLifeSpanWithoutDecimal}% through the lifespan of the Node.js ${version} LTS release line.\n${data.currentPercentOfLTSLifeSpanAsProgressBar}`)
    console.log()
}

prettyPrint()

Examples of What Will Work When Passing a Version

• v4, v6, v8, v10, v12, v14

Examples of What Will Not Work When Passing a Version

• 6, 8, 10, 12
• v7, v9, v11, v13
• 6.0.0, 12.0.0
• v6.0.0, v12.0.0
• 8.x, 10.x
• v8.x, v10.x
• v30

Exposed API

Once resolved, the temporalts promise returns an object. It provides this shape:

• now: An instance of moment() which is the current moment in time.
• timeframeStart: An instance of moment that is the beginning of the LTS window of a given release's lifespan.
  • Important: This is not the original release of the LTS release line as Current, but rather the moment it moved from Current to LTS.
• timeframeEnd: An instance of moment that is the moment a given release line goes End of Life (EOL).
• diffStartAndEnd: Difference (in milliseconds) between timeframeStart and timeframeEnd.
• diffNowAndStart: Difference (in milliseconds) between now and timeframeStart.
• diffNowAndEnd: Difference (in milliseconds) between now and timeframeEnd.
• onePercentOfLTSLifeSpanInMilliseconds: A calculation (in milliseconds) of 1% of the lifespan of a given release.
• onePercentOfLTSLifeSpanInDays: A calculation (in days) of 1% of the lifespan of a given release.
• currentPercentOfLTSLifeSpan: Gives the raw (including decimal) percentage of time that has passed from the beginning to the end of a given release's LTS lifespan.
• currentPercentOfLTSLifeSpanWithoutDecimal: Gives the more human-friendly (exclusing decimal) percentage of time that has passed from the beginning to the end of a given release's LTS lifespan.
• currentPercentOfLTSLifeSpanAsProgressBar: Proives a progress bar (using the charachters [, =, , and ]) that shows the current progress of a given release's lifespan in a visual format.
• fromNowToEnd: Human-readable time from now to the end of the LTS window.
• fromLTSStartToNow: Human-readable time from the start of the LTS window to now.

Below is an example of of one entry. You will get several of these as properties of their respective versions as keys if you execute the module without passing a version.

{
    "now": "2020-01-02T03:44:02.171Z",
    "timeframeStart": "2018-10-30T04:00:00.000Z",
    "timeframeEnd": "2021-04-30T04:00:00.000Z",
    "diffStartAndEnd": 78883200000,
    "diffNowAndStart": 37064642171,
    "diffNowAndEnd": 41818557829,
    "onePercentOfLTSLifeSpanInMilliseconds": 788832000,
    "onePercentOfLTSLifeSpanInDays": 9.13,
    "currentPercentOfLTSLifeSpan": 46.98673757023042,
    "currentPercentOfLTSLifeSpanWithoutDecimal": 46,
    "currentPercentOfLTSLifeSpanAsProgressBar": "[=========           ]",
    "fromNowToEnd": "in a year",
    "fromLTSStartToNow": "a year ago"
  }