Interface FlagManager

Top level manager of flags for the client. LDClient should be using this interface and not any of the specific instances managed by it. Updates from data sources should be directed to the [init] and [upsert] methods of this interface.

Hierarchy

FlagManager

Index

Methods

get getAll init loadCached off on setBootstrap upsert

Methods

get

get(key): undefined | ItemDescriptor
Attempts to get a flag by key from the current flags.
Parameters
- key: string
Returns undefined | ItemDescriptor
- Defined in packages/shared/sdk-client/src/flag-manager/FlagManager.ts:19

getAll

getAll(): {
[key: string]: ItemDescriptor;
}
Gets all the current flags.

Returns {
[key: string]: ItemDescriptor;
}
- [key: string]: ItemDescriptor
- Defined in packages/shared/sdk-client/src/flag-manager/FlagManager.ts:24

init

init(context, newFlags): Promise<void>
Initializes the flag manager with data from a data source. Persistence initialization is handled by FlagPersistence
Parameters
- context: Context
- newFlags: {
  [key: string]: ItemDescriptor;
  }
  - [key: string]: ItemDescriptor
Returns Promise<void>
- Defined in packages/shared/sdk-client/src/flag-manager/FlagManager.ts:30

loadCached

loadCached(context): Promise<boolean>
Asynchronously load cached values from persistence.
Parameters
- context: Context
Returns Promise<boolean>
- Defined in packages/shared/sdk-client/src/flag-manager/FlagManager.ts:41

off

off(callback): void
Unregister a flag change callback.
Parameters
- callback: FlagsChangeCallback
Returns void
- Defined in packages/shared/sdk-client/src/flag-manager/FlagManager.ts:57

on

on(callback): void
Register a flag change callback.
Parameters
- callback: FlagsChangeCallback
Returns void
- Defined in packages/shared/sdk-client/src/flag-manager/FlagManager.ts:52

setBootstrap

setBootstrap(context, newFlags): void
Update in-memory storage with the specified flags, but do not persistent them to cache storage.
Parameters
- context: Context
- newFlags: {
  [key: string]: ItemDescriptor;
  }
  - [key: string]: ItemDescriptor
Returns void
- Defined in packages/shared/sdk-client/src/flag-manager/FlagManager.ts:47

upsert

upsert(context, key, item): Promise<boolean>
Attempt to update a flag. If the flag is for the wrong context, or it is of an older version, then an update will not be performed.
Parameters
- context: Context
- key: string
- item: ItemDescriptor
Returns Promise<boolean>
- Defined in packages/shared/sdk-client/src/flag-manager/FlagManager.ts:36

Generated using TypeDoc