Node.js v25.0.0 ドキュメンテーション

クラス: AbortController#

選択された Promise ベースの API でキャンセルを通知するために使用されるユーティリティクラスです。この API は Web API の <AbortController> に基づいています。

const ac = new AbortController();

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

ac.abort();

console.log(ac.signal.aborted);  // Prints true copy

const ac = new AbortController();

// Use either the onabort property...
ac.signal.onabort = () => console.log('aborted!');

// Or the EventTarget API...
ac.signal.addEventListener('abort', (event) => {
  console.log(event.type);  // Prints 'abort'
}, { once: true });

ac.abort(); copy

const ac = new AbortController();
ac.abort(new Error('boom!'));
console.log(ac.signal.reason);  // Error: boom! copy

クラス: Blob#

<Blob> を参照してください。

クラス: Buffer#

• 型: <Function>

バイナリデータを扱うために使用されます。buffer のセクションを参照してください。

クラス: ByteLengthQueuingStrategy#

ByteLengthQueuingStrategy のブラウザ互換実装です。

__dirname#

この変数はグローバルに見えるかもしれませんが、そうではありません。__dirname を参照してください。

__filename#

この変数はグローバルに見えるかもしれませんが、そうではありません。__filename を参照してください。

atob(data)#

buffer.atob() のグローバルエイリアスです。

クラス: BroadcastChannel#

<BroadcastChannel> を参照してください。

btoa(data)#

buffer.btoa() のグローバルエイリアスです。

clearImmediate(immediateObject)#

clearImmediate は タイマーのセクションで説明されています。

clearInterval(intervalObject)#

clearInterval は タイマーのセクションで説明されています。

clearTimeout(timeoutObject)#

clearTimeout は タイマーのセクションで説明されています。

クラス: CloseEvent#

<CloseEvent> のブラウザ互換実装です。この API は --no-experimental-websocket CLI フラグで無効にできます。

クラス: CompressionStream#

CompressionStream のブラウザ互換実装です。

console#

• 型: <Object>

標準出力および標準エラー出力に表示するために使用されます。console のセクションを参照してください。

クラス: CountQueuingStrategy#

CountQueuingStrategy のブラウザ互換実装です。

クラス: Crypto#

<Crypto> のブラウザ互換実装です。このグローバルは、Node.js バイナリが node:crypto モジュールのサポートを含めてコンパイルされた場合にのみ利用可能です。

crypto#

Web Crypto API のブラウザ互換実装です。

クラス: CryptoKey#

<CryptoKey> のブラウザ互換実装です。このグローバルは、Node.js バイナリが node:crypto モジュールのサポートを含めてコンパイルされた場合にのみ利用可能です。

クラス: CustomEvent#

<CustomEvent> のブラウザ互換実装です。

クラス: DecompressionStream#

DecompressionStream のブラウザ互換実装です。

ErrorEvent#

<ErrorEvent> のブラウザ互換実装です。

クラス: Event#

Event クラスのブラウザ互換実装です。詳細は EventTarget と Event API を参照してください。

クラス: EventSource#

<EventSource> のブラウザ互換実装です。

クラス: EventTarget#

EventTarget クラスのブラウザ互換実装です。詳細は EventTarget と Event API を参照してください。

exports#

この変数はグローバルに見えるかもしれませんが、そうではありません。exports を参照してください。

fetch#

fetch() 関数のブラウザ互換実装です。

const res = await fetch('https://node.dokyumento.jp/api/documentation.json');
if (res.ok) {
  const data = await res.json();
  console.log(data);
} copy

この実装は、Node.js のためにゼロから書かれた HTTP/1.1 クライアントである undici に基づいています。Node.js プロセスにバンドルされている undici のバージョンは、process.versions.undici プロパティを読むことで確認できます。

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

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

クラス: File#

<File> を参照してください。

クラス: FormData#

<FormData> のブラウザ互換実装です。

global#

• 型: <Object> グローバル名前空間オブジェクトです。

ブラウザでは、伝統的にトップレベルスコープはグローバルスコープでした。これは、ECMAScript モジュール内を除き、var something が新しいグローバル変数を定義することを意味します。Node.js では、これは異なります。トップレベルスコープはグローバルスコープではありません。Node.js モジュール内の var something は、それがCommonJS モジュールであれECMAScript モジュールであれ、そのモジュールに対してローカルになります。

クラス: Headers#

<Headers> のブラウザ互換実装です。

localStorage#

localStorage のブラウザ互換実装です。データは --localstorage-file CLI フラグで指定されたファイルに暗号化されずに保存されます。保存できるデータの最大量は 10 MB です。Web Storage API 以外でのこのデータの変更はサポートされていません。この API を無効にするには --no-webstorage (またはそのエイリアス --no-experimental-webstorage) CLI フラグを使用します。サーバーのコンテキストで使用する場合、localStorage のデータはユーザーごとやリクエストごとに保存されるのではなく、すべてのユーザーとリクエストで共有されます。

クラス: MessageChannel#

MessageChannel クラスです。詳細は MessageChannel を参照してください。

クラス: MessageEvent#

<MessageEvent> のブラウザ互換実装です。

クラス: MessagePort#

MessagePort クラスです。詳細は MessagePort を参照してください。

module#

この変数はグローバルに見えるかもしれませんが、そうではありません。module を参照してください。

クラス: Navigator#

Navigator API の部分的な実装です。

navigator#

window.navigator の部分的な実装です。

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

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

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

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

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

// Request an exclusive lock
await navigator.locks.request('my_resource', async (lock) => {
  // The lock has been acquired.
  console.log(`Lock acquired: ${lock.name}`);
  // Lock is automatically released when the function returns
});

