跳至主要內容

Mastra.removeWorkspace()

.removeWorkspace() 方法從 Mastra 執行階段 registry 中移除 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 仍保持註冊狀態,以便呼叫方重試清理。