Class Firestore

Firestore REST API client.

Implements

FirestoreClientInterface

Index

Constructors

Methods

collection doc runTransaction useEmulator useServiceAccount

Constructors

constructor

new Firestore(_config: ConnectionConfig, _databaseId: string): Firestore
Parameters
- _config: ConnectionConfig
- _databaseId: string
Returns Firestore
- Defined in client.ts:46

Methods

collection

collection(collectionPath: string): CollectionReference
Get a collection reference.
Parameters
- collectionPath: string
Returns CollectionReference
- Defined in client.ts:90

doc

doc(documentPath: string): DocumentReference
Get a document reference.
Parameters
- documentPath: string
Returns DocumentReference
- Defined in client.ts:97

runTransaction

runTransaction<R>(
updateFn: (transaction: Transaction) => Promise<R>,
options?: { maxAttempts?: number },
): Promise<R>
Run a transaction.
Type Parameters
- R
Parameters
- updateFn: (transaction: Transaction) => Promise<R>
- Optionaloptions: { maxAttempts?: number }
Returns Promise<R>
- Defined in client.ts:104

`Static`useEmulator

useEmulator(
    __namedParameters?: {
        admin?: boolean;
        databaseId?: string;
        emulatorHost?: string;
        projectId?: string;
    },
): Firestore
Parameters
- __namedParameters: {
      admin?: boolean;
      databaseId?: string;
      emulatorHost?: string;
      projectId?: string;
  } = {}
Returns Firestore
- Defined in client.ts:66

`Static`useServiceAccount

useServiceAccount(
    projectId: string,
    config: ServiceAccountAuthConfig,
    databaseId?: string,
): Firestore
Parameters
- projectId: string
- config: ServiceAccountAuthConfig
- databaseId: string = DEFAULT_DATABASE
Returns Firestore
- Defined in client.ts:51