@microsoft/1ds-post-js 4.3.5-nightly3.2411-13 → 4.3.5-nightly3.2412-01

package/types/1ds-post-js.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK Post Channel, 4.3.5-nightly3.2411-13
+ * 1DS JS SDK Post Channel, 4.3.5-nightly3.2412-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -370,7 +370,6 @@ declare namespace oneDS {
         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>;
         /**
@@ -425,7 +424,6 @@ declare namespace oneDS {
         /**
          * 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;
@@ -862,8 +860,8 @@ declare namespace oneDS {
          * 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;
         /**
@@ -872,8 +870,8 @@ declare namespace oneDS {
          * 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;
         /**
@@ -900,7 +898,6 @@ declare namespace oneDS {
          */
         readonly channels?: IChannelControls[][];
         /**
-         * @type {boolean}
          * Flag that disables the Instrumentation Key validation.
          */
         disableInstrumentationKeyValidation?: boolean;
@@ -931,14 +928,12 @@ declare namespace oneDS {
         /**
          * @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;
@@ -1050,7 +1045,7 @@ declare namespace oneDS {
         /**
          * 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;
         /**
@@ -1164,7 +1159,7 @@ declare namespace oneDS {
         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;
         /**
@@ -1185,7 +1180,7 @@ declare namespace oneDS {
         getName(): string;
         /**
          * Sets the current name of the page
-         * @param pageName
+         * @param pageName - The name of the page
          */
         setName(pageName: string): void;
         /**
@@ -1217,7 +1212,7 @@ declare namespace oneDS {
         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;
     }
@@ -1279,10 +1274,10 @@ declare namespace oneDS {
          *
          * 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[];
@@ -1430,32 +1425,31 @@ declare namespace oneDS {
         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;
@@ -1515,7 +1509,7 @@ declare namespace oneDS {
         /**
          * [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;
         /**
@@ -2502,9 +2496,9 @@ declare namespace oneDS {
         /**
          * Sets the event queue limits at runtime (after initialization), if the number of queued events is greater than the
          * eventLimit or autoFlushLimit then a flush() operation will be scheduled.
-         * @param eventLimit The number of events that can be kept in memory before the SDK starts to drop events. If the value passed is less than or
+         * @param eventLimit - The number of events that can be kept in memory before the SDK starts to drop events. If the value passed is less than or
          * equal to zero the value will be reset to the default (10,000).
-         * @param autoFlushLimit When defined, once this number of events has been queued the system perform a flush() to send the queued events
+         * @param autoFlushLimit - When defined, once this number of events has been queued the system perform a flush() to send the queued events
          * without waiting for the normal schedule timers. Passing undefined, null or a value less than or equal to zero will disable the auto flush.
          */
         setEventQueueLimits(eventLimit: number, autoFlushLimit?: number): void;