@microsoft/applicationinsights-core-js 3.3.5-nightly3.2501-07 → 3.3.5-nightly3.2501-08

package/types/applicationinsights-core-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.3.5-nightly3.2501-07
+ * Microsoft Application Insights Core Javascript SDK, 3.3.5-nightly3.2501-08
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -81,10 +81,10 @@ export declare type ActiveStatus = number | eActiveStatus;
 
 /**
  * Trys to add an event handler for the specified event to the window, body and document
- * @param eventName - {string} - The name of the event
- * @param callback - {any} - The callback function that needs to be executed for the given event
+ * @param eventName  - The name of the event
+ * @param callback  - The callback function that needs to be executed for the given event
  * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
- * @returns {boolean} - true if the handler was successfully added
+ * @returns - true if the handler was successfully added
  */
 export declare function addEventHandler(eventName: string, callback: any, evtNamespace?: string | string[] | null): boolean;
 
@@ -283,7 +283,7 @@ export declare class AppInsightsCore<CfgType extends IConfiguration = IConfigura
     /**
      * Watches and tracks changes for accesses to the current config, and if the accessed config changes the
      * handler will be recalled.
-     * @param handler
+     * @param handler - The watcher handler to call when the config changes
      * @returns A watcher handler instance that can be used to remove itself when being unloaded
      */
     onCfgChange(handler: WatcherFunction<CfgType>): IUnloadHook;
@@ -593,7 +593,7 @@ export declare function createCustomDomEvent(eventName: string, details?: any):
 export declare function createDynamicConfig<T = IConfiguration>(config: T, defaultConfig?: IConfigDefaults<T>, logger?: IDiagnosticLogger, inPlace?: boolean): IDynamicConfigHandler<T>;
 
 /**
- * Create an enum style object which has both the key \=> value and value \=> key mappings
+ * Create an enum style object which has both the key \=\> value and value \=\> key mappings
  * @param values - The values to populate on the new object
  * @returns
  */
