@launchdarkly/js-server-sdk-common/dist/api/subsystems/LDDataSourceUpdates.d.ts

LaunchDarkly Server SDK for JavaScript - common code

import { DataKind } from '../interfaces';
import { LDFeatureStoreDataStorage, LDKeyedFeatureStoreItem } from './LDFeatureStore';
/**
 * Interface that a data source implementation will use to push data into the SDK.
 *
 * The data source interacts with this object, rather than manipulating the data store directly, so
 * that the SDK can perform any other necessary operations that must happen when data is updated.
 */
export interface LDDataSourceUpdates {
    /**
     * Completely overwrites the current contents of the data store with a set of items for each
     * collection.
     *
     * @param allData
     *   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 callback
     *   Will be called when the store has been initialized.
     */
    init(allData: LDFeatureStoreDataStorage, callback: () => void): void;
    /**
     * Updates or inserts an item in the specified collection. For updates, the object will only be
     * updated if the existing version is less than the new version.
     *
     * @param kind
     *   The type of data to be accessed. The actual type of this parameter is
     *   {@link interfaces.DataKind}.
     *
     * @param data
     *   The contents of the entity, as an object that can be converted to JSON. The store
     *   should check the `version` property of this object, and should *not* overwrite any
     *   existing data if the existing `version` is greater than or equal to that value.
     *   The actual type of this parameter is {@link interfaces.VersionedData}.
     *
     * @param callback
     *   Will be called after the upsert operation is complete.
     */
    upsert(kind: DataKind, data: LDKeyedFeatureStoreItem, callback: () => void): void;
}
//# sourceMappingURL=LDDataSourceUpdates.d.ts.map