agentskit.js

CronSchedulerOptions

Auto-generated API reference for CronSchedulerOptions.

Interface: CronSchedulerOptions<TContext>

Defined in: background.ts:25

#Type Parameters

#TContext

TContext = unknown

#Properties

#jobs

jobs: CronJob<TContext>[]

Defined in: background.ts:26


#now?

optional now?: () => Date

Defined in: background.ts:36

Clock override for tests.

#Returns

Date


#onEvent?

optional onEvent?: (event) => void

Defined in: background.ts:28

Observability hook.

#Parameters

event
error?

string

job

string

now

Date

result?

string

type

"tick" | "run:start" | "run:end" | "run:error"

#Returns

void


#scheduleTick?

optional scheduleTick?: (fn) => () => void

Defined in: background.ts:38

Timer override for tests β€” takes tick handler, returns stop fn.

#Parameters

fn

() => void

#Returns

() => void

Explore nearby

✎ Edit this page on GitHubΒ·Found a problem? Open an issue β†’Β·How to contribute β†’

On this page