Skip to content

Commit 39feb93

Browse files
committed
Format comments.
1 parent a2a3d12 commit 39feb93

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

packages/firestore/src/api/credentials.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,10 @@ export class EmptyCredentialsProvider implements CredentialsProvider {
135135
}
136136
}
137137

138-
/** A CredentialsProvider that always returns a constant token. Used for emulator token mocking. */
138+
/**
139+
* A CredentialsProvider that always returns a constant token. Used for
140+
* emulator token mocking.
141+
*/
139142
export class EmulatorCredentialsProvider implements CredentialsProvider {
140143
constructor(private token: Token) {}
141144

packages/firestore/src/lite/database.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,8 @@ export function getFirestore(app: FirebaseApp = getApp()): FirebaseFirestore {
230230
* emulator.
231231
* @param host - the emulator host (ex: localhost).
232232
* @param port - the emulator port (ex: 9000).
233+
* @param options.mockUserToken - the mock auth token to use for unit testing
234+
* Security Rules.
233235
*/
234236
export function useFirestoreEmulator(
235237
firestore: FirebaseFirestore,
@@ -256,7 +258,8 @@ export function useFirestoreEmulator(
256258
});
257259

258260
if (options.mockUserToken) {
259-
// Let createMockUserToken validate first (catches common mistakes like "uid" and missing sub.)
261+
// Let createMockUserToken validate first (catches common mistakes like
262+
// invalid field "uid" and missing field "sub" / "user_id".)
260263
const token = createMockUserToken(options.mockUserToken);
261264
const uid = options.mockUserToken.sub || options.mockUserToken.user_id;
262265
if (!uid) {

0 commit comments

Comments
 (0)