daemon.connect now accepts connection timeout in milliseconds.

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ## [14.2.1]
 ### Changed
-- `daemon.connect()` now returns a rejected promise on failure to connect instead of throwing an uncaught exception
+- [`daemon.connect()`](./src/daemon/README.md#daemonconnecturl-string-timeoutms-number) now returns a rejected promise on failure to connect instead of throwing an uncaught exception
+- [`daemon.connect()`](./src/daemon/README.md#daemonconnecturl-string-timeoutms-number) now accepts connection timeout in milliseconds.
 
 ## [14.2.0]
 ### Note

src/daemon/README.md

@@ -12,11 +12,11 @@ const {getDaemon} = require("chia-agent");
 const daemon = getDaemon();
 ```
 
-## daemon.connect
+## daemon.connect(url?: string, timeoutMs?: number)
 
 Connect to chia daemon via websocket.
 
-If you don't pass any argument, it tries to connect to an url specified in chia configuration file.  
+If you don't pass any argument, it tries to connect to an url specified in chia configuration file.
 (Note: `chia-agent` cares environment variable `CHIA_ROOT`)
 ```js
 await daemon.connect();
@@ -27,7 +27,17 @@ You can specify chia daemon url to connect to.
 await daemon.connect("wss://hostname:port");
 ```
 
-## daemon.close
+### `url`
+Optional. A URL to the daemon server to connect.  
+The default url is `wss://{DAEMON_HOST}:{DAEMON_PORT}` where
+`DAEMON_HOST` is `ui.daemon_host` and `DAEMON_PORT`  is `ui.daemon_port` in `$CHIA_ROOT/config/config.yaml`  
+(Usually `wss://localhost:55400`)
+
+### `timeoutMs`
+Optional. Connection timeout in milliseconds.  
+The default value is `50000`.
+
+## daemon.close()
 
 Close active connection.  
 If no active connection found, it silently returns without error.
@@ -42,7 +52,7 @@ daemon.addEventListener("close", () => {
 });
 ```
 
-## daemon.subscribe
+## daemon.subscribe(service: string)
 
 Start to monitor message channel via websocket.
 

src/daemon/connection.ts

@@ -50,6 +50,7 @@ export function open(url: string, timeoutMs?: number): Promise<{ ws: WS, openEve
         resolve({ws, openEvent});
       }
     };
+
     ws.onerror = (err) => reject(err);
   });
 }

src/daemon/index.ts

@@ -88,8 +88,9 @@ class Daemon {
   /**
    * Connect to local daemon via websocket.
    * @param daemonServerURL
+   * @param timeoutMs
    */
-  public async connect(daemonServerURL?: string): Promise<boolean> {
+  public async connect(daemonServerURL?: string, timeoutMs?: number): Promise<boolean> {
     if(!daemonServerURL){
       const config = getConfig();
       const daemonHost = config["/ui/daemon_host"];
@@ -107,7 +108,7 @@ class Daemon {
 
     getLogger().debug(`Opening websocket connection to ${daemonServerURL}`);
 
-    const result = await open(daemonServerURL);
+    const result = await open(daemonServerURL, timeoutMs);
     this._socket = result.ws;
     this._socket.onerror = this.onError;
     this._socket.onmessage = this.onMessage;