UNPKG

@firebase/firestore

Version:

The Cloud Firestore component of the Firebase JS SDK.

41 lines (40 loc) 2.25 kB
/** * @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 { FirebaseFirestore } from '../../src/lite/database'; import { DocumentData, CollectionReference, DocumentReference, SetOptions } from '../../src/lite/reference'; import { Settings } from '../../src/lite/settings'; import { QueryDocumentSnapshot } from '../../src/lite/snapshot'; export declare function withTestDbSettings(projectId: string, settings: Settings, fn: (db: FirebaseFirestore) => void | Promise<void>): Promise<void>; export declare function withTestDb(fn: (db: FirebaseFirestore) => void | Promise<void>): Promise<void>; export declare function withTestDoc(fn: (doc: DocumentReference) => void | Promise<void>): Promise<void>; export declare function withTestDocAndInitialData(data: DocumentData, fn: (doc: DocumentReference<DocumentData>) => void | Promise<void>): Promise<void>; export declare function withTestCollectionAndInitialData(data: DocumentData[], fn: (collRef: CollectionReference<DocumentData>) => void | Promise<void>): Promise<void>; export declare function withTestCollection(fn: (collRef: CollectionReference) => void | Promise<void>): Promise<void>; export declare class Post { readonly title: string; readonly author: string; constructor(title: string, author: string); byline(): string; } export declare const postConverter: { toFirestore(post: Post): DocumentData; fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData>): Post; }; export declare const postConverterMerge: { toFirestore(post: Partial<Post>, options?: SetOptions | undefined): DocumentData; fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData>): Post; };