Class FlagConfigPoller

Hierarchy

FlagConfigUpdaterBase
- FlagConfigPoller

Implements

FlagConfigUpdater

Index

Constructors

Properties

cache cohortFetcher? cohortStorage fetcher

Methods

start stop update

Constructors

constructor

new FlagConfigPoller(fetcher: FlagConfigFetcher, cache: FlagConfigCache, cohortStorage: CohortStorage, cohortFetcher?: CohortFetcher, pollingIntervalMillis?: number, debug?: boolean): FlagConfigPoller
Parameters
- fetcher: FlagConfigFetcher
- cache: FlagConfigCache
- cohortStorage: CohortStorage
- Optional cohortFetcher: CohortFetcher
- pollingIntervalMillis: number = LocalEvaluationDefaults.flagConfigPollingIntervalMillis
- debug: boolean = false
Returns FlagConfigPoller

Overrides FlagConfigUpdaterBase.constructor

Properties

`Readonly` cache

cache: FlagConfigCache

`Optional` `Readonly` cohortFetcher

cohortFetcher?: CohortFetcher

`Readonly` cohortStorage

cohortStorage: CohortStorage

`Readonly` fetcher

fetcher: FlagConfigFetcher

Methods

start

start(onChange?: ((cache: FlagConfigCache) => Promise<void>)): Promise<void>
Fetch initial flag configurations and start polling for updates.

You must call this function to begin polling for flag config updates. The promise returned by this function is resolved when the initial call to fetch the flag configuration completes.

Calling this function while the poller is already running does nothing.
Parameters
- Optional onChange: ((cache: FlagConfigCache) => Promise<void>)
  - - (cache: FlagConfigCache): Promise<void>
    - Parameters
      
      cache: FlagConfigCache
      
      Returns Promise<void>
Returns Promise<void>

Implementation of FlagConfigUpdater.start

stop

stop(): void
Stop polling for flag configurations.

Calling this function while the poller is not running will do nothing.

Returns void

Implementation of FlagConfigUpdater.stop

update

update(onChange?: ((cache: FlagConfigCache) => Promise<void>)): Promise<void>
Parameters
- Optional onChange: ((cache: FlagConfigCache) => Promise<void>)
  - - (cache: FlagConfigCache): Promise<void>
    - Parameters
      
      cache: FlagConfigCache
      
      Returns Promise<void>
Returns Promise<void>

Implementation of FlagConfigUpdater.update