UNPKG

1.07 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google LLC
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 { Auth, UserCredential } from '../../model/public_types';
18/**
19 * Asynchronously signs in as an anonymous user.
20 *
21 * @remarks
22 * If there is already an anonymous user signed in, that user will be returned; otherwise, a
23 * new anonymous user identity will be created and returned.
24 *
25 * @param auth - The {@link Auth} instance.
26 *
27 * @public
28 */
29export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;