fireodm
Version:
A basic and extensible ODM for the Firestore Admin SDK in Node.js with decorators, relationships, and validation.
17 lines • 798 B
TypeScript
import { Firestore } from "firebase-admin/firestore";
/**
* Defines the instance of the Firestore that the library will use.
* It must be called once in the initialization of your application.
* @Param Instance the initialized instance of Firestore (Admin.firestore()).
* @Param Options Options for configuration.`ALLOWOVERWRITE` (False Standard) allows you to redefine the instance, useful for testing.
*/
export declare function setFirestoreInstance(instance: Firestore, options?: {
allowOverwrite?: boolean;
}): void;
/**
* Obtains the instance of the configured Firestore.
* @throws Error If Setfirestoreinstance was not called.
* @returns The Instance of the Firestore.
*/
export declare function getFirestoreInstance(): Firestore;
//# sourceMappingURL=firestore-instance.d.ts.map