@microsoft/applicationinsights-core-js 2.8.0-beta.2203-09 → 2.8.0-beta.2203-12

package/dist/applicationinsights-core-js.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.19.4",
+    "toolVersion": "7.19.5",
     "schemaVersion": 1004,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -2488,7 +2488,7 @@
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -2637,11 +2637,11 @@
             },
             {
               "kind": "Content",
-              "text": ", excludeEvents: "
+              "text": ", excludeEvents?: "
             },
             {
               "kind": "Content",
-              "text": "string[]"
+              "text": "string[] | null"
             },
             {
               "kind": "Content",
@@ -2649,7 +2649,7 @@
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -2710,11 +2710,11 @@
             },
             {
               "kind": "Content",
-              "text": ", excludeEvents: "
+              "text": ", excludeEvents?: "
             },
             {
               "kind": "Content",
-              "text": "string[]"
+              "text": "string[] | null"
             },
             {
               "kind": "Content",
@@ -2722,7 +2722,7 @@
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -2783,7 +2783,7 @@
             },
             {
               "kind": "Content",
-              "text": ", excludeEvents: "
+              "text": ", excludeEvents?: "
             },
             {
               "kind": "Content",
@@ -3117,7 +3117,7 @@
             },
             {
               "kind": "Content",
-              "text": "(value: T, index?: number, array?: T[]) => void | number"
+              "text": "(value: T, index?: number, array?: T[]) => undefined | void | number"
             },
             {
               "kind": "Content",
@@ -6022,6 +6022,10 @@
               "text": "ITelemetryPluginChain",
               "canonicalReference": "@microsoft/applicationinsights-core-js!ITelemetryPluginChain:interface"
             },
+            {
+              "kind": "Content",
+              "text": " | null"
+            },
             {
               "kind": "Content",
               "text": ", config: "
@@ -6064,8 +6068,8 @@
             }
           ],
           "returnTypeTokenRange": {
-            "startIndex": 9,
-            "endIndex": 10
+            "startIndex": 10,
+            "endIndex": 11
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -6074,28 +6078,28 @@
               "parameterName": "telemetryChain",
               "parameterTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               }
             },
             {
               "parameterName": "config",
               "parameterTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
+                "startIndex": 4,
+                "endIndex": 5
               }
             },
             {
               "parameterName": "core",
               "parameterTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
+                "startIndex": 6,
+                "endIndex": 7
               }
             },
             {
               "parameterName": "startAt",
               "parameterTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 8
+                "startIndex": 8,
+                "endIndex": 9
               }
             }
           ],
