メインコンテンツへ移動

Mastra.removeWorkspace()

.removeWorkspace() メソッドは、Mastra のランタイムレジストリから Workspace を削除します。削除前に Workspace を破棄するには、{ destroy: true } を渡します。

使用例
使用例への直接リンク

await mastra.removeWorkspace('workspace-123', { destroy: true })

パラメーター
パラメーターへの直接リンク

id:

string
削除する Workspace の ID。

options?:

{ destroy?: boolean }
任意のクリーンアップ動作。Workspace を削除する前に workspace.destroy() を呼び出すには、destroytrue に設定します。

戻り値
戻り値への直接リンク

removed:

Promise<boolean>
Workspace が削除された場合は true。指定した ID の Workspace が存在しない場合は false

destroytrueworkspace.destroy() が例外をスローした場合、呼び出しはそのエラーで拒否されます。呼び出し元がクリーンアップを再試行できるよう、Workspace は登録されたままになります。