PopiiTaskDefinition

Popii

---

Popii / PopiiTaskDefinition

Interface: PopiiTaskDefinition<TState, TPayload>

Defined in: types.ts:446

The definition of a scheduled background task.

Use the task builder function to create one with full type inference. Tasks are auto-loaded from src/tasks/ and can also be triggered on demand via pop.schedule("task-name", payload, delayMs).

Type Parameters

TState

TState = any

TPayload

TPayload = unknown

Methods

run()

run(pop, payload?): void | Promise<void>

Defined in: types.ts:464

The function to run. payload is provided when triggered via pop.schedule().

Parameters

pop

TaskPop<TState>

payload?

TPayload

Returns

void | Promise<void>

Properties

name?

optional name?: string

Defined in: types.ts:448

A unique name for this task. Used when scheduling it via pop.schedule().

---

schedule?

optional schedule?: string

Defined in: types.ts:450

Cron expression (e.g. "0 9 * * *" for every day at 9am). Omit for on-demand-only tasks.

---

timezone?

optional timezone?: string

Defined in: types.ts:452

Timezone for the cron schedule. Bun’s in-process scheduler currently supports UTC only.

---

payloadSchema?

optional payloadSchema?: ZodType<TPayload, unknown, $ZodTypeInternals<TPayload, unknown>>

Defined in: types.ts:454

Runtime schema used to validate manually scheduled and delayed payloads.

---

overlap?

optional overlap?: boolean

Defined in: types.ts:456

Allow concurrent runs of this task. Defaults to false (skips if previous run is still active).

---

retries?

optional retries?: number

Defined in: types.ts:458

Number of times to retry on failure. Defaults to 0.

---

retryDelay?

optional retryDelay?: number

Defined in: types.ts:460

Milliseconds to wait between retries. Defaults to 1000.

---

timeoutMs?

optional timeoutMs?: number

Defined in: types.ts:462

Maximum execution time in ms before the run is considered timed out.