异步节流器选项
接口：AsyncThrottlerOptions<TFn>
配置异步节流函数的选项
类型参数
• TFn extends AnyAsyncFunction
属性
enabled?
ts
optional enabled: boolean | (throttler) => boolean;
optional enabled: boolean | (throttler) => boolean;
节流器是否启用。禁用时，maybeExecute 不会触发任何执行。可以是布尔值或返回布尔值的函数。默认为 true。
initialState?
ts
optional initialState: Partial<AsyncThrottlerState<TFn>>;
optional initialState: Partial<AsyncThrottlerState<TFn>>;
异步节流器的初始状态
key?
ts
optional key: string;
optional key: string;
用于标识此异步节流器实例的可选键。如果提供，异步节流器将在开发者工具和 PacerProvider（如果适用）中由此键标识。
leading?
ts
optional leading: boolean;
optional leading: boolean;
调用时是否立即执行函数。默认为 true。
onError()?
ts
optional onError: (error, args, asyncThrottler) => void;
optional onError: (error, args, asyncThrottler) => void;
节流函数抛出错误时可选的错误处理程序。如果提供，处理程序将使用错误和节流器实例进行调用。这可以与 throwOnError 一起使用 - 处理程序将在任何错误抛出之前被调用。
参数
error
unknown
args
Parameters<TFn>
asyncThrottler
AsyncThrottler<TFn>
Returns (返回)
void
onSettled()?
ts
optional onSettled: (args, asyncThrottler) => void;
optional onSettled: (args, asyncThrottler) => void;
当节流函数被执行时可选调用的函数。
参数
args
Parameters<TFn>
asyncThrottler
AsyncThrottler<TFn>
Returns (返回)
void
onSuccess()?
ts
optional onSuccess: (result, args, asyncThrottler) => void;
optional onSuccess: (result, args, asyncThrottler) => void;
当节流函数被执行时可选调用的函数。
参数
result
ReturnType<TFn>
args
Parameters<TFn>
asyncThrottler
AsyncThrottler<TFn>
Returns (返回)
void
throwOnError?
ts
optional throwOnError: boolean;
optional throwOnError: boolean;
发生错误时是否抛出。如果未提供 onError 处理程序，则默认为 true；如果提供了 onError 处理程序，则默认为 false。可以显式设置以覆盖这些默认值。
trailing?
ts
optional trailing: boolean;
optional trailing: boolean;
在等待期结束时执行函数。默认为 true。
wait
ts
wait: number | (throttler) => number;
wait: number | (throttler) => number;
函数只能执行一次的时间窗口（毫秒）。可以是数字或返回数字的函数。默认为 0ms。
我们的合作伙伴
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。