Skip to main content

Class: ThrottledTaskQueueProcess

A process which dispatches tasks in a task queue potentially over multiple frames.

Constructors​

constructor​

• new ThrottledTaskQueueProcess(queue, handler): ThrottledTaskQueueProcess

Constructor.

Parameters​

NameTypeDescription
queueTaskQueueThe queue to process.
handlerThrottledTaskQueueHandlerA handler which defines the behavior of this process.

Returns​

ThrottledTaskQueueProcess

Defined in​

src/sdk/utils/task/ThrottledTaskQueueProcess.ts:56

Methods​

abort​

▸ abort(): void

Aborts this process. Has no effect if the process has not been started or if it has already ended.

Returns​

void

Defined in​

src/sdk/utils/task/ThrottledTaskQueueProcess.ts:116

hasEnded​

▸ hasEnded(): boolean

Checks whether this process has ended.

Returns​

boolean

whether this process has ended.

Defined in​

src/sdk/utils/task/ThrottledTaskQueueProcess.ts:71

hasStarted​

▸ hasStarted(): boolean

Checks whether this process has been started.

Returns​

boolean

whether this process has been started.

Defined in​

src/sdk/utils/task/ThrottledTaskQueueProcess.ts:63

start​

▸ start(): void

Starts this process.

Returns​

void

Defined in​

src/sdk/utils/task/ThrottledTaskQueueProcess.ts:78