框架
版本
Debouncer API 参考
Throttler API 参考
速率限制器 API 参考
队列 API 参考
批处理器 API 参考
批处理器示例

AsyncThrottlerOptions

接口:AsyncThrottlerOptions<TFn>

定义于:async-throttler.ts:7

用于配置异步节流函数的选项

类型参数

TFn extends AnyAsyncFunction

属性

enabled?

ts
optional enabled: boolean | (throttler) => boolean;
optional enabled: boolean | (throttler) => boolean;

定义于:async-throttler.ts:13

节流器是否启用。禁用时,maybeExecute 不会触发任何执行。 可以是布尔值或返回布尔值的函数。 默认为 true。


leading?

ts
optional leading: boolean;
optional leading: boolean;

定义于:async-throttler.ts:18

是否在调用时立即执行函数 默认为 true


onError()?

ts
optional onError: (error, asyncThrottler) => void;
optional onError: (error, asyncThrottler) => void;

定义于:async-throttler.ts:24

可选的错误处理程序,用于处理节流函数抛出错误时的情况。 如果提供,处理程序将使用错误和节流器实例进行调用。 这可以与 throwOnError 一起使用——处理程序将在抛出任何错误之前被调用。

参数

error

unknown

asyncThrottler

AsyncThrottler<TFn>

返回

void


onSettled()?

ts
optional onSettled: (asyncThrottler) => void;
optional onSettled: (asyncThrottler) => void;

定义于:async-throttler.ts:28

可选的函数,在执行节流函数时调用

参数

asyncThrottler

AsyncThrottler<TFn>

返回

void


onSuccess()?

ts
optional onSuccess: (result, asyncThrottler) => void;
optional onSuccess: (result, asyncThrottler) => void;

定义于:async-throttler.ts:32

可选的函数,在执行节流函数时调用

参数

result

ReturnType<TFn>

asyncThrottler

AsyncThrottler<TFn>

返回

void


throwOnError?

ts
optional throwOnError: boolean;
optional throwOnError: boolean;

定义于:async-throttler.ts:41

发生错误时是否抛出错误。 如果未提供 onError 处理程序,则默认为 true;如果提供了 onError 处理程序,则默认为 false。 可以显式设置以覆盖这些默认值。


trailing?

ts
optional trailing: boolean;
optional trailing: boolean;

定义于:async-throttler.ts:46

是否在等待期的后沿执行函数 默认为 true


wait

ts
wait: number | (throttler) => number;
wait: number | (throttler) => number;

定义于:async-throttler.ts:52

函数只能执行一次的时间窗口(以毫秒为单位)。 可以是数字或返回数字的函数。 默认为 0 毫秒