Symbol.dispose

値

ウェルノウンシンボル Symbol.dispose です。

解説

処分可能な（disposable）オブジェクトとは、 [Symbol.dispose]() メソッドを備えたオブジェクトです。このメソッドは、以下のようなセマンティクスを持つことが期待されます:

• このメソッドを呼び出すことで、呼び出し元がこのオブジェクトの使用を継続する意図がないことを、処分可能なオブジェクトに伝えます。このメソッドは、ファイルシステムハンドル、ストリーム、ホストオブジェクトなど、リソースを明示的にクリーンアップするために必要なロジックを実行する必要があります。
• このメソッドが例外をスローした場合、通常はリソースを解放できなかったことを意味します。
• 同じオブジェクトにおいて2回以上呼び出された場合でも、メソッドは例外をスローするべきではありません。ただし、この要件は強制ではありません。

このメソッドはプロミスを返すべきではありません。なぜなら、[Symbol.dispose]() が返すプロミスは await using によって待機されないからです。非同期の処分可能オブジェクトを宣言するには、Symbol.asyncDispose を使用してください。

例

ユーザー定義の処分可能オブジェクト

[Symbol.dispose] により、カスタムの処分可能オブジェクトを作成できます。詳細については、using を参照してください。

class Disposable {
  constructor() {
    this.disposed = false;
  }
  [Symbol.dispose]() {
    this.disposed = true;
  }
  get isDisposed() {
    return this.disposed;
  }
}
const resource = new Disposable();
{
  using resourceUsed = resource;
  console.log(resource.isDisposed); // false
}
console.log(resource.isDisposed); // true

仕様書

ブラウザーの互換性

関連情報

• Polyfill of Symbol.dispose in core-js
• JavaScript resource management
• Symbol.asyncDispose
• using
• DisposableStack.prototype[Symbol.dispose]()
• Iterator.prototype[Symbol.dispose]()