// Request a shared lock
await navigator.locks.request('shared_resource', { mode: 'shared' }, async (lock) => {
  // Multiple shared locks can be held simultaneously
  console.log(`Shared lock acquired: ${lock.name}`);
});// Request an exclusive lock
navigator.locks.request('my_resource', async (lock) => {
  // The lock has been acquired.
  console.log(`Lock acquired: ${lock.name}`);
  // Lock is automatically released when the function returns
}).then(() => {
  console.log('Lock released');
});

// Request a shared lock
navigator.locks.request('shared_resource', { mode: 'shared' }, async (lock) => {
  // Multiple shared locks can be held simultaneously
  console.log(`Shared lock acquired: ${lock.name}`);
}).then(() => {
  console.log('Shared lock released');
});copy

クラス: PerformanceEntry#

PerformanceEntry クラスです。詳細は PerformanceEntry を参照してください。

クラス: PerformanceMark#

PerformanceMark クラスです。詳細は PerformanceMark を参照してください。

クラス: PerformanceMeasure#

PerformanceMeasure クラスです。詳細は PerformanceMeasure を参照してください。

クラス: PerformanceObserver#

PerformanceObserver クラスです。詳細は PerformanceObserver を参照してください。

クラス: PerformanceObserverEntryList#

PerformanceObserverEntryList クラスです。詳細は PerformanceObserverEntryList を参照してください。

クラス: PerformanceResourceTiming#

PerformanceResourceTiming クラスです。詳細は PerformanceResourceTiming を参照してください。

performance#

perf_hooks.performance オブジェクトです。

process#

• 型: <Object>

process オブジェクトです。process オブジェクトのセクションを参照してください。

queueMicrotask(callback)#

• callback <Function> キューに追加される関数。

queueMicrotask() メソッドは、callback を呼び出すマイクロタスクをキューに追加します。callback が例外をスローした場合、process オブジェクトの 'uncaughtException' イベントが発行されます。

マイクロタスクキューは V8 によって管理され、Node.js によって管理される process.nextTick() キューと同様の方法で使用できます。Node.js イベントループの各ターンにおいて、process.nextTick() キューは常にマイクロタスクキューの前に処理されます。

// Here, `queueMicrotask()` is used to ensure the 'load' event is always
// emitted asynchronously, and therefore consistently. Using
// `process.nextTick()` here would result in the 'load' event always emitting
// before any other promise jobs.

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);
}; copy

クラス: ReadableByteStreamController#

ReadableByteStreamController のブラウザ互換実装です。

クラス: ReadableStream#

ReadableStream のブラウザ互換実装です。

クラス: ReadableStreamBYOBReader#

ReadableStreamBYOBReader のブラウザ互換実装です。

クラス: ReadableStreamBYOBRequest#

ReadableStreamBYOBRequest のブラウザ互換実装です。

クラス: ReadableStreamDefaultController#

ReadableStreamDefaultController のブラウザ互換実装です。

クラス: ReadableStreamDefaultReader#

ReadableStreamDefaultReader のブラウザ互換実装です。

require()#

この変数はグローバルに見えるかもしれませんが、そうではありません。require() を参照してください。

クラス: Response#

<Response> のブラウザ互換実装です。

クラス: Request#

<Request> のブラウザ互換実装です。

sessionStorage#

sessionStorage のブラウザ互換実装です。データはメモリに保存され、ストレージのクォータは 10 MB です。sessionStorage のデータは現在実行中のプロセス内でのみ持続し、ワーカー間では共有されません。

setImmediate(callback[, ...args])#

setImmediate は タイマーのセクションで説明されています。

setInterval(callback, delay[, ...args])#

setInterval は タイマーのセクションで説明されています。

setTimeout(callback, delay[, ...args])#

setTimeout は タイマーのセクションで説明されています。

クラス: Storage#

<Storage> のブラウザ互換実装です。この API を無効にするには --no-webstorage (またはそのエイリアス --no-experimental-webstorage) CLI フラグを使用します。

structuredClone(value[, options])#

WHATWG の structuredClone メソッドです。

クラス: SubtleCrypto#

<SubtleCrypto> のブラウザ互換実装です。このグローバルは、Node.js バイナリが node:crypto モジュールのサポートを含めてコンパイルされた場合にのみ利用可能です。

クラス: DOMException#

WHATWG の <DOMException> クラスです。

クラス: TextDecoder#

WHATWG の TextDecoder クラスです。TextDecoder のセクションを参照してください。

クラス: TextDecoderStream#

TextDecoderStream のブラウザ互換実装です。

クラス: TextEncoder#

WHATWG の TextEncoder クラスです。TextEncoder のセクションを参照してください。

クラス: TextEncoderStream#

TextEncoderStream のブラウザ互換実装です。

クラス: TransformStream#

TransformStream のブラウザ互換実装です。

クラス: TransformStreamDefaultController#

TransformStreamDefaultController のブラウザ互換実装です。

クラス: URL#

WHATWG の URL クラスです。URL のセクションを参照してください。

クラス: URLPattern#

WHATWG の URLPattern クラスです。URLPattern のセクションを参照してください。

クラス: URLSearchParams#

WHATWG の URLSearchParams クラスです。URLSearchParams のセクションを参照してください。

クラス: WebAssembly#

• 型: <Object>

すべての W3C WebAssembly 関連機能の名前空間として機能するオブジェクトです。使用法と互換性については、Mozilla Developer Network を参照してください。

クラス: WebSocket#

<WebSocket> のブラウザ互換実装です。この API は --no-experimental-websocket CLI フラグで無効にできます。

クラス: WritableStream#

WritableStream のブラウザ互換実装です。

クラス: WritableStreamDefaultController#

WritableStreamDefaultController のブラウザ互換実装です。

クラス: WritableStreamDefaultWriter#

WritableStreamDefaultWriter のブラウザ互換実装です。