fix: re-expose model.send for custom messages (#146)

manzt · Jun 19, 2023 · 774f139 · 774f139
1 parent c2a9d9b
commit 774f139
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/.changeset/giant-trainers-wink.md b/.changeset/giant-trainers-wink.md
@@ -0,0 +1,6 @@
+---
+"anywidget": patch
+"@anywidget/types": patch
+---
+
+fix: re-expose model.send for custom messages
diff --git a/packages/anywidget/src/widget.js b/packages/anywidget/src/widget.js
@@ -108,22 +108,15 @@ async function load_esm(esm) {
  * added by the user-defined render.
  */
 function extract_context(view) {
+	/** @type {import("@anywidget/types").AnyModel} */
 	let model = {
-		/** @param {string} name */
 		get: view.model.get.bind(view.model),
 		set: view.model.set.bind(view.model),
 		save_changes: view.model.save_changes.bind(view.model),
-		/**
-		 * @param {string} name
-		 * @param {any} callback
-		 */
+		send: view.model.send.bind(view.model),
 		on(name, callback) {
 			view.model.on(name, callback, view);
 		},
-		/**
-		 * @param {string} name
-		 * @param {any} callback
-		 */
 		off(name, callback) {
 			view.model.off(name, callback, view);
 		},

diff --git a/packages/types/index.d.ts b/packages/types/index.d.ts
@@ -13,12 +13,13 @@ interface EventHandler {
 export interface AnyModel<T extends ObjectHash = ObjectHash> {
 	get<K extends keyof T>(key: K): T[K];
 	set<K extends keyof T>(key: K, value: T[K]): void;
+	off(eventName?: string | null, callback?: EventHandler | null): void;
+	on(eventName: string, callback: EventHandler): void;
 	save_changes(): void;
-    on(eventName: string, callback: EventHandler): void;
-    off(eventName?: string | null, callback?: EventHandler | null): void;
+	send(content: any, callbacks?: any, buffers?: ArrayBuffer[] | ArrayBufferView[]): void;
 }
 
-export interface RenderContext<Model> {
+export interface RenderContext<Model extends AnyModel> {
 	model: Model;
 	el: HTMLElement;
 }