Class AbstractSimpleTask<TaskType, TaskProps, ReturnType, CommonTaskContext>Abstract

constructor

• new AbstractSimpleTask<TaskType, TaskProps, ReturnType, CommonTaskContext>(params, data, abortSignal, logger): AbstractSimpleTask<TaskType, TaskProps, ReturnType, CommonTaskContext>

• Type Parameters

  • TaskType extends string
  • TaskProps extends TTaskProps
  • ReturnType
  • CommonTaskContext

  Parameters

  • params: TaskParams<TaskProps, CommonTaskContext>
  • data: undefined | ReturnType
  • abortSignal: AbortSignal
  • logger: undefined | ILoggerLike

  Returns AbstractSimpleTask<TaskType, TaskProps, ReturnType, CommonTaskContext>

abortSignal

commonContext

data

disabled

end

errorCount

errors

props

runCount

runErrorCount

Readonly singleInstance

public override readonly singleInstance = true;
Copy

start

status

taskError

Abstract trigger

Readonly Abstract type

Readonly uuid

allowRestart

• allowRestart(): boolean | Promise<boolean>

• Check if the task instance is allowed to restart, default is false

  Returns boolean | Promise<boolean>

  true if the task can be restarted, false otherwise

  Example

  public override allowRestart(): boolean {
       return this.status === TaskStatusType.REJECTED;
  }
  Copy

getDescription

• getDescription(): string | Promise<string>

• Builds description of the task

  Returns string | Promise<string>

onErrorSleep

• onErrorSleep(): number | Promise<number>

• Sleep time before retrying the task, default is 0

  Returns number | Promise<number>

  time in milliseconds to sleep before retrying

  Example

  public override onErrorSleep(): Promise<number> | number {
       return this.runCount * 100;
  }
  Copy

onInit

• onInit(): void | Promise<void>

• callback when task is initialized

  Returns void | Promise<void>

onPreStart

• onPreStart(): boolean | Promise<boolean>

• Called before the task is running. how to use:

  • clear old errors
  • validate current props

  Returns boolean | Promise<boolean>

  true if the task should be started

  Example

  public override onPreStart(): Promise<boolean> | boolean {
    // leave only the last 10 errors
    if (this.errors.size > 10) {
      const errors = Array.from(this.errors);
      errors.splice(0, errors.length - 10);
      this.errors = new Set(errors);
    }
    return true;
  }
  Copy

onRejected

• onRejected(): void | Promise<void>

• Called when the task is rejected

  Returns void | Promise<void>

  Example

  public override onRejected(): Promise<void> | void {
       this.logger?.error('Task rejected', this.taskError);
  }
  Copy

onResolved

• onResolved(): void | Promise<void>

• Called when the task is resolved

  Returns void | Promise<void>

  Example

  public override onResolved(): Promise<void> | void {
       this.logger?.info('Task resolved', this.data);
  }
  Copy

onUpdate

• onUpdate(callback): void

• Event listener for task update event.

  Parameters

  • callback: (() => void)

    to call when task is updated

    • • (): void

      • Returns void

  Returns void

retry

• retry(): boolean | Promise<boolean>

• Check if the task is allowed to be retried on error, default is false

  Returns boolean | Promise<boolean>

  true if the task should be retried, false otherwise

  Example

  public override retry(): Promise<boolean> | boolean {
    return this.errorCount < 4;
  }
  Copy

Abstract runTask

• runTask(): ReturnType | Promise<ReturnType>

• run task action

  Returns ReturnType | Promise<ReturnType>

update

• update(): void

• Notify about task update (like current props update).

  Returns void