@webreflection/bindings 0.0.0 → 0.0.1

package/README.md

@@ -5,24 +5,26 @@ A (soon to be) collection of bindings for various scenarios.
 ### Example
 
 ```js
-import bindings from '@webreflection/bindings/port';
+import bindings from '@webreflection/bindings/message-port';
 
 const { port1, port2 } = new MessageChannel;
 
 // expose bindings the remote can invoke
 // the `remote` itself can invoke (asynchronously)
 // bindings exposed via the other port
-const remote = bindings(port1, {
-  log(...values) {
-    console.log(...values);
-  }
-});
+const remote = /** @type {{sum: (a:number, b:number) => Promise<number>}} */(
+  bindings(port1, {
+    log(...values) {
+      console.log(...values);
+    }
+  })
+);
 
 // assuming this is an iframe
 parent.postMessage(null, '*', [port2]);
 
 // later on ...
-const value = await remote.doThings(1, 2, 3);
+const value = await remote.sum(1, 2);
 ```
 
 The remote counterpart can use or expose bindings in a similar way, this module just orchestrate a reliable way to invoke exposed APIs via `postMessage` dances.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@webreflection/bindings",
-  "version": "0.0.0",
-  "description": "",
+  "version": "0.0.1",
+  "description": "A (soon to be) collection of bindings for various scenarios.",
   "exports": {
     "./message-port": "./src/message-port.js"
   },
@@ -17,5 +17,15 @@
   "dependencies": {
     "@webreflection/utils": "^0.3.6",
     "next-resolver": "^0.2.0"
-  }
+  },
+  "main": "index.js",
+  "devDependencies": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/WebReflection/bindings.git"
+  },
+  "bugs": {
+    "url": "https://github.com/WebReflection/bindings/issues"
+  },
+  "homepage": "https://github.com/WebReflection/bindings#readme"
 }

package/src/message-port.js

@@ -7,7 +7,7 @@ const [next, resolve] = nextResolver();
  * Creates a proxy that can be used to call methods remotely via the port.
  * @param {MessagePort} port - The port to use for communication.
  * @param {Record<string, (...args: any[]) => Promise<any>>} bindings - The bindings to use for the methods.
- * @returns {Record<string, (...args: any[]) => Promise<any>>}
+ * @returns {unknown}
  */
 export default (port, bindings) => {
   port.onmessage = async ({ data: [exec, id, name, args] }) => {