[Master] Add readme documentation for IStorageBuffer (#2045)

microsoft · Apr 11, 2023 · f38e486 · f38e486
1 parent a83241c
commit f38e486
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -365,6 +365,7 @@ Most configuration fields are named such that they can be defaulted to falsey. A
 | 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.
+| 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.
 
 ### ICookieMgrConfig
 

diff --git a/channels/applicationinsights-channel-js/src/Interfaces.ts b/channels/applicationinsights-channel-js/src/Interfaces.ts
@@ -33,6 +33,7 @@ export interface ISenderConfig {
 
     /**
      * Specify the storage buffer type implementation.
+     * @since 2.8.12
      */
     bufferOverride: IStorageBuffer | false;
 

diff --git a/common/config/rush/npm-shrinkwrap.json b/common/config/rush/npm-shrinkwrap.json
diff --git a/shared/AppInsightsCommon/src/Interfaces/IStorageBuffer.ts b/shared/AppInsightsCommon/src/Interfaces/IStorageBuffer.ts
@@ -1,5 +1,11 @@
 import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
 
+/**
+ * Identifies a simple interface to allow you to override the storage mechanism used
+ * to track unsent and unacknowledged events. When provided it must provide both
+ * the get and set item functions.
+ * @since 2.8.12
+ */
 export interface IStorageBuffer {
     /**
      * Retrieves the stored value for a given key