Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncRequestIdleCallbackOptions<CTX>

Type parameters

Hierarchy

Index

Properties

Properties

Optional group

group?: string

Group name of a task

Optional join

join?: Join

Strategy to join competitive tasks (with the same labels):

  1. true - all tasks are joined to the first;
  2. 'replace' - all tasks are joined (replaced) to the last (only for promises).

Optional label

label?: Label

Label of a task (the previous task with the same label will be canceled)

Optional onClear

onClear?: CanArray<Function | ((this: CTX, e: TaskCtx<CTX>) => void)>

Handler/s of task clearing

Optional onMerge

onMerge?: CanArray<Function | ((this: CTX, e: TaskCtx<CTX>) => void)>

Handler/s of task merging: a task should merge to another task with the same label and with "join: true" strategy

Optional onMutedCall

onMutedCall?: CanArray<Function | ((this: CTX, e: TaskCtx<CTX>) => void)>

Handler/s of muted task calling. These handlers are invoked when occurring calling the task if it is muted.

Optional promise

promise?: boolean

If true, then a task namespace is marked as promisified

default

false

Optional timeout

timeout?: number

Timeout value for the native requestIdleCallback function