Interface MatchLifecycleObservationEvent<TSettings, TOverlayExtensions>

interface MatchLifecycleObservationEvent<
    TSettings extends object = JsonObject,
    TOverlayExtensions extends object = object,
> {
    initial: boolean;
    match: Match;
    nextMatch?: Match;
    observedAt: string;
    phase: "ended" | "started";
    previousMatch?: Match;
    state: MatchState<TSettings, TOverlayExtensions>;
}

Type Parameters

TSettings extends object = JsonObject
TOverlayExtensions extends object = object

Hierarchy (View Summary)

MatchLifecycleEvent<TSettings, TOverlayExtensions>
- MatchLifecycleObservationEvent

Index

Properties

initial match nextMatch? observedAt phase previousMatch? state

Properties

`Readonly`initial

initial: boolean

`Readonly`match

match: Match

Started match, or the completed snapshot for a same-ID ended transition.

`Optional` `Readonly`nextMatch

nextMatch?: Match

`Readonly`observedAt

observedAt: string

Client observation time; this is not an authoritative match timestamp.

`Readonly`phase

phase: "ended" | "started"

`Optional` `Readonly`previousMatch

previousMatch?: Match

`Readonly`state

state: MatchState<TSettings, TOverlayExtensions>