@automerge/automerge-repo-network-broadcastchannel 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -1,3 +1,18 @@
+/**
+ *
+ * A `NetworkAdapter` which uses [BroadcastChannel](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel)
+ * to communicate with other peers in the same browser tab. This is a bit of a
+ * hack because `NetworkAdapter`s are supposed to be used as point to
+ * point communication channels. To get around this the {@link BroadcastChannelNetworkAdapter}
+ * broadcasts messages to all peers and then filters out messages not intended
+ * for the current peer. This is quite inefficient as messages get duplicated
+ * for every peer in the tab, but as it's all local communication anyway
+ * it's not too bad. If efficiency is becoming an issue you can switch to
+ * `automerge-repo-network-messagechannel`.
+ *
+ * @module
+ *
+ */
 import { NetworkAdapter, PeerId, Message } from "@automerge/automerge-repo";
 export type BroadcastChannelNetworkAdapterOptions = {
     channelName: string;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,MAAM,EACN,OAAO,EACR,MAAM,2BAA2B,CAAA;AAElC,MAAM,MAAM,qCAAqC,GAAG;IAClD,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,qBAAa,8BAA+B,SAAQ,cAAc;;gBAKpD,OAAO,CAAC,EAAE,qCAAqC;IAK3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAoDtB,IAAI,CAAC,OAAO,EAAE,OAAO;IAcrB,UAAU;CAIX"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAEL,cAAc,EACd,MAAM,EACN,OAAO,EACR,MAAM,2BAA2B,CAAA;AAGlC,MAAM,MAAM,qCAAqC,GAAG;IAClD,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,qBAAa,8BAA+B,SAAQ,cAAc;;gBAKpD,OAAO,CAAC,EAAE,qCAAqC;IAK3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAoDtB,IAAI,CAAC,OAAO,EAAE,OAAO;IAcrB,UAAU;CAIX"}

package/dist/index.js

@@ -1,3 +1,18 @@
+/**
+ *
+ * A `NetworkAdapter` which uses [BroadcastChannel](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel)
+ * to communicate with other peers in the same browser tab. This is a bit of a
+ * hack because `NetworkAdapter`s are supposed to be used as point to
+ * point communication channels. To get around this the {@link BroadcastChannelNetworkAdapter}
+ * broadcasts messages to all peers and then filters out messages not intended
+ * for the current peer. This is quite inefficient as messages get duplicated
+ * for every peer in the tab, but as it's all local communication anyway
+ * it's not too bad. If efficiency is becoming an issue you can switch to
+ * `automerge-repo-network-messagechannel`.
+ *
+ * @module
+ *
+ */
 import { NetworkAdapter, } from "@automerge/automerge-repo";
 export class BroadcastChannelNetworkAdapter extends NetworkAdapter {
     #broadcastChannel;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-broadcastchannel",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "BroadcastChannel network adapter for Automerge Repo",
   "repository": "https://github.com/automerge/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -17,7 +17,7 @@
     "@automerge/automerge": "^2.1.0"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.1"
+    "@automerge/automerge-repo": "^1.0.3"
   },
   "watch": {
     "build": {
@@ -30,5 +30,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9c1eb5fb161eac78a71a6e866b30879994278d22"
+  "gitHead": "4f3391cd33cd0cabfebde48dbd56749ddb6922da"
 }

package/src/index.ts

@@ -1,3 +1,19 @@
+/**
+ * 
+ * A `NetworkAdapter` which uses [BroadcastChannel](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel)
+ * to communicate with other peers in the same browser tab. This is a bit of a
+ * hack because `NetworkAdapter`s are supposed to be used as point to 
+ * point communication channels. To get around this the {@link BroadcastChannelNetworkAdapter}
+ * broadcasts messages to all peers and then filters out messages not intended
+ * for the current peer. This is quite inefficient as messages get duplicated
+ * for every peer in the tab, but as it's all local communication anyway
+ * it's not too bad. If efficiency is becoming an issue you can switch to
+ * `automerge-repo-network-messagechannel`.
+ *
+ * @module
+ *
+ */
+
 import {
   NetworkAdapterMessage,
   NetworkAdapter,
@@ -5,6 +21,7 @@ import {
   Message,
 } from "@automerge/automerge-repo"
 
+
 export type BroadcastChannelNetworkAdapterOptions = {
   channelName: string
 }

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "extends": "../../typedoc.base.json",
+    "entryPoints": ["src/index.ts"],
+    "readme": "none"
+}