updated types and documentation on key event payloads

floodfx · Feb 1, 2022 · 87561cf · 87561cf
1 parent d04a14d
commit 87561cf
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/server/socket/types.ts b/src/server/socket/types.ts
@@ -79,8 +79,11 @@ export type PhxFormPayload = PhxEventPayload<"form", { value: string }> & PhxEve
 // See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
 // for all the string values for the key that kicked off the event
 //{type: "keyup", event: "key_update", value: {key: "ArrowUp"}}
-export type PhxKeyUpPayload = PhxEventPayload<"keyup", { value: { key: string } }>;
-export type PhxKeyDownPayload = PhxEventPayload<"keydown", { value: { key: string } }>;
+// {type: "keyup", event: "key_update", value: {key: "ArrowUp", value: ""}}
+// {type: "keyup", event: "key_update", value: {key: "ArrowUp", value: "foo"}}
+// NOTE: these payloads are the same for phx-window-key* events and phx-key* events
+export type PhxKeyUpPayload = PhxEventPayload<"keyup", { value: { key: string, value?: string } }>;
+export type PhxKeyDownPayload = PhxEventPayload<"keydown", { value: { key: string, value?: string } }>;
 
 
 // export type PhxClickEvent = PhxIncomingMessage<PhxClickPayload>