Class LocalScheduleStore

Schedule Store API

Implements

IScheduleStore

Index

Constructors

Properties

Methods

create delete get nextRunTime search update

Constructors

constructor

new LocalScheduleStore(store, storage): LocalScheduleStore
Parameters
- store: LocalStore
- storage: IStorage<Schedule>
Returns LocalScheduleStore
- Defined in lib/core/stores/local.ts:332

Properties

`Private` storage

storage: IStorage<Schedule>

`Private` store

store: LocalStore

Methods

create

create(id, ikey, description, cron, tags, promiseId, promiseTimeout, promiseHeaders, promiseData, promiseTags): Promise<Schedule>
Creates a new schedule.
Parameters
- id: string
  Unique identifier for the schedule.
- ikey: undefined | string
  Idempotency key associated with the create operation.
- description: undefined | string
  Description of the schedule.
- cron: string
  CRON expression defining the schedule's execution time.
- tags: undefined | Record<string, string>
  Key-value pairs associated with the schedule.
- promiseId: string
  Unique identifier for the associated promise.
- promiseTimeout: number
  Timeout for the associated promise in milliseconds.
- promiseHeaders: Record<string, string>
  Headers associated with the promise data.
- promiseData: undefined | string
  Encoded data for the promise of type string.
- promiseTags: undefined | Record<string, string>
  Key-value pairs associated with the promise.
Returns Promise<Schedule>
A Promise resolving to the created schedule.
Implementation of IScheduleStore.create
- Defined in lib/core/stores/local.ts:337

delete

delete(id): Promise<void>
Deletes a schedule based on its id.
Parameters
- id: string
  Unique identifier for the promise to be deleted.
Returns Promise<void>
A promise schedule that is pending, canceled, resolved, or rejected.
Implementation of IScheduleStore.delete
- Defined in lib/core/stores/local.ts:421

get

get(id): Promise<Schedule>
Retrieves a schedule based on its id.
Parameters
- id: string
  Unique identifier for the promise to be retrieved.
Returns Promise<Schedule>
A promise schedule that is pending, canceled, resolved, or rejected.
Implementation of IScheduleStore.get
- Defined in lib/core/stores/local.ts:432

`Private` nextRunTime

nextRunTime(cron, lastRunTime): number
Parameters
- cron: string
- lastRunTime: number
Returns number
- Defined in lib/core/stores/local.ts:452

search

search(id, tags?, limit?): AsyncGenerator<Schedule[], void, unknown>
Search for schedules.
Parameters
- id: string
  Ids to match, can include wildcards.
- Optional tags: Record<string, string>
  Tags to match.
- Optional limit: number
Returns AsyncGenerator<Schedule[], void, unknown>
A list of promise schedules.
Implementation of IScheduleStore.search
- Defined in lib/core/stores/local.ts:442

update

update(id, lastRunTime): Promise<undefined | Schedule>
Parameters
- id: string
- lastRunTime: number
Returns Promise<undefined | Schedule>
- Defined in lib/core/stores/local.ts:392