Lint

Author: kinyoklion

packages/shared/sdk-client/src/api/integrations/Hooks.ts

@@ -73,9 +73,10 @@ export interface IdentifySeriesData {
  *
  * An example in which an error may occur is lack of network connectivity
  * preventing the SDK from functioning.
- * 
+ *
  * The SDK may also shed an identify operation if it is not needed. In which case
- * the status will be 'shed'.
+ * the status will be 'shed'. For SDKs that default to non-sheddable, the status
+ * will only ever be 'shed' if the user has opted into a sheddable identify.
  */
 export type IdentifySeriesStatus = 'completed' | 'error' | 'shed';
 
@@ -186,7 +187,7 @@ export interface Hook {
   /**
    * This method is called during the execution of the identify process, after the operation
    * completes.
-   * 
+   *
    * The beforeIdentify methods will be called in the order of the identify calls to the SDK,
    * but afterIdentify may not be in the same order. This is because the SDK may shed an identify
    * operation if it is not needed. This will result in the afterIdentify method potentially being