Skip to content

Commit 8c8b262

Browse files
committed
Update API reports
1 parent a36d545 commit 8c8b262

File tree

4 files changed

+22
-2
lines changed

4 files changed

+22
-2
lines changed

common/api-review/auth.api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ export function applyActionCode(auth: Auth, oobCode: string): Promise<void>;
8181
// @public
8282
export interface Auth {
8383
readonly app: FirebaseApp;
84+
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
8485
readonly config: Config;
8586
readonly currentUser: User | null;
8687
readonly emulatorConfig: EmulatorConfig | null;
@@ -241,6 +242,9 @@ export interface AuthSettings {
241242
appVerificationDisabledForTesting: boolean;
242243
}
243244

245+
// @public
246+
export function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
247+
244248
// @public
245249
export const browserLocalPersistence: Persistence;
246250

common/api-review/database.api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,12 @@ export function equalTo(value: number | string | boolean | null, key?: string):
6464
// @public
6565
export type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
6666

67+
// @public
68+
export function forceLongPolling(): void;
69+
70+
// @public
71+
export function forceWebSockets(): void;
72+
6773
// @public
6874
export function get(query: Query): Promise<DataSnapshot>;
6975

common/api-review/firestore-lite.api.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ export class QuerySnapshot<T = DocumentData> {
254254
export function refEqual<T>(left: DocumentReference<T> | CollectionReference<T>, right: DocumentReference<T> | CollectionReference<T>): boolean;
255255

256256
// @public
257-
export function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;
257+
export function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;
258258

259259
// @public
260260
export function serverTimestamp(): FieldValue;
@@ -331,6 +331,11 @@ export class Transaction {
331331
update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
332332
}
333333

334+
// @public
335+
export interface TransactionOptions {
336+
readonly maxAttempts?: number;
337+
}
338+
334339
// @public
335340
export type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
336341

common/api-review/firestore.api.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ export class QuerySnapshot<T = DocumentData> {
385385
export function refEqual<T>(left: DocumentReference<T> | CollectionReference<T>, right: DocumentReference<T> | CollectionReference<T>): boolean;
386386

387387
// @public
388-
export function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;
388+
export function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;
389389

390390
// @public
391391
export function serverTimestamp(): FieldValue;
@@ -475,6 +475,11 @@ export class Transaction {
475475
update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
476476
}
477477

478+
// @public
479+
export interface TransactionOptions {
480+
readonly maxAttempts?: number;
481+
}
482+
478483
// @public
479484
export type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
480485

0 commit comments

Comments
 (0)