The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment.

Functions

Interfaces

Type Aliases

function(app, ...)

getRemoteConfig(app, options)

Signature:

exportdeclarefunctiongetRemoteConfig(app?:FirebaseApp,options?:RemoteConfigOptions):RemoteConfig;

Parameters

Returns:

RemoteConfig

ARemoteConfig instance.

function(remoteConfig, ...)

activate(remoteConfig)

Makes the last fetched config available to the getters.

Signature:

exportdeclarefunctionactivate(remoteConfig:RemoteConfig):Promise<boolean>;

Parameters

Returns:

Promise<boolean>

APromise which resolves to true if the current call activated the fetched configs. If the fetched configs were already activated, thePromise will resolve to false.

ensureInitialized(remoteConfig)

Ensures the last activated config are available to the getters.

Signature:

exportdeclarefunctionensureInitialized(remoteConfig:RemoteConfig):Promise<void>;

Parameters

Returns:

Promise<void>

APromise that resolves when the last activated config is available to the getters.

fetchAndActivate(remoteConfig)

Performs fetch and activate operations, as a convenience.

Signature:

exportdeclarefunctionfetchAndActivate(remoteConfig:RemoteConfig):Promise<boolean>;

Parameters

Returns:

Promise<boolean>

APromise which resolves to true if the current call activated the fetched configs. If the fetched configs were already activated, thePromise will resolve to false.

fetchConfig(remoteConfig)

Fetches and caches configuration from the Remote Config service.

Signature:

exportdeclarefunctionfetchConfig(remoteConfig:RemoteConfig):Promise<void>;

Parameters

Returns:

Promise<void>

getAll(remoteConfig)

Gets all config.

Signature:

exportdeclarefunctiongetAll(remoteConfig:RemoteConfig):Record<string,Value>;

Parameters

Returns:

Record<string,Value>

All config.

getBoolean(remoteConfig, key)

Gets the value for the given key as a boolean.

Convenience method for callingremoteConfig.getValue(key).asBoolean().

Signature:

exportdeclarefunctiongetBoolean(remoteConfig:RemoteConfig,key:string):boolean;

Parameters

Returns:

boolean

The value for the given key as a boolean.

getNumber(remoteConfig, key)

Gets the value for the given key as a number.

Convenience method for callingremoteConfig.getValue(key).asNumber().

Signature:

exportdeclarefunctiongetNumber(remoteConfig:RemoteConfig,key:string):number;

Parameters

Returns:

number

The value for the given key as a number.

getString(remoteConfig, key)

Gets the value for the given key as a string. Convenience method for callingremoteConfig.getValue(key).asString().

Signature:

exportdeclarefunctiongetString(remoteConfig:RemoteConfig,key:string):string;

Parameters

Returns:

string

The value for the given key as a string.

getValue(remoteConfig, key)

Gets theValue for the given key.

Signature:

exportdeclarefunctiongetValue(remoteConfig:RemoteConfig,key:string):Value;

Parameters

Returns:

Value

The value for the given key.

onConfigUpdate(remoteConfig, observer)

Starts listening for real-time config updates from the Remote Config backend and automatically fetches updates from the Remote Config backend when they are available.

If a connection to the Remote Config backend is not already open, calling this method will open it. Multiple listeners can be added by calling this method again, but subsequent calls re-use the same connection to the backend.

Signature:

exportdeclarefunctiononConfigUpdate(remoteConfig:RemoteConfig,observer:ConfigUpdateObserver):Unsubscribe;

Parameters

Returns:

Unsubscribe

AnUnsubscribe function to remove the listener.

setCustomSignals(remoteConfig, customSignals)

Sets the custom signals for the app instance.

Signature:

exportdeclarefunctionsetCustomSignals(remoteConfig:RemoteConfig,customSignals:CustomSignals):Promise<void>;

Parameters

Returns:

Promise<void>

setLogLevel(remoteConfig, logLevel)

Defines the log level to use.

Signature:

exportdeclarefunctionsetLogLevel(remoteConfig:RemoteConfig,logLevel:RemoteConfigLogLevel):void;

Parameters

Returns:

void

function()

isSupported()

This method provides two different checks:

1. Check if IndexedDB exists in the browser environment. 2. Check if the current browser context allows IndexedDBopen() calls.

Signature:

exportdeclarefunctionisSupported():Promise<boolean>;

Returns:

Promise<boolean>

APromise which resolves to true if aRemoteConfig instance can be initialized in this environment, or false if it cannot.

FetchStatus

Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server.

• "no-fetch-yet" indicates the [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) instance has not yet attempted to fetch config, or that SDK initialization is incomplete.
• "success" indicates the last attempt succeeded.
• "failure" indicates the last attempt failed.
• "throttle" indicates the last attempt was rate-limited.

Signature:

exporttypeFetchStatus='no-fetch-yet'|'success'|'failure'|'throttle';

FetchType

Indicates the type of fetch request.

• "BASE" indicates a standard fetch request.
• "REALTIME" indicates a fetch request triggered by a real-time update.

Signature:

exporttypeFetchType='BASE'|'REALTIME';

LogLevel

Defines levels of Remote Config logging.

Signature:

exporttypeLogLevel='debug'|'error'|'silent';

Unsubscribe

A function that unsubscribes from a real-time event stream.

Signature:

exporttypeUnsubscribe=()=>void;

ValueSource

Indicates the source of a value.

• "static" indicates the value was defined by a static constant.
• "default" indicates the value was defined by default config.
• "remote" indicates the value was defined by fetched config.

Signature:

exporttypeValueSource='static'|'default'|'remote';