haystack-nclient - npm Package Compare versions

Comparing version 3.0.14 to 3.0.15

dist/client/Client.d.ts

@@ -170,2 +170,9 @@ import { HNamespace, HVal, HaysonVal } from 'haystack-core';
     fetchVal<T extends HVal>(resource: RequestInfo, body?: HVal | HaysonVal, options?: RequestInit): Promise<T>;
+    /**
+     * Closes the client.
+     *
+     * Warning: this will close any watches associated with this client. Any
+     * watches may throw an error if they are used after being closed.
+     */
+    close(): Promise<void>;
 }

dist/client/finAuthFetch.d.ts

 import { FetchMethod } from './fetchVal';
 /**
- * An enhanced fetch API for a pluggable authentication mechanism
+ * An enhanced fetch API for a pluggable authentication mechanism.
  *
@@ -8,7 +8,7 @@ * Transparently handles pre-authentication, authentication fault detection, authentication, and
  *
- * This fetch function will utilize the finCsrfFetch function internally to execute the request
+ * By default, this fetch function will utilize the finCsrfFetch function internally to execute the request.
  *
- * Example
+ * For example...
+ *
  * ```typescript
- *
  * const result = finAuthFetch(request, {
@@ -15,0 +15,0 @@ * 		authenticator: {

dist/client/watches/Watch.d.ts

@@ -121,2 +121,12 @@ import { HGrid, HDict } from 'haystack-core';
     /**
+     * Close all watches for the given subject.
+     *
+     * Please note, this method doesn't normally need to be called
+     * and is designed to be used internally. If you want
+     * to close a watch then please just call `Watch.#close()` instead.
+     *
+     * @param subject The subject to close watches for.
+     */
+    static close(subject: Subject): Promise<void>;
+    /**
      * Add records to watch.
@@ -123,0 +133,0 @@ *

dist/client/watches/WatchService.d.ts

@@ -31,2 +31,6 @@ import { HGrid } from 'haystack-core';
     make(display: string, ids: Ids, grid?: HGrid): Promise<Watch>;
+    /**
+     * Closes any open watches for this watch service.
+     */
+    close(): Promise<void>;
 }

package.json

@@ -13,3 +13,3 @@ {
 	"homepage": "https://github.com/j2inn/haystack-nclient",
-	"version": "3.0.14",
+	"version": "3.0.15",
 	"module": "dist/index.es.js",
@@ -16,0 +16,0 @@ "main": "dist/index.js",

No alert changes

Improved metrics

Total package byte prevSize

490403

increased by0.68%

Lines of code

12060

increased by0.81%

No dependency changes