Class PersistentDataStoreWrapper

constructor

• new PersistentDataStoreWrapper(
      _core: PersistentDataStore,
      ttl: number,
      _logger?: LDLogger,
  ): PersistentDataStoreWrapper

  Parameters

  • _core: PersistentDataStore
  • ttl: number
  • Optional_logger: LDLogger

  Returns PersistentDataStoreWrapper

OptionalisStoreAvailable

all

• all(kind: DataKind, callback: (res: LDFeatureStoreKindData) => void): void

  Get all entities from a collection.

  The store should filter out any entities with the property deleted: true.

  Parameters

  • kind: DataKind

    The type of data to be accessed. The store should not make any assumptions about the format of the data, but just return an object in which each key is the key property of an entity and the value is the entity. The actual type of this parameter is interfaces.DataKind.

  • callback: (res: LDFeatureStoreKindData) => void

    Will be called with the resulting map. The actual type of the result value is interfaces.KeyedItems<VersionedData>.

  Returns void

close

• close(): void

  Releases any resources being used by the feature store.

  Returns void

delete

• delete(kind: DataKind, key: string, version: number, callback: () => void): void

  Delete an entity from the store.

  Deletion should be implemented by storing a placeholder object with the property deleted: true and a version property equal to the provided version. In other words, it should be exactly the same as calling upsert with such an object.

  Parameters

  • kind: DataKind

    The type of data to be accessed. The actual type of this parameter is interfaces.DataKind.

  • key: string

    The unique key of the entity within the specified collection.

  • version: number

    A number that must be greater than the version property of the existing entity in order for it to be deleted. If it is less than or equal to the existing version, the method should do nothing.

  • callback: () => void

    Will be called when the delete operation is complete.

  Returns void

get

• get(
      kind: DataKind,
      key: string,
      callback: (res: LDFeatureStoreItem | null) => void,
  ): void

  Get an entity from the store.

  The store should treat any entity with the property deleted: true as "not found".

  Parameters

  • kind: DataKind

    The type of data to be accessed. The store should not make any assumptions about the format of the data, but just return a JSON object. The actual type of this parameter is interfaces.DataKind.

  • key: string

    The unique key of the entity within the specified collection.

  • callback: (res: LDFeatureStoreItem | null) => void

    Will be called with the retrieved entity, or null if not found. The actual type of the result value is interfaces.VersionedData.

  Returns void

getDescription

• getDescription(): string

  Get a description of the store.

  Returns string

init

• init(allData: LDFeatureStoreDataStorage, callback: (err?: Error) => void): void

  Initialize the store, overwriting any existing data.

  Parameters

  • allData: LDFeatureStoreDataStorage

    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>.

  • callback: (err?: Error) => void

    Will be called when the store has been initialized. If the store could not apply the data, then it may be called with an error. Implementations are not required to report errors.

  Returns void

initialized

• initialized(callback: (isInitialized: boolean) => void): void

  Tests whether the store is initialized.

  "Initialized" means that the store has been populated with data, either by the client having called init() within this process, or by another process (if this is a shared database).

  Parameters

  • callback: (isInitialized: boolean) => void

    Will be called back with the boolean result.

  Returns void

upsert

• upsert(
      kind: DataKind,
      data: LDKeyedFeatureStoreItem,
      callback: (err?: Error) => void,
  ): void

  Add an entity or update an existing entity.

  Parameters

  • kind: DataKind

    The type of data to be accessed. The actual type of this parameter is interfaces.DataKind.

  • data: LDKeyedFeatureStoreItem

    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 interfaces.VersionedData.

  • callback: (err?: Error) => void

    Will be called after the upsert operation is complete. If the store could not apply the update, then it may be called with an error. Implementations are not required to report errors.

  Returns void