跳至主要內容

Mastra.removeWorkspace()

.removeWorkspace() 方法會從 Mastra 執行階段登錄中移除 Workspace。傳入 { destroy: true },即可在移除 Workspace 前將其銷毀。

使用範例
使用範例 的直接連結

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

參數
參數 的直接連結

id:

string
要移除的 Workspace ID。

options?:

{ destroy?: boolean }
可選的清理行為。將 destroy 設為 true,即可在移除 Workspace 前呼叫 workspace.destroy()

傳回值
傳回值 的直接連結

removed:

Promise<boolean>
移除 Workspace 時為 true。指定 ID 沒有對應 Workspace 時則為 false

destroytrueworkspace.destroy() 擲回錯誤時,呼叫會因該錯誤而被拒絕,而 Workspace 仍會保留在登錄中,讓呼叫者可再次嘗試清理。