Node.js v21.7.2 ドキュメント

クラス: 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

abortController.abort([reason])#

• reason <any> オプションの理由。AbortSignal の reason プロパティで取得できます。

abort シグナルをトリガーし、abortController.signal が 'abort' イベントを発行します。

abortController.signal#

• 型: <AbortSignal>

クラス: AbortSignal#

• 拡張: <EventTarget>

AbortSignal は、abortController.abort() メソッドが呼び出されたときにオブザーバーに通知するために使用されます。

静的メソッド: AbortSignal.abort([reason])#

• reason: <any>
• 戻り値: <AbortSignal>

既に中止されている新しい AbortSignal を返します。

静的メソッド: AbortSignal.timeout(delay)#

• delay <number> AbortSignal をトリガーするまで待機するミリ秒数。

delay ミリ秒後に中止される新しい AbortSignal を返します。

静的メソッド: AbortSignal.any(signals)#

• signals <AbortSignal[]> 新しい AbortSignal を構成する AbortSignal。

提供されたシグナルのいずれかが中止された場合に中止される新しい AbortSignal を返します。その abortSignal.reason は、中止された原因となった signals のいずれかに設定されます。

イベント: 'abort'#

'abort' イベントは、abortController.abort() メソッドが呼び出されたときに発行されます。コールバックは、type プロパティが 'abort' に設定された単一のオブジェクト引数で呼び出されます。

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

AbortSignal が関連付けられている AbortController は、'abort' イベントを 1 回だけトリガーします。コードは、'abort' イベントリスナーを追加する前に、abortSignal.aborted 属性が false であることを確認することをお勧めします。

AbortSignal にアタッチされたすべてのイベントリスナーは、イベントリスナーが 'abort' イベントが処理されるとすぐに削除されるように、{ once: true } オプションを使用する必要があります（または、リスナーをアタッチするために EventEmitter API を使用する場合は、once() メソッドを使用します）。これに失敗すると、メモリリークが発生する可能性があります。

abortSignal.aborted#

• 型: <boolean> AbortController が中止された後は true。

abortSignal.onabort#

• 型: <Function>

abortController.abort() 関数が呼び出されたときに通知されるように、ユーザーコードによって設定できるオプションのコールバック関数。

abortSignal.reason#

• 型: <any>

AbortSignal がトリガーされたときに指定されたオプションの理由。

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

abortSignal.throwIfAborted()#

abortSignal.aborted が true の場合、abortSignal.reason をスローします。

クラス: 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 は、タイマーのセクションで説明されています。

クラス: 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 Web API のブラウザ互換実装です。

クラス: DecompressionStream#

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

Event#

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

EventTarget#

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

exports#

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

fetch#

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

クラス: File#

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

クラス FormData#

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

global#

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

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

クラス Headers#

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

MessageChannel#

MessageChannel クラス。詳細については、MessageChannel を参照してください。

MessageEvent#

MessageEvent クラス。詳細については、MessageEvent を参照してください。

MessagePort#

MessagePort クラス。詳細については、MessagePort を参照してください。

module#

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

Navigator#

Navigator API の部分的な実装。

navigator#

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

navigator.hardwareConcurrency#

• <number>

navigator.hardwareConcurrency 読み取り専用プロパティは、現在の Node.js インスタンスで利用可能な論理プロセッサの数を返します。

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

navigator.language#

• <string>

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

navigator.languages#

• {Array}

navigator.languages 読み取り専用プロパティは、Node.js インスタンスの優先言語を表す文字列の配列を返します。デフォルトでは、navigator.languages には navigator.language の値のみが含まれており、これはオペレーティングシステムのデフォルト言語に基づいて、実行時に Node.js によって使用される ICU ライブラリによって決定されます。

ICU を含まないビルドでのフォールバック値は ['en-US'] です。

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

navigator.platform#

• <string>

navigator.platform 読み取り専用プロパティは、Node.js インスタンスが実行されているプラットフォームを識別する文字列を返します。

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

navigator.userAgent#

• <string>

navigator.userAgent 読み取り専用プロパティは、ランタイム名とメジャーバージョン番号で構成されるユーザーエージェントを返します。

console.log(`The user-agent is ${navigator.userAgent}`); // Prints "Node.js/21" 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 オブジェクト セクションを参照してください。

queueMicrotask(callback)#

• callback <Function> キューに入れる関数。

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

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

// 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> のブラウザ互換実装です。

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

setImmediate は timers セクションで説明されています。

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

setInterval は timers セクションで説明されています。

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

setTimeout は timers セクションで説明されています。

structuredClone(value[, options])#

WHATWG の structuredClone メソッドです。

SubtleCrypto#

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

DOMException#

WHATWG の DOMException クラスです。詳細については、DOMException を参照してください。

TextDecoder#

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

クラス: TextDecoderStream#

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

TextEncoder#

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

クラス: TextEncoderStream#

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

クラス: TransformStream#

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

クラス: TransformStreamDefaultController#

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

URL#

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

URLSearchParams#

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

WebAssembly#

• <Object>

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

WebSocket#

WebSocket のブラウザ互換実装です。このAPIを有効にするには、--experimental-websocket CLI フラグを使用してください。

クラス: WritableStream#

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

クラス: WritableStreamDefaultController#

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

クラス: WritableStreamDefaultWriter#

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