0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-25 08:19:38 +01:00
Cross-platform JavaScript runtime environment https://nodejs.org/
Go to file
Deokjin Kim cd4f4b4dfa
doc: describe argument of Symbol.for
Symbol is described with argument, but argument of Symbol.for
is ommited. So describe argument of Symbol.for for consistency.

Refs: https://github.com/nodejs/node/blob/main/doc/contributing/using-symbols.md#symbolstring
PR-URL: https://github.com/nodejs/node/pull/46019
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
2023-01-04 20:37:33 +00:00
.github tools: add url to AUTHORS update automation 2022-12-27 12:34:45 +00:00
android-patches build: rewritten the Android build system 2022-09-12 08:10:29 +00:00
benchmark src: speed up process.getActiveResourcesInfo() 2023-01-03 10:36:25 +00:00
deps deps: update corepack to 0.15.3 2023-01-02 19:08:12 +00:00
doc doc: describe argument of Symbol.for 2023-01-04 20:37:33 +00:00
lib events: check signal before listener 2023-01-04 04:28:54 +00:00
src node-api: disambiguate napi_add_finalizer 2023-01-04 18:56:12 +08:00
test test,esm: validate more edge cases for dynamic imports 2023-01-04 13:52:23 +00:00
tools tools: update lint-md-dependencies to rollup@3.9.0 2023-01-01 16:48:38 +00:00
typings crypto: refactor ArrayBuffer to bigint conversion utils 2022-11-27 18:27:21 +00:00
.clang-format tools: add make format-cpp to run clang-format on C++ diffs 2018-08-03 19:40:23 +08:00
.cpplint tools: move cpplint configuration to .cpplint 2019-04-08 08:30:29 -04:00
.editorconfig tools: enforce use of single quotes in editorconfig 2020-11-12 06:19:49 +00:00
.eslintignore src,lib: print source map error source on demand 2022-07-28 08:09:30 +08:00
.eslintrc.js tools: enforce use of trailing commas in tools/ 2022-12-18 16:39:39 +00:00
.flake8 tools: python: ignore instead of select flake8 rules 2019-04-13 20:33:06 -04:00
.gitattributes build: add .gitattributes for npm and other shims 2022-07-19 21:27:49 +01:00
.gitignore build: convert V8 test JSON to JUnit XML 2022-10-03 17:45:40 +00:00
.gitpod.yml build: make GitPod less noisy 2022-07-14 05:49:31 +01:00
.mailmap meta: add .mailmap entry for Stefan Stojanovic 2022-12-01 22:10:33 +00:00
.nycrc test: add windows and C++ coverage 2020-10-21 19:41:08 -07:00
.yamllint.yaml build: extend yamllint configuration 2022-02-14 19:09:26 +01:00
android_configure.py build: rewritten the Android build system 2022-09-12 08:10:29 +00:00
android-configure build: add python 3.11 support for android 2022-12-11 02:58:02 +00:00
AUTHORS meta: update AUTHORS 2023-01-01 16:48:47 +00:00
BSDmakefile build: replace which with command -v 2020-11-19 19:33:28 +01:00
BUILDING.md build: support Python 3.11 2022-10-28 18:35:49 +00:00
CHANGELOG.md 2022-12-14, Version 19.3.0 (Current) 2022-12-14 13:52:52 +00:00
CODE_OF_CONDUCT.md tools: avoid unnecessary escaping in markdown formatter 2021-10-31 09:36:05 -07:00
codecov.yml build: turn off Codecov comments 2020-10-26 03:56:13 -07:00
common.gypi deps: V8: cherry-pick 30861a39323d 2023-01-01 10:54:22 +00:00
configure build: support Python 3.11 2022-10-28 18:35:49 +00:00
configure.py build: add option to disable shared readonly heap 2022-12-21 19:16:56 +00:00
CONTRIBUTING.md doc: make contributing info more discoverable 2022-01-18 14:24:30 -05:00
glossary.md doc: add undici to glossary 2022-06-08 17:22:09 -07:00
GOVERNANCE.md doc: make contributing info more discoverable 2022-01-18 14:24:30 -05:00
LICENSE deps: add simdutf dependency 2022-12-22 20:22:27 +00:00
Makefile deps: add simdutf dependency 2022-12-22 20:22:27 +00:00
node.gyp deps: add simdutf dependency 2022-12-22 20:22:27 +00:00
node.gypi src: fix creating Isolates from addons 2022-12-23 17:06:05 +00:00
onboarding.md doc: update name of Node.js core Slack channel 2022-11-03 03:02:18 +00:00
README.md doc: remove Juan Jose keys 2022-12-14 18:25:22 +00:00
SECURITY.md doc: fix typo in threat model 2022-11-21 14:25:43 +00:00
tsconfig.json typings: add more bindings typings 2021-10-31 13:41:45 +01:00
vcbuild.bat build: fix arm64 cross-compile from powershell 2022-12-24 20:20:39 +00:00

Node.js

