Skip to content

five-on-it / packages/protocol/src/lobby / LobbyFeedEvent

Variable: LobbyFeedEvent ​

const LobbyFeedEvent: ZodDiscriminatedUnion<[ZodObject<{ from: ZodOptional<ZodObject<{ id: ZodString; name: ZodString; }, $strip>>; kind: ZodLiteral<"lobby">; lobby: ZodString; n: ZodNumber; state: ZodUnion<readonly [ZodEnum<{ countdown: "countdown"; gathering: "gathering"; ready: "ready"; results: "results"; running: "running"; }>, ZodLiteral<"closed">]>; text: ZodOptional<ZodString>; title: ZodOptional<ZodString>; view: ZodOptional<ZodObject<{ canStart: ZodBoolean; countdown: ZodNullable<ZodObject<{ seconds: ZodNumber; waiting: ZodBoolean; }, $strip>>; game: ZodObject<{ by: ZodString; curated: ZodBoolean; id: ZodString; level: ZodString; rating: ZodObject<{ average: ...; count: ...; }, $strip>; title: ZodString; }, $strip>; host: ZodNullable<ZodString>; id: ZodString; join: ZodOptional<ZodObject<{ joinUrl: ZodString; room: ZodString; run: ZodString; }, $strip>>; max: ZodNumber; mission: ZodObject<{ blurb: ZodNullable<ZodString>; id: ZodString; rules: ZodObject<{ each: ...; friendlyFire: ...; joinInProgress: ...; lives: ...; mode: ...; onDeath: ...; players: ...; respect: ...; retries: ...; teams: ...; timeLimit: ...; }, $strip>; title: ZodString; }, $strip>; notice: ZodNullable<ZodObject<{ code: ZodEnum<...>; text: ZodString; }, $strip>>; players: ZodNumber; playlist: ZodOptional<ZodNullable<ZodEnum<{ any: ...; coop: ...; races: ...; versus: ...; }>>>; results: ZodNullable<ZodObject<{ forfeit: ZodBoolean; mission: ZodString; outcome: ZodEnum<...>; run: ZodNullable<...>; seats: ZodArray<...>; seconds: ZodNullable<...>; title: ZodString; winner: ZodNullable<...>; winnerName: ZodNullable<...>; }, $strip>>; run: ZodNullable<ZodString>; state: ZodEnum<{ countdown: "countdown"; gathering: "gathering"; ready: "ready"; results: "results"; running: "running"; }>; teams: ZodArray<ZodObject<{ id: ZodString; members: ZodArray<...>; name: ZodString; players: ZodObject<..., ...>; }, $strip>>; visibility: ZodEnum<{ private: "private"; public: "public"; }>; vote: ZodNullable<ZodObject<{ endsIn: ZodNumber; mine: ZodNullable<...>; offers: ZodArray<...>; }, $strip>>; you: ZodNullable<ZodString>; }, $strip>>; why: ZodEnum<{ changed: "changed"; closed: "closed"; invite: "invite"; joined: "joined"; kicked: "kicked"; removed: "removed"; results: "results"; }>; }, $strip>, ZodObject<{ joinUrl: ZodString; kind: ZodLiteral<"run">; lobby: ZodString; n: ZodNumber; room: ZodString; run: ZodString; }, $strip>], "kind">

Defined in: packages/protocol/src/lobby.ts:328

What the feed brings a member of a lobby: the lobby changed (why: changed, the member was brought in by their party's leader (from), kicked by the host, removed (gone from the page), the lobby closed (text says why), an invitation, a run's results in), with the lobby as the member sees it now when it changed (view: changes close together come as one), and the lobby's run opened, with the member's join URL to their seat.