Skip to main content

Type Alias: StateOptions<TStateShape>

StateOptions<TStateShape> = object

Defined in: online/state/useState.ts:28

Type Parameters​

TStateShape​

TStateShape extends StateBase

Properties​

debug?​

optional debug: boolean

Defined in: online/state/useState.ts:39

deltaThrottleMs?​

optional deltaThrottleMs: number

Defined in: online/state/useState.ts:38

onAfterStateUpdated()?​

optional onAfterStateUpdated: (state, delta) => void

Defined in: online/state/useState.ts:36

Parameters​

state​

PartialDeep<TStateShape>

delta​

StateDelta<TStateShape>

Returns​

void

onBeforeSendDelta()?​

optional onBeforeSendDelta: (delta) => StateDelta<TStateShape>

Defined in: online/state/useState.ts:34

Parameters​

delta​

StateDelta<TStateShape>

Returns​

StateDelta<TStateShape>

onBeforeSendState()?​

optional onBeforeSendState: (state) => PartialDeep<TStateShape>

Defined in: online/state/useState.ts:29

Parameters​

state​

PartialDeep<TStateShape>

Returns​

PartialDeep<TStateShape>

onDeltaReceived()?​

optional onDeltaReceived: (delta) => StateDelta<TStateShape>

Defined in: online/state/useState.ts:35

Parameters​

delta​

StateDelta<TStateShape>

Returns​

StateDelta<TStateShape>

onStateReceived()?​

optional onStateReceived: (currentState, newState) => PartialDeep<TStateShape>

Defined in: online/state/useState.ts:30

Parameters​

currentState​

PartialDeep<TStateShape>

newState​

PartialDeep<TStateShape>

Returns​

PartialDeep<TStateShape>

socket?​

optional socket: PartySocket

Defined in: online/state/useState.ts:37