Five On It

Appearance

five-on-it / apps/server/src/supervisor / SupervisorOptions

Interface: SupervisorOptions ​

Defined in: apps/server/src/supervisor.ts:30

How the supervisor runs.

Properties ​

basePort ​

basePort: number

Defined in: apps/server/src/supervisor.ts:33

The first process's port.

env ​

env: Readonly<Record<string, string | undefined>>

Defined in: apps/server/src/supervisor.ts:37

The environment the processes start from.

log? ​

optional log?: (message) => void

Defined in: apps/server/src/supervisor.ts:46

Parameters ​

message ​

string

Returns ​

void

now? ​

optional now?: () => number

Defined in: apps/server/src/supervisor.ts:47

Returns ​

number

processes ​

processes: number

Defined in: apps/server/src/supervisor.ts:31

schedule? ​

optional schedule?: (run, ms) => unknown

Defined in: apps/server/src/supervisor.ts:48

Parameters ​

run ​

() => void

ms ​

number

Returns ​

unknown

script ​

script: string

Defined in: apps/server/src/supervisor.ts:35

The server's entry (this process's own script).

start? ​

optional start?: (script, env) => object

Defined in: apps/server/src/supervisor.ts:39

Starts a process (child_process.fork by default; the tests give a fake that hears exit and takes kill).

Parameters ​

script ​

string

env ​

Record<string, string>

Returns ​

object

kill() ​

kill(signal?): unknown

Parameters ​
signal? ​

Signals

Returns ​

unknown

on() ​

on(event, listener): unknown

Parameters ​
event ​

"exit"

listener ​

(code) => void

Returns ​

unknown