https://github.com/jokeyrhyme/nodejs-support-dates.js

calculate planned Node.js support windows based on LTS plans
https://github.com/jokeyrhyme/nodejs-support-dates.js

Last synced: 21 days ago
JSON representation

calculate planned Node.js support windows based on LTS plans

• Host: GitHub
• URL: https://github.com/jokeyrhyme/nodejs-support-dates.js
• Owner: jokeyrhyme
• License: mit
• Created: 2016-08-09T11:08:42.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-02T23:53:13.000Z (over 4 years ago)
• Last Synced: 2024-10-14T21:23:39.129Z (25 days ago)
• Language: JavaScript
• Size: 173 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nodejs-support-dates [![npm](https://img.shields.io/npm/v/nodejs-support-dates.svg?maxAge=2592000)](https://www.npmjs.com/package/nodejs-support-dates) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/github/jokeyrhyme/nodejs-support-dates-js?branch=master&svg=true)](https://ci.appveyor.com/project/jokeyrhyme/nodejs-support-dates-js) [![Travis CI Status](https://travis-ci.org/jokeyrhyme/nodejs-support-dates.js.svg?branch=master)](https://travis-ci.org/jokeyrhyme/nodejs-support-dates.js)

calculate planned Node.js support windows based on LTS plans

## What is this?

This project hardcodes a few key dates for past releases,

and otherwise calculates key dates for current and future releases.

The behaviour of this project is based upon:

- upstream Node.js Long-Term Support schedule: https://github.com/nodejs/LTS

- dates of previous releases: https://github.com/nodejs/node/releases

- change logs for previous releases: https://github.com/nodejs/node/blob/master/doc/changelogs/

The purpose of this project is to allow other tools to make useful and accurate recommendations to Node.js users.

## Usage

### API

#### `datesFromVersion (version)`

- version: number (major version) | string (e.g. `"1.2.3"`)

- returns: `{ release: '...', end: '...' }` (values are `Date`s)

This will return accurate dates for versions listed at: https://github.com/nodejs/LTS

Other versions will result in incorrect dates set in the distant past,

as this is sufficient for the primary purpose of this library.

Example:

```js

var datesFromVersion = require('nodejs-support-dates').datesFromVersion

JSON.stringify(datesFromVersion(process.version), null, 2)

/* if run within Node.js 6.x, will return

{

  "release": "2016-04-01T00:00:00.000Z",

  "end": "2019-04-01T00:00:00.000Z"

}

*/

// example uses `JSON.stringify()` to more easily illustrate the `Date` values

```

#### `ltsFromDate (date)`

- date: string (ISO8601) | `Date`

- returns: number (major version)

Example:

```js

var ltsFromDate = require('nodejs-support-dates').ltsFromDate

ltsFromDate('2016-04-01') // => 6

ltsFromDate(new Date()) // => 6

```