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

QueuerOptions

接口:QueuerOptions<TValue>

定义于:queuer.ts:8

用于配置 Queuer 实例的选项。

这些选项控制队列行为、项目过期、回调等。

类型参数

TValue

属性

addItemsTo?

ts
optional addItemsTo: QueuePosition;
optional addItemsTo: QueuePosition;

定义于:queuer.ts:13

将项目添加到队列器的默认位置

默认值

ts
'back'
'back'

expirationDuration?

ts
optional expirationDuration: number;
optional expirationDuration: number;

定义于:queuer.ts:18

项目可以在队列中停留的最长时间(以毫秒为单位) 如果未提供,项目将永不过期


getIsExpired()?

ts
optional getIsExpired: (item, addedAt) => boolean;
optional getIsExpired: (item, addedAt) => boolean;

定义于:queuer.ts:23

用于确定项目是否已过期的函数 如果提供,则此函数将覆盖 expirationDuration 行为

参数

item

TValue

addedAt

number

返回

boolean


getItemsFrom?

ts
optional getItemsFrom: QueuePosition;
optional getItemsFrom: QueuePosition;

定义于:queuer.ts:28

处理期间从中获取项目的默认位置

默认值

ts
'front'
'front'

getPriority()?

ts
optional getPriority: (item) => number;
optional getPriority: (item) => number;

定义于:queuer.ts:33

用于确定队列器中项目优先级的函数 优先级较高的项目将首先处理

参数

item

TValue

返回

number


initialItems?

ts
optional initialItems: TValue[];
optional initialItems: TValue[];

定义于:queuer.ts:37

用于填充队列器的初始项目


maxSize?

ts
optional maxSize: number;
optional maxSize: number;

定义于:queuer.ts:41

队列器中允许的最大项目数


onExecute()?

ts
optional onExecute: (item, queuer) => void;
optional onExecute: (item, queuer) => void;

定义于:queuer.ts:49

每当从队列器中删除项目时触发的回调

参数

item

TValue

queuer

Queuer<TValue>

返回

void


onExpire()?

ts
optional onExpire: (item, queuer) => void;
optional onExpire: (item, queuer) => void;

定义于:queuer.ts:45

每当队列器中的项目过期时触发的回调

参数

item

TValue

queuer

Queuer<TValue>

返回

void


onIsRunningChange()?

ts
optional onIsRunningChange: (queuer) => void;
optional onIsRunningChange: (queuer) => void;

定义于:queuer.ts:53

每当队列器的运行状态更改时触发的回调

参数

queuer

Queuer<TValue>

返回

void


onItemsChange()?

ts
optional onItemsChange: (queuer) => void;
optional onItemsChange: (queuer) => void;

定义于:queuer.ts:57

每当从队列器中添加或删除项目时触发的回调

参数

queuer

Queuer<TValue>

返回

void


onReject()?

ts
optional onReject: (item, queuer) => void;
optional onReject: (item, queuer) => void;

定义于:queuer.ts:61

每当项目被拒绝添加到队列器时触发的回调

参数

item

TValue

queuer

Queuer<TValue>

返回

void


started?

ts
optional started: boolean;
optional started: boolean;

定义于:queuer.ts:65

队列器是否应立即开始处理任务


wait?

ts
optional wait: number | (queuer) => number;
optional wait: number | (queuer) => number;

定义于:queuer.ts:71

处理项目之间的等待时间(以毫秒为单位)。 可以是数字或返回数字的函数。

默认值

ts
0
0