chor: add comments

launchdarkly · Aug 28, 2023 · a3d3132 · a3d3132
1 parent 11cb96a
commit a3d3132
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/packages/shared/common/src/internal/events/LDInternalOptions.ts b/packages/shared/common/src/internal/events/LDInternalOptions.ts
@@ -1,3 +1,13 @@
+/**
+ * This is for internal use only.
+ *
+ * Edge sdks use clientSideID to query feature stores. They also send analytics
+ * using this clientSideID. This is a hybrid behavior because they are based
+ * on js-server-common, but uses the clientSideID instead of the sdkKey for the
+ * above reasons. These internal options allow the edge sdks to use the
+ * EventSender to send analytics to the correct LD endpoints using
+ * the clientSideId.
+ */
 export type LDInternalOptions = {
   analyticsEventPath?: string;
   diagnosticEventPath?: string;