Skip to content

Commit

Permalink
[Main][Task]24499174: Add service notification doc (#2170)
Browse files Browse the repository at this point in the history
* add service notification doc

* update
  • Loading branch information
Karlie-777 authored Sep 28, 2023
1 parent 4ea7963 commit 0ccc0e1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,8 @@ Most configuration fields are named such that they can be defaulted to falsey. A
| 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.
| bufferOverride <br/><sub>since 2.8.12</sub> | IStorageBuffer | undefined | [Optional] Identifies a simple interface to allow you to override the storage mechanism used for tracking unsent and unacknowledged events, when not provided defaults to using SessionStorage interface. You MUST supply both the `getItem` and `setItem` functions when defined.
| storagePrefix | string[] | undefined | [Optional] An optional value that will be added as name prefix for storage name. |
| featureOptIn <br/><sub>since 3.0.3</sub> | IFeatureOptIn | undefined | [Optional] Set Feature opt in details. |
| throttleMgrCfg <br/><sub>since 3.0.3</sub> | `{[key: number]: IThrottleMgrConfig}` | undefined | [Optional] Set throttle mgr configuration by key. |
### ICookieMgrConfig
Expand Down Expand Up @@ -434,6 +436,10 @@ As part of changes being introduced in version 2.6.0 we are deprecating and remo
[See Tree-Shaking Recommendations](TreeShakingRecommendations.md)
## Service Notification
As part of changes being introduced in version 3.0.3, we are intergrating [cfgSync plugin](https://github.com/microsoft/ApplicationInsights-JS/tree/main/extensions/applicationinsights-cfgsync-js) and [throttle manager](./docs/ThrottleMgr.md) to AISKU. By default, these components will be disabled during the current initial release, but they will be enabled by default in future releases once extensive production level testing is completed.
## Single Page Applications
By default, this SDK will **not** handle state based route changing that occurs in single page applications. To enable automatic route change tracking for your single page application, you can add `enableAutoRouteTracking: true` to your setup configuration.
Expand Down

0 comments on commit 0ccc0e1

Please sign in to comment.