ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / share / doc / nodejs-8.19.4 / 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.

[-] node-postmortem-support.md [edit]
[-] using-symbols.md [edit]
[-] offboarding.md [edit]
[-] maintaining-dependencies.md [edit]
[-] maintaining-zlib.md [edit]
[-] maintaining-shared-library-support.md [edit]
[-] components-in-core.md [edit]
[-] internal-api.md [edit]
[-] maintaining-cjs-module-lexer.md [edit]
[-] commit-queue.md [edit]
[+] ..
[+] doc_img
[-] maintaining-http.md [edit]
[-] adding-new-napi-api.md [edit]
[-] strategic-initiatives.md [edit]
[-] writing-tests.md [edit]
[-] maintaining-root-certs.md [edit]
[-] using-internal-errors.md [edit]
[-] maintaining-openssl.md [edit]
[-] collaborator-guide.md [edit]
[-] investigating-native-memory-leaks.md [edit]
[-] maintaining-web-assembly.md [edit]
[-] maintaining-c-ares.md [edit]
[-] maintaining-icu.md [edit]
[-] maintaining-types-for-nodejs.md [edit]
[-] issues.md [edit]
[-] writing-and-running-benchmarks.md [edit]
[-] maintaining-the-build-files.md [edit]
[-] technical-values.md [edit]
[-] cpp-style-guide.md [edit]
[-] security-steward-on-off-boarding.md [edit]
[-] technical-priorities.md [edit]
[-] backporting-to-release-lines.md [edit]
[-] releases.md [edit]
[-] maintaining-V8.md [edit]
[-] diagnostic-tooling-support-tiers.md [edit]
[-] security-model-strategy.md [edit]
[-] security-release-process.md [edit]
[-] building-node-with-ninja.md [edit]
[-] feature-request-management.md [edit]
[-] pull-requests.md [edit]
[-] maintaining-npm.md [edit]
[-] static-analysis.md [edit]
[-] primordials.md [edit]
[-] code-of-conduct.md [edit]