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

package/dist/index.d.ts

@@ -1,8 +1,16 @@
+/**
+ * A `NetworkAdapter` which uses [`MessageChannel`](https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel)
+ * to communicate with other peers. This is useful for communicating between
+ * browser tabs and web workers (including shared workers).
+ *
+ * @module
+ */
 import { type Message, NetworkAdapter, type PeerId } from "@automerge/automerge-repo";
 import { MessagePortRef } from "./MessagePortRef.js";
 export declare class MessageChannelNetworkAdapter extends NetworkAdapter {
     #private;
     channels: {};
+    /** @hidden */
     messagePortRef: MessagePortRef;
     constructor(messagePort: MessagePort, config?: MessageChannelNetworkAdapterConfig);
     connect(peerId: PeerId): void;
@@ -10,7 +18,7 @@ export declare class MessageChannelNetworkAdapter extends NetworkAdapter {
     announceConnection(peerId: PeerId): void;
     disconnect(): void;
 }
-interface MessageChannelNetworkAdapterConfig {
+export interface MessageChannelNetworkAdapterConfig {
     /**
      * This is an optional parameter to use a weak ref to reference the message port that is passed to
      * the adapter. This option is useful when using a message channel with a shared worker. If you
@@ -21,5 +29,4 @@ interface MessageChannelNetworkAdapterConfig {
      */
     useWeakRef?: boolean;
 }
-export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,cAAc,EACd,KAAK,MAAM,EAEZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAOpD,qBAAa,4BAA6B,SAAQ,cAAc;;IAC9D,QAAQ,KAAK;IACb,cAAc,EAAE,cAAc,CAAA;gBAI5B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,kCAAuC;IAWjD,OAAO,CAAC,MAAM,EAAE,MAAM;IAgEtB,IAAI,CAAC,OAAO,EAAE,OAAO;IAmBrB,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAQjC,UAAU;CAIX;AAED,UAAU,kCAAkC;IAC1C;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EACL,KAAK,OAAO,EACZ,cAAc,EACd,KAAK,MAAM,EAEZ,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAOpD,qBAAa,4BAA6B,SAAQ,cAAc;;IAC9D,QAAQ,KAAK;IACb,cAAc;IACd,cAAc,EAAE,cAAc,CAAA;gBAI5B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,kCAAuC;IAWjD,OAAO,CAAC,MAAM,EAAE,MAAM;IAgEtB,IAAI,CAAC,OAAO,EAAE,OAAO;IAmBrB,kBAAkB,CAAC,MAAM,EAAE,MAAM;IAQjC,UAAU;CAIX;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB"}

package/dist/index.js

@@ -1,3 +1,10 @@
+/**
+ * A `NetworkAdapter` which uses [`MessageChannel`](https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel)
+ * to communicate with other peers. This is useful for communicating between
+ * browser tabs and web workers (including shared workers).
+ *
+ * @module
+ */
 import { NetworkAdapter, } from "@automerge/automerge-repo";
 import { StrongMessagePortRef } from "./StrongMessagePortRef.js";
 import { WeakMessagePortRef } from "./WeakMessagePortRef.js";
@@ -5,6 +12,7 @@ import debug from "debug";
 const log = debug("automerge-repo:messagechannel");
 export class MessageChannelNetworkAdapter extends NetworkAdapter {
     channels = {};
+    /** @hidden */
     messagePortRef;
     #startupComplete = false;
     constructor(messagePort, config = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-network-messagechannel",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "MessageChannel network adapter for Automerge Repo",
   "repository": "https://github.com/automerge/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -14,7 +14,7 @@
     "test": "mocha --no-warnings --experimental-specifier-resolution=node --exit"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.1"
+    "@automerge/automerge-repo": "^1.0.3"
   },
   "peerDependencies": {
     "@automerge/automerge": "^2.1.0"
@@ -30,5 +30,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9c1eb5fb161eac78a71a6e866b30879994278d22"
+  "gitHead": "4f3391cd33cd0cabfebde48dbd56749ddb6922da"
 }

package/src/index.ts

@@ -1,3 +1,10 @@
+/**
+ * A `NetworkAdapter` which uses [`MessageChannel`](https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel)
+ * to communicate with other peers. This is useful for communicating between
+ * browser tabs and web workers (including shared workers).
+ *
+ * @module
+ */
 import {
   type Message,
   NetworkAdapter,
@@ -13,6 +20,7 @@ const log = debug("automerge-repo:messagechannel")
 
 export class MessageChannelNetworkAdapter extends NetworkAdapter {
   channels = {}
+  /** @hidden */
   messagePortRef: MessagePortRef
   #startupComplete = false
 
@@ -126,7 +134,7 @@ export class MessageChannelNetworkAdapter extends NetworkAdapter {
   }
 }
 
-interface MessageChannelNetworkAdapterConfig {
+export interface MessageChannelNetworkAdapterConfig {
   /**
    * This is an optional parameter to use a weak ref to reference the message port that is passed to
    * the adapter. This option is useful when using a message channel with a shared worker. If you

package/typedoc.json

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