Class ResumableTaskStoreLevel

constructor

• new ResumableTaskStoreLevel(config): ResumableTaskStoreLevel

• Parameters

  • config: ResumableTaskStoreLevelConfig

  Returns ResumableTaskStoreLevel

config

db

clear

• clear(): Promise<void>

• Deletes everything in the store. Mainly used in tests.

  Returns Promise<void>

close

• close(): Promise<void>

• Closes the connection to the underlying store.

  Returns Promise<void>

delete

• delete(taskId): Promise<void>

• Deletes the task associated with the task ID provided. No-op if the task is not found, as this implies that the task has already been completed. Called when the task has been successfully completed.

  Parameters

  • taskId: string

  Returns Promise<void>

extend

• extend(taskId, timeoutInSeconds): Promise<void>

• Extends the timeout of the task associated with the task ID provided. No-op if the task is not found, as this implies that the task has already been completed. This allows the client that is executing the task to continue working on it before the task is considered timed out.

  Parameters

  • taskId: string

    ID of the task to extend the timeout for.
  • timeoutInSeconds: number

    Timeout in seconds from the current time.

  Returns Promise<void>

grab

• grab(count): Promise<ManagedResumableTask[]>

• Grabs a number of unhandled tasks from the store. Unhandled tasks are tasks that are not currently in-flight/under processing (ie. tasks that have timed-out). NOTE: The implementation must make sure that once a task is grabbed by a client, tis timeout must be updated so that it is considered in-flight/under processing and cannot be grabbed by another client until it is timed-out.

  Parameters

  • count: number

    Desired number of tasks to grab.

  Returns Promise<ManagedResumableTask[]>

  A list of tasks exclusive for the caller to handle; or empty array if there is no tasks, or if all tasks are already grabbed by others.

open

• open(): Promise<void>

• Opens a connection to the underlying store and initializes it.

  Returns Promise<void>

read

• read(taskId): Promise<undefined | ManagedResumableTask>

• Reads the task associated with the task ID provided regardless of whether it is in-flight/under processing or not. This is mainly introduced for testing purposes: ie. to check the status of a task for easy test verification.

  Parameters

  • taskId: string

    ID of the task to read.

  Returns Promise<undefined | ManagedResumableTask>

register

• register(task, timeoutInSeconds): Promise<ManagedResumableTask>

• Registers a new resumable task that is currently in-flight/under processing to the store. If the task is timed out, a client will be able to grab it through the grab() method and resume the task.

  Parameters

  • task: any

    Task specific data. This is deliberately of type any because this store should not have to be ware of its type.
  • timeoutInSeconds: number

    Timeout in seconds from the current time.

  Returns Promise<ManagedResumableTask>

  A ManagedResumableTask object that can be used to extend or delete the task.

  Throws

  with code set to ResumableTaskAlreadyExists if the same task is already registered.