Documents / @faasjs/jobs

@faasjs/jobs / JobEvent

Type Alias: JobEvent<TSchema>

JobEvent<TSchema> > > > > = object

Runtime event passed to the underlying job function.

Type Parameters

TSchema

TSchema extends ZodType | undefined = undefined

Properties

attempt?

optional attempt?: number

Current execution attempt. Defaults to 1 when omitted.

job?

optional job?: Partial<JobRecord>>>>>

Job metadata. Defaults are filled when omitted, which keeps direct job tests small.

params?

optional params?: TSchema extends ZodType ? ZodInfer<TSchema> > > > > : Record<string, any>>>>>

Raw params passed to the job. They are validated before handler receives params.