firebase-admin
Version:
Firebase admin SDK for Node.js
46 lines (45 loc) • 1.82 kB
TypeScript
/*! firebase-admin v14.0.0 */
/*!
* Copyright 2019 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 Security Rules client error codes.
*/
export declare const SecurityRulesErrorCode: {
readonly ALREADY_EXISTS: "already-exists";
readonly AUTHENTICATION_ERROR: "authentication-error";
readonly INTERNAL_ERROR: "internal-error";
readonly INVALID_ARGUMENT: "invalid-argument";
readonly INVALID_SERVER_RESPONSE: "invalid-server-response";
readonly NOT_FOUND: "not-found";
readonly RESOURCE_EXHAUSTED: "resource-exhausted";
readonly SERVICE_UNAVAILABLE: "service-unavailable";
readonly UNKNOWN_ERROR: "unknown-error";
};
/**
* The type definition for valid Security Rules client error codes.
*/
export type SecurityRulesErrorCode = typeof SecurityRulesErrorCode[keyof typeof SecurityRulesErrorCode];
/**
* Firebase Security Rules error code structure. This extends `FirebaseError`.
*/
export declare class FirebaseSecurityRulesError extends FirebaseError {
/**
* @param info - The error code info.
* @param message - The error message. If provided, this will override the default message.
*/
constructor(info: ErrorInfo, message?: string);
}