@@ -632,7 +632,7 @@ export declare function createUnloadHandlerContainer(): IUnloadHandlerContainer;
 export declare function createUnloadHookContainer(): IUnloadHookContainer;
 
 /**
- * Create a 2 index map that maps an enum's key and value to the defined map value, X["key"] \=> mapValue and X[0] \=> mapValue.
+ * Create a 2 index map that maps an enum's key and value to the defined map value, X["key"] \=\> mapValue and X[0] \=\> mapValue.
  * Generic values
  * - E = the const enum type (typeof eRequestHeaders);
  * - V = Identifies the valid values for the keys, this should include both the enum numeric and string key of the type. The
@@ -651,9 +651,9 @@ export { deepFreeze }
 /**
  * Removes an event handler for the specified event
  * @param Object - to remove the event from
- * @param eventNameWithoutOn - {string} - The name of the event, with optional namespaces or just the namespaces,
+ * @param eventNameWithoutOn  - The name of the event, with optional namespaces or just the namespaces,
  * such as "click", "click.mynamespace" or ".mynamespace"
- * @param handlerRef - {any} - The callback function that needs to be removed from the given event, when using a
+ * @param handlerRef - The callback function that needs to be removed from the given event, when using a
  * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
  * otherwise this will only remove events with this specific handler.
  * @param useCapture - [Optional] Defaults to false
@@ -670,28 +670,28 @@ export declare class DiagnosticLogger implements IDiagnosticLogger {
     /**
      * 0: OFF (default)
      * 1: CRITICAL
-     * 2: >= WARNING
+     * 2: \>= WARNING
      */
     consoleLoggingLevel(): number;
     /**
      * This method will throw exceptions in debug mode or attempt to log the error as a console warning.
-     * @param severity - {LoggingSeverity} - The severity of the log message
-     * @param message - {_InternalLogMessage} - The log message.
+     * @param severity  - The severity of the log message
+     * @param message - The log message.
      */
     throwInternal(severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
     /**
      * This will write a debug message to the console if possible
-     * @param message - {string} - The debug message
+     * @param message - The debug message
      */
     debugToConsole(message: string): void;
     /**
      * This will write a warning to the console if possible
-     * @param message - {string} - The warning message
+     * @param message  - The warning message
      */
     warnToConsole(message: string): void;
     /**
      * This will write an error to the console if possible
-     * @param message - {string} - The warning message
+     * @param message - The warning message
      */
     errorToConsole(message: string): void;
     /**
@@ -700,8 +700,8 @@ export declare class DiagnosticLogger implements IDiagnosticLogger {
     resetInternalMessageCount(): void;
     /**
      * Logs a message to the internal queue.
-     * @param severity - {LoggingSeverity} - The severity of the log message
-     * @param message - {_InternalLogMessage} - The message to log.
+     * @param severity - The severity of the log message
+     * @param message - The message to log.
      */
     logInternalMessage(severity: LoggingSeverity, message: _InternalLogMessage): void;
     /**
@@ -930,9 +930,9 @@ export declare type EnumValue<E = any> = EnumCls<E>;
 /**
  * Removes an event handler for the specified event
  * @param Object - to remove the event from
- * @param eventName - {string} - The name of the event, with optional namespaces or just the namespaces,
+ * @param eventName - The name of the event, with optional namespaces or just the namespaces,
  * such as "click", "click.mynamespace" or ".mynamespace"
- * @param handlerRef - {any} - The callback function that needs to be removed from the given event, when using a
+ * @param handlerRef - The callback function that needs to be removed from the given event, when using a
  * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
  * otherwise this will only remove events with this specific handler.
  * @param evtNamespace - [Optional] Additional namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace,
@@ -1593,8 +1593,8 @@ export declare interface IConfiguration {
      */
     enablePerfMgr?: boolean;
     /**
-     * [Optional] Callback function that will be called to create a the IPerfManager instance when required and ```enablePerfMgr```
-     * is enabled, this enables you to override the default creation of a PerfManager() without needing to ```setPerfMgr()```
+     * [Optional] Callback function that will be called to create a the IPerfManager instance when required and `enablePerfMgr`
+     * is enabled, this enables you to override the default creation of a PerfManager() without needing to `setPerfMgr()`
      * after initialization.
      */
     createPerfMgr?: (core: IAppInsightsCore, notificationManager: INotificationManager) => IPerfManager;
@@ -1824,7 +1824,7 @@ export declare interface IDiagnosticLogger {
     throwInternal(severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
     /**
      * This will write a debug message to the console if possible
-     * @param message - {string} - The debug message
+     * @param message - The debug message
      */
     debugToConsole?(message: string): void;
     /**
@@ -2065,7 +2065,7 @@ export declare interface IFeatureOptInDetails {
     /**
      * Identifies configuration override values when given feature is enabled
      * NOTE: should use flat string for fields, for example, if you want to set value for extensionConfig.Ananlytics.disableAjaxTrackig in configurations,
-     * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: {["extensionConfig.Analytics.disableAjaxTrackig"]:1}
+     * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: \{["extensionConfig.Analytics.disableAjaxTrackig"]:1\}
      * Default: undefined
      */
     onCfg?: {
@@ -2074,7 +2074,7 @@ export declare interface IFeatureOptInDetails {
     /**
      * Identifies configuration override values when given feature is disabled
      * NOTE: should use flat string for fields, for example, if you want to set value for extensionConfig.Ananlytics.disableAjaxTrackig in configurations,
-     * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: {["extensionConfig.Analytics.disableAjaxTrackig"]:1}
+     * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: \{["extensionConfig.Analytics.disableAjaxTrackig"]:1\}
      * Default: undefined
      */
     offCfg?: {
@@ -2752,9 +2752,9 @@ export declare interface _ISendPostMgrConfig {
      */
     disableCredentials?: boolean;
     /**
-     * Identifies if XMLHttpRequest or XDomainRequest (for IE < 9) should be used
+     * Identifies if `XMLHttpRequest` or `XDomainRequest` (for IE version before 9) should be used
      * Default: false
-     * @since version after 3.1.0
+     * @since 3.1.1
      */
     disableXhr?: boolean;
     /**
@@ -3194,8 +3194,8 @@ export declare type LoggingSeverity = number | eLoggingSeverity;
 /**
  * Logs a message to the internal queue.
  * @param logger - The Diagnostic Logger instance to use.
- * @param severity - {LoggingSeverity} - The severity of the log message
- * @param message - {_InternalLogMessage} - The message to log.
+ * @param severity  - The severity of the log message
+ * @param message - The message to log.
  */
 export declare function _logInternalMessage(logger: IDiagnosticLogger, severity: LoggingSeverity, message: _InternalLogMessage): void;
 
@@ -3532,8 +3532,8 @@ export declare class ProcessTelemetryContext implements IProcessTelemetryContext
  *
  * Special ES3 Notes:
  * Updates (setting) of direct property values on the target or indirectly on the source object WILL NOT WORK PROPERLY, updates to the
- * properties of "referenced" object will work (target.context.newValue = 10 => will be reflected in the source.context as it's the
- * same object). ES3 Failures: assigning target.myProp = 3 -> Won't change source.myProp = 3, likewise the reverse would also fail.
+ * properties of "referenced" object will work (target.context.newValue = 10 =\> will be reflected in the source.context as it's the
+ * same object). ES3 Failures: assigning target.myProp = 3 -\> Won't change source.myProp = 3, likewise the reverse would also fail.
  * @param target - The target object to be assigned with the source properties and functions
  * @param source - The source object which will be assigned / called by setting / calling the targets proxies
  * @param chkSet - An optional callback to determine whether a specific property/function should be proxied
@@ -3576,9 +3576,9 @@ export declare function randomValue(maxValue: number): number;
 
 /**
  * Trys to remove event handler(s) for the specified event/namespace to the window, body and document
- * @param eventName - {string} - The name of the event, with optional namespaces or just the namespaces,
+ * @param eventName - The name of the event, with optional namespaces or just the namespaces,
  * such as "click", "click.mynamespace" or ".mynamespace"
- * @param callback - {any} - - The callback function that needs to be removed from the given event, when using a
+ * @param callback - The callback function that needs to be removed from the given event, when using a
  * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
  * otherwise this will only remove events with this specific handler.
  * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
@@ -3856,8 +3856,8 @@ export { throwError }
  * support minification as logger.throwInternal() will not compress the publish "throwInternal" used throughout
  * the code.
  * @param logger - The Diagnostic Logger instance to use.
- * @param severity - {LoggingSeverity} - The severity of the log message
- * @param message - {_InternalLogMessage} - The log message.
+ * @param severity - The severity of the log message
+ * @param message  - The log message.
  */
 export declare function _throwInternal(logger: IDiagnosticLogger, severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
 
@@ -3907,7 +3907,7 @@ export declare function useXDomainRequest(): boolean | undefined;
 /**
  * This is a helper method which will call warnToConsole on the passed logger with the provided message.
  * @param logger - The Diagnostic Logger instance to use.
- * @param message - {_InternalLogMessage} - The log message.
+ * @param message  - The log message.
  */
 export declare function _warnToConsole(logger: IDiagnosticLogger, message: string): void;
 

package/types/applicationinsights-core-js.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.3.5-nightly3.2501-07
+ * Microsoft Application Insights Core Javascript SDK, 3.3.5-nightly3.2501-08
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -23,10 +23,10 @@ declare namespace ApplicationInsights {
 
     /**
      * Trys to add an event handler for the specified event to the window, body and document
-     * @param eventName - {string} - The name of the event
-     * @param callback - {any} - The callback function that needs to be executed for the given event
+     * @param eventName  - The name of the event
+     * @param callback  - The callback function that needs to be executed for the given event
      * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
-     * @returns {boolean} - true if the handler was successfully added
+     * @returns - true if the handler was successfully added
      */
     function addEventHandler(eventName: string, callback: any, evtNamespace?: string | string[] | null): boolean;
 
@@ -225,7 +225,7 @@ declare namespace ApplicationInsights {
         /**
          * Watches and tracks changes for accesses to the current config, and if the accessed config changes the
          * handler will be recalled.
-         * @param handler
+         * @param handler - The watcher handler to call when the config changes
          * @returns A watcher handler instance that can be used to remove itself when being unloaded
          */
         onCfgChange(handler: WatcherFunction<CfgType>): IUnloadHook;
@@ -788,7 +788,7 @@ declare namespace ApplicationInsights {
     function createDynamicConfig<T = IConfiguration>(config: T, defaultConfig?: IConfigDefaults<T>, logger?: IDiagnosticLogger, inPlace?: boolean): IDynamicConfigHandler<T>;
 
     /**
-     * Create an enum style object which has both the key \=> value and value \=> key mappings
+     * Create an enum style object which has both the key \=\> value and value \=\> key mappings
      * @param values - The values to populate on the new object
      * @returns
      */
@@ -827,7 +827,7 @@ declare namespace ApplicationInsights {
     function createUnloadHookContainer(): IUnloadHookContainer;
 
     /**
-     * Create a 2 index map that maps an enum's key and value to the defined map value, X["key"] \=> mapValue and X[0] \=> mapValue.
+     * Create a 2 index map that maps an enum's key and value to the defined map value, X["key"] \=\> mapValue and X[0] \=\> mapValue.
      * Generic values
      * - E = the const enum type (typeof eRequestHeaders);
      * - V = Identifies the valid values for the keys, this should include both the enum numeric and string key of the type. The
@@ -869,9 +869,9 @@ declare namespace ApplicationInsights {
     /**
      * Removes an event handler for the specified event
      * @param Object - to remove the event from
-     * @param eventNameWithoutOn - {string} - The name of the event, with optional namespaces or just the namespaces,
+     * @param eventNameWithoutOn  - The name of the event, with optional namespaces or just the namespaces,
      * such as "click", "click.mynamespace" or ".mynamespace"
-     * @param handlerRef - {any} - The callback function that needs to be removed from the given event, when using a
+     * @param handlerRef - The callback function that needs to be removed from the given event, when using a
      * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
      * otherwise this will only remove events with this specific handler.
      * @param useCapture - [Optional] Defaults to false
@@ -888,28 +888,28 @@ declare namespace ApplicationInsights {
         /**
          * 0: OFF (default)
          * 1: CRITICAL
-         * 2: >= WARNING
+         * 2: \>= WARNING
          */
         consoleLoggingLevel(): number;
         /**
          * This method will throw exceptions in debug mode or attempt to log the error as a console warning.
-         * @param severity - {LoggingSeverity} - The severity of the log message
-         * @param message - {_InternalLogMessage} - The log message.
+         * @param severity  - The severity of the log message
+         * @param message - The log message.
          */
         throwInternal(severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
         /**
          * This will write a debug message to the console if possible
-         * @param message - {string} - The debug message
+         * @param message - The debug message
          */
         debugToConsole(message: string): void;
         /**
          * This will write a warning to the console if possible
-         * @param message - {string} - The warning message
+         * @param message  - The warning message
          */
         warnToConsole(message: string): void;
         /**
          * This will write an error to the console if possible
-         * @param message - {string} - The warning message
+         * @param message - The warning message
          */
         errorToConsole(message: string): void;
         /**
@@ -918,8 +918,8 @@ declare namespace ApplicationInsights {
         resetInternalMessageCount(): void;
         /**
          * Logs a message to the internal queue.
-         * @param severity - {LoggingSeverity} - The severity of the log message
-         * @param message - {_InternalLogMessage} - The message to log.
+         * @param severity - The severity of the log message
+         * @param message - The message to log.
          */
         logInternalMessage(severity: LoggingSeverity, message: _InternalLogMessage): void;
         /**
@@ -1215,9 +1215,9 @@ declare namespace ApplicationInsights {
     /**
      * Removes an event handler for the specified event
      * @param Object - to remove the event from
-     * @param eventName - {string} - The name of the event, with optional namespaces or just the namespaces,
+     * @param eventName - The name of the event, with optional namespaces or just the namespaces,
      * such as "click", "click.mynamespace" or ".mynamespace"
-     * @param handlerRef - {any} - The callback function that needs to be removed from the given event, when using a
+     * @param handlerRef - The callback function that needs to be removed from the given event, when using a
      * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
      * otherwise this will only remove events with this specific handler.
      * @param evtNamespace - [Optional] Additional namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace,
@@ -2002,8 +2002,8 @@ declare namespace ApplicationInsights {
          */
         enablePerfMgr?: boolean;
         /**
-         * [Optional] Callback function that will be called to create a the IPerfManager instance when required and ```enablePerfMgr```
-         * is enabled, this enables you to override the default creation of a PerfManager() without needing to ```setPerfMgr()```
+         * [Optional] Callback function that will be called to create a the IPerfManager instance when required and `enablePerfMgr`
+         * is enabled, this enables you to override the default creation of a PerfManager() without needing to `setPerfMgr()`
          * after initialization.
          */
         createPerfMgr?: (core: IAppInsightsCore, notificationManager: INotificationManager) => IPerfManager;
@@ -2233,7 +2233,7 @@ declare namespace ApplicationInsights {
         throwInternal(severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
         /**
          * This will write a debug message to the console if possible
-         * @param message - {string} - The debug message
+         * @param message - The debug message
          */
         debugToConsole?(message: string): void;
         /**
@@ -2474,7 +2474,7 @@ declare namespace ApplicationInsights {
         /**
          * Identifies configuration override values when given feature is enabled
          * NOTE: should use flat string for fields, for example, if you want to set value for extensionConfig.Ananlytics.disableAjaxTrackig in configurations,
-         * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: {["extensionConfig.Analytics.disableAjaxTrackig"]:1}
+         * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: \{["extensionConfig.Analytics.disableAjaxTrackig"]:1\}
          * Default: undefined
          */
         onCfg?: {
@@ -2483,7 +2483,7 @@ declare namespace ApplicationInsights {
         /**
          * Identifies configuration override values when given feature is disabled
          * NOTE: should use flat string for fields, for example, if you want to set value for extensionConfig.Ananlytics.disableAjaxTrackig in configurations,
-         * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: {["extensionConfig.Analytics.disableAjaxTrackig"]:1}
+         * you should use "extensionConfig.Ananlytics.disableAjaxTrackig" as field name: \{["extensionConfig.Analytics.disableAjaxTrackig"]:1\}
          * Default: undefined
          */
         offCfg?: {
@@ -3384,9 +3384,9 @@ declare namespace ApplicationInsights {
          */
         disableCredentials?: boolean;
         /**
-         * Identifies if XMLHttpRequest or XDomainRequest (for IE < 9) should be used
+         * Identifies if `XMLHttpRequest` or `XDomainRequest` (for IE version before 9) should be used
          * Default: false
-         * @since version after 3.1.0
+         * @since 3.1.1
          */
         disableXhr?: boolean;
         /**
@@ -4101,8 +4101,8 @@ declare namespace ApplicationInsights {
     /**
      * Logs a message to the internal queue.
      * @param logger - The Diagnostic Logger instance to use.
-     * @param severity - {LoggingSeverity} - The severity of the log message
-     * @param message - {_InternalLogMessage} - The message to log.
+     * @param severity  - The severity of the log message
+     * @param message - The message to log.
      */
     function _logInternalMessage(logger: IDiagnosticLogger, severity: LoggingSeverity, message: _InternalLogMessage): void;
 
@@ -4579,8 +4579,8 @@ declare namespace ApplicationInsights {
      *
      * Special ES3 Notes:
      * Updates (setting) of direct property values on the target or indirectly on the source object WILL NOT WORK PROPERLY, updates to the
-     * properties of "referenced" object will work (target.context.newValue = 10 => will be reflected in the source.context as it's the
-     * same object). ES3 Failures: assigning target.myProp = 3 -> Won't change source.myProp = 3, likewise the reverse would also fail.
+     * properties of "referenced" object will work (target.context.newValue = 10 =\> will be reflected in the source.context as it's the
+     * same object). ES3 Failures: assigning target.myProp = 3 -\> Won't change source.myProp = 3, likewise the reverse would also fail.
      * @param target - The target object to be assigned with the source properties and functions
      * @param source - The source object which will be assigned / called by setting / calling the targets proxies
      * @param chkSet - An optional callback to determine whether a specific property/function should be proxied
@@ -4630,9 +4630,9 @@ declare namespace ApplicationInsights {
 
     /**
      * Trys to remove event handler(s) for the specified event/namespace to the window, body and document
-     * @param eventName - {string} - The name of the event, with optional namespaces or just the namespaces,
+     * @param eventName - The name of the event, with optional namespaces or just the namespaces,
      * such as "click", "click.mynamespace" or ".mynamespace"
-     * @param callback - {any} - - The callback function that needs to be removed from the given event, when using a
+     * @param callback - The callback function that needs to be removed from the given event, when using a
      * namespace (with or without a qualifying event) this may be null to remove all previously attached event handlers
      * otherwise this will only remove events with this specific handler.
      * @param evtNamespace - [Optional] Namespace(s) to append to the event listeners so they can be uniquely identified and removed based on this namespace.
@@ -4950,8 +4950,8 @@ declare namespace ApplicationInsights {
      * support minification as logger.throwInternal() will not compress the publish "throwInternal" used throughout
      * the code.
      * @param logger - The Diagnostic Logger instance to use.
-     * @param severity - {LoggingSeverity} - The severity of the log message
-     * @param message - {_InternalLogMessage} - The log message.
+     * @param severity - The severity of the log message
+     * @param message  - The log message.
      */
     function _throwInternal(logger: IDiagnosticLogger, severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
 
@@ -5001,7 +5001,7 @@ declare namespace ApplicationInsights {
     /**
      * This is a helper method which will call warnToConsole on the passed logger with the provided message.
      * @param logger - The Diagnostic Logger instance to use.
-     * @param message - {_InternalLogMessage} - The log message.
+     * @param message  - The log message.
      */
     function _warnToConsole(logger: IDiagnosticLogger, message: string): void;