在此页面
- Interface: QueuerOptions<TValue>
- 类型参数
- 属性
- addItemsTo?
- 默认
- expirationDuration?
- getIsExpired()?
- 参数
- item
- addedAt
- Returns (返回)
- getItemsFrom?
- 默认
- getPriority()?
- 参数
- item
- Returns (返回)
- initialItems?
- initialState?
- key?
- maxSize?
- onExecute()?
- 参数
- item
- queuer
- Returns (返回)
- onExpire()?
- 参数
- item
- queuer
- Returns (返回)
- onItemsChange()?
- 参数
- queuer
- Returns (返回)
- onReject()?
- 参数
- item
- queuer
- Returns (返回)
- started?
- wait?
- 默认
排队器选项
Interface: QueuerOptions<TValue>
定义于: queuer.ts:83
用于配置 Queuer 实例的选项。
这些选项控制队列行为、项目过期、回调等。
类型参数
• TValue
属性
addItemsTo?
optional addItemsTo: QueuePosition;
optional addItemsTo: QueuePosition;
定义于: queuer.ts:88
向队列添加项目的默认位置
默认
'back'
'back'
expirationDuration?
optional expirationDuration: number;
optional expirationDuration: number;
定义于: queuer.ts:93
项目在队列中停留的最大毫秒数。如果未提供，项目将永远不会过期。
getIsExpired()?
optional getIsExpired: (item, addedAt) => boolean;
optional getIsExpired: (item, addedAt) => boolean;
定义于: queuer.ts:98
确定项目是否已过期的函数。如果提供，这将覆盖 expirationDuration 的行为。
参数
item
TValue
addedAt
number
Returns (返回)
boolean
getItemsFrom?
optional getItemsFrom: QueuePosition;
optional getItemsFrom: QueuePosition;
定义于: queuer.ts:103
处理期间从队列中获取项目的默认位置
默认
'front'
'front'
getPriority()?
optional getPriority: (item) => number;
optional getPriority: (item) => number;
定义于: queuer.ts:108
确定队列中项目优先级的函数。优先级较高的项目将首先被处理。
参数
item
TValue
Returns (返回)
number
initialItems?
optional initialItems: TValue[];
optional initialItems: TValue[];
定义于: queuer.ts:112
用于填充队列的初始项目
initialState?
optional initialState: Partial<QueuerState<TValue>>;
optional initialState: Partial<QueuerState<TValue>>;
定义于: queuer.ts:116
队列的初始状态
key?
optional key: string;
optional key: string;
定义于: queuer.ts:121
可选键，用于标识此队列实例。如果提供，队列将在开发工具和 PacerProvider（如果适用）中通过此键进行标识。
maxSize?
optional maxSize: number;
optional maxSize: number;
定义于: queuer.ts:125
允许在队列中的最大项目数
onExecute()?
optional onExecute: (item, queuer) => void;
optional onExecute: (item, queuer) => void;
定义于: queuer.ts:129
从队列中移除项目时触发的回调
参数
item
TValue
queuer
Queuer<TValue>
Returns (返回)
void
onExpire()?
optional onExpire: (item, queuer) => void;
optional onExpire: (item, queuer) => void;
定义于: queuer.ts:133
项目在队列中过期时触发的回调
参数
item
TValue
queuer
Queuer<TValue>
Returns (返回)
void
onItemsChange()?
optional onItemsChange: (queuer) => void;
optional onItemsChange: (queuer) => void;
定义于: queuer.ts:137
向队列添加或从中移除项目时触发的回调
参数
queuer
Queuer<TValue>
Returns (返回)
void
onReject()?
optional onReject: (item, queuer) => void;
optional onReject: (item, queuer) => void;
定义于: queuer.ts:141
项目被拒绝添加到队列时触发的回调
参数
item
TValue
queuer
Queuer<TValue>
Returns (返回)
void
started?
optional started: boolean;
optional started: boolean;
定义于: queuer.ts:145
队列是否应立即开始处理任务
wait?
optional wait: number | (queuer) => number;
optional wait: number | (queuer) => number;
定义于: queuer.ts:151
处理项目之间等待的毫秒数。可以是数字或返回数字的函数。
默认
0
0
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。