five-on-it / packages/protocol/src/messages / parseRun

Function: parseRun()

parseRun(text): { debug?: boolean; game: string; id: string; lives?: { count: number; left?: number; per: "player" | "team"; }; mission: string; mode?: "solo" | "coop" | "versus"; phase: "gathering" | "countdown" | "live" | "ended"; playtest?: boolean; result?: { forfeit?: boolean; outcome: "complete" | "failed" | "abandoned" | "won" | "draw"; seats: object[]; seconds: number; winner?: string; }; retries: { left: number; total: number; }; seat?: number; seats: object[]; startsIn?: number; teams?: object[]; title: string; type: "run"; } | undefined

Defined in: packages/protocol/src/messages.ts:848

Parses a text frame as a run's state; undefined when it is not one.

Parameters

text

string

Returns

{ debug?: boolean; game: string; id: string; lives?: { count: number; left?: number; per: "player" | "team"; }; mission: string; mode?: "solo" | "coop" | "versus"; phase: "gathering" | "countdown" | "live" | "ended"; playtest?: boolean; result?: { forfeit?: boolean; outcome: "complete" | "failed" | "abandoned" | "won" | "draw"; seats: object[]; seconds: number; winner?: string; }; retries: { left: number; total: number; }; seat?: number; seats: object[]; startsIn?: number; teams?: object[]; title: string; type: "run"; } | undefined