summaryrefslogtreecommitdiff
path: root/doc/api/process.md
diff options
context:
space:
mode:
authorGus Caplan <me@gus.host>2018-03-18 23:26:41 -0500
committerGus Caplan <me@gus.host>2018-03-22 17:09:19 -0500
commit982e3bdb1f06bf9d9926c808d30864b32a8223f9 (patch)
tree32bf78decd1d3541f33ccd20e43318ec02ef6cbf /doc/api/process.md
parentcef909797af1d716b802f04264e51cf7f26c1b51 (diff)
downloadandroid-node-v8-982e3bdb1f06bf9d9926c808d30864b32a8223f9.tar.gz
android-node-v8-982e3bdb1f06bf9d9926c808d30864b32a8223f9.tar.bz2
android-node-v8-982e3bdb1f06bf9d9926c808d30864b32a8223f9.zip
process: add more version properties to release
PR-URL: https://github.com/nodejs/node/pull/19438 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Diffstat (limited to 'doc/api/process.md')
-rw-r--r--doc/api/process.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/api/process.md b/doc/api/process.md
index e89e5c0281..631a1458f9 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -1503,6 +1503,21 @@ tarball.
- `'Argon'` for the 4.x LTS line beginning with 4.2.0.
- `'Boron'` for the 6.x LTS line beginning with 6.9.0.
- `'Carbon'` for the 8.x LTS line beginning with 8.9.1.
+* `majorVersion` {number} The major version of Node.js.
+* `minorVersion` {number} The minor version of Node.js.
+* `patchVersion` {number} The patch version of Node.js.
+* `prereleaseTag` {string} The SemVer pre-release tag for Node.js.
+* `computedVersion` {number} A number representing the current version, created
+ using the following method:
+ `(majorVersion << 16) + (minorVersion << 8) + patchVersion`
+* `compareVersion` {function} Perform a SemVer comparison to the release
+ version.
+ * `major`
+ * `minor`
+ * `patch`
+ * Returns: {number} `-1` if the given version is lower than the release version,
+ `0` if the given version matches the process version, and `1` if the given
+ version is greater than the release version.
<!-- eslint-skip -->
```js
@@ -1511,7 +1526,12 @@ tarball.
lts: 'Argon',
sourceUrl: 'https://nodejs.org/download/release/v4.4.5/node-v4.4.5.tar.gz',
headersUrl: 'https://nodejs.org/download/release/v4.4.5/node-v4.4.5-headers.tar.gz',
- libUrl: 'https://nodejs.org/download/release/v4.4.5/win-x64/node.lib'
+ libUrl: 'https://nodejs.org/download/release/v4.4.5/win-x64/node.lib',
+ majorVersion: 4,
+ minorVersion: 4,
+ patchVersion: 5,
+ prereleaseTag: '',
+ computedVersion: 263173,
}
```