@firebase/app/dist/app/src/types.d.ts

The primary entrypoint to the Firebase JS SDK

/**
 * @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.
 */
export interface VersionService {
    library: string;
    version: string;
}
export interface PlatformLoggerService {
    getPlatformInfoString(): string;
}
export interface HeartbeatService {
    /**
     * Called to report a heartbeat. The function will generate
     * a HeartbeatsByUserAgent object, update heartbeatsCache, and persist it
     * to IndexedDB.
     * Note that we only store one heartbeat per day. So if a heartbeat for today is
     * already logged, subsequent calls to this function in the same day will be ignored.
     */
    triggerHeartbeat(): Promise<void>;
    /**
     * Returns a base64 encoded string which can be attached to the heartbeat-specific header directly.
     * It also clears all heartbeats from memory as well as in IndexedDB.
     */
    getHeartbeatsHeader(): Promise<string>;
}
export interface HeartbeatsByUserAgent {
    agent: string;
    dates: string[];
}
export interface SingleDateHeartbeat {
    agent: string;
    date: string;
}
export interface HeartbeatStorage {
    overwrite(heartbeats: HeartbeatsInIndexedDB): Promise<void>;
    add(heartbeats: HeartbeatsInIndexedDB): Promise<void>;
    read(): Promise<HeartbeatsInIndexedDB>;
}
export interface HeartbeatsInIndexedDB {
    lastSentHeartbeatDate?: string;
    heartbeats: SingleDateHeartbeat[];
}