框架
版本
防抖器 API 参考
节流器 API 参考
速率限制器 API 参考
队列 API 参考
批处理器 API 参考

异步防抖器选项

接口:AsyncDebouncerOptions<TFn>

定义于:async-debouncer.ts:69

用于配置异步防抖函数的选项

类型参数

TFn extends AnyAsyncFunction

属性

enabled?

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

定义于:async-debouncer.ts:75

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


initialState?

ts
optional initialState: Partial<AsyncDebouncerState<TFn>>;
optional initialState: Partial<AsyncDebouncerState<TFn>>;

定义于:async-debouncer.ts:79

异步防抖器的初始状态


key?

ts
optional key: string;
optional key: string;

定义于:async-debouncer.ts:84

用于标识此异步防抖器实例的可选键。如果提供,则在 devtools 和 PacerProvider(如果适用)中将使用此键标识异步防抖器。


leading?

ts
optional leading: boolean;
optional leading: boolean;

定义于:async-debouncer.ts:89

是否在超时前的领先边缘执行。默认为 false。


onError()?

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

定义于:async-debouncer.ts:95

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

参数

error

unknown

args

Parameters<TFn>

debouncer

AsyncDebouncer<TFn>

Returns (返回)

void


onSettled()?

ts
optional onSettled: (args, debouncer) => void;
optional onSettled: (args, debouncer) => void;

定义于:async-debouncer.ts:103

当防抖函数执行时要调用的可选回调

参数

args

Parameters<TFn>

debouncer

AsyncDebouncer<TFn>

Returns (返回)

void


onSuccess()?

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

定义于:async-debouncer.ts:107

当防抖函数执行时要调用的可选回调

参数

结果

ReturnType<TFn>

args

Parameters<TFn>

debouncer

AsyncDebouncer<TFn>

Returns (返回)

void


throwOnError?

ts
optional throwOnError: boolean;
optional throwOnError: boolean;

定义于:async-debouncer.ts:117

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


trailing?

ts
optional trailing: boolean;
optional trailing: boolean;

定义于:async-debouncer.ts:122

是否在超时后沿执行。默认为 true。


wait

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

定义于:async-debouncer.ts:128

等待执行的延迟(以毫秒为单位)。可以是数字或返回数字的函数。默认为 0 毫秒。

我们的合作伙伴
Code Rabbit
Unkey
订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。

订阅 Bytes

您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。

Bytes

无垃圾邮件。您可以随时取消订阅。