@@ -7231,7 +7235,7 @@
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -7347,7 +7351,7 @@
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -9959,16 +9963,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "(onComplete: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Function",
-                  "canonicalReference": "!Function:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", that?: any, ...args: any[]) => void"
+                  "text": "(onComplete: () => void, that?: any, ...args: any[]) => void"
                 },
                 {
                   "kind": "Content",
@@ -9980,7 +9975,7 @@
               "name": "onComplete",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 4
+                "endIndex": 2
               }
             },
             {
@@ -13760,6 +13755,148 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-core-js!ILoadedPlugin:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface ILoadedPlugin<T extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "IPlugin",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IPlugin:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "> "
+            }
+          ],
+          "releaseTag": "Public",
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "ILoadedPlugin",
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!ILoadedPlugin#isEnabled:member",
+              "docComment": "/**\n * Identifies whether the plugin is enabled and can process events. This is slightly different from isInitialized as the plugin may be initialized but disabled via the setEnabled() or it may be a shared plugin which has had it's teardown function called from another instance..\n *\n * @returns boolean = true if the plugin is in a state where it is operational.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "isEnabled: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "isEnabled",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!ILoadedPlugin#plugin:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "plugin: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "T"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "plugin",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!ILoadedPlugin#remove:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "remove: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(isAsync?: boolean, removeCb?: (removed?: boolean) => void) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "remove",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!ILoadedPlugin#setEnabled:member",
+              "docComment": "/**\n * You can optionally enable / disable a plugin from processing events. Setting enabled to true will not necessarily cause the `isEnabled()` to also return true as the plugin must also have been successfully initialized and not had it's `teardown` method called (unless it's also been re-initialized)\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setEnabled: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(isEnabled: boolean) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setEnabled",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-core-js!initializePlugins:function(1)",
@@ -16283,19 +16420,24 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare function isNotNullOrUndefined(value: "
+              "text": "export declare function isNotNullOrUndefined<T>(value: "
             },
             {
               "kind": "Content",
-              "text": "any"
+              "text": "T"
             },
             {
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "value",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!~value"
+            },
             {
               "kind": "Content",
-              "text": "boolean"
+              "text": " is T"
             },
             {
               "kind": "Content",
@@ -16304,7 +16446,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 4
+            "endIndex": 5
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -16317,6 +16459,19 @@
               }
             }
           ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
           "name": "isNotNullOrUndefined"
         },
         {
@@ -16369,19 +16524,24 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare function isNotUndefined(value: "
+              "text": "export declare function isNotUndefined<T>(value: "
             },
             {
               "kind": "Content",
-              "text": "any"
+              "text": "T"
             },
             {
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "value",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!~value"
+            },
             {
               "kind": "Content",
-              "text": "boolean"
+              "text": " is T"
             },
             {
               "kind": "Content",
@@ -16390,7 +16550,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 4
+            "endIndex": 5
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -16403,6 +16563,19 @@
               }
             }
           ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
           "name": "isNotUndefined"
         },
         {
@@ -16422,9 +16595,14 @@
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "value",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!~value"
+            },
             {
               "kind": "Content",
-              "text": "boolean"
+              "text": " is null | undefined"
             },
             {
               "kind": "Content",
@@ -16433,7 +16611,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 4
+            "endIndex": 5
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -16503,19 +16681,24 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare function isObject(value: "
+              "text": "export declare function isObject<T>(value: "
             },
             {
               "kind": "Content",
-              "text": "any"
+              "text": "T"
             },
             {
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "value",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!~value"
+            },
             {
               "kind": "Content",
-              "text": "boolean"
+              "text": " is T"
             },
             {
               "kind": "Content",
@@ -16524,7 +16707,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 4
+            "endIndex": 5
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -16537,6 +16720,19 @@
               }
             }
           ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
           "name": "isObject"
         },
         {
@@ -16818,9 +17014,14 @@
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "value",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!~value"
+            },
             {
               "kind": "Content",
-              "text": "boolean"
+              "text": " is undefined"
             },
             {
               "kind": "Content",
@@ -16829,7 +17030,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 4
+            "endIndex": 5
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -17695,6 +17896,66 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadableComponent:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IUnloadableComponent "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "IUnloadableComponent",
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadableComponent#_doUnload:member",
+              "docComment": "/**\n * Teardown / Unload hook to allow implementations to perform some additional unload operations before the BaseTelemetryPlugin finishes it's removal.\n *\n * @param unloadCtx - This is the context that should be used during unloading.\n *\n * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.\n *\n * @param asyncCallback - An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async unload/teardown operations.\n *\n * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "_doUnload?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(unloadCtx?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IProcessTelemetryUnloadContext",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IProcessTelemetryUnloadContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", unloadState?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ITelemetryUnloadState",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!ITelemetryUnloadState:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", asyncCallback?: () => void) => void | boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "_doUnload",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 6
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHandlerContainer:interface",
@@ -17856,11 +18117,11 @@
             },
             {
               "kind": "Content",
-              "text": ", namespaces: "
+              "text": ", namespaces?: "
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -19151,6 +19412,49 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@microsoft/applicationinsights-core-js!objToString:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function objToString(obj: "
+            },
+            {
+              "kind": "Content",
+              "text": "any"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "any"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "obj",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "name": "objToString"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-core-js!optimizeObject:function(1)",
@@ -19650,7 +19954,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "constructor(manager: "
+                  "text": "constructor(manager?: "
                 },
                 {
                   "kind": "Reference",
@@ -20207,7 +20511,39 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "(identifier: string, field: string, defaultValue?: number | string | boolean) => number | string | boolean"
+                  "text": "(identifier: string, field: string, defaultValue?: number | string | boolean | string[] | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RegExp",
+                  "canonicalReference": "!RegExp:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[] | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Function",
+                  "canonicalReference": "!Function:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => number | string | boolean | string[] | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RegExp",
+                  "canonicalReference": "!RegExp:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[] | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Function",
+                  "canonicalReference": "!Function:interface"
                 },
                 {
                   "kind": "Content",
@@ -20219,7 +20555,7 @@
               "name": "getConfig",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 9
               },
               "isStatic": false
             },
@@ -20910,7 +21246,7 @@
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -21048,7 +21384,7 @@
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -21106,7 +21442,7 @@
             },
             {
               "kind": "Content",
-              "text": "string | string[]"
+              "text": "string | string[] | null"
             },
             {
               "kind": "Content",
@@ -21769,7 +22105,7 @@
             },
             {
               "kind": "Content",
-              "text": "(value: T[K]) => boolean"
+              "text": "((value: T[K]) => boolean) | null"
             },
             {
               "kind": "Content",
@@ -21777,7 +22113,7 @@
             },
             {
               "kind": "Content",
-              "text": "(value: T[K]) => boolean"
+              "text": "((value: T[K]) => boolean) | null"
             },
             {
               "kind": "Content",
@@ -22593,6 +22929,105 @@
             "endIndex": 0
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@microsoft/applicationinsights-core-js!unloadComponents:function(1)",
+          "docComment": "/**\n * Teardown / Unload helper to perform teardown/unloading operations for the provided components synchronously or asynchronously, this will call any _doTeardown() or _doUnload() functions on the provided components to allow them to finish removal.\n *\n * @param components - The components you want to unload\n *\n * @param unloadCtx - This is the context that should be used during unloading.\n *\n * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.\n *\n * @param asyncCallback - An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async unload/teardown operations.\n *\n * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function unloadComponents(components: "
+            },
+            {
+              "kind": "Content",
+              "text": "any | "
+            },
+            {
+              "kind": "Reference",
+              "text": "IUnloadableComponent",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadableComponent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": ", unloadCtx?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "IProcessTelemetryUnloadContext",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IProcessTelemetryUnloadContext:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", unloadState?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ITelemetryUnloadState",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!ITelemetryUnloadState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", asyncCallback?: "
+            },
+            {
+              "kind": "Content",
+              "text": "() => void"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void | boolean"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "returnTypeTokenRange": {
+            "startIndex": 11,
+            "endIndex": 12
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "components",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
+            {
+              "parameterName": "unloadCtx",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              }
+            },
+            {
+              "parameterName": "unloadState",
+              "parameterTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              }
+            },
+            {
+              "parameterName": "asyncCallback",
+              "parameterTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 10
+              }
+            }
+          ],
+          "name": "unloadComponents"
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@microsoft/applicationinsights-core-js!UnloadHandler:type",