Class TaskBucket<T>

constructor

• new TaskBucket<T>(options): TaskBucket<T>

• Type Parameters

  • T = any

  Parameters

  • options: TaskBucketOptions

  Returns TaskBucket<T>

name

pluginId

deleteAll

• deleteAll(): Promise<number>

• Delete all tasks within this bucket

  Returns Promise<number>

  the number of tasks deleted

deleteById

• deleteById(id): Promise<boolean>

• Delete a task by its globally unique ID (NOT key)

  Throws an error if it did not belong to this bucket

  Parameters

  • id: number

  Returns Promise<boolean>

  true if found and deleted, false otherwise

deleteByKey

• deleteByKey(key): Promise<boolean>

• Delete a task by its unique key

  Parameters

  • key: string

  Returns Promise<boolean>

  true if found and deleted, false otherwise

getById

• getById(id): Promise<undefined | Task<T>>

• Retrieve a task by its globally unique ID (NOT unique key)

  Parameters

  • id: number

  Returns Promise<undefined | Task<T>>

  The task if found, or undefined if not found

getByKey

• getByKey(key): Promise<undefined | Task<T>>

• Retrieve a task by its unique key

  Parameters

  • key: string

  Returns Promise<undefined | Task<T>>

  Either the task if found, or undefined

getMany

• getMany(options?): Promise<Task<T>[]>

• Paginate through all scheduled tasks in this bucket

  Note that only a small number is returned each call (25 as of writing, may change) so if you need to scan through all of them you need to paginate using BucketListOptions.afterId

  Entries are sorted by increasing ID

  Parameters

  • Optional options: BucketListOptions

  Returns Promise<Task<T>[]>

schedule

• schedule(opts): Promise<Task<T>>

• Create a new scheduled task.

  Parameters

  • opts: CreateOptions<T>

  Returns Promise<Task<T>>

  The scheduled task