@magnetarjs/plugin-firestore-admin
Version:
Magnetar plugin firestore-admin
20 lines (19 loc) • 1.12 kB
TypeScript
import type { DocMetadata } from '@magnetarjs/types';
import type { FirestoreModuleConfig } from '@magnetarjs/utils-firestore';
import type { DocumentReference, DocumentSnapshot, Firestore, Query, QueryDocumentSnapshot, WriteBatch } from 'firebase-admin/firestore';
import { FieldValue } from 'firebase-admin/firestore';
export type { CollectionReference, DocumentReference, DocumentSnapshot, Firestore, QueryDocumentSnapshot, WriteBatch, } from 'firebase-admin/firestore';
export declare function doc(db: Firestore, path: string): DocumentReference<{
[key: string]: unknown;
}>;
export declare function createWriteBatch(db: Firestore): WriteBatch;
export declare function deleteField(): FieldValue;
/**
* If the collectionPath includes a `*` it will use a collectionQuery for the part beyond that point
*/
export declare function getQueryInstance(collectionPath: string, config: FirestoreModuleConfig, db: Firestore): Query;
export declare function docSnapshotToDocMetadata(docSnapshot: DocumentSnapshot<{
[key: string]: unknown;
}> | QueryDocumentSnapshot<{
[key: string]: unknown;
}>): DocMetadata;