/usr/share/doc/nodejs/html/contributing
# Using global symbols ES6 introduced a new type: `Symbol`. This new type is _immutable_, and it is often used for metaprogramming purposes, as it can be used as property keys like string. There are two types of symbols, local and global. Symbol-keyed properties of an object are not included in the output of `JSON.stringify()`, but the `util.inspect()` function includes them by default. Learn more about symbols at <https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol>. ## `Symbol(string)` Symbols created via `Symbol(string)` are local to the caller function. For this reason, we often use them to simulate private fields, like so: ```js const kField = Symbol('kField'); console.log(kField === Symbol('kField')); // false class MyObject { constructor() { this[kField] = 'something'; } } module.exports.MyObject = MyObject; ``` Symbols are not fully private, as the data could be accessed anyway: ```js for (const s of Object.getOwnPropertySymbols(obj)) { const desc = s.toString().replace(/Symbol\((.*)\)$/, '$1'); if (desc === 'kField') { console.log(obj[s]); // 'something' } } ``` Local symbols make it harder for developers to monkey patch/access private fields, as they require more work than a property prefixed with an `_`. Monkey patching private API that were not designed to be monkey-patchable make maintaining and evolving Node.js harder, as private properties are not documented and can change within a patch release. Some extremely popular modules in the ecosystem monkey patch some internals, making it impossible for us to update and improve those areas without causing issues for a significant amount of users. ## `Symbol.for` Symbols created with `Symbol.for(string)` are global and unique to the same V8 Isolate. On the first call to `Symbol.for(string)` a symbol is stored in a global registry and easily retrieved for every call of `Symbol.for(string)`. However, this might cause problems when two module authors use the same symbol for different reasons. ```js const s = Symbol.for('hello'); console.log(s === Symbol.for('hello')); // true ``` In the Node.js runtime we prefix all our global symbols with `nodejs.`, e.g. `Symbol.for('nodejs.hello')`. Global symbols should be preferred when a developer-facing interface is needed to allow behavior customization, i.e., metaprogramming.
.
Edit
..
Edit
adding-new-napi-api.md
Edit
backporting-to-release-lines.md
Edit
building-node-with-ninja.md
Edit
code-of-conduct.md
Edit
collaborator-guide.md
Edit
commit-queue.md
Edit
components-in-core.md
Edit
cpp-style-guide.md
Edit
diagnostic-tooling-support-tiers.md
Edit
doc_img
Edit
feature-request-management.md
Edit
internal-api.md
Edit
investigating-native-memory-leaks.md
Edit
issues.md
Edit
maintaining-V8.md
Edit
maintaining-c-ares.md
Edit
maintaining-cjs-module-lexer.md
Edit
maintaining-dependencies.md
Edit
maintaining-http.md
Edit
maintaining-icu.md
Edit
maintaining-npm.md
Edit
maintaining-openssl.md
Edit
maintaining-root-certs.md
Edit
maintaining-shared-library-support.md
Edit
maintaining-the-build-files.md
Edit
maintaining-types-for-nodejs.md
Edit
maintaining-web-assembly.md
Edit
maintaining-zlib.md
Edit
node-postmortem-support.md
Edit
offboarding.md
Edit
primordials.md
Edit
pull-requests.md
Edit
releases.md
Edit
security-model-strategy.md
Edit
security-release-process.md
Edit
security-steward-on-off-boarding.md
Edit
static-analysis.md
Edit
strategic-initiatives.md
Edit
technical-priorities.md
Edit
technical-values.md
Edit
using-internal-errors.md
Edit
using-symbols.md
Edit
writing-and-running-benchmarks.md
Edit
writing-tests.md
Edit