remote-config package

Веб-SDK Firebase Remote Config. Этот SDK не работает в среде Node.js.

Функции

Функция Описание
функция (приложение, ...)
getRemoteConfig (приложение)
функция (remoteConfig, ...)
активировать (удаленная конфигурация) Делает последнюю полученную конфигурацию доступной для геттеров.
обеспеченияИнициализированный(удаленныйКонфиг) Гарантирует, что последняя активированная конфигурация доступна геттерам.
fetchAndActivate (удаленная конфигурация) Для удобства выполняет операции выборки и активации.
выборкаConfig (удаленная конфигурация) Извлекает и кэширует конфигурацию из службы Remote Config.
getAll (удаленная конфигурация) Получает все настройки.
getBoolean (remoteConfig, ключ) Получает значение данного ключа в виде логического значения. Удобный метод для вызова remoteConfig.getValue(key).asBoolean() .
getNumber (удаленная конфигурация, ключ) Получает значение для данного ключа в виде числа. Удобный метод для вызова remoteConfig.getValue(key).asNumber() .
getString (remoteConfig, ключ) Получает значение данного ключа в виде строки. Удобный метод для вызова remoteConfig.getValue(key).asString() .
getValue (remoteConfig, ключ) Получает значение для данного ключа.
setLogLevel (remoteConfig, logLevel) Определяет используемый уровень журнала.
функция()
isSupported() Этот метод обеспечивает две разные проверки: 1. Проверьте, существует ли IndexedDB в среде браузера. 2. Проверьте, разрешает ли текущий контекст браузера вызовы IndexedDB open() .

Интерфейсы

Интерфейс Описание
Удаленная конфигурация Интерфейс службы Firebase Remote Config.
Параметры удаленной конфигурации Определяет параметры конфигурации для Remote Config SDK.
Ценить Обертывает значение метаданными и типобезопасными методами получения.

Введите псевдонимы

Введите псевдоним Описание
FetchStatus Обобщает результаты последней попытки получить конфигурацию с сервера Firebase Remote Config.
  • «no-fetch-yet» указывает, что экземпляр RemoteConfig еще не пытался получить конфигурацию или что инициализация SDK не завершена.
  • «успех» указывает на успешную последнюю попытку.
  • «сбой» означает, что последняя попытка не удалась.
  • «Дроссель» указывает на то, что последняя попытка была ограничена по скорости.
Уровень журнала Определяет уровни ведения журнала Remote Config.
Источник значения Указывает источник значения.
  • «статический» указывает, что значение было определено статической константой.
  • «по умолчанию» указывает, что значение было определено конфигурацией по умолчанию.
  • «Удаленный» указывает, что значение было определено полученной конфигурацией.

функция (приложение, ...)

getRemoteConfig (приложение)

Подпись:

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

Параметры

Параметр Тип Описание
приложение FirebaseApp Экземпляр FirebaseApp .

Возврат:

Удаленная конфигурация

Экземпляр RemoteConfig .

функция (remoteConfig, ...)

активировать (удаленная конфигурация)

Делает последнюю полученную конфигурацию доступной для геттеров.

Подпись:

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .

Возврат:

Обещание <логическое значение>

Promise , которое принимает значение true, если текущий вызов активировал полученные конфигурации. Если полученные конфигурации уже активированы, Promise примет значение false.

обеспеченияИнициализированный (удаленнаяконфигурация)

Гарантирует, что последняя активированная конфигурация доступна геттерам.

Подпись:

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .

Возврат:

Обещание<void>

Promise , которое выполняется, когда геттерам доступна последняя активированная конфигурация.

fetchAndActivate (удаленная конфигурация)

Для удобства выполняет операции выборки и активации.

Подпись:

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .

Возврат:

Обещание <логическое значение>

Promise , которое принимает значение true, если текущий вызов активировал полученные конфигурации. Если полученные конфигурации уже активированы, Promise примет значение false.

выборкаConfig (удаленная конфигурация)

Извлекает и кэширует конфигурацию из службы Remote Config.

Подпись:

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .

Возврат:

Обещание<void>

getAll (удаленная конфигурация)

Получает все настройки.

Подпись:

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .

Возврат:

Запись<строка, Значение >

Все конфиг.

getBoolean (remoteConfig, ключ)

Получает значение данного ключа в виде логического значения.

Удобный метод для вызова remoteConfig.getValue(key).asBoolean() .

Подпись:

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .
ключ нить Имя параметра.

Возврат:

логическое значение

Значение данного ключа в виде логического значения.

getNumber (удаленная конфигурация, ключ)

Получает значение для данного ключа в виде числа.

Удобный метод для вызова remoteConfig.getValue(key).asNumber() .

Подпись:

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .
ключ нить Имя параметра.

Возврат:

число

Значение данного ключа в виде числа.

getString (remoteConfig, ключ)

Получает значение данного ключа в виде строки. Удобный метод для вызова remoteConfig.getValue(key).asString() .

Подпись:

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .
ключ нить Имя параметра.

Возврат:

нить

Значение данного ключа в виде строки.

getValue (remoteConfig, ключ)

Получает значение для данного ключа.

Подпись: 

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

Параметры

Параметр Тип Описание
удаленнаяконфигурация Удаленная конфигурация Экземпляр RemoteConfig .
ключ нить Имя параметра.

Возврат:

Ценить

Значение данного ключа.

setLogLevel (remoteConfig, logLevel)

Определяет используемый уровень журнала.

Подпись: 

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

Параметры

Параметр Тип Описание
удаленная конфигурация Удаленная конфигурация Экземпляр RemoteConfig .
уровень журнала Ремолентконфиглоглевел Уровень журнала, который необходимо установить.

Возврат:

пустота

функция()

isSupported()

Этот метод обеспечивает две разные проверки:

  1. Проверьте, существует ли IndexedDB в среде браузера. 2. Проверьте, разрешает ли текущий контекст браузера вызовы IndexedDB open() .

Подпись: 

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

Возврат:

Обещание <логическое значение>

Promise , которое принимает значение true, если экземпляр RemoteConfig может быть инициализирован в этой среде, или значение false, если это невозможно.

FetchStatus

Обобщает результаты последней попытки получить конфигурацию с сервера Firebase Remote Config.

  • «no-fetch-yet» указывает, что экземпляр [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) еще не пытался получить конфигурацию или что инициализация SDK не завершена.
  • «успех» указывает на успешную последнюю попытку.
  • «сбой» означает, что последняя попытка не удалась.
  • «Дроссель» указывает на то, что последняя попытка была ограничена по скорости.

Подпись: 

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

Уровень журнала

Определяет уровни ведения журнала Remote Config.

Подпись: 

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

Источник значения

Указывает источник значения.

  • «статический» указывает, что значение было определено статической константой.
  • «по умолчанию» указывает, что значение было определено конфигурацией по умолчанию.
  • «Удаленный» указывает, что значение было определено полученной конфигурацией.

Подпись: 

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