ObjectStackObjectStack

Job

Job protocol schemas

Cron Schedule Schema

Schedule jobs using cron expressions

Source: packages/spec/src/system/job.zod.ts

TypeScript Usage

import { IntervalSchedule, JobExecution, JobExecutionStatus, OnceSchedule, RetryPolicy } from '@objectstack/spec/system';
import type { IntervalSchedule, JobExecution, JobExecutionStatus, OnceSchedule, RetryPolicy } from '@objectstack/spec/system';

// Validate data
const result = IntervalSchedule.parse(data);

IntervalSchedule

Properties

PropertyTypeRequiredDescription
typestring✅
intervalMsinteger✅Interval in milliseconds

JobExecution

Properties

PropertyTypeRequiredDescription
jobIdstring✅Job identifier
startedAtstring✅ISO 8601 datetime when execution started
completedAtstringoptionalISO 8601 datetime when execution completed
statusEnum<'running' | 'success' | 'failed' | 'timeout'>✅Execution status
errorstringoptionalError message if failed
durationintegeroptionalExecution duration in milliseconds

JobExecutionStatus

Allowed Values

  • running
  • success
  • failed
  • timeout

OnceSchedule

Properties

PropertyTypeRequiredDescription
typestring✅
atstring✅ISO 8601 datetime when to execute

RetryPolicy

Properties

PropertyTypeRequiredDescription
maxRetriesinteger✅Maximum number of retry attempts
backoffMsinteger✅Initial backoff delay in milliseconds
backoffMultipliernumber✅Multiplier for exponential backoff

On this page

TypeScript UsageIntervalSchedulePropertiesJobExecutionPropertiesJobExecutionStatusAllowed ValuesOnceSchedulePropertiesRetryPolicyProperties