UNPKG

2.07 kBTypeScriptView Raw
1/*! firebase-admin v10.0.0 */
2/*!
3 * Copyright 2020 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17/**
18 * Firebase Remote Config.
19 *
20 * @packageDocumentation
21 */
22import { App } from '../app';
23import { RemoteConfig } from './remote-config';
24export { ExplicitParameterValue, InAppDefaultValue, ListVersionsOptions, ListVersionsResult, ParameterValueType, RemoteConfigCondition, RemoteConfigParameter, RemoteConfigParameterGroup, RemoteConfigParameterValue, RemoteConfigTemplate, RemoteConfigUser, TagColor, Version, } from './remote-config-api';
25export { RemoteConfig } from './remote-config';
26/**
27 * Gets the {@link RemoteConfig} service for the default app or a given app.
28 *
29 * `getRemoteConfig()` can be called with no arguments to access the default
30 * app's `RemoteConfig` service or as `getRemoteConfig(app)` to access the
31 * `RemoteConfig` service associated with a specific app.
32 *
33 * @example
34 * ```javascript
35 * // Get the `RemoteConfig` service for the default app
36 * const defaultRemoteConfig = getRemoteConfig();
37 * ```
38 *
39 * @example
40 * ```javascript
41 * // Get the `RemoteConfig` service for a given app
42 * const otherRemoteConfig = getRemoteConfig(otherApp);
43 * ```
44 *
45 * @param app - Optional app for which to return the `RemoteConfig` service.
46 * If not provided, the default `RemoteConfig` service is returned.
47 *
48 * @returns The default `RemoteConfig` service if no
49 * app is provided, or the `RemoteConfig` service associated with the provided
50 * app.
51 */
52export declare function getRemoteConfig(app?: App): RemoteConfig;