Interface Options

Optionalorm

OptionalrateLimit

Optionaljobs

• jobs(): Job<Data<Parser<unknown>>>[]

  A function that returns the list of jobs to register

  Returns Job<Data<Parser<unknown>>>[]

OptionalonJobError

• onJobError(error: unknown, message: Message): void

  A function that will run if a job failed

  Parameters

  • error: unknown
  • message: Message

  Returns void

OptionalonQueue

• onQueue(
      batch: MessageBatch,
      env: Environment,
      ctx: ExecutionContext,
  ): Promise<void>

  The function that will run every time a queue message is consumed

  Parameters

  • batch: MessageBatch
  • env: Environment
  • ctx: ExecutionContext

  Returns Promise<void>

onRequest

• onRequest(
      request: Request,
      env: Environment,
      ctx: ExecutionContext,
  ): Promise<Response>

  The function that will run every time a new request comes in

  Parameters

  • request: Request
  • env: Environment
  • ctx: ExecutionContext

  Returns Promise<Response>

OptionalonSchedule

• onSchedule(
      event: ScheduledController,
      env: Environment,
      ctx: ExecutionContext,
  ): Promise<void>

  The function that will run every time a scheduled task is executed

  Parameters

  • event: ScheduledController
  • env: Environment
  • ctx: ExecutionContext

  Returns Promise<void>

OptionalonTaskError

• onTaskError(error: unknown, task: Task): void

  A function that will run if a task failed

  Parameters

  • error: unknown
  • task: Task

  Returns void

Optionaltasks

• tasks(): Task[]

  A function that returns the list of tasks to register

  Returns Task[]