Do not edit this file. It is a report generated by API Extractor.
import{EmulatorMockTokenOptions}from'@firebase/util';import{FirebaseApp}from'@firebase/app';import{FirebaseError}from'@firebase/util';import{LogLevelStringasLogLevel}from'@firebase/logger';// @publicexportfunctionaddDoc<AppModelType,DbModelTypeextendsDocumentData>(reference: CollectionReference<AppModelType,DbModelType>,data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType,DbModelType>>;// @publicexporttypeAddPrefixToKeys<Prefixextendsstring,TextendsRecord<string,unknown>>={[KinkeyofT&stringas `${Prefix}.${K}`]+?: stringextendsK ? any : T[K];};// @publicexportclassAggregateField<T>{readonlyaggregateType: AggregateType;readonlytype="AggregateField";}// @publicexportfunctionaggregateFieldEqual(left: AggregateField<unknown>,right: AggregateField<unknown>): boolean;// @publicexporttypeAggregateFieldType=ReturnType<typeofsum>|ReturnType<typeofaverage>|ReturnType<typeofcount>;// @publicexportclassAggregateQuerySnapshot<AggregateSpecTypeextendsAggregateSpec,AppModelType=DocumentData,DbModelTypeextendsDocumentData=DocumentData>{data(): AggregateSpecData<AggregateSpecType>;readonlyquery: Query<AppModelType,DbModelType>;readonlytype="AggregateQuerySnapshot";}// @publicexportfunctionaggregateQuerySnapshotEqual<AggregateSpecTypeextendsAggregateSpec,AppModelType,DbModelTypeextendsDocumentData>(left: AggregateQuerySnapshot<AggregateSpecType,AppModelType,DbModelType>,right: AggregateQuerySnapshot<AggregateSpecType,AppModelType,DbModelType>): boolean;// @publicexportinterfaceAggregateSpec{// (undocumented)[field: string]: AggregateFieldType;}// @publicexporttypeAggregateSpecData<TextendsAggregateSpec>={[PinkeyofT]: T[P]extendsAggregateField<infer U> ? U : never;};// @publicexporttypeAggregateType='count'|'avg'|'sum';// @publicexportfunctionand(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;// @publicexportfunctionarrayRemove(...elements: unknown[]): FieldValue;// @publicexportfunctionarrayUnion(...elements: unknown[]): FieldValue;// @publicexportfunctionaverage(field: string|FieldPath): AggregateField<number|null>;// @publicexportclassBytes{staticfromBase64String(base64: string): Bytes;staticfromUint8Array(array: Uint8Array): Bytes;isEqual(other: Bytes): boolean;toBase64(): string;toString(): string;toUint8Array(): Uint8Array;}// @publicexporttypeChildUpdateFields<Kextendsstring,V>=VextendsRecord<string,unknown> ? AddPrefixToKeys<K,UpdateData<V>> : never;// @publicexportfunctioncollection(firestore: Firestore,path: string, ...pathSegments: string[]): CollectionReference<DocumentData,DocumentData>;// @publicexportfunctioncollection<AppModelType,DbModelTypeextendsDocumentData>(reference: CollectionReference<AppModelType,DbModelType>,path: string, ...pathSegments: string[]): CollectionReference<DocumentData,DocumentData>;// @publicexportfunctioncollection<AppModelType,DbModelTypeextendsDocumentData>(reference: DocumentReference<AppModelType,DbModelType>,path: string, ...pathSegments: string[]): CollectionReference<DocumentData,DocumentData>;// @publicexportfunctioncollectionGroup(firestore: Firestore,collectionId: string): Query<DocumentData,DocumentData>;// @publicexportclassCollectionReference<AppModelType=DocumentData,DbModelTypeextendsDocumentData=DocumentData>extendsQuery<AppModelType,DbModelType>{getid(): string;getparent(): DocumentReference<DocumentData,DocumentData>|null;getpath(): string;readonlytype="collection";withConverter<NewAppModelType,NewDbModelTypeextendsDocumentData=DocumentData>(converter: FirestoreDataConverter<NewAppModelType,NewDbModelType>): CollectionReference<NewAppModelType,NewDbModelType>;withConverter(converter: null): CollectionReference<DocumentData,DocumentData>;}// @publicexportfunctionconnectFirestoreEmulator(firestore: Firestore,host: string,port: number,options?: {mockUserToken?: EmulatorMockTokenOptions|string;}): void;// @publicexportfunctioncount(): AggregateField<number>;// @publicexportfunctiondeleteDoc<AppModelType,DbModelTypeextendsDocumentData>(reference: DocumentReference<AppModelType,DbModelType>): Promise<void>;// @publicexportfunctiondeleteField(): FieldValue;// @publicexportfunctiondoc(firestore: Firestore,path: string, ...pathSegments: string[]): DocumentReference<DocumentData,DocumentData>;// @publicexportfunctiondoc<AppModelType,DbModelTypeextendsDocumentData>(reference: CollectionReference<AppModelType,DbModelType>,path?: string, ...pathSegments: string[]): DocumentReference<AppModelType,DbModelType>;// @publicexportfunctiondoc<AppModelType,DbModelTypeextendsDocumentData>(reference: DocumentReference<AppModelType,DbModelType>,path: string, ...pathSegments: string[]): DocumentReference<DocumentData,DocumentData>;// @publicexportinterfaceDocumentData{[field: string]: any;}// @publicexportfunctiondocumentId(): FieldPath;// @publicexportclassDocumentReference<AppModelType=DocumentData,DbModelTypeextendsDocumentData=DocumentData>{readonlyconverter: FirestoreDataConverter<AppModelType,DbModelType>|null;readonlyfirestore: Firestore;getid(): string;getparent(): CollectionReference<AppModelType,DbModelType>;getpath(): string;readonlytype="document";withConverter<NewAppModelType,NewDbModelTypeextendsDocumentData=DocumentData>(converter: FirestoreDataConverter<NewAppModelType,NewDbModelType>): DocumentReference<NewAppModelType,NewDbModelType>;withConverter(converter: null): DocumentReference<DocumentData,DocumentData>;}// @publicexportclassDocumentSnapshot<AppModelType=DocumentData,DbModelTypeextendsDocumentData=DocumentData>{protectedconstructor();data(): AppModelType|undefined;exists(): this is QueryDocumentSnapshot<AppModelType,DbModelType>;get(fieldPath: string|FieldPath): any;getid(): string;getref(): DocumentReference<AppModelType,DbModelType>;}export{EmulatorMockTokenOptions}// @publicexportfunctionendAt<AppModelType,DbModelTypeextendsDocumentData>(snapshot: DocumentSnapshot<AppModelType,DbModelType>): QueryEndAtConstraint;// @publicexportfunctionendAt(...fieldValues: unknown[]): QueryEndAtConstraint;// @publicexportfunctionendBefore<AppModelType,DbModelTypeextendsDocumentData>(snapshot: DocumentSnapshot<AppModelType,DbModelType>): QueryEndAtConstraint;// @publicexportfunctionendBefore(...fieldValues: unknown[]): QueryEndAtConstraint;// @publicexportclassFieldPath{constructor(...fieldNames: string[]);isEqual(other: FieldPath): boolean;}// @publicexportabstractclassFieldValue{abstractisEqual(other: FieldValue): boolean;}// @publicexportclassFirestore{getapp(): FirebaseApp;toJSON(): object;type: 'firestore-lite'|'firestore';}// @publicexportinterfaceFirestoreDataConverter<AppModelType,DbModelTypeextendsDocumentData=DocumentData>{fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData,DocumentData>): AppModelType;toFirestore(modelObject: WithFieldValue<AppModelType>): WithFieldValue<DbModelType>;toFirestore(modelObject: PartialWithFieldValue<AppModelType>,options: SetOptions): PartialWithFieldValue<DbModelType>;}// @publicexportclassFirestoreErrorextendsFirebaseError{readonlycode: FirestoreErrorCode;readonlymessage: string;readonlystack?: string;}// @publicexporttypeFirestoreErrorCode='cancelled'|'unknown'|'invalid-argument'|'deadline-exceeded'|'not-found'|'already-exists'|'permission-denied'|'resource-exhausted'|'failed-precondition'|'aborted'|'out-of-range'|'unimplemented'|'internal'|'unavailable'|'data-loss'|'unauthenticated';// @publicexportclassGeoPoint{constructor(latitude: number,longitude: number);isEqual(other: GeoPoint): boolean;getlatitude(): number;getlongitude(): number;toJSON(): {latitude: number;longitude: number;};}// @publicexportfunctiongetAggregate<AggregateSpecTypeextendsAggregateSpec,AppModelType,DbModelTypeextendsDocumentData>(query: Query<AppModelType,DbModelType>,aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType,AppModelType,DbModelType>>;// @publicexportfunctiongetCount<AppModelType,DbModelTypeextendsDocumentData>(query: Query<AppModelType,DbModelType>): Promise<AggregateQuerySnapshot<{count: AggregateField<number>;},AppModelType,DbModelType>>;// @publicexportfunctiongetDoc<AppModelType,DbModelTypeextendsDocumentData>(reference: DocumentReference<AppModelType,DbModelType>): Promise<DocumentSnapshot<AppModelType,DbModelType>>;// @publicexportfunctiongetDocs<AppModelType,DbModelTypeextendsDocumentData>(query: Query<AppModelType,DbModelType>): Promise<QuerySnapshot<AppModelType,DbModelType>>;// @publicexportfunctiongetFirestore(): Firestore;// @publicexportfunctiongetFirestore(app: FirebaseApp): Firestore;// @betaexportfunctiongetFirestore(databaseId: string): Firestore;// @betaexportfunctiongetFirestore(app: FirebaseApp,databaseId: string): Firestore;// @publicexportfunctionincrement(n: number): FieldValue;// @publicexportfunctioninitializeFirestore(app: FirebaseApp,settings: Settings): Firestore;// @betaexportfunctioninitializeFirestore(app: FirebaseApp,settings: Settings,databaseId?: string): Firestore;// @publicexportfunctionlimit(limit: number): QueryLimitConstraint;// @publicexportfunctionlimitToLast(limit: number): QueryLimitConstraint;export{LogLevel}// @publicexporttypeNestedUpdateFields<TextendsRecord<string,unknown>>=UnionToIntersection<{[KinkeyofT&string]: ChildUpdateFields<K,T[K]>;}[keyofT&string]>;// @publicexportfunctionor(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;// @publicexportfunctionorderBy(fieldPath: string|FieldPath,directionStr?: OrderByDirection): QueryOrderByConstraint;// @publicexporttypeOrderByDirection='desc'|'asc';// @publicexporttypePartialWithFieldValue<T>=Partial<T>|(TextendsPrimitive ? T : Textends{} ? {[KinkeyofT]?: PartialWithFieldValue<T[K]>|FieldValue;} : never);// @publicexporttypePrimitive=string|number|boolean|undefined|null;// @publicexportclassQuery<AppModelType=DocumentData,DbModelTypeextendsDocumentData=DocumentData>{protectedconstructor();readonlyconverter: FirestoreDataConverter<AppModelType,DbModelType>|null;readonlyfirestore: Firestore;readonlytype: 'query'|'collection';withConverter(converter: null): Query<DocumentData,DocumentData>;withConverter<NewAppModelType,NewDbModelTypeextendsDocumentData=DocumentData>(converter: FirestoreDataConverter<NewAppModelType,NewDbModelType>): Query<NewAppModelType,NewDbModelType>;}// @publicexportfunctionquery<AppModelType,DbModelTypeextendsDocumentData>(query: Query<AppModelType,DbModelType>,compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType,DbModelType>;// @publicexportfunctionquery<AppModelType,DbModelTypeextendsDocumentData>(query: Query<AppModelType,DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType,DbModelType>;// @publicexportclassQueryCompositeFilterConstraint{readonlytype: 'or'|'and';}// @publicexportabstractclassQueryConstraint{abstractreadonlytype: QueryConstraintType;}// @publicexporttypeQueryConstraintType='where'|'orderBy'|'limit'|'limitToLast'|'startAt'|'startAfter'|'endAt'|'endBefore';// @publicexportclassQueryDocumentSnapshot<AppModelType=DocumentData,DbModelTypeextendsDocumentData=DocumentData>extendsDocumentSnapshot<AppModelType,DbModelType>{// @overridedata(): AppModelType;}// @publicexportclassQueryEndAtConstraintextendsQueryConstraint{readonlytype: 'endBefore'|'endAt';}// @publicexportfunctionqueryEqual<AppModelType,DbModelTypeextendsDocumentData>(left: Query<AppModelType,DbModelType>,right: Query<AppModelType,DbModelType>): boolean;// @publicexportclassQueryFieldFilterConstraintextendsQueryConstraint{readonlytype="where";}// @publicexporttypeQueryFilterConstraint=QueryFieldFilterConstraint|QueryCompositeFilterConstraint;// @publicexportclassQueryLimitConstraintextendsQueryConstraint{readonlytype: 'limit'|'limitToLast';}// @publicexporttypeQueryNonFilterConstraint=QueryOrderByConstraint|QueryLimitConstraint|QueryStartAtConstraint|QueryEndAtConstraint;// @publicexportclassQueryOrderByConstraintextendsQueryConstraint{readonlytype="orderBy";}// @publicexportclassQuerySnapshot<AppModelType=DocumentData,DbModelTypeextendsDocumentData=DocumentData>{getdocs(): Array<QueryDocumentSnapshot<AppModelType,DbModelType>>;getempty(): boolean;forEach(callback: (result: QueryDocumentSnapshot<AppModelType,DbModelType>)=>void,thisArg?: unknown): void;readonlyquery: Query<AppModelType,DbModelType>;getsize(): number;}// @publicexportclassQueryStartAtConstraintextendsQueryConstraint{readonlytype: 'startAt'|'startAfter';}// @publicexportfunctionrefEqual<AppModelType,DbModelTypeextendsDocumentData>(left: DocumentReference<AppModelType,DbModelType>|CollectionReference<AppModelType,DbModelType>,right: DocumentReference<AppModelType,DbModelType>|CollectionReference<AppModelType,DbModelType>): boolean;// @publicexportfunctionrunTransaction<T>(firestore: Firestore,updateFunction: (transaction: Transaction)=>Promise<T>,options?: TransactionOptions): Promise<T>;// @publicexportfunctionserverTimestamp(): FieldValue;// @publicexportfunctionsetDoc<AppModelType,DbModelTypeextendsDocumentData>(reference: DocumentReference<AppModelType,DbModelType>,data: WithFieldValue<AppModelType>): Promise<void>;// @publicexportfunctionsetDoc<AppModelType,DbModelTypeextendsDocumentData>(reference: DocumentReference<AppModelType,DbModelType>,data: PartialWithFieldValue<AppModelType>,options: SetOptions): Promise<void>;// @publicexportfunctionsetLogLevel(logLevel: LogLevel): void;// @publicexporttypeSetOptions={readonlymerge?: boolean;}|{readonlymergeFields?: Array<string|FieldPath>;};// @publicexportinterfaceSettings{host?: string;ignoreUndefinedProperties?: boolean;ssl?: boolean;}// @publicexportfunctionsnapshotEqual<AppModelType,DbModelTypeextendsDocumentData>(left: DocumentSnapshot<AppModelType,DbModelType>|QuerySnapshot<AppModelType,DbModelType>,right: DocumentSnapshot<AppModelType,DbModelType>|QuerySnapshot<AppModelType,DbModelType>): boolean;// @publicexportfunctionstartAfter<AppModelType,DbModelTypeextendsDocumentData>(snapshot: DocumentSnapshot<AppModelType,DbModelType>): QueryStartAtConstraint;// @publicexportfunctionstartAfter(...fieldValues: unknown[]): QueryStartAtConstraint;// @publicexportfunctionstartAt<AppModelType,DbModelTypeextendsDocumentData>(snapshot: DocumentSnapshot<AppModelType,DbModelType>): QueryStartAtConstraint;// @publicexportfunctionstartAt(...fieldValues: unknown[]): QueryStartAtConstraint;// @publicexportfunctionsum(field: string|FieldPath): AggregateField<number>;// @publicexportfunctionterminate(firestore: Firestore): Promise<void>;// @publicexportclassTimestamp{constructor(seconds: number,nanoseconds: number);staticfromDate(date: Date): Timestamp;staticfromMillis(milliseconds: number): Timestamp;isEqual(other: Timestamp): boolean;readonlynanoseconds: number;staticnow(): Timestamp;readonlyseconds: number;toDate(): Date;toJSON(): {seconds: number;nanoseconds: number;};toMillis(): number;toString(): string;valueOf(): string;}// @publicexportclassTransaction{delete<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>): this;get<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>): Promise<DocumentSnapshot<AppModelType,DbModelType>>;set<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>,data: WithFieldValue<AppModelType>): this;set<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>,data: PartialWithFieldValue<AppModelType>,options: SetOptions): this;update<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>,data: UpdateData<DbModelType>): this;update<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>,field: string|FieldPath,value: unknown, ...moreFieldsAndValues: unknown[]): this;}// @publicexportinterfaceTransactionOptions{readonlymaxAttempts?: number;}// @publicexporttypeUnionToIntersection<U>=(Uextendsunknown ? (k: U)=>void : never)extends(k: infer I)=>void ? I : never;// @publicexporttypeUpdateData<T>=TextendsPrimitive ? T : Textends{} ? {[KinkeyofT]?: UpdateData<T[K]>|FieldValue;}&NestedUpdateFields<T> : Partial<T>;// @publicexportfunctionupdateDoc<AppModelType,DbModelTypeextendsDocumentData>(reference: DocumentReference<AppModelType,DbModelType>,data: UpdateData<DbModelType>): Promise<void>;// @publicexportfunctionupdateDoc<AppModelType,DbModelTypeextendsDocumentData>(reference: DocumentReference<AppModelType,DbModelType>,field: string|FieldPath,value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;// @publicexportfunctionvector(values?: number[]): VectorValue;// @publicexportclassVectorValue{/* Excluded from this release type: __constructor */isEqual(other: VectorValue): boolean;toArray(): number[];}// @publicexportfunctionwhere(fieldPath: string|FieldPath,opStr: WhereFilterOp,value: unknown): QueryFieldFilterConstraint;// @publicexporttypeWhereFilterOp='<'|'<='|'=='|'!='|'>='|'>'|'array-contains'|'in'|'array-contains-any'|'not-in';// @publicexporttypeWithFieldValue<T>=T|(TextendsPrimitive ? T : Textends{} ? {[KinkeyofT]: WithFieldValue<T[K]>|FieldValue;} : never);// @publicexportclassWriteBatch{commit(): Promise<void>;delete<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>): WriteBatch;set<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>,data: WithFieldValue<AppModelType>): WriteBatch;set<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>,data: PartialWithFieldValue<AppModelType>,options: SetOptions): WriteBatch;update<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>,data: UpdateData<DbModelType>): WriteBatch;update<AppModelType,DbModelTypeextendsDocumentData>(documentRef: DocumentReference<AppModelType,DbModelType>,field: string|FieldPath,value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;}// @publicexportfunctionwriteBatch(firestore: Firestore): WriteBatch;