JavaScript 的 Azure Core LRO 客户端库
这是Azure SDK JavaScript 客户端库中长期运行的操作的默认执行,它同时在浏览器和NodeJS中工作. 此库主要用于该库生成的代码 类型Spec @azure-tools/typespec-ts 发射器.
@azure/core-lro 如下 Azure SDK 长期运行操作设计准则
密钥链接 :
开始
目前得到支持的环境
- 节点.js的LTS版本
- Safari,Chrome,Edge,和Firefox的最新版本.
安装
这个软件包主要用于生成的代码中,而无意被终端用户直接消耗.
关键概念
PollerLike
传票人是指可以在服务器上对其状态进行长期运行的操作进行投票直至达到终端状态的对象. 它也延伸 Promise<TResult>这样你就可以 await 它直接得到最终结果。 它规定如下:
operationState: 返回当前操作状态的属性, 键入为扩展类型OperationState这是undefined如果尚未提交传票人.result: 完成操作后返回操作结果的财产undefined否则isDone: 返回操作是否处于终端状态的属性onProgress:每次收到投票答复时,登记召回功能poll: 发出单一投票请求pollUntilDone: 返回将随操作结果而解决的承诺serialize: 返回一个承诺, 解决一个连环化的 代表投票者状态submitted: 返回一个承诺, 当授粉者成功提交后解决
OperationState
操作状态的类型 。 它包含一个 status 字段,可能有以下值: notStarted, (中文(简体) ), running, (中文(简体) ), succeeded, (中文(简体) ), failed,以及 canceled。可通过以下方式访问:
switch (poller.operationState?.status) {
case "succeeded": // return poller.result;
case "failed": // throw poller.operationState?.error;
case "canceled": // throw new Error("Operation was canceled");
case "running": // ...
case "notStarted": // ...
}
createHttpPoller
返回类型对象的函数 PollerLike。这个授粉者在出现错误时表现如下:
- 呼吁
poll财务报告和审定财务报表pollUntilDone如果操作失败或取消, 除非resolveOnUnsuccessful选项被设定为对. poller.operationState?.status将设定为"failed"或者说"canceled"当操作失败或返回错误响应时.
实例
实例可见于 samples 文件夹.
解决问题
日志
日志可以由执行"长跑行动传票人"的图书馆酌情添加. 内包装 祖尔·斯德克·换杰斯 使用情况 @ azure/ logger (缩写)。 。 。 .
今后的步骤
请看一下 样本 关于如何使用此库的详细示例的目录.
捐款
如果您想为图书馆捐钱 请读一下 贡献指南 学习如何构建和测试密码.
测试
为了进行我们的测试,首先安装依赖关系(与 pnpm install, (中文(简体) ),
然后用: pnpm run test:node。 。 。 .
行为守则
该项目通过了 Microsoft 开源行为守则。 。 。 . 更多信息见 《行为守则》 或者说 联系人 打开码@ microsoft.com 并附上任何其他问题或评论.