remote-config package

Internetowy pakiet SDK zdalnej konfiguracji Firebase. Ten zestaw SDK nie działa w środowisku Node.js.

Funkcje

Funkcjonować Opis
funkcja (aplikacja, ...)
pobierzRemoteConfig(aplikacja)
funkcja(zdalna konfiguracja, ...)
aktywuj (zdalną konfigurację) Udostępnia modułom pobierającym ostatnią pobraną konfigurację.
upewnij się, że zainicjowano (zdalną konfigurację) Zapewnia dostępność ostatniej aktywowanej konfiguracji dla modułów pobierających.
fetchAndActivate(zdalna konfiguracja) Dla wygody wykonuje operacje pobierania i aktywacji.
fetchConfig (zdalna konfiguracja) Pobiera i buforuje konfigurację z usługi Remote Config.
pobierz wszystko (zdalna konfiguracja) Pobiera całą konfigurację.
getBoolean(zdalna konfiguracja, klucz) Pobiera wartość dla danego klucza jako wartość logiczną. Wygodna metoda wywoływania remoteConfig.getValue(key).asBoolean() .
getNumber(zdalna konfiguracja, klucz) Pobiera wartość dla danego klucza jako liczbę. Wygodna metoda wywoływania remoteConfig.getValue(key).asNumber() .
getString(zdalna konfiguracja, klucz) Pobiera wartość dla danego klucza jako ciąg. Wygodna metoda wywoływania remoteConfig.getValue(key).asString() .
getValue(zdalna konfiguracja, klucz) Pobiera wartość dla danego klucza.
setLogLevel(remoteConfig, logLevel) Określa używany poziom rejestrowania.
funkcjonować()
jest wspierany() Ta metoda zapewnia dwie różne kontrole: 1. Sprawdź, czy w środowisku przeglądarki istnieje IndexedDB. 2. Sprawdź, czy bieżący kontekst przeglądarki pozwala na wywoływanie metody open() IndexedDB.

Interfejsy

Interfejs Opis
Zdalna konfiguracja Interfejs usługi Firebase Remote Config.
Ustawienia zdalnej konfiguracji Definiuje opcje konfiguracji pakietu SDK zdalnej konfiguracji.
Wartość Zawija wartość metadanymi i modułami pobierającymi bezpiecznymi dla typu.

Wpisz aliasy

Wpisz Alias Opis
Stan pobierania Podsumowuje wynik ostatniej próby pobrania konfiguracji z serwera zdalnej konfiguracji Firebase.
  • „no-fetch-jet” oznacza, że ​​instancja RemoteConfig nie podjęła jeszcze próby pobrania konfiguracji lub że inicjalizacja pakietu SDK nie została ukończona.
  • „sukces” oznacza, że ​​ostatnia próba zakończyła się sukcesem.
  • „niepowodzenie” oznacza, że ​​ostatnia próba nie powiodła się.
  • „przepustnica” oznacza, że ​​ostatnia próba miała ograniczoną prędkość.
Poziom dziennika Definiuje poziomy rejestrowania zdalnej konfiguracji.
Źródło wartości Wskazuje źródło wartości.
  • „static” oznacza, że ​​wartość została zdefiniowana przez stałą statyczną.
  • „default” oznacza, że ​​wartość została zdefiniowana w konfiguracji domyślnej.
  • „remote” oznacza, że ​​wartość została zdefiniowana przez pobraną konfigurację.

funkcja (aplikacja, ...)

pobierzRemoteConfig(aplikacja)

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase Instancja FirebaseApp .

Zwroty:

Zdalna konfiguracja

Instancja RemoteConfig .

funkcja(zdalna konfiguracja, ...)

aktywuj (zdalną konfigurację)

Udostępnia modułom pobierającym ostatnią pobraną konfigurację.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .

Zwroty:

Obietnica<boolean>

Promise , która ma wartość true, jeśli bieżące wywołanie aktywowało pobrane konfiguracje. Jeśli pobrane konfiguracje zostały już aktywowane, Promise zmieni się na false.

upewnij się, że zainicjowano (zdalną konfigurację)

