firebase-admin/lib/firestore/error.d.ts

Firebase admin SDK for Node.js

/*! firebase-admin v14.0.0 */
/*!
 * Copyright 2026 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { FirebaseError, ErrorInfo } from '../utils/error';
/**
 * The constant mapping for valid Firestore client error codes.
 */
export declare const FirestoreErrorCode: {
    readonly FAILED_PRECONDITION: "failed-precondition";
    readonly INVALID_ARGUMENT: "invalid-argument";
    readonly INVALID_CREDENTIAL: "invalid-credential";
    readonly MISSING_DEPENDENCIES: "missing-dependencies";
};
/**
 * The type definition for valid Firestore client error codes.
 */
export type FirestoreErrorCode = typeof FirestoreErrorCode[keyof typeof FirestoreErrorCode];
/**
 * Firebase Firestore error code structure. This extends `FirebaseError`.
 */
export declare class FirebaseFirestoreError extends FirebaseError {
    /**
     * @param info - The error code info.
     * @param message - The error message. This will override the default
     *     message if provided.
     */
    constructor(info: ErrorInfo, message?: string);
}