Class Scheduler<Result, Binding, PollingGroups>

constructor

• new Scheduler<
      Result = any,
      Binding = any,
      PollingGroups extends PollingGroup = DefaultPollingGroups,
  >(
      name: string,
      options?: SchedulerOptions<Result, Binding, PollingGroups>,
  ): Scheduler<Result, Binding, PollingGroups>

• Create a new scheduler

  Type Parameters

  • Result = any
  • Binding = any
  • PollingGroups extends PollingGroup = DefaultPollingGroups

  Parameters

  • name: string

    The name of the scheduler
  • options: SchedulerOptions<Result, Binding, PollingGroups> = {}

    The options for the scheduler

  Returns Scheduler<Result, Binding, PollingGroups>

ReadonlycomponentId

Readonlymetrics

ReadonlymetricsDefinitions

Readonlyname

checks

• get checks(): Checks<any>

• Get the health checks for the scheduler

  Returns Checks<any>

status

• get status(): "pass" | "fail" | "warn"

• Get the health status for the scheduler

  Returns "pass" | "fail" | "warn"

addListener

• addListener(event: "done", listener: DoneListener<Result>): this

• Add a listener for the done event, emitted when a task is done, with the result or the error.

  Parameters

  • event: "done"

    done event
  • listener: DoneListener<Result>

    Done event listener

  Returns this

  Event

addResource

• addResource(
      resource: string,
      entry: ResourceConfigEntry<Result, Binding, PollingGroups>,
  ): void

• Add a resource to the scheduler

  Parameters

  • resource: string

    The resource
  • entry: ResourceConfigEntry<Result, Binding, PollingGroups>

    The resource configuration

  Returns void

addResources

• addResources(
      resources: ResourcesConfigObject<Result, Binding, PollingGroups>,
  ): void

• Add resources to the scheduler

  Parameters

  • resources: ResourcesConfigObject<Result, Binding, PollingGroups>

    The resources configuration

  Returns void

cleanup

• cleanup(): void

• Cleanup the scheduler

  Returns void

close

• close(): Promise<void>

• Close the scheduler

  Returns Promise<void>

dropResource

• dropResource(resource: string): void

• Drop a resource from the scheduler

  Parameters

  • resource: string

    The resource to drop

  Returns void

off

• off(event: "done", listener: DoneListener<Result>): this

• Removes the specified listener from the listener array for the done event.

  Parameters

  • event: "done"

    done event
  • listener: DoneListener<Result>

    Error event listener

  Returns this

  Event

on

• on(event: "error", listener: (error: Crash | Error | Multi) => void): this

• Add a listener for the error event, emitted when the component detects an error.

  Parameters

  • event: "error"

    error event
  • listener: (error: Crash | Error | Multi) => void

    Error event listener

  Returns this

  Event

• on(event: "status", listener: (status: "pass" | "fail" | "warn") => void): this

• Add a listener for the status event, emitted when the component status changes.

  Parameters

  • event: "status"

    status event
  • listener: (status: "pass" | "fail" | "warn") => void

    Status event listener

  Returns this

  Event

• on(event: "done", listener: DoneListener<Result>): this

• Add a listener for the done event, emitted when a task is done, with the result or the error.

  Parameters

  • event: "done"

    done event
  • listener: DoneListener<Result>

    Done event listener

  Returns this

  Event

once

• once(event: "done", listener: DoneListener<Result>): this

• Add a listener for the done event, emitted when a task is done, with the result or the error. This is a one-time event, the listener will be removed after the first emission.

  Parameters

  • event: "done"

    done event
  • listener: DoneListener<Result>

    Done event listener

  Returns this

  Event

removeAllListeners

• removeAllListeners(event?: "done"): this

• Removes all listeners, or those of the specified event.

  Parameters

  • Optionalevent: "done"

    done event

  Returns this

removeListener

• removeListener(event: "done", listener: DoneListener<Result>): this

• Removes the specified listener from the listener array for the done event.

  Parameters

  • event: "done"

    done event
  • listener: DoneListener<Result>

    Error event listener

  Returns this

  Event

start

• start(): Promise<void>

• Start the scheduler

  Returns Promise<void>

stop

• stop(): Promise<void>

• Stop the scheduler

  Returns Promise<void>