UNPKG

1.28 kBTypeScriptView Raw
1/*! firebase-admin v10.0.0 */
2/*!
3 * Copyright 2019 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17import { HttpError } from '../utils/api-request';
18import { FirebaseMessagingError } from '../utils/error';
19/**
20 * Creates a new FirebaseMessagingError by extracting the error code, message and other relevant
21 * details from an HTTP error response.
22 *
23 * @param err - The HttpError to convert into a Firebase error
24 * @returns A Firebase error that can be returned to the user.
25 */
26export declare function createFirebaseError(err: HttpError): FirebaseMessagingError;
27/**
28 * @param response - The response to check for errors.
29 * @returns The error code if present; null otherwise.
30 */
31export declare function getErrorCode(response: any): string | null;