UNPKG

@firebase/firestore

Version:

The Cloud Firestore component of the Firebase JS SDK.

45 lines (44 loc) 2.13 kB
/** * @license * Copyright 2019 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 { Target } from '../../../src/core/target'; import { IndexManager, IndexType } from '../../../src/local/index_manager'; import { Persistence } from '../../../src/local/persistence'; import { DocumentMap } from '../../../src/model/collections'; import { DocumentKey } from '../../../src/model/document_key'; import { FieldIndex, IndexOffset } from '../../../src/model/field_index'; import { ResourcePath } from '../../../src/model/path'; /** * A wrapper around IndexManager that automatically creates a * transaction around every operation to reduce test boilerplate. */ export declare class TestIndexManager { persistence: Persistence; indexManager: IndexManager; constructor(persistence: Persistence, indexManager: IndexManager); addToCollectionParentIndex(collectionPath: ResourcePath): Promise<void>; getCollectionParents(collectionId: string): Promise<ResourcePath[]>; addFieldIndex(index: FieldIndex): Promise<void>; deleteFieldIndex(index: FieldIndex): Promise<void>; createTargetIndexes(target: Target): Promise<void>; deleteAllFieldIndexes(): Promise<void>; getFieldIndexes(collectionGroup?: string): Promise<FieldIndex[]>; getIndexType(target: Target): Promise<IndexType>; getDocumentsMatchingTarget(target: Target): Promise<DocumentKey[] | null>; getNextCollectionGroupToUpdate(): Promise<string | null>; updateCollectionGroup(collectionGroup: string, offset: IndexOffset): Promise<void>; updateIndexEntries(documents: DocumentMap): Promise<void>; }