firebase-admin
Version:
Firebase admin SDK for Node.js
38 lines (37 loc) • 1.5 kB
TypeScript
/*! firebase-admin v13.3.0 */
/*!
* @license
* Copyright 2024 Google Inc.
*
* 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 { PrefixedFirebaseError } from '../utils/error';
/**
* When true the SDK should communicate with the Data Connect Emulator for all API
* calls and also produce unsigned tokens.
*/
export declare function useEmulator(): boolean;
export declare const DATA_CONNECT_ERROR_CODE_MAPPING: {
[key: string]: DataConnectErrorCode;
};
export type DataConnectErrorCode = 'aborted' | 'invalid-argument' | 'invalid-credential' | 'internal-error' | 'permission-denied' | 'unauthenticated' | 'not-found' | 'unknown-error' | 'query-error';
/**
* Firebase Data Connect error code structure. This extends PrefixedFirebaseError.
*
* @param code - The error code.
* @param message - The error message.
* @constructor
*/
export declare class FirebaseDataConnectError extends PrefixedFirebaseError {
constructor(code: DataConnectErrorCode, message: string);
}