@livestore/webmesh 0.0.0-snapshot-1d99fea7d2ce2c7a5d9ed0a3752f8a7bda6bc3db → 0.0.0-snapshot-aed277ba0960f72b8d464508961ab4aec1881230
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -1
- package/dist/.tsbuildinfo +1 -1
- package/dist/channel/message-channel-internal.d.ts +26 -0
- package/dist/channel/message-channel-internal.d.ts.map +1 -0
- package/dist/channel/message-channel-internal.js +202 -0
- package/dist/channel/message-channel-internal.js.map +1 -0
- package/dist/channel/message-channel.d.ts +21 -19
- package/dist/channel/message-channel.d.ts.map +1 -1
- package/dist/channel/message-channel.js +125 -162
- package/dist/channel/message-channel.js.map +1 -1
- package/dist/channel/proxy-channel.d.ts +2 -2
- package/dist/channel/proxy-channel.d.ts.map +1 -1
- package/dist/channel/proxy-channel.js +7 -5
- package/dist/channel/proxy-channel.js.map +1 -1
- package/dist/common.d.ts +8 -4
- package/dist/common.d.ts.map +1 -1
- package/dist/common.js +2 -1
- package/dist/common.js.map +1 -1
- package/dist/mesh-schema.d.ts +23 -1
- package/dist/mesh-schema.d.ts.map +1 -1
- package/dist/mesh-schema.js +21 -2
- package/dist/mesh-schema.js.map +1 -1
- package/dist/node.d.ts +12 -1
- package/dist/node.d.ts.map +1 -1
- package/dist/node.js +39 -9
- package/dist/node.js.map +1 -1
- package/dist/node.test.d.ts +1 -1
- package/dist/node.test.d.ts.map +1 -1
- package/dist/node.test.js +256 -124
- package/dist/node.test.js.map +1 -1
- package/dist/websocket-connection.d.ts +1 -2
- package/dist/websocket-connection.d.ts.map +1 -1
- package/dist/websocket-connection.js +5 -4
- package/dist/websocket-connection.js.map +1 -1
- package/package.json +3 -3
- package/src/channel/message-channel-internal.ts +337 -0
- package/src/channel/message-channel.ts +177 -308
- package/src/channel/proxy-channel.ts +238 -230
- package/src/common.ts +3 -1
- package/src/mesh-schema.ts +20 -2
- package/src/node.test.ts +367 -150
- package/src/node.ts +68 -12
- package/src/websocket-connection.ts +83 -79
package/README.md
CHANGED
|
@@ -2,4 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
Webmesh is a library for connecting multiple nodes (windows/tabs, workers, threads, ...) in a network-like topology. It helps to establish end-to-end communication channels between nodes either by proxying messages via hop nodes or by establishing an end-to-end `MessageChannel` with support for transferable objects (e.g. `Uint8Array`) when possible.
|
|
4
4
|
|
|
5
|
-
It's used in LiveStore as the foundation for the LiveStore devtools protocol communication.
|
|
5
|
+
It's used in LiveStore as the foundation for the LiveStore devtools protocol communication.
|
|
6
|
+
|
|
7
|
+
## Available connection implementations
|
|
8
|
+
|
|
9
|
+
- `MessageChannel`
|
|
10
|
+
- `BroadcastChannel` (both web and Node.js)
|
|
11
|
+
- `WebSocket`
|
|
12
|
+
- `window.postMessage`
|
|
13
|
+
|
|
14
|
+
## Important notes
|
|
15
|
+
|
|
16
|
+
- Each node name needs to be unique in the network.
|
|
17
|
+
- The node name is also used as a "tie-breaker" as part of the messaging protocol.
|
|
18
|
+
|
|
19
|
+
## Inspiration
|
|
20
|
+
|
|
21
|
+
- Elixir `Distribution` / OTP
|
|
22
|
+
- https://elixirschool.com/en/lessons/advanced/otp_distribution
|
|
23
|
+
- https://serokell.io/blog/elixir-otp-guide
|