什么是 @bentley/context-registry-client?
@bentley/context-registry-client 是一个基于 Node.js 的 npm 包,用于与 Bentley 的 iModel.js 产品交互,提供了一系列的 API,可以读取和处理 iModel.js 中的信息,例如模型元数据,版本历史和文件路径等。
如何使用 @bentley/context-registry-client?
安装
在使用 @bentley/context-registry-client 之前,需要先安装 Node.js 和 npm。然后,可以在命令行中使用如下命令进行安装:
npm install @bentley/context-registry-client
例子
下面是一个简单的例子,用于演示如何使用 @bentley/context-registry-client 读取 iModel.js 中的信息:
-- -------------------- ---- ------- ----- - ---------------------- ----------- - - -------------------------------------------- ----- -------- ------ - ----- ---------- - -------------- ----- --------- - ------------- ----- ----- - --- --------------------------------- ----- -------------- - --- ------------------------ ----- ------ - ----- -------------------------------- ---------- ------- ---------------------- -------- - -------
这个例子中,我们首先引入了 @bentley/context-registry-client 包中的 ContextRegistryClient和IModelQuery两个类,然后使用这两个类来查询 iModel.js 中的信息。通过传递项目 ID 和 iModel 名称,我们可以得到一个包含 iModel 元数据的对象,最后将其打印出来。
API
下面是一些常用的 API,供参考:
ContextRegistryClient
getAuthorizedContext
获取授权的 context。
async getAuthorizedContext(actx: AuthorizedFrontendRequestContext): Promise<SpatialContext>;
参数:
- actx —— 类型: AuthorizedFrontendRequestContext,用于表示一个授权的请求上下文。
返回值:
- 类型: Promise<spatialcontext>,表示获取到的授权 context 对象。
iModels
获取 iModel 类型的操作对象。
get iModels(): IModelHubClient;
参数:
- 无。
返回值:
- 类型: IModelHubClient,表示获取到的 iModel 操作对象。
IModelQuery
构建 iModel 查询的类。
class IModelQuery { byName(imodelName: string): IModelQuery; byNamePrefix(prefix: string): IModelQuery; byId(id: GuidString): IModelQuery; top(n: number): IModelQuery; skip(n: number): IModelQuery; }
返回值:
- 类型: IModelQuery,表示构建出的 iModel 查询对象。
总结
在本文中,我们介绍了 npm 包 @bentley/context-registry-client 的用法,并提供了一个简单的例子。希望本文对于从事前端开发的读者有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedb05db5cbfe1ea06110cf