全局对象 | Node.js 26.4.0 Documentation

稳定性：2 - 稳定

这些对象在所有模块中均可用。

以下变量可能看起来是全局的，但实际上不是。它们仅存在于 CommonJS 模块的作用域中：

此处列出的对象是 Node.js 特有的。还有内置对象是 JavaScript 语言本身的一部分，它们也是全局可访问的。

此变量可能看起来是全局的，但实际上不是。参见 __dirname。

此变量可能看起来是全局的，但实际上不是。参见 __filename。

一个用于在选定的基于 Promise 的 API 中信号取消的工具类。该 API 基于 Web API <AbortController>。

const ac = new AbortController();

ac.signal.addEventListener('abort', () => console.log('已中止!'),
                           { once: true });

ac.abort();

console.log(ac.signal.aborted);  // 打印 true

JavaScript

触发中止信号，导致 abortController.signal 发出 'abort' 事件。

继承自：<EventTarget>

AbortSignal 用于在调用 abortController.abort() 方法时通知观察者。

返回一个新的已中止的 AbortSignal。

返回一个新的 AbortSignal，它将在 delay 毫秒后中止。

返回一个新的 AbortSignal，如果任何提供的信号被中止，它也将被中止。其 abortSignal.reason 将设置为导致其被中止的任一 signals。

const ac = new AbortController();

// 使用 onabort 属性...
ac.signal.onabort = () => console.log('aborted!');

// 或使用 EventTarget API...
ac.signal.addEventListener('abort', (event) => {
  console.log(event.type);  // 打印 'abort'
}, { once: true });

ac.abort();

JavaScript

关联 AbortSignal 的 AbortController 只会触发一次 'abort' 事件。我们建议代码在添加 'abort' 事件监听器之前检查 abortSignal.aborted 属性是否为 false。

附加到 AbortSignal 的任何事件监听器都应使用 { once: true } 选项（或者，如果使用 EventEmitter API 附加监听器，请使用 once() 方法），以确保一旦 'abort' 事件被处理，事件监听器即被移除。否则可能导致内存泄漏。

在 AbortController 被中止后为 true。

一个可选的回调函数，可由用户代码设置，以便在调用 abortController.abort() 函数时收到通知。

在触发 AbortSignal 时指定的可选原因。

const ac = new AbortController();
ac.abort(new Error('boom!'));
console.log(ac.signal.reason);  // 错误：boom!

JavaScript

稳定性：3 - 遗留。请改用 Buffer.from(data, 'base64')。

buffer.atob() 的全局别名。

提供了一个自动迁移工具 (来源)：

npx codemod@latest @nodejs/buffer-atob-btoa

参见 <Blob>。

参见 <BroadcastChannel>。

稳定性：3 - 遗留。请改用 buf.toString('base64')。

buffer.btoa() 的全局别名。

提供了一个自动迁移工具 (来源)：

npx codemod@latest @nodejs/buffer-atob-btoa

类型：<Function>

用于处理二进制数据。参见 buffer 部分。

ByteLengthQueuingStrategy 的与浏览器兼容的实现。

clearImmediate 在 [计时器][] 部分中描述。

clearInterval 在 [计时器][] 部分中描述。

clearTimeout 在 [计时器][] 部分中描述。

<CloseEvent> 的与浏览器兼容的实现。使用 --no-experimental-websocket CLI 标志禁用此 API。

CompressionStream 的与浏览器兼容的实现。

类型：<Object>

用于打印到 stdout 和 stderr。参见 console 部分。

CountQueuingStrategy 的与浏览器兼容的实现。

<Crypto> 的与浏览器兼容的实现。仅当编译 Node.js 二进制文件时包含对 node:crypto 模块的支持，此全局对象才可用。

Web Crypto API 的与浏览器兼容的实现。

<CryptoKey> 的与浏览器兼容的实现。仅当编译 Node.js 二进制文件时包含对 node:crypto 模块的支持，此全局对象才可用。

<CustomEvent> 的与浏览器兼容的实现。

DecompressionStream 的与浏览器兼容的实现。

WHATWG <DOMException> 类。

<ErrorEvent> 的与浏览器兼容的实现。

与浏览器兼容的 Event 类实现。有关更多详细信息，请参阅 EventTarget 和 Event API。

稳定性：1 - 实验性。使用 --experimental-eventsource CLI 标志启用此 API。

与浏览器兼容的 <EventSource> 实现。

与浏览器兼容的 EventTarget 类实现。有关更多详细信息，请参阅 EventTarget 和 Event API。

此变量可能看起来是全局的，但并不是。请参阅 exports。

与浏览器兼容的 fetch() 函数实现。

const res = await fetch('https://nodejs.org/api/documentation.json');
if (res.ok) {
  const data = await res.json();
  console.log(data);
}

JavaScript

该实现基于 undici，这是一个专为 Node.js 从头编写的 HTTP/1.1 客户端。你可以通过读取 process.versions.undici 属性来确定你的 Node.js 进程中捆绑了哪个版本的 undici。

fetch(url, { dispatcher: new MyAgent() });

可以通过安装 undici 并使用 setGlobalDispatcher() 方法来更改 Node.js 中的全局 dispatcher。调用此方法将影响 undici 和 Node.js 两者。

import { setGlobalDispatcher } from 'undici';
setGlobalDispatcher(new MyAgent());

