跳到主要内容

findDescendants

findDescendants 用于树结构实体的后代查询。它返回的是响应式 Observable。

适用对象​

  • 继承 TreeAdjacencyListEntityBase 的实体
  • 通常配合 @TreeEntity() 使用

树关系图​

签名​

findDescendants(options: FindTreeOptions<T>): Observable<InstanceType<T>[]>
interface FindTreeOptions<T> {
  entityId?: EntityStaticType<T, 'idType'> | null;
  where?: RuleGroup<InstanceType<T>>;
  level?: number;
}

level 语义​

  • level 默认 0
  • level < 0 会被规范化为 0
  • level > 100 会被限制为 100
  • 层级数包含当前节点本身

这意味着：

  • entityId 已知且 level: 0 时，只返回当前节点
  • entityId 已知且 level: 1 时，返回当前节点和直接子节点
  • entityId 未传且 level: 0 时，返回根节点集合

返回语义​

  • 传 entityId：返回“当前节点 + 后代节点”
  • 不传 entityId：以所有根节点为起点执行查询

基础用法​

import { firstValueFrom } from 'rxjs';

const descendants = await firstValueFrom(
  Menu.findDescendants({
    entityId: root.id,
    level: 2
  })
);

过滤后代​

const visibleDescendants = await firstValueFrom(
  Menu.findDescendants({
    entityId: root.id,
    level: 3,
    where: {
      combinator: 'and',
      rules: [{ field: 'enabled', operator: '=', value: true }]
    }
  })
);

什么时候用它​

  • 渲染树形菜单
  • 加载某个目录下的全部子节点
  • 对某个子树做批量过滤

参考​