Fires2REST - v0.3.0
    Preparing search index...

    Interface FirestoreClientInterface

    Interface for the Firestore client. Used internally by Query, DocumentReference, and CollectionReference.

    interface FirestoreClientInterface {
        _deleteDocument(path: string): Promise<void>;
        _getDocument(
            path: string,
            transactionId?: string,
        ): Promise<FirestoreDocument>;
        _getDocumentName(path: string): string;
        _runAggregationQuery(
            collectionPath: string,
            query: StructuredQuery,
            aggregations: Aggregation[],
        ): Promise<AggregationResult>;
        _runQuery(
            collectionPath: string,
            query: StructuredQuery,
            transactionId?: string,
        ): Promise<RunQueryResponseItem[]>;
        _setDocument(
            path: string,
            data: Record<string, unknown>,
            options?: { merge?: boolean },
        ): Promise<WriteResult>;
        _updateDocument(
            path: string,
            data: Record<string, unknown>,
        ): Promise<WriteResult>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • path: string

      Returns Promise<void>

    • Parameters

      • path: string

      Returns string

    • Parameters

      • path: string
      • data: Record<string, unknown>
      • Optionaloptions: { merge?: boolean }

      Returns Promise<WriteResult>

    • Parameters

      • path: string
      • data: Record<string, unknown>

      Returns Promise<WriteResult>