Five On It

Appearance

five-on-it / apps/server/src/rtc-peers / RtcPeersOptions

Interface: RtcPeersOptions ​

Defined in: apps/server/src/rtc-peers.ts:64

How the peers run.

Properties ​

clearTimer? ​

optional clearTimer?: (timer) => void

Defined in: apps/server/src/rtc-peers.ts:75

Parameters ​

timer ​

unknown

Returns ​

void

connectTimeoutMs ​

connectTimeoutMs: number

Defined in: apps/server/src/rtc-peers.ts:72

emit ​

emit: (event) => void

Defined in: apps/server/src/rtc-peers.ts:67

Tells the game thread (an answer, a candidate, a channel opened or closed).

Parameters ​

event ​

FromWorker

Returns ​

void

factory ​

factory: PeerFactory

Defined in: apps/server/src/rtc-peers.ts:65

frame ​

frame: (peer, data) => void

Defined in: apps/server/src/rtc-peers.ts:69

Hands the game thread a frame that came on a peer's channel.

Parameters ​

peer ​

number

data ​

Uint8Array

Returns ​

void

maxHandshakes ​

maxHandshakes: number

Defined in: apps/server/src/rtc-peers.ts:71

maxPeers ​

maxPeers: number

Defined in: apps/server/src/rtc-peers.ts:70

setTimer? ​

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

Defined in: apps/server/src/rtc-peers.ts:74

Timers (setTimeout and clearTimeout by default; the tests drive their own).

Parameters ​

run ​

() => void

ms ​

number

Returns ​

unknown