@contrast/common 1.20.1 → 1.21.0

package/lib/types.d.ts

@@ -278,6 +278,15 @@ export interface Messages extends EventEmitter {
     on(event: Event.SERVER_SETTINGS_UPDATE, listener: (msg: Record<string, any>) => void): this;
     on(event: Event, listener: (...args: any[]) => void): this;
 }
+/**
+ * IntentionalError is used when code wants to cause no-instrumentation in cases
+ * when no actual programmatic error has occurred. E.g., if the api is enabled
+ * but not all required api settings are present.
+ *
+ * It is expected that the code throwing an IntentionalError logs any pertinent
+ * information because the try/catch block will not output any error or message
+ * when it catches an IntentionalError.
+ */
 export declare class IntentionalError extends Error {
 }
 //# sourceMappingURL=types.d.ts.map

package/lib/types.js

@@ -15,6 +15,15 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IntentionalError = void 0;
+/**
+ * IntentionalError is used when code wants to cause no-instrumentation in cases
+ * when no actual programmatic error has occurred. E.g., if the api is enabled
+ * but not all required api settings are present.
+ *
+ * It is expected that the code throwing an IntentionalError logs any pertinent
+ * information because the try/catch block will not output any error or message
+ * when it catches an IntentionalError.
+ */
 class IntentionalError extends Error {
 }
 exports.IntentionalError = IntentionalError;

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;AAqUH,MAAa,gBAAiB,SAAQ,KAAK;CAAI;AAA/C,4CAA+C"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;AAqUH;;;;;;;;GAQG;AACH,MAAa,gBAAiB,SAAQ,KAAK;CAAG;AAA9C,4CAA8C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/common",
-  "version": "1.20.1",
+  "version": "1.21.0",
   "description": "Shared constants and utilities for all Contrast Agent modules",
   "license": "UNLICENSED",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",