feat(services): Services now uses join/leave instead of start/stop

aholstenson · Jun 9, 2021 · 845e5f5 · 845e5f5
1 parent eee9bdc
commit 845e5f5
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -126,8 +126,8 @@ services.onUnavailable(service => console.log(service.id, 'is no longer availabl
 // Join the network
 await net.join();
 
-// Start the services on top of the network
-await services.start();
+// Join the services on top of the network
+await services.join();
 
 // Register a service as a plain object
 const handle = services.register({

diff --git a/packages/services/README.md b/packages/services/README.md
@@ -28,8 +28,8 @@ services.onServiceUnavailable(service => console.log(service.id, 'is no longer a
 // Join the network
 await net.join();
 
-// Start the services on top of the network
-await services.start();
+// Join the services layer on top of the network
+await services.join();
 
 // Register a service as a plain object
 const handle = services.register({

diff --git a/packages/services/src/Services.ts b/packages/services/src/Services.ts
@@ -108,22 +108,22 @@ export class Services {
 
 
 	/**
-	 * Start the services allowing access to remote services.
+	 * Join the services layer allowing access to remote services.
 	 *
 	 * @returns
 	 *   promise that resolves when services have started
 	 */
-	public start(): Promise<void> {
+	public join(): Promise<void> {
 		return this.exchange.join();
 	}
 
 	/**
-	 * Stop the services no longer allowing access to remote services.
+	 * Leave the services no longer allowing access to remote services.
 	 *
 	 * @returns
 	 *   promise that resolves when services have stopped
 	 */
-	public stop(): Promise<void> {
+	public leave(): Promise<void> {
 		return this.exchange.leave();
 	}