five-on-it / apps/creator/src/client / CreatorClient
Interface: CreatorClient
Defined in: apps/creator/src/client.ts:12
The private routes, as a runner calls them.
Methods
claim()
claim(
waitMs):Promise<ClaimedJob|undefined>
Defined in: apps/creator/src/client.ts:14
The next creation, waiting up to waitMs for one; none when there was none.
Parameters
waitMs
number
Returns
Promise<ClaimedJob | undefined>
finish()
finish(
id,attempt,outcome):Promise<void>
Defined in: apps/creator/src/client.ts:18
Ends a job: done or failed (system: its creation given back), what it spent, its transcript.
Parameters
id
string
attempt
number
outcome
Returns
Promise<void>
heartbeat()
heartbeat(
id,attempt,step,spent):Promise<{stop:boolean; }>
Defined in: apps/creator/src/client.ts:16
Renews a job's lease with its step and spend; whether to stop.
Parameters
id
string
attempt
number
step
string
spent
number
Returns
Promise<{ stop: boolean; }>