Skip to content

Commit 4e620b0

Browse files
committed
Use jsdoc style comments.
1 parent 6d3f78e commit 4e620b0

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

packages/firebase/index.d.ts

+19-19
Original file line numberDiff line numberDiff line change
@@ -9999,59 +9999,59 @@ declare namespace firebase.firestore {
99999999
| 'apple.com';
1000010000

1000110001
interface FirebaseIdToken {
10002-
// Always set to https://securetoken.google.com/PROJECT_ID
10002+
/** Always set to https://securetoken.google.com/PROJECT_ID */
1000310003
iss: string;
1000410004

10005-
// Always set to PROJECT_ID
10005+
/** Always set to PROJECT_ID */
1000610006
aud: string;
1000710007

10008-
// The user's unique id
10008+
/** The user's unique id */
1000910009
sub: string;
1001010010

10011-
// The token issue time, in seconds since epoch
10011+
/** The token issue time, in seconds since epoch */
1001210012
iat: number;
1001310013

10014-
// The token expiry time, normally 'iat' + 3600
10014+
/** The token expiry time, normally 'iat' + 3600 */
1001510015
exp: number;
1001610016

10017-
// The user's unique id, must be equal to 'sub'
10017+
/** The user's unique id, must be equal to 'sub' */
1001810018
user_id: string;
1001910019

10020-
// The time the user authenticated, normally 'iat'
10020+
/** The time the user authenticated, normally 'iat' */
1002110021
auth_time: number;
1002210022

10023-
// The sign in provider, only set when the provider is 'anonymous'
10023+
/** The sign in provider, only set when the provider is 'anonymous' */
1002410024
provider_id?: 'anonymous';
1002510025

10026-
// The user's primary email
10026+
/** The user's primary email */
1002710027
email?: string;
1002810028

10029-
// The user's email verification status
10029+
/** The user's email verification status */
1003010030
email_verified?: boolean;
1003110031

10032-
// The user's primary phone number
10032+
/** The user's primary phone number */
1003310033
phone_number?: string;
1003410034

10035-
// The user's display name
10035+
/** The user's display name */
1003610036
name?: string;
1003710037

10038-
// The user's profile photo URL
10038+
/** The user's profile photo URL */
1003910039
picture?: string;
1004010040

10041-
// Information on all identities linked to this user
10041+
/** Information on all identities linked to this user */
1004210042
firebase: {
10043-
// The primary sign-in provider
10043+
/** The primary sign-in provider */
1004410044
sign_in_provider: FirebaseSignInProvider;
1004510045

10046-
// A map of providers to the user's list of unique identifiers from
10047-
// each provider
10046+
/** A map of providers to the user's list of unique identifiers from each provider */
1004810047
identities?: { [provider in FirebaseSignInProvider]?: string[] };
1004910048
};
1005010049

10051-
// Custom claims set by the developer
10050+
/** Custom claims set by the developer */
1005210051
[claim: string]: unknown;
1005310052

10054-
uid?: never; // Try to catch a common mistake of "uid" (should be "sub" instead).
10053+
// NO LONGER SUPPORTED. Use "sub" instead. (Not a jsdoc comment to avoid generating docs.)
10054+
uid?: never;
1005510055
}
1005610056

1005710057
export type EmulatorMockTokenOptions = (

0 commit comments

Comments
 (0)