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

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights JavaScript SDK - Web Analytics, 3.3.5-nightly3.2501-07
+ * Microsoft Application Insights JavaScript SDK - Web Analytics, 3.3.5-nightly3.2501-08
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -23,14 +23,14 @@ declare namespace ApplicationInsights {
         trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
         /**
          * Start timing an extended event. Call `stopTrackEvent` to log the event when it ends.
-         * @param   name    A string that identifies this event uniquely within the document.
+         * @param name - A string that identifies this event uniquely within the document.
          */
         startTrackEvent(name: string): void;
         /**
          * Log an extended event that you started timing with `startTrackEvent`.
-         * @param   name    The string you used to identify this event in `startTrackEvent`.
-         * @param   properties  map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.
-         * @param   measurements    map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty.
+         * @param name - The string you used to identify this event in `startTrackEvent`.
+         * @param properties - map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.
+         * @param measurements - map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty.
          */
         stopTrackEvent(name: string, properties?: {
             [key: string]: string;
@@ -50,7 +50,7 @@ declare namespace ApplicationInsights {
          * frequently, you can reduce the telemetry bandwidth by aggregating multiple measurements
          * and sending the resulting average at intervals
          * @param metric - input object argument. Only name and average are mandatory.
-         * @param } customProperties additional data used to filter metrics in the
+         * @param customProperties - additional data used to filter metrics in the
          * portal. Defaults to empty.
          */
         trackMetric(metric: IMetricTelemetry, customProperties?: ICustomProperties): void;
@@ -98,10 +98,10 @@ declare namespace ApplicationInsights {
         /**
          * Stops the timer that was started by calling `startTrackPage` and sends the pageview load time telemetry with the specified properties and measurements.
          * The duration of the page view will be the time between calling `startTrackPage` and `stopTrackPage`.
-         * @param   name  The string you used as the name in startTrackPage. Defaults to the document title.
-         * @param   url   String - a relative or absolute URL that identifies the page or other item. Defaults to the window location.
-         * @param   properties  map[string, string] - additional data used to filter pages and metrics in the portal. Defaults to empty.
-         * @param   measurements    map[string, number] - metrics associated with this page, displayed in Metrics Explorer on the portal. Defaults to empty.
+         * @param name - The string you used as the name in startTrackPage. Defaults to the document title.
+         * @param url - String - a relative or absolute URL that identifies the page or other item. Defaults to the window location.
+         * @param properties - map[string, string] - additional data used to filter pages and metrics in the portal. Defaults to empty.
+         * @param measurements - map[string, number] - metrics associated with this page, displayed in Metrics Explorer on the portal. Defaults to empty.
          */
         stopTrackPage(name?: string, url?: string, properties?: {
             [key: string]: string;
@@ -122,8 +122,8 @@ declare namespace ApplicationInsights {
         /**
          * Log an exception you have caught.
          *
-         * @param exception -   Object which contains exception to be sent
-         * @param } customProperties   Additional data used to filter pages and metrics in the portal. Defaults to empty.
+         * @param exception - Object which contains exception to be sent
+         * @param customProperties - Additional data used to filter pages and metrics in the portal. Defaults to empty.
          *
          * Any property of type double will be considered a measurement, and will be treated by Application Insights as a metric.
          */
@@ -1267,8 +1267,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;
@@ -1488,7 +1488,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;
         /**
@@ -1673,7 +1673,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?: {
@@ -1682,7 +1682,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?: {