UNPKG

1.81 kBTypeScriptView Raw
1/*! firebase-admin v10.0.0 */
2/*!
3 * @license
4 * Copyright 2021 Google Inc.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18/**
19 * Firebase App Check.
20 *
21 * @packageDocumentation
22 */
23import { App } from '../app';
24import { AppCheck } from './app-check';
25export { AppCheckToken, AppCheckTokenOptions, DecodedAppCheckToken, VerifyAppCheckTokenResponse, } from './app-check-api';
26export { AppCheck } from './app-check';
27/**
28 * Gets the {@link AppCheck} service for the default app or a given app.
29 *
30 * `getAppCheck()` can be called with no arguments to access the default
31 * app's `AppCheck` service or as `getAppCheck(app)` to access the
32 * `AppCheck` service associated with a specific app.
33 *
34 * @example
35 * ```javascript
36 * // Get the `AppCheck` service for the default app
37 * const defaultAppCheck = getAppCheck();
38 * ```
39 *
40 * @example
41 * ```javascript
42 * // Get the `AppCheck` service for a given app
43 * const otherAppCheck = getAppCheck(otherApp);
44 * ```
45 *
46 * @param app - Optional app for which to return the `AppCheck` service.
47 * If not provided, the default `AppCheck` service is returned.
48 *
49 * @returns The default `AppCheck` service if no
50 * app is provided, or the `AppCheck` service associated with the provided
51 * app.
52 */
53export declare function getAppCheck(app?: App): AppCheck;