add readme for ikey error messge (#1845)

* add readme for ikey error messge * change ikey error message default value to true
microsoft · May 27, 2022 · 3e8bece · 3e8bece
1 parent ed12939
commit 3e8bece
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/AISKU/src/Initialization.ts b/AISKU/src/Initialization.ts
@@ -189,8 +189,8 @@ export class Initialization implements IApplicationInsights {
             _core = new AppInsightsCore();
             _self.core = _core;
 
-
-            if (!config.connectionString && !config.disableIkeyDeprecationMessage) {
+            let isErrMessageDisabled = isNullOrUndefined(config.disableIkeyDeprecationMessage)? true:config.disableIkeyDeprecationMessage;
+            if (!config.connectionString && !isErrMessageDisabled) {
                 _throwInternal(_core.logger,
                     eLoggingSeverity.CRITICAL,
                     _eInternalMessageId.InstrumentationKeyDeprecation,

diff --git a/README.md b/README.md
@@ -326,6 +326,7 @@ Most configuration fields are named such that they can be defaulted to falsey. A
 | customHeaders | `[{header: string, value: string}]` | undefined | [Optional] The ability for the user to provide extra headers when using a custom endpoint. customHeaders will not be added on browser shutdown moment when beacon sender is used. And adding custom headers is not supported on IE9 or earlier.
 | convertUndefined | `any` | undefined | [Optional] Provide user an option to convert undefined field to user defined value.
 | eventsLimitInMem | number | 10000 | [Optional] The number of events that can be kept in memory before the SDK starts to drop events when not using Session Storage (the default).
+| disableIkeyDeprecationMessage | boolean | true | [Optional]  Disable instrumentation Key deprecation error message. If true, error message will NOT be sent. **Note: instrumentation key support will end soon**, see aka.ms/IkeyMigrate for more details.
 
 ### ICookieMgrConfig