Un-deprecate the NetworkAdapter class (#310)

automerge · Mar 19, 2024 · 1167268 · 1167268
1 parent 217c369
commit 1167268
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/packages/automerge-repo/src/network/NetworkAdapter.ts b/packages/automerge-repo/src/network/NetworkAdapter.ts
@@ -7,12 +7,14 @@ import { Message } from "./messages.js"
 import { NetworkAdapterInterface } from "./NetworkAdapterInterface.js"
 
 /** An interface representing some way to connect to other peers
- * @deprecated use {@link NetworkAdapterInterface}
  *
  * @remarks
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
+ *
+ * This utility class can be used as a base to build a custom network adapter. It
+ * is most useful as a simple way to add the necessary event emitter functionality
  */
 export abstract class NetworkAdapter
   extends EventEmitter<NetworkAdapterEvents>

diff --git a/packages/automerge-repo/src/network/NetworkAdapterInterface.ts b/packages/automerge-repo/src/network/NetworkAdapterInterface.ts
@@ -22,8 +22,13 @@ export interface PeerMetadata {
  * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
  * Because the network may take some time to be ready the {@link Repo} will wait
  * until the adapter emits a `ready` event before it starts trying to use it
+ *
+ * The {@link NetworkAdapter} is an abstract class that can be used as a base to build a
+ * custom network adapter. It is most useful as a simple way to add the necessary event
+ * emitter functionality
  */
-export interface NetworkAdapterInterface extends EventEmitter<NetworkAdapterEvents> {
+export interface NetworkAdapterInterface
+  extends EventEmitter<NetworkAdapterEvents> {
   peerId?: PeerId
   peerMetadata?: PeerMetadata