Skip to main content
Version: 2.x

API Reference > @next-core/brick-types > ProviderPollOptions

ProviderPollOptions interface

使用 Provider 进行轮询时的选项配置。

Signature:

export interface ProviderPollOptions

Properties

PropertyTypeDescription
continueOnErrorboolean当轮询出现错误时,是否继续轮询。
delegateLoadingBarboolean是否代理系统加载条的显示与隐藏。应配合 expectPollEnd 使用。
enabledboolean是否启用轮询。
expectPollEnd(result: unknown) => boolean提供一个方法以校验轮询是否应该结束。 该方法接收一个参数:当前轮询的执行结果。 轮询结束时将触发 callback.success 事件。
expectPollStopImmediately() => boolean提供一个方法以校验轮询是否应该立即停止,还在等待或进行中的轮询将失效, 不会触发 progress|success|error|finally 等事件。
intervalnumber每次轮询间隔时间(毫秒),默认为 3000
leadingRequestDelaynumber第一次轮询延迟时间(毫秒),默认为 0