Class Schedule

constructor

• new Schedule(store, encoder, schedule): Schedule

• Parameters

  • store: IScheduleStore
  • encoder: IEncoder<unknown, undefined | string>
  • schedule: Schedule

  Returns Schedule

schedule

delete

• delete(): Promise<void>

• Returns Promise<void>

Static create

• create(store, encoder, id, cron, promiseId, promiseTimeout, opts?): Promise<Schedule>

• Parameters

  • store: IScheduleStore
  • encoder: IEncoder<unknown, undefined | string>
  • id: string
  • cron: string
  • promiseId: string
  • promiseTimeout: number
  • opts: Partial<schedules.Options> = {}

  Returns Promise<Schedule>

Static get

• get(store, encoder, id): Promise<Schedule>

• Parameters

  • store: IScheduleStore
  • encoder: IEncoder<unknown, undefined | string>
  • id: string

  Returns Promise<Schedule>

Static search

• search(store, encoder, id, tags?, limit?): AsyncGenerator<Schedule[], void, unknown>

• Parameters

  • store: IScheduleStore
  • encoder: IEncoder<unknown, undefined | string>
  • id: string
  • Optional tags: Record<string, string>
  • Optional limit: number

  Returns AsyncGenerator<Schedule[], void, unknown>