跳到主要内容

useGraphNeighbors()

function useGraphNeighbors<T>(EntityType, options): RxDBResource<GraphQueryResult<NeighborResult<T, EdgeInfo>>>;

Defined in: rxdb-vue/src/hooks.ts:397

查找图结构中的邻居实体

Type Parameters​

Type Parameter
T extends GraphEntityType

Parameters​

ParameterTypeDescription
EntityTypeT实体类
optionsUseOptions<EntityStaticType<T, "findNeighborsOptions">>图查询选项(entityId、direction、level 等)

Returns​

RxDBResource<GraphQueryResult<NeighborResult<T, EdgeInfo>>>

包含邻居实体的响应式资源对象

Example​

// 整体持有:resource 是 reactive 对象,解构会拿到一次性快照(见 RxDBResource)
const friends = useGraphNeighbors(User, {
entityId: 'user-1',
direction: 'out',
level: 1
});
// 模板里用 friends.value / friends.isLoading