Skip to content

Commit

Permalink
adds comments
Browse files Browse the repository at this point in the history
  • Loading branch information
tanderson-ld committed Jan 9, 2025
1 parent c17e3fe commit f54db93
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ export interface LDDataSourceUpdates {
*/
upsert(kind: DataKind, data: LDKeyedFeatureStoreItem, callback: () => void): void;

/**
* @param basis If true, completely overwrites the current contents of the data store
* with the provided data. If false, upserts the items in the provided data. Upserts
* are made only if provided items have newer versions than existing items.
* @param data An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
* the value is an object that maps keys to entities. The actual type of this parameter is
* `interfaces.FullDataSet<VersionedData>`.
* @param selector TODO
* @param callback Will be called after the changes are applied.
*/
applyChanges(
basis: boolean,
data: LDFeatureStoreDataStorage,
Expand Down
10 changes: 10 additions & 0 deletions packages/shared/sdk-server/src/api/subsystems/LDFeatureStore.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,16 @@ export interface LDFeatureStore {
*/
upsert(kind: DataKind, data: LDKeyedFeatureStoreItem, callback: () => void): void;

/**
* @param basis If true, completely overwrites the current contents of the data store
* with the provided data. If false, upserts the items in the provided data. Upserts
* are made only if provided items have newer versions than existing items.
* @param data An object in which each key is the "namespace" of a collection (e.g. `"features"`) and
* the value is an object that maps keys to entities. The actual type of this parameter is
* `interfaces.FullDataSet<VersionedData>`.
* @param selector TODO
* @param callback Will be called after the changes are applied.
*/
applyChanges(
basis: boolean,
data: LDFeatureStoreDataStorage,
Expand Down

0 comments on commit f54db93

Please sign in to comment.