Five On It

Appearance

five-on-it / apps/creator/src/runner / RunOptions

Interface: RunOptions ​

Defined in: apps/creator/src/runner.ts:144

What a run needs.

Properties ​

apiUrl ​

apiUrl: string

Defined in: apps/creator/src/runner.ts:146

The platform API (the job's session calls it) and the web client (its links).

control ​

control: Control

Defined in: apps/creator/src/runner.ts:149

fetch? ​

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: apps/creator/src/runner.ts:151

The HTTP client the tools call the API with.

Call Signature ​

(input, init?): Promise<Response>

MDN Reference

Parameters ​
input ​

URL | RequestInfo

init? ​

RequestInit

Returns ​

Promise<Response>

Call Signature ​

(input, init?): Promise<Response>

MDN Reference

Parameters ​
input ​

string | URL | Request

init? ​

RequestInit

Returns ​

Promise<Response>

heartbeatMs? ​

optional heartbeatMs?: number

Defined in: apps/creator/src/runner.ts:157

How often a heartbeat goes out (ms; 3 s).

limits? ​

optional limits?: Partial<TurnLimits>

Defined in: apps/creator/src/runner.ts:155

Other caps than the claim's and LIMITS (the tests').

log? ​

optional log?: (message) => void

Defined in: apps/creator/src/runner.ts:161

Hears what went wrong in the background.

Parameters ​

message ​

string

Returns ​

void

model ​

model: Model

Defined in: apps/creator/src/runner.ts:148

now? ​

optional now?: () => number

Defined in: apps/creator/src/runner.ts:159

The clock (ms).

Returns ​

number

poll? ​

optional poll?: object

Defined in: apps/creator/src/runner.ts:153

How builds are waited for (every second, ten minutes at most).

intervalMs ​

intervalMs: number

timeoutMs ​

timeoutMs: number

signal? ​

optional signal?: AbortSignal

Defined in: apps/creator/src/runner.ts:163

Aborts when the runner stops: the job fails through no fault of its brief.

webUrl ​

webUrl: string

Defined in: apps/creator/src/runner.ts:147