Class Queueable

constructor

• new Queueable(
      queueableData?: {
          next?: Queueable;
          ready?: boolean | Function;
          task?: any;
      },
  ): Queueable

  Create a queueable item that can be used in a queue.

  Parameters

  • queueableData: { next?: Queueable; ready?: boolean | Function; task?: any } = {}

    The settings for the new queueable.

    • Optionalnext?: Queueable

      The reference to the next queueable if any

    • Optionalready?: boolean | Function

      Indicate if the queueable is ready to run

    • Optionaltask?: any

      The data to be stored in this queueable

  Returns Queueable

ReadonlyclassType

complete

data

next

ready

running

isReady

• get isReady(): boolean

  Check ready state.

  Returns boolean

task

• get task(): any

  Retrieve the data which should be formed as a task.

  Returns any

markCompleted

• markCompleted(
      completeResponse?: { context?: any; error?: any; success?: any },
  ): completeResponse

  Set this queueable as completed.

  Parameters

  • completeResponse: { context?: any; error?: any; success?: any } = {}

    The result to report for the task.

    • Optionalcontext?: any

      Provide additional data in the response

    • Optionalerror?: any

      Indicate a task was error-free (use false) or give an error message

    • Optionalsuccess?: any

      Indicate when the task failed (use false) or give a success message

  Returns completeResponse

run

• run(): completeResponse

  Intend to run the queued task when it is ready. If ready, mark this task as running and run the task.

  Returns completeResponse

StaticfromArray

• fromArray(values?: any[], classType?: any): { head: IsLinker; tail: IsLinker }

  Convert an array into Queueable instances, return the head and tail Queueables.

  Parameters

  • values: any[] = []

    Provide an array of data that will be converted to a chain of queueable linkers.

  • classType: any = Queueable

    Provide the type of IsLinker to use.

  Returns { head: IsLinker; tail: IsLinker }

Staticmake

• make(queueable: any, classType?: any): IsLinker

  Make a new Queueable from the data given if it is not already a valid Queueable.

  Parameters

  • queueable: any

    Return a valid Queueable instance from given data, or even an already valid one.

  • classType: any = Queueable

    Provide the type of IsLinker to use.

  Returns IsLinker