Edit File: Repo.d.ts
/** * @license * Copyright 2017 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 { AppCheckTokenProvider } from './AppCheckTokenProvider'; import { AuthTokenProvider } from './AuthTokenProvider'; import { PersistentConnection } from './PersistentConnection'; import { RepoInfo } from './RepoInfo'; import { ServerActions } from './ServerActions'; import { Node } from './snap/Node'; import { SnapshotHolder } from './SnapshotHolder'; import { SparseSnapshotTree } from './SparseSnapshotTree'; import { StatsCollection } from './stats/StatsCollection'; import { StatsListener } from './stats/StatsListener'; import { StatsReporter } from './stats/StatsReporter'; import { SyncTree } from './SyncTree'; import { Indexable } from './util/misc'; import { Path } from './util/Path'; import { Tree } from './util/Tree'; import { EventQueue } from './view/EventQueue'; import { EventRegistration, QueryContext } from './view/EventRegistration'; declare const enum TransactionStatus { RUN = 0, SENT = 1, COMPLETED = 2, SENT_NEEDS_ABORT = 3, NEEDS_ABORT = 4 } interface Transaction { path: Path; update: (a: unknown) => unknown; onComplete: (error: Error | null, committed: boolean, node: Node | null) => void; status: TransactionStatus; order: number; applyLocally: boolean; retryCount: number; unwatcher: () => void; abortReason: string | null; currentWriteId: number; currentInputSnapshot: Node | null; currentOutputSnapshotRaw: Node | null; currentOutputSnapshotResolved: Node | null; } /** * A connection to a single data repository. */ export declare class Repo { repoInfo_: RepoInfo; forceRestClient_: boolean; authTokenProvider_: AuthTokenProvider; appCheckProvider_: AppCheckTokenProvider; /** Key for uniquely identifying this repo, used in RepoManager */ readonly key: string; dataUpdateCount: number; infoSyncTree_: SyncTree; serverSyncTree_: SyncTree; stats_: StatsCollection; statsListener_: StatsListener | null; eventQueue_: EventQueue; nextWriteId_: number; server_: ServerActions; statsReporter_: StatsReporter; infoData_: SnapshotHolder; interceptServerDataCallback_: ((a: string, b: unknown) => void) | null; /** A list of data pieces and paths to be set when this client disconnects. */ onDisconnect_: SparseSnapshotTree; /** Stores queues of outstanding transactions for Firebase locations. */ transactionQueueTree_: Tree<Transaction[]>; persistentConnection_: PersistentConnection | null; constructor(repoInfo_: RepoInfo, forceRestClient_: boolean, authTokenProvider_: AuthTokenProvider, appCheckProvider_: AppCheckTokenProvider); /** * @returns The URL corresponding to the root of this Firebase. */ toString(): string; } export declare function repoStart(repo: Repo, appId: string, authOverride?: object): void; /** * @returns The time in milliseconds, taking the server offset into account if we have one. */ export declare function repoServerTime(repo: Repo): number; /** * Generate ServerValues using some variables from the repo object. */ export declare function repoGenerateServerValues(repo: Repo): Indexable; export declare function repoInterceptServerData(repo: Repo, callback: ((a: string, b: unknown) => unknown) | null): void; /** * The purpose of `getValue` is to return the latest known value * satisfying `query`. * * This method will first check for in-memory cached values * belonging to active listeners. If they are found, such values * are considered to be the most up-to-date. * * If the client is not connected, this method will try to * establish a connection and request the value for `query`. If * the client is not able to retrieve the query result, it reports * an error. * * @param query - The query to surface a value for. */ export declare function repoGetValue(repo: Repo, query: QueryContext): Promise<Node>; export declare function repoSetWithPriority(repo: Repo, path: Path, newVal: unknown, newPriority: number | string | null, onComplete: ((status: Error | null, errorReason?: string) => void) | null): void; export declare function repoUpdate(repo: Repo, path: Path, childrenToMerge: { [k: string]: unknown; }, onComplete: ((status: Error | null, errorReason?: string) => void) | null): void; export declare function repoOnDisconnectCancel(repo: Repo, path: Path, onComplete: ((status: Error | null, errorReason?: string) => void) | null): void; export declare function repoOnDisconnectSet(repo: Repo, path: Path, value: unknown, onComplete: ((status: Error | null, errorReason?: string) => void) | null): void; export declare function repoOnDisconnectSetWithPriority(repo: Repo, path: Path, value: unknown, priority: unknown, onComplete: ((status: Error | null, errorReason?: string) => void) | null): void; export declare function repoOnDisconnectUpdate(repo: Repo, path: Path, childrenToMerge: { [k: string]: unknown; }, onComplete: ((status: Error | null, errorReason?: string) => void) | null): void; export declare function repoAddEventCallbackForQuery(repo: Repo, query: QueryContext, eventRegistration: EventRegistration): void; export declare function repoRemoveEventCallbackForQuery(repo: Repo, query: QueryContext, eventRegistration: EventRegistration): void; export declare function repoInterrupt(repo: Repo): void; export declare function repoResume(repo: Repo): void; export declare function repoStats(repo: Repo, showDelta?: boolean): void; export declare function repoStatsIncrementCounter(repo: Repo, metric: string): void; export declare function repoCallOnCompleteCallback(repo: Repo, callback: ((status: Error | null, errorReason?: string) => void) | null, status: string, errorReason?: string | null): void; /** * Creates a new transaction, adds it to the transactions we're tracking, and * sends it to the server if possible. * * @param path - Path at which to do transaction. * @param transactionUpdate - Update callback. * @param onComplete - Completion callback. * @param unwatcher - Function that will be called when the transaction no longer * need data updates for `path`. * @param applyLocally - Whether or not to make intermediate results visible */ export declare function repoStartTransaction(repo: Repo, path: Path, transactionUpdate: (a: unknown) => unknown, onComplete: ((error: Error, committed: boolean, node: Node) => void) | null, unwatcher: () => void, applyLocally: boolean): void; export {};
Back to File Manager