49 lines
2.0 KiB
TypeScript
49 lines
2.0 KiB
TypeScript
/*! 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';
|
|
/** @const {Record<string, FunctionsErrorCode>} Cloud Functions server to client error code mapping. */
|
|
export declare const FUNCTIONS_ERROR_CODE_MAPPING: Record<string, FunctionsErrorCode>;
|
|
/**
|
|
* The constant mapping for valid Cloud Functions client error codes.
|
|
*/
|
|
export declare const FunctionsErrorCode: {
|
|
readonly ABORTED: "aborted";
|
|
readonly INVALID_ARGUMENT: "invalid-argument";
|
|
readonly INVALID_CREDENTIAL: "invalid-credential";
|
|
readonly INTERNAL_ERROR: "internal-error";
|
|
readonly FAILED_PRECONDITION: "failed-precondition";
|
|
readonly PERMISSION_DENIED: "permission-denied";
|
|
readonly UNAUTHENTICATED: "unauthenticated";
|
|
readonly NOT_FOUND: "not-found";
|
|
readonly UNKNOWN_ERROR: "unknown-error";
|
|
readonly TASK_ALREADY_EXISTS: "task-already-exists";
|
|
};
|
|
/**
|
|
* The type definition for valid Cloud Functions client error codes.
|
|
*/
|
|
export type FunctionsErrorCode = typeof FunctionsErrorCode[keyof typeof FunctionsErrorCode];
|
|
/**
|
|
* Cloud Functions error code structure. This extends `FirebaseError`.
|
|
*/
|
|
export declare class FirebaseFunctionsError 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);
|
|
}
|