@microsoft/applicationinsights-analytics-js 3.0.0-beta.2209-03 → 3.0.0-beta.2210-02

package/dist/applicationinsights-analytics-js.rollup.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights JavaScript SDK - Web Analytics, 3.0.0-beta.2209-03
+ * Microsoft Application Insights JavaScript SDK - Web Analytics, 3.0.0-beta.2210-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -37,10 +37,9 @@ import { ITraceTelemetry } from '@microsoft/applicationinsights-common';
 
 declare class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
     static Version: string;
-    static getDefaultConfig: typeof _getDefaultConfig;
     identifier: string;
     priority: number;
-    config: IConfig;
+    readonly config: IConfig;
     queue: Array<() => void>;
     autoRoutePVDelay: number;
     constructor();
@@ -68,7 +67,7 @@ declare class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsight
     }): void;
     /**
      * @description Log a diagnostic message
-     * @param {ITraceTelemetry} trace
+     * @param trace
      * @param ICustomProperties.
      * @memberof ApplicationInsights
      */
@@ -79,24 +78,24 @@ declare class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsight
      * use the name and average fields of {@link IMetricTelemetry}. If you take measurements
      * frequently, you can reduce the telemetry bandwidth by aggregating multiple measurements
      * and sending the resulting average at intervals
-     * @param {IMetricTelemetry} metric input object argument. Only name and average are mandatory.
-     * @param {{[key: string]: any}} customProperties additional data used to filter metrics in the
+     * @param metric - input object argument. Only name and average are mandatory.
+     * @param } customProperties additional data used to filter metrics in the
      * portal. Defaults to empty.
      * @memberof ApplicationInsights
      */
     trackMetric(metric: IMetricTelemetry, customProperties?: ICustomProperties): void;
     /**
      * Logs that a page or other item was viewed.
-     * @param IPageViewTelemetry The string you used as the name in startTrackPage. Defaults to the document title.
-     * @param customProperties Additional data used to filter events and metrics. Defaults to empty.
+     * @param IPageViewTelemetry - The string you used as the name in startTrackPage. Defaults to the document title.
+     * @param customProperties - Additional data used to filter events and metrics. Defaults to empty.
      * If a user wants to provide duration for pageLoad, it'll have to be in pageView.properties.duration
      */
     trackPageView(pageView?: IPageViewTelemetry, customProperties?: ICustomProperties): void;
     /**
      * Create a page view telemetry item and send it to the SDK pipeline through the core.track API
-     * @param pageView Page view item to be sent
-     * @param properties Custom properties (Part C) that a user can add to the telemetry item
-     * @param systemProperties System level properties (Part A) that a user can add to the telemetry item
+     * @param pageView - Page view item to be sent
+     * @param properties - Custom properties (Part C) that a user can add to the telemetry item
+     * @param systemProperties - System level properties (Part A) that a user can add to the telemetry item
      */
     sendPageViewInternal(pageView: IPageViewTelemetryInternal, properties?: {
         [key: string]: any;
@@ -123,7 +122,7 @@ declare class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsight
      * Starts the timer for tracking a page load time. Use this instead of `trackPageView` if you want to control when the page view timer starts and stops,
      * but don't want to calculate the duration yourself. This method doesn't send any telemetry. Call `stopTrackPage` to log the end of the page view
      * and send the event.
-     * @param name A string that idenfities this item, unique within this HTML document. Defaults to the document title.
+     * @param name - A string that idenfities this item, unique within this HTML document. Defaults to the document title.
      */
     startTrackPage(name?: string): void;
     /**
@@ -153,8 +152,8 @@ declare class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsight
     /**
      * Log an exception you have caught.
      *
-     * @param {IExceptionTelemetry} exception   Object which contains exception to be sent
-     * @param {{[key: string]: any}} 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.
      * @memberof ApplicationInsights
@@ -162,18 +161,16 @@ declare class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsight
     trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
     /**
      * @description Custom error handler for Application Insights Analytics
-     * @param {IAutoExceptionTelemetry} exception
+     * @param exception
      * @memberof ApplicationInsights
      */
     _onerror(exception: IAutoExceptionTelemetry): void;
-    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): ITelemetryInitializerHandler | void;
+    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): ITelemetryInitializerHandler;
     initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
 }
 export { AnalyticsPlugin }
 export { AnalyticsPlugin as ApplicationInsights }
 
-declare function _getDefaultConfig(config?: IConfig): IConfig;
-
 /**
  * Internal interface to pass appInsights object to subcomponents without coupling
  */