basalt / queue/src / defineJob

Function: defineJob()

> defineJob<T>(config): JobDefinition<T>

Defined in: queue/src/job.ts:84

Defines a declarative job:

export const SendWelcomeEmail = defineJob({ name: 'email.welcome', schema: z.object({ userId: z.string() }), attempts: 3, backoff: { type: 'exponential', delay: '30s' }, async handle({ userId }) { ... }, })

Type Parameters

T

T = unknown

Parameters

config

attempts?

number

backoff?

JobBackoff

name

string

queue?

string

removeOnComplete?

JobRetention

removeOnFail?

JobRetention

schema?

JobSchema<T>

handle

Returns

JobDefinition<T>