AsyncQueuerOptions

接��：AsyncQueuerOptions<TValue>

类型参数

• TValue

属性

addItemsTo?

optional addItemsTo: QueuePosition;

optional addItemsTo: QueuePosition;

定义于：async-queuer.ts:10

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

默认值

'back'

'back'

concurrency?

optional concurrency: number | (queuer) => number;

optional concurrency: number | (queuer) => number;

定义于：async-queuer.ts:16

要处理的最大并发任务数。可以是数字或返回数字的函数。

默认值

expirationDuration?

optional expirationDuration: number;

optional expirationDuration: number;

定义于：async-queuer.ts:21

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

getIsExpired()?

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

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

定义于：async-queuer.ts:26

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

参数

item

TValue

addedAt

number

boolean

getItemsFrom?

optional getItemsFrom: QueuePosition;

optional getItemsFrom: QueuePosition;

定义于：async-queuer.ts:31

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

默认值

'front'

'front'

getPriority()?

optional getPriority: (item) => number;

optional getPriority: (item) => number;

定义于：async-queuer.ts:37

用于确定队列器中项目优先级的函数优先级较高的项目将首先处理如果未提供，将使用附加到任务的静态优先级值

参数

item

TValue

number

initialItems?

optional initialItems: TValue[];

optional initialItems: TValue[];

定义于：async-queuer.ts:41

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

maxSize?

optional maxSize: number;

optional maxSize: number;

定义于：async-queuer.ts:45

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

onError()?

optional onError: (error, queuer) => void;

optional onError: (error, queuer) => void;

定义于：async-queuer.ts:51

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

参数

error

unknown

queuer

AsyncQueuer<TValue>

void

onExpire()?

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

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

定义于：async-queuer.ts:55

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

参数

item

TValue

queuer

AsyncQueuer<TValue>

void

onIsRunningChange()?

optional onIsRunningChange: (queuer) => void;

optional onIsRunningChange: (queuer) => void;

定义于：async-queuer.ts:59

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

参数

queuer

AsyncQueuer<TValue>

void

onItemsChange()?

optional onItemsChange: (queuer) => void;

optional onItemsChange: (queuer) => void;

定义于：async-queuer.ts:63

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

参数

queuer

AsyncQueuer<TValue>

void

onReject()?

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

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

定义于：async-queuer.ts:67

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

参数

item

TValue

queuer

AsyncQueuer<TValue>

void

onSettled()?

optional onSettled: (queuer) => void;

optional onSettled: (queuer) => void;

定义于：async-queuer.ts:71

可选的回调，在任务完成时调用

参数

queuer

AsyncQueuer<TValue>

void

onSuccess()?

optional onSuccess: (result, queuer) => void;

optional onSuccess: (result, queuer) => void;

定义于：async-queuer.ts:75

可选的回调，在任务成功时调用

参数

result

TValue

queuer

AsyncQueuer<TValue>

void

started?

optional started: boolean;

optional started: boolean;

定义于：async-queuer.ts:79

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

throwOnError?

optional throwOnError: boolean;

optional throwOnError: boolean;

定义于：async-queuer.ts:85

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

wait?

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

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

定义于：async-queuer.ts:91

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