Add developer note for identifyResolve/identifyReject.

launchdarkly · Sep 25, 2024 · eb21120 · eb21120
1 parent 55d9b6b
commit eb21120
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/shared/sdk-client/src/DataManager.ts b/packages/shared/sdk-client/src/DataManager.ts
@@ -23,6 +23,12 @@ export interface DataManager {
   /**
    * This function handles the data management aspects of the identification process.
    *
+   * Implementation Note: The identifyResolve and identifyReject function resolve or reject the
+   * identify function at LDClient level. It is likely in individual implementations that these
+   * functions will be passed to other components, such as a datasource, do indicate when the
+   * identify process has been completed. The data manager identify function should return once
+   * everything has been set in motion to complete the identification process.
+   *
    * @param identifyResolve Called to reject the identify operation.
    * @param identifyReject Called to complete the identify operation.
    * @param context The context being identified.