/** * @license * Copyright 2020 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { FirebaseApp } from '@firebase/app'; /** * The Firebase Remote Config service interface. * * @public */ export interface RemoteConfig { /** * The {@link @firebase/app#FirebaseApp} this `RemoteConfig` instance is associated with. */ app: FirebaseApp; /** * Defines configuration for the Remote Config SDK. */ settings: RemoteConfigSettings; /** * Object containing default values for configs. */ defaultConfig: { [key: string]: string | number | boolean; }; /** * The Unix timestamp in milliseconds of the last successful fetch, or negative one if * the {@link RemoteConfig} instance either hasn't fetched or initialization * is incomplete. */ fetchTimeMillis: number; /** * The status of the last fetch attempt. */ lastFetchStatus: FetchStatus; } /** * Indicates the source of a value. * *
Number(value) || 0
.
*/
asNumber(): number;
/**
* Gets the value as a string.
*/
asString(): string;
/**
* Gets the {@link ValueSource} for the given key.
*/
getSource(): ValueSource;
}
/**
* Defines configuration options for the Remote Config SDK.
*
* @public
*/
export interface RemoteConfigSettings {
/**
* Defines the maximum age in milliseconds of an entry in the config cache before
* it is considered stale. Defaults to 43200000 (Twelve hours).
*/
minimumFetchIntervalMillis: number;
/**
* Defines the maximum amount of milliseconds to wait for a response when fetching
* configuration from the Remote Config server. Defaults to 60000 (One minute).
*/
fetchTimeoutMillis: number;
}
/**
* Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server.
*
*