Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

poll_data: Define outbound data types for each message type. 

This commit introduces specific outbound data types for each
message type for reusability. For example, `poll_widget.ts` reuses
these types.
This commit is contained in:
Junyao Chen 2023-08-25 23:06:35 -04:00 committed by Tim Abbott
parent 721fbb1bed
commit 6840715222
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
web/shared/src/poll_data.ts
View File

@ -31,7 +31,9 @@ export type WidgetData = {
};
export type InboundData = Record<string, unknown> & {type: string};
export type NewOptionOutboundData = {type: string; idx: number; option: string};
export type QuestionOutboundData = {type: string; question: string};
export type VoteOutboundData = {type: string; key: string; vote: number};
export type PollHandle = {
// Add generic key property to allow string indexing on PollHandle type in `handle_event` method.
[key: string]: {
@ -39,15 +41,15 @@ export type PollHandle = {
inbound: (sender_id: number, data: InboundData) => void;
};
new_option: {
outbound: (option: string) => {type: string; idx: number; option: string};
outbound: (option: string) => NewOptionOutboundData;
inbound: (sender_id: number | string, data: InboundData) => void;
};
question: {
outbound: (question: string) => {type: string; question: string} | undefined;
outbound: (question: string) => QuestionOutboundData | undefined;
inbound: (sender_id: number, data: InboundData) => void;
};
vote: {
outbound: (key: string) => {type: string; key: string; vote: number};
outbound: (key: string) => VoteOutboundData;
inbound: (sender_id: number, data: InboundData) => void;
};
};