@aalis/api-user-relation
v0.2.0
Published
关系图契约:user-relation 服务描述符与消费方用到的查询接口(默认提供者 @aalis/plugin-user-relation)
Readme
@aalis/api-user-relation
关系图契约:user-relation 服务描述符与消费方用到的查询接口 UserRelationService。不含服务实现,默认提供者是 @aalis/plugin-user-relation。
角色
userRelation:服务描述符(服务名user-relation)。消费方以optional(userRelation)声明,缺席时自行降级。UserRelationService:只含消费方实际用到的查询面,目前是getCommunityPeers(personId, limit?)(同社群成员,按 PageRank 降序)。关系图的完整实现类RelationService仍由@aalis/plugin-user-relation导出。
安装
pnpm add @aalis/api-user-relation使用
import { userRelation } from '@aalis/api-user-relation';
import { definePlugin, optional } from '@aalis/core';
export default definePlugin({
name: '@acme/plugin-example-relation',
uses: { userRelation: optional(userRelation) },
apply({ userRelation }) {
// 服务缺席时 present 为 false
if (!userRelation.present) return;
void userRelation.use.getCommunityPeers('<platform>:<userId>', 5);
},
});许可
见仓库根目录 LICENSE。