Node.js is an open-source, cross-platform JavaScript runtime environment.

For information on using Node.js, see the Node.js website.

The Node.js project uses an open governance model. The OpenJS Foundation provides support for the project.

This project has a Code of Conduct.

Table of contents

Support

Looking for help? Check out the instructions for getting support.

Release types

  • Current: Under active development. Code for the Current release is in the branch for its major version number (for example, v15.x). Node.js releases a new major version every 6 months, allowing for breaking changes. This happens in April and October every year. Releases appearing each October have a support life of 8 months. Releases appearing each April convert to LTS (see below) each October.
  • LTS: Releases that receive Long Term Support, with a focus on stability and security. Every even-numbered major version will become an LTS release. LTS releases receive 12 months of Active LTS support and a further 18 months of Maintenance. LTS release lines have alphabetically-ordered code names, beginning with v4 Argon. There are no breaking changes or feature additions, except in some special circumstances.
  • Nightly: Code from the Current branch built every 24-hours when there are changes. Use with caution.

Current and LTS releases follow semantic versioning. A member of the Release Team signs each Current and LTS release. For more information, see the Release README.

Download

Binaries, installers, and source tarballs are available at https://nodejs.org/en/download/.

Current and LTS releases

https://nodejs.org/download/release/

The latest directory is an alias for the latest Current release. The latest-codename directory is an alias for the latest release from an LTS line. For example, the latest-fermium directory contains the latest Fermium (Node.js 14) release.

Nightly releases

https://nodejs.org/download/nightly/

Each directory name and filename contains a date (in UTC) and the commit SHA at the HEAD of the release.

API documentation

Documentation for the latest Current release is at https://nodejs.org/api/. Version-specific documentation is available in each release directory in the docs subdirectory. Version-specific documentation is also at https://nodejs.org/download/docs/.

Verifying binaries

Download directories contain a SHASUMS256.txt file with SHA checksums for the files.

To download SHASUMS256.txt using curl:

$ curl -O https://nodejs.org/dist/vx.y.z/SHASUMS256.txt

To check that a downloaded file matches the checksum, run it through sha256sum with a command such as:

$ grep node-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c -

For Current and LTS, the GPG detached signature of SHASUMS256.txt is in SHASUMS256.txt.sig. You can use it with gpg to verify the integrity of SHASUMS256.txt. You will first need to import the GPG keys of individuals authorized to create releases. To import the keys:

$ gpg --keyserver hkps://keys.openpgp.org --recv-keys 4ED778F539E3634C779C87C6D7062848A1AB005C

See Release keys for a script to import active release keys.

Next, download the SHASUMS256.txt.sig for the release:

$ curl -O https://nodejs.org/dist/vx.y.z/SHASUMS256.txt.sig

Then use gpg --verify SHASUMS256.txt.sig SHASUMS256.txt to verify the file's signature.

Building Node.js

See BUILDING.md for instructions on how to build Node.js from source and a list of supported platforms.

Security

For information on reporting security vulnerabilities in Node.js, see SECURITY.md.

Contributing to Node.js

Current project team members

For information about the governance of the Node.js project, see GOVERNANCE.md.

TSC (Technical Steering Committee)

Emeriti

TSC emeriti

Collaborators

Emeriti

Collaborator emeriti

Collaborators follow the Collaborator Guide in maintaining the Node.js project.

Triagers

Triagers follow the Triage Guide when responding to new issues.

Release keys

Primary GPG keys for Node.js Releasers (some Releasers sign with subkeys):

To import the full set of trusted release keys (including subkeys possibly used to sign releases):

gpg --keyserver hkps://keys.openpgp.org --recv-keys 4ED778F539E3634C779C87C6D7062848A1AB005C
gpg --keyserver hkps://keys.openpgp.org --recv-keys 141F07595B7B3FFE74309A937405533BE57C7D57
gpg --keyserver hkps://keys.openpgp.org --recv-keys 74F12602B6F1C4E913FAA37AD3A89613643B6201
gpg --keyserver hkps://keys.openpgp.org --recv-keys 8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600
gpg --keyserver hkps://keys.openpgp.org --recv-keys C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8
gpg --keyserver hkps://keys.openpgp.org --recv-keys 890C08DB8579162FEE0DF9DB8BEAB4DFCF555EF4
gpg --keyserver hkps://keys.openpgp.org --recv-keys C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C
gpg --keyserver hkps://keys.openpgp.org --recv-keys 108F52B48DB57BB0CC439B2997B01419BD92F80A

See Verifying binaries for how to use these keys to verify a downloaded file.

Other keys used to sign some previous releases

Security release stewards

When possible, the commitment to take slots in the security release steward rotation is made by companies in order to ensure individuals who act as security stewards have the support and recognition from their employer to be able to prioritize security releases. Security release stewards manage security releases on a rotation basis as outlined in the security release process.

License

Node.js is available under the MIT license. Node.js also includes external libraries that are available under a variety of licenses. See LICENSE for the full license text.