删除节点

提示

删除节点是一个数据写操作，需要在write方法中执行。

删除节点

deleteNode方法用来删除树的节点以及其后代节点。

async deleteNode(
    nodeId: NodeId | TreeNode,
    options?: {
        recycle?: boolean
        includeRecyclebin?: boolean
    }
): Promise<void>

• 参数

参数	类型	默认	描述
nodeId	NodeId | TreeNode	无	节点id或节点对象
options.recycle	boolean	false	逻辑删除：子树移入回收站而非物理删除
options.includeRecyclebin	boolean	false	false（默认）：回收站内的节点视为不存在，删除时抛NotFound；true：进入回收站视角，可删除站内节点（物理删除）。管理回收站内容时需要设为true（见下文详解）

物理删除（默认）

默认删除节点及其全部后代节点，并回缩右侧节点的左右值：

await tree.write(async () => {
    // A 及其全部后代从表中删除
    await tree.deleteNode(aId);
});

逻辑删除（回收站）

启用回收站后，recycle: true 将目标子树移入回收站而非物理删除——结构保持、数据保留，但从逻辑树上消失：

await tree.write(async () => {
    // A 及其全部后代（保持结构）移入回收站
    await tree.deleteNode(aId, { recycle: true });
});

// 此后默认视角下 A 逻辑不存在：
await tree.findNode({ name: "A" });   // null
await tree.getNode(aId);              // 抛 NotFound

注意：

• recycle: true仅在启用回收站后生效；未启用时等同物理删除。
• 回收的是整个子树：后代连同层级结构一并进站。
• 删除回收站节点自身等效于清空回收站（clearRecycleBin()），保留 bin 节点、删除其全部子孙。

完整的回收站特性（启用配置、恢复节点、清空、事件语义）见回收站。

includeRecyclebin：删除站内节点

节点被逻辑删除（已进入回收站）后，它在逻辑上已经不存在——默认调用deleteNode会抛出节点不存在（FlexTreeNodeNotFoundError）：

await tree.write(async () => {
    await tree.deleteNode(aId, { recycle: true });   // A 移入回收站
});

await tree.write(async () => {
    await tree.deleteNode(aId);                      // 抛 NotFound —— A 逻辑上已删除
});

传入includeRecyclebin: true可跳过该判定，进入回收站视角对站内节点执行删除——此时是物理删除（recycle 参数无效，已在站内的节点再"删除"即彻底移除）：

await tree.write(async () => {
    // 从回收站中彻底删除 A 及其全部后代
    await tree.deleteNode(aId, { includeRecyclebin: true });
});

• 适合"清空回收站中的部分内容"场景（全部清空用clearRecycleBin()）
• 站外节点不受影响：includeRecyclebin: true对未回收节点照常生效，可与recycle: true组合
• 一般而言，管理回收站内容（列出、恢复、彻底删除站内节点）都需要includeRecyclebin: true——默认视角下站内节点不可见，不进入回收站视角就找不到操作目标

清空树

clear方法用来清空树的所有节点。

async clear(): Promise<void>