Class InMemoryFlagConfigCache

Used to store flag configurations for use in local evaluations.

Hierarchy

InMemoryFlagConfigCache

Implements

FlagConfigCache

Index

Constructors

Methods

clear delete get getAll getAllCached put putAll

Constructors

constructor

new InMemoryFlagConfigCache(store?: FlagConfigCache, flagConfigs?: Record<string, FlagConfig>): InMemoryFlagConfigCache
Parameters
- Optional store: FlagConfigCache
- flagConfigs: Record<string, FlagConfig> = {}
Returns InMemoryFlagConfigCache

Methods

clear

clear(): Promise<void>
Clear the cache of all flag keys and configurations.

Returns Promise<void>

Implementation of FlagConfigCache.clear

delete

delete(flagKey: string): Promise<void>
Delete a flag key and configuration from the cache.
Parameters
- flagKey: string
  
  The key and configuration to delete.
Returns Promise<void>

Implementation of FlagConfigCache.delete

get

get(flagKey: string): Promise<FlagConfig>
Get a flag configuration for the given flag key from the cache.
Parameters
- flagKey: string
  
  the key to get the flag configuration for
Returns Promise<FlagConfig>

Implementation of FlagConfigCache.get

getAll

getAll(): Promise<Record<string, FlagConfig>>
Get all the flag configurations from the cache.

Returns Promise<Record<string, FlagConfig>>

Implementation of FlagConfigCache.getAll

getAllCached

getAllCached(): Record<string, FlagConfig>
Returns Record<string, FlagConfig>

put

put(flagKey: string, flagConfig: FlagConfig): Promise<void>
Put a flag configuration in the cache, overwriting an existing configuration for the same flag key.
Parameters
- flagKey: string
  
  The flag key for the given flag configuration.
- flagConfig: FlagConfig
  
  The flag configuration to store in the cache.
Returns Promise<void>

Implementation of FlagConfigCache.put

putAll

putAll(flagConfigs: Record<string, FlagConfig>): Promise<void>
Put all the flag configurations into the cache, overwriting any existing configurations for the same key, but not clearing the cache completely.
Parameters
- flagConfigs: Record<string, FlagConfig>
  
  The flag keys and configurations to put into the cache.
Returns Promise<void>

Implementation of FlagConfigCache.putAll