remote-config package

El SDK web de Firebase Remote Config Este SDK no funciona en un entorno de Node.js.

Funciones

Interfaces

Escribe alias

función(app, ...)

getRemoteConfig(aplicación)

Firma:

export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;

Parámetros

Muestra:

RemoteConfig

Una instancia de RemoteConfig

función(remoteConfig, ...)

activar(remoteConfig)

Permite que la última configuración recuperada esté disponible para los métodos get.

Firma:

export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;

Parámetros

Muestra:

Promise<boolean>

Un Promise que se resuelve como verdadero si la llamada actual activó los parámetros de configuración recuperados. Si los parámetros de configuración recuperados ya estaban activados, Promise se resolverá como falso.

AssuredInitialized(remoteConfig)

Garantiza que la última configuración activada esté disponible para los métodos get.

Firma:

export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;

Parámetros

Muestra:

Promesa<void>

Una Promise que se resuelve cuando la última configuración activada está disponible para los métodos get.

recuperarAndActivar(remoteConfig)

Realiza operaciones de recuperación y activación para tu conveniencia.

Firma:

export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;

Parámetros

Muestra:

Promise&lt;boolean&gt;

Un Promise que se resuelve como verdadero si la llamada actual activó los parámetros de configuración recuperados. Si los parámetros de configuración recuperados ya estaban activados, Promise se resolverá como falso.

recuperarConfig(remoteConfig)

Recupera y almacena en caché la configuración del servicio de Remote Config.

Firma:

export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;

Parámetros

Muestra:

Promesa<void>

getAll(remoteConfig)

Obtiene toda la configuración.

Firma:

export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;

Parámetros

Muestra:

Registro<string, Valor>

Toda la configuración.

getBoolean(remoteConfig, clave)

Obtiene el valor de la clave dada como un valor booleano.

Método de conveniencia para llamar a remoteConfig.getValue(key).asBoolean()

Firma:

export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;

Parámetros

Muestra:

booleano

El valor de la clave dada como un valor booleano.

getNumber(remoteConfig, clave)

Obtiene el valor de la clave determinada como un número.

Método de conveniencia para llamar a remoteConfig.getValue(key).asNumber()

Firma:

export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;

Parámetros

Muestra:

número

El valor de la clave dada como un número.

getString(remoteConfig, clave)

Obtiene el valor de la clave determinada como una string. Método de conveniencia para llamar a remoteConfig.getValue(key).asString()

Firma:

export declare function getString(remoteConfig: RemoteConfig, key: string): string;

Parámetros

Muestra:

string

Valor de la clave dada como una cadena.

getValue(remoteConfig, clave)

Obtiene el Value de la clave determinada.

Firma:

export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;

Parámetros

Muestra:

Valor

Es el valor de la clave determinada.

setLogLevel(remoteConfig, logLevel)

Define el nivel de registro que se usará.

Firma:

export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

Parámetros

Muestra:

void

función()

isSupported()

Este método proporciona dos comprobaciones diferentes:

1. Comprueba si IndexedDB existe en el entorno del navegador. 2. Comprueba si el contexto actual del navegador permite las llamadas open() de IndexedDB.

Firma:

export declare function isSupported(): Promise<boolean>;

Muestra:

Promise&lt;boolean&gt;

Una Promise, que se resuelve como verdadera si una instancia de RemoteConfig se puede inicializar en este entorno o como falsa si no se puede inicializar.

Estado de recuperación

Resume el resultado del último intento para recuperar la configuración del servidor de Firebase Remote Config.

• “todavía no puedo recuperar” indica que la instancia [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) aún no intentó recuperar la configuración o que la inicialización del SDK está incompleta.
• "éxito" indica que el último intento se realizó correctamente.
• “error” indica que el último intento falló.
• "limitar" indica que el último intento tuvo un límite de frecuencia.

Firma:

export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';

LogLevel

Define los niveles de registro de Remote Config.

Firma:

export declare type LogLevel = 'debug' | 'error' | 'silent';

ValorSource

Indica la fuente de un valor.

• “estático” indica que el valor se definió por una constante estática.
• “predeterminado” indica que el valor se definió según la configuración predeterminada.
• "remoto" indica que la configuración recuperada definió el valor.

Firma:

export declare type ValueSource = 'static' | 'default' | 'remote';