Gecko [ betsfootball.net ]

Name	Size	Permission	Date
doc_img	[ DIR ]	drwxr-xr-x	2025-04-07 20:36
maintaining	[ DIR ]	drwxr-xr-x	2025-04-07 20:36
adding-new-napi-api.md	3.46 KB	-rw-r--r--	2024-04-10 12:46
adding-v8-fast-api.md	5.06 KB	-rw-r--r--	2024-04-10 12:46
api-documentation.md	15.36 KB	-rw-r--r--	2024-04-10 12:46
backporting-to-release-lines.md	6.14 KB	-rw-r--r--	2024-04-10 12:46
building-node-with-ninja.md	1.72 KB	-rw-r--r--	2024-04-10 12:46
code-of-conduct.md	2.12 KB	-rw-r--r--	2024-04-10 12:46
collaborator-guide.md	43.78 KB	-rw-r--r--	2024-04-10 12:46
commit-queue.md	5.76 KB	-rw-r--r--	2024-04-10 12:46
components-in-core.md	2.51 KB	-rw-r--r--	2024-04-10 12:46
cpp-style-guide.md	12.81 KB	-rw-r--r--	2024-04-10 12:46
diagnostic-tooling-support-tiers.md	8 KB	-rw-r--r--	2024-04-10 12:46
distribution.md	1.16 KB	-rw-r--r--	2024-04-10 12:46
feature-request-management.md	3.41 KB	-rw-r--r--	2024-04-10 12:46
gn-build.md	3.98 KB	-rw-r--r--	2024-04-10 12:46
internal-api.md	539 B	-rw-r--r--	2024-04-10 12:46
investigating-native-memory-leaks.md	30.56 KB	-rw-r--r--	2024-04-10 12:46
issues.md	3.31 KB	-rw-r--r--	2024-04-10 12:46
node-postmortem-support.md	2.53 KB	-rw-r--r--	2024-04-10 12:46
offboarding.md	1.39 KB	-rw-r--r--	2024-04-10 12:46
primordials.md	23.51 KB	-rw-r--r--	2024-04-10 12:46
pull-requests.md	24.87 KB	-rw-r--r--	2024-04-10 12:46
releases-node-api.md	7.06 KB	-rw-r--r--	2024-04-10 12:46
releases.md	46.46 KB	-rw-r--r--	2024-04-10 12:46
security-model-strategy.md	2.81 KB	-rw-r--r--	2024-04-10 12:46
security-release-process.md	12.4 KB	-rw-r--r--	2024-04-10 12:46
security-steward-on-off-boarding.md	1.02 KB	-rw-r--r--	2024-04-10 12:46
sharing-project-news.md	1.65 KB	-rw-r--r--	2024-04-10 12:46
static-analysis.md	798 B	-rw-r--r--	2024-04-10 12:46
strategic-initiatives.md	3.43 KB	-rw-r--r--	2024-04-10 12:46
streaming-to-youtube.md	4.51 KB	-rw-r--r--	2024-04-10 12:46
suggesting-social-media-posts.md	257 B	-rw-r--r--	2024-04-10 12:46
technical-priorities.md	7.44 KB	-rw-r--r--	2024-04-10 12:46
technical-values.md	2.79 KB	-rw-r--r--	2024-04-10 12:46
using-internal-errors.md	5.05 KB	-rw-r--r--	2024-04-10 12:46
using-symbols.md	2.33 KB	-rw-r--r--	2024-04-10 12:46
writing-and-running-benchmarks.md	23.49 KB	-rw-r--r--	2024-04-10 12:46
writing-tests.md	16.03 KB	-rw-r--r--	2024-04-10 12:46

Rename

# 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(string)`

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.