JavaScript

FormData
Headers
Request
Response

请参阅 <File>。

与浏览器兼容的 <FormData> 实现。

稳定性：3 - 遗留。请改用 globalThis。

类型：<Object> 全局命名空间对象。

在浏览器中，顶层作用域传统上是全局作用域。这意味着 var something 将定义一个新的全局变量，除了在 ECMAScript 模块内。在 Node.js 中，这是不同的。顶层作用域不是全局作用域；Node.js 模块内的 var something 将局限于该模块，无论它是 CommonJS 模块还是 ECMAScript 模块。

与浏览器兼容的 <Headers> 实现。

稳定性：1.2 - 发布候选。使用 --no-experimental-webstorage 禁用此 API。

与浏览器兼容的 localStorage 实现。数据存储在由 --localstorage-file CLI 标志指定的文件中，未加密。可存储的最大数据量为 10 MB。不支持在 Web Storage API 之外对此数据进行任何修改。在服务器上下文中使用时，localStorage 数据不是按用户或按请求存储的，它在所有用户和请求之间共享。

MessageChannel 类。有关更多详细信息，请参阅 MessageChannel。

与浏览器兼容的 <MessageEvent> 实现。

MessagePort 类。有关更多详细信息，请参阅 MessagePort。

此变量可能看起来是全局的，但并不是。请参阅 module。

稳定性：1.1 - 积极开发中。使用 --no-experimental-global-navigator CLI 标志禁用此 API。

Navigator API 的部分实现。

稳定性：1.1 - 积极开发中。使用 --no-experimental-global-navigator CLI 标志禁用此 API。

window.navigator 的部分实现。

navigator.hardwareConcurrency 只读属性返回当前 Node.js 实例可用的逻辑处理器数量。

console.log(`This process is running on ${navigator.hardwareConcurrency} logical processors`);

navigator.language 只读属性返回一个字符串，表示 Node.js 实例的首选语言。语言将由运行时基于操作系统的默认语言使用的 Node.js 的 ICU 库确定。

该值表示 RFC 5646 中定义的语言版本。

在没有 ICU 的构建上，回退值为 'en-US'。

console.log(`The preferred language of the Node.js instance has the tag '${navigator.language}'`);

navigator.languages 只读属性返回一个字符串数组，表示 Node.js 实例的首选语言。默认情况下，navigator.languages 仅包含 navigator.language 的值，该值将由运行时基于操作系统的默认语言使用的 Node.js 的 ICU 库确定。

在没有 ICU 的构建上，回退值为 ['en-US']。

console.log(`The preferred languages are '${navigator.languages}'`);

navigator.locks 只读属性返回一个 LockManager 实例，该实例可用于协调对可能在同一进程内多个线程之间共享的资源的访问。此全局实现匹配 [浏览器 LockManager][] API 的语义。

// 请求独占锁
await navigator.locks.request('my_resource', async (lock) => {
  // 锁已获取。
  console.log(`Lock acquired: ${lock.name}`);
  // 函数返回时锁会自动释放
});

// 请求共享锁
await navigator.locks.request('shared_resource', { mode: 'shared' }, async (lock) => {
  // 可以同时持有多个共享锁
  console.log(`Shared lock acquired: ${lock.name}`);
});

JavaScript

有关详细的 API 文档，请参阅 worker_threads.locks。

navigator.platform 只读属性返回一个字符串，标识运行 Node.js 实例的平台。

console.log(`This process is running on ${navigator.platform}`);

navigator.userAgent 只读属性返回用户代理，由运行时名称和主版本号组成。

console.log(`The user-agent is ${navigator.userAgent}`); // 打印 "Node.js/21"

perf_hooks.performance 对象。

PerformanceEntry 类。有关更多详细信息，请参阅 PerformanceEntry。

PerformanceMark 类。有关更多详细信息，请参阅 PerformanceMark。

PerformanceMeasure 类。有关更多详细信息，请参阅 PerformanceMeasure。

PerformanceObserver 类。有关更多详细信息，请参阅 PerformanceObserver。

PerformanceObserverEntryList 类。详见 PerformanceObserverEntryList 以获取更多详情。

PerformanceResourceTiming 类。详见 PerformanceResourceTiming 以获取更多详情。

类型：<Object>

process 对象。详见 process 对象部分。

Attributes

callback:<Function>

要排队等待执行的函数。

queueMicrotask() 方法将一个微任务排队以调用 callback。如果 callback 抛出异常，将发出 process 对象的 'uncaughtException' 事件。

微任务队列由 V8 管理，其使用方式可能与由 Node.js 管理的 process.nextTick() 队列类似。在 Node.js 事件循环的每一轮中，process.nextTick() 队列总是在微任务队列之前被处理。

// 这里，`queueMicrotask()` 用于确保 'load' 事件总是
// 异步发出，因此保持一致。使用
// `process.nextTick()` 会导致 'load' 事件总是在
// 任何其他 Promise 作业之前发出。

DataHandler.prototype.load = async function load(key) {
  const hit = this._cache.get(key);
  if (hit !== undefined) {
    queueMicrotask(() => {
      this.emit('load', hit);
    });
    return;
  }

  const data = await fetchData(key);
  this._cache.set(key, data);
  this.emit('load', data);
};