UNPKG

1.41 kBTypeScriptView Raw
1import { ObservableStatus } from './useObservable';
2import { AllParameters } from 'rxfire/remote-config';
3import type { Value as RemoteConfigValue } from 'firebase/remote-config';
4/**
5 * Accepts a key and optionally a Remote Config instance. Returns a
6 * Remote Config Value.
7 *
8 * @param key The parameter key in Remote Config
9 */
10export declare function useRemoteConfigValue(key: string): ObservableStatus<RemoteConfigValue>;
11/**
12 * Convience method similar to useRemoteConfigValue. Returns a `string` from a Remote Config parameter.
13 * @param key The parameter key in Remote Config
14 */
15export declare function useRemoteConfigString(key: string): ObservableStatus<string>;
16/**
17 * Convience method similar to useRemoteConfigValue. Returns a `number` from a Remote Config parameter.
18 * @param key The parameter key in Remote Config
19 */
20export declare function useRemoteConfigNumber(key: string): ObservableStatus<number>;
21/**
22 * Convience method similar to useRemoteConfigValue. Returns a `boolean` from a Remote Config parameter.
23 * @param key The parameter key in Remote Config
24 */
25export declare function useRemoteConfigBoolean(key: string): ObservableStatus<boolean>;
26/**
27 * Convience method similar to useRemoteConfigValue. Returns allRemote Config parameters.
28 * @param key The parameter key in Remote Config
29 */
30export declare function useRemoteConfigAll(key: string): ObservableStatus<AllParameters>;