Zapewnia dostępność ostatniej aktywowanej konfiguracji dla modułów pobierających.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .

Zwroty:

Obietnica<pusta>

Promise , która zostaje rozpatrzona, gdy ostatnia aktywowana konfiguracja będzie dostępna dla pobierających.

fetchAndActivate(zdalna konfiguracja)

Dla wygody wykonuje operacje pobierania i aktywacji.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .

Zwroty:

Obietnica<boolean>

Promise , która ma wartość true, jeśli bieżące wywołanie aktywowało pobrane konfiguracje. Jeśli pobrane konfiguracje zostały już aktywowane, Promise zmieni się na false.

fetchConfig (zdalna konfiguracja)

Pobiera i buforuje konfigurację z usługi Remote Config.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .

Zwroty:

Obietnica<pusta>

pobierz wszystko (zdalna konfiguracja)

Pobiera całą konfigurację.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .

Zwroty:

Rekord<ciąg, Wartość >

Cała konfiguracja

getBoolean(zdalna konfiguracja, klucz)

Pobiera wartość dla danego klucza jako wartość logiczną.

Wygodna metoda wywoływania remoteConfig.getValue(key).asBoolean() .

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .
klucz strunowy Nazwa parametru.

Zwroty:

wartość logiczna

Wartość dla danego klucza jako wartość logiczna.

getNumber(zdalna konfiguracja, klucz)

Pobiera wartość dla danego klucza jako liczbę.

Wygodna metoda wywoływania remoteConfig.getValue(key).asNumber() .

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .
klucz strunowy Nazwa parametru.

Zwroty:

numer

Wartość danego klucza jako liczba.

getString(zdalna konfiguracja, klucz)

Pobiera wartość dla danego klucza jako ciąg. Wygodna metoda wywoływania remoteConfig.getValue(key).asString() .

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .
klucz strunowy Nazwa parametru.

Zwroty:

strunowy

Wartość dla danego klucza jako ciąg.

getValue(zdalna konfiguracja, klucz)

Pobiera wartość dla danego klucza.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .
klucz strunowy Nazwa parametru.

Zwroty:

Wartość

Wartość dla danego klucza.

setLogLevel(remoteConfig, logLevel)

Określa używany poziom rejestrowania.

Podpis:

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

Parametry

Parametr Typ Opis
zdalna konfiguracja Zdalna konfiguracja Instancja RemoteConfig .
poziom dziennika Poziom dziennika zdalnej konfiguracji Poziom rejestrowania do ustawienia.

Zwroty:

próżnia

funkcjonować()

jest wspierany()

Ta metoda zapewnia dwie różne kontrole:

  1. Sprawdź, czy w środowisku przeglądarki istnieje IndexedDB. 2. Sprawdź, czy bieżący kontekst przeglądarki pozwala na wywoływanie metody open() IndexedDB.

Podpis:

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

Zwroty:

Obietnica<boolean>

Promise , która ma wartość true, jeśli instancję RemoteConfig można zainicjować w tym środowisku, lub false, jeśli nie jest to możliwe.

Stan pobierania

Podsumowuje wynik ostatniej próby pobrania konfiguracji z serwera zdalnej konfiguracji Firebase.

  • „no-fetch-yet” oznacza, że ​​instancja [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) nie podjęła jeszcze próby pobrania konfiguracji lub że inicjalizacja zestawu SDK nie została ukończona.
  • „sukces” oznacza, że ​​ostatnia próba zakończyła się sukcesem.
  • „niepowodzenie” oznacza, że ​​ostatnia próba nie powiodła się.
  • „przepustnica” wskazuje, że ostatnia próba miała ograniczoną prędkość.

Podpis:

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

Poziom dziennika

Definiuje poziomy rejestrowania zdalnej konfiguracji.

Podpis:

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

Źródło wartości

Wskazuje źródło wartości.

  • „static” oznacza, że ​​wartość została zdefiniowana przez stałą statyczną.
  • „default” oznacza, że ​​wartość została zdefiniowana w konfiguracji domyślnej.
  • „remote” oznacza, że ​​wartość została zdefiniowana przez pobraną konfigurację.

Podpis:

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