@microsoft/applicationinsights-common 3.3.5-nightly3.2411-14 → 3.3.5-nightly3.2412-02

package/types/applicationinsights-common.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.3.5-nightly3.2411-14
+ * Microsoft Application Insights Common JavaScript Library, 3.3.5-nightly3.2412-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -98,7 +98,7 @@ declare namespace ApplicationInsights {
      * Create a telemetry item that the 1DS channel understands
      * @param item - domain specific properties; part B
      * @param baseType - telemetry item type. ie PageViewData
-     * @param envelopeName - name of the envelope. ie Microsoft.ApplicationInsights.<instrumentation key>.PageView
+     * @param envelopeName - Name of the envelope, e.g., `Microsoft.ApplicationInsights.\<instrumentation key\>.PageView`.
      * @param customProperties - user defined custom properties; part C
      * @param systemProperties - system properties that are added to the context; part A
      * @returns ITelemetryItem that is sent to channel
@@ -653,7 +653,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Find all script tags in the provided document and return the information about them.
-     * @param doc
+     * @param doc - The document to search for script tags
      * @returns
      */
     function findAllScripts(doc: any): scriptsInfo[];
@@ -803,7 +803,6 @@ declare namespace ApplicationInsights {
         unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void | IPromise<ITelemetryUnloadState>;
         /**
          * Find and return the (first) plugin with the specified identifier if present
-         * @param pluginIdentifier
          */
         getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
         /**
@@ -858,7 +857,6 @@ 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
          * @returns A watcher handler instance that can be used to remove itself when being unloaded
          */
         onCfgChange(handler: WatcherFunction<CfgType>): IUnloadHook;
@@ -902,47 +900,38 @@ declare namespace ApplicationInsights {
     interface IAutoExceptionTelemetry {
         /**
          * @description error message. Available as event in HTML onerror="" handler
-         * @type {string}
          */
         message: string;
         /**
          * @description URL of the script where the error was raised
-         * @type {string}
          */
         url: string;
         /**
          * @description Line number where error was raised
-         * @type {number}
          */
         lineNumber: number;
         /**
          * @description Column number for the line where the error occurred
-         * @type {number}
          */
         columnNumber: number;
         /**
          * @description Error Object (object)
-         * @type {any}
          */
         error: any;
         /**
          * @description The event at the time of the exception (object)
-         * @type {Event|string}
          */
         evt?: Event | string;
         /**
          * @description The provided stack for the error
-         * @type {IStackDetails}
          */
         stackDetails?: IStackDetails;
         /**
          * @description The calculated type of the error
-         * @type {string}
          */
         typeName?: string;
         /**
          * @description The descriptive source of the error
-         * @type {string}
          */
         errorSrc?: string;
     }
@@ -1169,7 +1158,7 @@ declare namespace ApplicationInsights {
          */
         disableFlushOnBeforeUnload?: boolean;
         /**
-         * Default value of {@link #disableFlushOnBeforeUnload}. If true, flush method will not be called when onPageHide or onVisibilityChange (hidden state) event(s) trigger.
+         * Default value of `disableFlushOnBeforeUnload`. If true, flush method will not be called when onPageHide or onVisibilityChange (hidden state) event(s) trigger.
          */
         disableFlushOnUnload?: boolean;
         /**
@@ -1221,12 +1210,12 @@ declare namespace ApplicationInsights {
          */
         isStorageUseDisabled?: boolean;
         /**
-         * If false, the SDK will send all telemetry using the [Beacon API](https://www.w3.org/TR/beacon)
+         * If false, the SDK will send all telemetry using the <a href="https://www.w3.org/TR/beacon">Beacon API</a>.
          * @defaultValue true
          */
         isBeaconApiDisabled?: boolean;
         /**
-         * Don't use XMLHttpRequest or XDomainRequest (for IE < 9) by default instead attempt to use fetch() or sendBeacon.
+         * Don't use XMLHttpRequest or XDomainRequest (for IE \< 9) by default instead attempt to use fetch() or sendBeacon.
          * If no other transport is available it will still use XMLHttpRequest
          */
         disableXhr?: boolean;
@@ -1483,8 +1472,8 @@ declare namespace ApplicationInsights {
          * be logged to console if their severity meets the configured loggingConsoleLevel
          *
          * 0: ALL console logging off
-         * 1: logs to console: severity >= CRITICAL
-         * 2: logs to console: severity >= WARNING
+         * 1: logs to console: severity \>= CRITICAL
+         * 2: logs to console: severity \>= WARNING
          */
         loggingLevelConsole?: number;
         /**
@@ -1493,8 +1482,8 @@ declare namespace ApplicationInsights {
          * the configured instrumentation key.
          *
          * 0: ALL iKey logging off
-         * 1: logs to iKey: severity >= CRITICAL
-         * 2: logs to iKey: severity >= WARNING
+         * 1: logs to iKey: severity \>= CRITICAL
+         * 2: logs to iKey: severity \>= WARNING
          */
         loggingLevelTelemetry?: number;
         /**
@@ -1521,7 +1510,6 @@ declare namespace ApplicationInsights {
          */
         readonly channels?: IChannelControls[][];
         /**
-         * @type {boolean}
          * Flag that disables the Instrumentation Key validation.
          */
         disableInstrumentationKeyValidation?: boolean;
@@ -1552,14 +1540,12 @@ declare namespace ApplicationInsights {
         /**
          * @description Custom cookie domain. This is helpful if you want to share Application Insights cookies across subdomains. It
          * can be set here or as part of the cookieCfg.domain, the cookieCfg takes precedence if both are specified.
-         * @type {string}
          * @defaultValue ""
          */
         cookieDomain?: string;
         /**
          * @description Custom cookie path. This is helpful if you want to share Application Insights cookies behind an application
          * gateway. It can be set here or as part of the cookieCfg.domain, the cookieCfg takes precedence if both are specified.
-         * @type {string}
          * @defaultValue ""
          */
         cookiePath?: string;
@@ -1842,7 +1828,7 @@ declare namespace ApplicationInsights {
         /**
          * Optional Callback hook to allow the cookie manager to update it's configuration, not generally implemented now that
          * dynamic configuration is supported
-         * @param updateState
+         * @param updateState - The new configuration state to apply to the cookie manager
          */
         update?(updateState: ITelemetryUpdateState): void;
         /**
@@ -2116,7 +2102,7 @@ declare namespace ApplicationInsights {
         logInternalMessage?(severity: LoggingSeverity, message: _InternalLogMessage): void;
         /**
          * Optional Callback hook to allow the diagnostic logger to update it's configuration
-         * @param updateState
+         * @param updateState - The new configuration state to apply to the diagnostic logger
          */
         update?(updateState: ITelemetryUpdateState): void;
         /**
@@ -2137,7 +2123,7 @@ declare namespace ApplicationInsights {
         getName(): string;
         /**
          * Sets the current name of the page
-         * @param pageName
+         * @param pageName - The name of the page
          */
         setName(pageName: string): void;
         /**
@@ -2169,7 +2155,7 @@ declare namespace ApplicationInsights {
         getTraceFlags(): number | undefined;
         /**
          * https://www.w3.org/TR/trace-context/#trace-flags
-         * @param newValue
+         * @param newValue - An integer representation of the W3C TraceContext trace-flags.
          */
         setTraceFlags(newValue?: number): void;
     }
@@ -2242,12 +2228,10 @@ declare namespace ApplicationInsights {
     interface IEventTelemetry extends IPartC {
         /**
          * @description An event name string
-         * @type {string}
          */
         name: string;
         /**
          * @description custom defined iKey
-         * @type {string}
          */
         iKey?: string;
     }
@@ -2286,10 +2270,10 @@ declare namespace ApplicationInsights {
          *
          * This callback is called before telemetry data is sent, allowing for dynamic customization of the logs.
          *
-         * @returns {Object} An object with the following property:
+         * @returns An object with the following property:
          * - logs: An array of strings, where each string represents a log entry to be included in the telemetry.
          *
-         * @property {number} maxLogs - Specifies the maximum number of logs that can be generated. If not explicitly set, it defaults to 50.
+         * @property maxLogs - Specifies the maximum number of logs that can be generated. If not explicitly set, it defaults to 50.
          */
         expLog?: () => {
             logs: string[];
@@ -2401,20 +2385,17 @@ declare namespace ApplicationInsights {
          */
         id?: string;
         /**
-         * @deprecated
-         * @type {Error}
-         * @description DEPRECATED: Please use exception instead. Behavior/usage for exception remains the same as this field.
+         * @deprecated Please use the `exception` field instead. The behavior and usage of `exception` remains the same as this field.
+         * Unique guid identifying this error.
          */
         error?: Error;
         /**
-         * @type {Error}
          * @description Error Object(s)
          */
         exception?: Error | IAutoExceptionTelemetry;
         /**
          * @description Specified severity of exception for use with
          * telemetry filtering in dashboard
-         * @type {(SeverityLevel | number)}
          */
         severityLevel?: SeverityLevel | number;
     }
@@ -2489,32 +2470,31 @@ declare namespace ApplicationInsights {
         getUrl: () => string;
         /**
          * Create payload data
-         * @param data data
          * @returns IPayloadData
          */
         createPayload: (data: string | Uint8Array) => IPayloadData;
         /**
          * Serialize an item into a string
-         * @param input telemetry item
-         * @param convertUndefined convert undefined to a custom-defined object
+         * @param input - telemetry item
+         * @param convertUndefined - convert undefined to a custom-defined object
          * @returns Serialized string
          */
         serialize?: (input: ITelemetryItem, convertUndefined?: any) => string;
         /**
          * Batch an array of strings into one string
-         * @param arr array of strings
+         * @param arr - array of strings
          * @returns a string represent all items in the given array
          */
         batch?: (arr: string[]) => string;
         /**
          * If the item should be processed by offline channel
-         * @param evt telemetry item
+         * @param evt - telemetry item
          * @returns should process or not
          */
         shouldProcess?: (evt: ITelemetryItem) => boolean;
         /**
          * Create 1ds payload data
-         * @param evts ITelemetryItems
+         * @param evts - ITelemetryItems
          * @returns IPayloadData
          */
         createOneDSPayload?: (evts: ITelemetryItem[]) => IPayloadData;
@@ -2606,29 +2586,24 @@ declare namespace ApplicationInsights {
     interface IMetricTelemetry extends IPartC {
         /**
          * @description (required) - name of this metric
-         * @type {string}
          */
         name: string;
         /**
          * @description (required) - Recorded value/average for this metric
-         * @type {number}
          */
         average: number;
         /**
          * @description (optional) Number of samples represented by the average.
-         * @type {number=}
          * @default sampleCount=1
          */
         sampleCount?: number;
         /**
          * @description (optional) The smallest measurement in the sample. Defaults to the average
-         * @type {number}
          * @default min=average
          */
         min?: number;
         /**
          * @description (optional) The largest measurement in the sample. Defaults to the average.
-         * @type {number}
          * @default max=average
          */
         max?: number;
@@ -2638,7 +2613,6 @@ declare namespace ApplicationInsights {
         stdDev?: number;
         /**
          * @description custom defined iKey
-         * @type {string}
          */
         iKey?: string;
     }
@@ -2669,7 +2643,7 @@ declare namespace ApplicationInsights {
         /**
          * [Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging
          * the event can be displayed via the debug plugin extension.
-         * @param perfEvent
+         * @param perfEvent - The performance event object
          */
         perfEvent?: (perfEvent: IPerfEvent) => void;
         /**
@@ -3622,7 +3596,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Validates that the provided ITraceParent instance conforms to the currently supported specifications
-     * @param value
+     * @param value - The parsed traceParent value
      * @returns
      */
     function isValidTraceParent(value: ITraceParent): boolean;
@@ -4094,17 +4068,14 @@ declare namespace ApplicationInsights {
     interface ITraceTelemetry extends IPartC {
         /**
          * @description A message string
-         * @type {string}
          */
         message: string;
         /**
          * @description Severity level of the logging message used for filtering in the portal
-         * @type {SeverityLevel}
          */
         severityLevel?: SeverityLevel;
         /**
          * @description custom defiend iKey
-         * @type {SeverityLevel}
          */
         iKey?: string;
     }
@@ -4268,7 +4239,7 @@ declare namespace ApplicationInsights {
 
     /**
      * this is the callback that will be called when the network status changes
-     * @param onlineState this is the current network running state
+     * @param onlineState - this is the current network running state
      */
     type OfflineCallback = (onlineState: IOfflineState) => void;
 
@@ -4600,7 +4571,7 @@ declare namespace ApplicationInsights {
          * Create a telemetry item that the 1DS channel understands
          * @param item - domain specific properties; part B
          * @param baseType - telemetry item type. ie PageViewData
-         * @param envelopeName - name of the envelope. ie Microsoft.ApplicationInsights.<instrumentation key>.PageView
+         * @param envelopeName - Name of the envelope (e.g., Microsoft.ApplicationInsights.[instrumentationKey].PageView).
          * @param customProperties - user defined custom properties; part C
          * @param systemProperties - system properties that are added to the context; part A
          * @returns ITelemetryItem that is sent to channel