Interface DefaultQueueProviderProps

interface DefaultQueueProviderProps {
    cancelAllOnUnmount?: boolean;
    continuousWorkMaxEntries?: number;
    continuousWorkTimeLimitMSec?: number;
    idPrefix: string;
    maxParallel?: number;
}

Hierarchy

  • RunQueueOptions
    • DefaultQueueProviderProps

Properties

cancelAllOnUnmount? continuousWorkMaxEntries? continuousWorkTimeLimitMSec? idPrefix maxParallel?

Properties

Optional cancelAllOnUnmount

cancelAllOnUnmount?: boolean

If true, cancelAll is called on the associated queue whenever this component is unmounted or whenever the idPrefix or other options change.

Default Value

false

Optional continuousWorkMaxEntries

continuousWorkMaxEntries?: number

The maximum number of entries that can be processed in a single run iteration.

Default Value

Number.MAX_SAFE_INTEGER

Optional continuousWorkTimeLimitMSec

continuousWorkTimeLimitMSec?: number

The amount of time that can be used for processing in a single run iteration.

Default Value

10

idPrefix

idPrefix: string

A technical, but human-readable ID prefix, which isn't guaranteed to be unique. This will be suffixed by ':default'

Optional maxParallel

maxParallel?: number

The maximum number of entries that can be executed at once.

Default Value

1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc