Skip to content

Commit 27918b1

Browse files
hsubox76hsubox76
committed
Update API reports
1 parent a7c81d8 commit 27918b1

File tree

2 files changed

+0
-101
lines changed

2 files changed

+0
-101
lines changed

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

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ export type AggregateFieldType = AggregateField<number>;
2727

2828
// @public
2929
export class AggregateQuerySnapshot<T extends AggregateSpec> {
30-
;
3130
data(): AggregateSpecData<T>;
3231
readonly query: Query<unknown>;
3332
readonly type = "AggregateQuerySnapshot";
@@ -55,7 +54,6 @@ export function arrayUnion(...elements: unknown[]): FieldValue;
5554

5655
// @public
5756
export class Bytes {
58-
;
5957
static fromBase64String(base64: string): Bytes;
6058
static fromUint8Array(array: Uint8Array): Bytes;
6159
isEqual(other: Bytes): boolean;
@@ -81,7 +79,6 @@ export function collectionGroup(firestore: Firestore, collectionId: string): Que
8179

8280
// @public
8381
export class CollectionReference<T = DocumentData> extends Query<T> {
84-
;
8582
get id(): string;
8683
get parent(): DocumentReference<DocumentData> | null;
8784
get path(): string;
@@ -120,11 +117,9 @@ export function documentId(): FieldPath;
120117

121118
// @public
122119
export class DocumentReference<T = DocumentData> {
123-
;
124120
readonly converter: FirestoreDataConverter<T> | null;
125121
readonly firestore: Firestore;
126122
get id(): string;
127-
;
128123
get parent(): CollectionReference<T>;
129124
get path(): string;
130125
readonly type = "document";
@@ -134,11 +129,6 @@ export class DocumentReference<T = DocumentData> {
134129

135130
// @public
136131
export class DocumentSnapshot<T = DocumentData> {
137-
;
138-
;
139-
;
140-
;
141-
;
142132
protected constructor();
143133
data(): T | undefined;
144134
exists(): this is QueryDocumentSnapshot<T>;
@@ -163,38 +153,20 @@ export function endBefore(...fieldValues: unknown[]): QueryConstraint;
163153

164154
// @public
165155
export class FieldPath {
166-
;
167156
constructor(...fieldNames: string[]);
168157
isEqual(other: FieldPath): boolean;
169158
}
170159

171160
// @public
172161
export abstract class FieldValue {
173-
;
174162
abstract isEqual(other: FieldValue): boolean;
175-
;
176163
}
177164

178165
// @public
179166
export class Firestore {
180-
;
181-
;
182-
;
183-
;
184-
;
185-
;
186-
;
187-
;
188167
get app(): FirebaseApp;
189168
toJSON(): object;
190-
;
191-
;
192-
;
193-
;
194-
;
195-
;
196169
type: 'firestore-lite' | 'firestore';
197-
;
198170
}
199171

200172
// @public
@@ -216,8 +188,6 @@ export type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' |
216188

217189
// @public
218190
export class GeoPoint {
219-
;
220-
;
221191
constructor(latitude: number, longitude: number);
222192
isEqual(other: GeoPoint): boolean;
223193
get latitude(): number;
@@ -226,7 +196,6 @@ export class GeoPoint {
226196
latitude: number;
227197
longitude: number;
228198
};
229-
;
230199
}
231200

232201
// @public
@@ -282,7 +251,6 @@ export type Primitive = string | number | boolean | undefined | null;
282251
// @public
283252
export class Query<T = DocumentData> {
284253
protected constructor();
285-
;
286254
readonly converter: FirestoreDataConverter<T> | null;
287255
readonly firestore: Firestore;
288256
readonly type: 'query' | 'collection';
@@ -296,7 +264,6 @@ export function query<T>(query: Query<T>, ...queryConstraints: QueryConstraint[]
296264
// @public
297265
export abstract class QueryConstraint {
298266
abstract readonly type: QueryConstraintType;
299-
;
300267
}
301268

302269
// @public
@@ -313,7 +280,6 @@ export function queryEqual<T>(left: Query<T>, right: Query<T>): boolean;
313280

314281
// @public
315282
export class QuerySnapshot<T = DocumentData> {
316-
;
317283
get docs(): Array<QueryDocumentSnapshot<T>>;
318284
get empty(): boolean;
319285
forEach(callback: (result: QueryDocumentSnapshot<T>) => void, thisArg?: unknown): void;
@@ -383,7 +349,6 @@ export class Timestamp {
383349
static now(): Timestamp;
384350
readonly seconds: number;
385351
toDate(): Date;
386-
;
387352
toJSON(): {
388353
seconds: number;
389354
nanoseconds: number;
@@ -395,9 +360,6 @@ export class Timestamp {
395360

396361
// @public
397362
export class Transaction {
398-
;
399-
;
400-
;
401363
delete(documentRef: DocumentReference<unknown>): this;
402364
get<T>(documentRef: DocumentReference<T>): Promise<DocumentSnapshot<T>>;
403365
set<T>(documentRef: DocumentReference<T>, data: WithFieldValue<T>): this;
@@ -438,18 +400,12 @@ export type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
438400

439401
// @public
440402
export class WriteBatch {
441-
;
442-
;
443-
;
444-
;
445-
;
446403
commit(): Promise<void>;
447404
delete(documentRef: DocumentReference<unknown>): WriteBatch;
448405
set<T>(documentRef: DocumentReference<T>, data: WithFieldValue<T>): WriteBatch;
449406
set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): WriteBatch;
450407
update<T>(documentRef: DocumentReference<T>, data: UpdateData<T>): WriteBatch;
451408
update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
452-
;
453409
}
454410

455411
// @public

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

Lines changed: 0 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ export type AggregateFieldType = AggregateField<number>;
2727

2828
// @public
2929
export class AggregateQuerySnapshot<T extends AggregateSpec> {
30-
;
3130
data(): AggregateSpecData<T>;
3231
readonly query: Query<unknown>;
3332
readonly type = "AggregateQuerySnapshot";
@@ -55,7 +54,6 @@ export function arrayUnion(...elements: unknown[]): FieldValue;
5554

5655
// @public
5756
export class Bytes {
58-
;
5957
static fromBase64String(base64: string): Bytes;
6058
static fromUint8Array(array: Uint8Array): Bytes;
6159
isEqual(other: Bytes): boolean;
@@ -87,7 +85,6 @@ export function collectionGroup(firestore: Firestore, collectionId: string): Que
8785

8886
// @public
8987
export class CollectionReference<T = DocumentData> extends Query<T> {
90-
;
9188
get id(): string;
9289
get parent(): DocumentReference<DocumentData> | null;
9390
get path(): string;
@@ -140,11 +137,9 @@ export function documentId(): FieldPath;
140137

141138
// @public
142139
export class DocumentReference<T = DocumentData> {
143-
;
144140
readonly converter: FirestoreDataConverter<T> | null;
145141
readonly firestore: Firestore;
146142
get id(): string;
147-
;
148143
get parent(): CollectionReference<T>;
149144
get path(): string;
150145
readonly type = "document";
@@ -154,17 +149,11 @@ export class DocumentReference<T = DocumentData> {
154149

155150
// @public
156151
export class DocumentSnapshot<T = DocumentData> {
157-
;
158-
;
159152
protected constructor();
160153
data(options?: SnapshotOptions): T | undefined;
161154
exists(): this is QueryDocumentSnapshot<T>;
162155
get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
163156
get id(): string;
164-
;
165-
;
166-
;
167-
;
168157
readonly metadata: SnapshotMetadata;
169158
get ref(): DocumentReference<T>;
170159
}
@@ -194,39 +183,19 @@ export function endBefore(...fieldValues: unknown[]): QueryConstraint;
194183

195184
// @public
196185
export class FieldPath {
197-
;
198186
constructor(...fieldNames: string[]);
199187
isEqual(other: FieldPath): boolean;
200188
}
201189

202190
// @public
203191
export abstract class FieldValue {
204-
;
205192
abstract isEqual(other: FieldValue): boolean;
206-
;
207193
}
208194

209195
// @public
210196
export class Firestore {
211-
;
212-
;
213-
;
214197
get app(): FirebaseApp;
215-
;
216-
;
217-
;
218-
;
219-
;
220-
;
221-
;
222-
;
223198
toJSON(): object;
224-
;
225-
;
226-
;
227-
;
228-
;
229-
;
230199
type: 'firestore-lite' | 'firestore';
231200
}
232201

@@ -259,8 +228,6 @@ export interface FirestoreSettings {
259228

260229
// @public
261230
export class GeoPoint {
262-
;
263-
;
264231
constructor(latitude: number, longitude: number);
265232
isEqual(other: GeoPoint): boolean;
266233
get latitude(): number;
@@ -269,7 +236,6 @@ export class GeoPoint {
269236
latitude: number;
270237
longitude: number;
271238
};
272-
;
273239
}
274240

275241
// @public
@@ -342,15 +308,9 @@ export function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint
342308

343309
// @public
344310
export class LoadBundleTask implements PromiseLike<LoadBundleTaskProgress> {
345-
;
346-
;
347-
;
348311
catch<R>(onRejected: (a: Error) => R | PromiseLike<R>): Promise<R | LoadBundleTaskProgress>;
349312
onProgress(next?: (progress: LoadBundleTaskProgress) => unknown, error?: (err: Error) => unknown, complete?: () => void): void;
350313
then<T, R>(onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>, onRejected?: (a: Error) => R | PromiseLike<R>): Promise<T | R>;
351-
;
352-
;
353-
;
354314
}
355315

356316
// @public
@@ -444,7 +404,6 @@ export type Primitive = string | number | boolean | undefined | null;
444404
// @public
445405
export class Query<T = DocumentData> {
446406
protected constructor();
447-
;
448407
readonly converter: FirestoreDataConverter<T> | null;
449408
readonly firestore: Firestore;
450409
readonly type: 'query' | 'collection';
@@ -458,7 +417,6 @@ export function query<T>(query: Query<T>, ...queryConstraints: QueryConstraint[]
458417
// @public
459418
export abstract class QueryConstraint {
460419
abstract readonly type: QueryConstraintType;
461-
;
462420
}
463421

464422
// @public
@@ -475,12 +433,7 @@ export function queryEqual<T>(left: Query<T>, right: Query<T>): boolean;
475433

476434
// @public
477435
export class QuerySnapshot<T = DocumentData> {
478-
;
479-
;
480-
;
481436
docChanges(options?: SnapshotListenOptions): Array<DocumentChange<T>>;
482-
;
483-
;
484437
get docs(): Array<QueryDocumentSnapshot<T>>;
485438
get empty(): boolean;
486439
forEach(callback: (result: QueryDocumentSnapshot<T>) => void, thisArg?: unknown): void;
@@ -570,7 +523,6 @@ export class Timestamp {
570523
static now(): Timestamp;
571524
readonly seconds: number;
572525
toDate(): Date;
573-
;
574526
toJSON(): {
575527
seconds: number;
576528
nanoseconds: number;
@@ -582,10 +534,7 @@ export class Timestamp {
582534

583535
// @public
584536
export class Transaction {
585-
;
586537
delete(documentRef: DocumentReference<unknown>): this;
587-
;
588-
;
589538
get<T>(documentRef: DocumentReference<T>): Promise<DocumentSnapshot<T>>;
590539
set<T>(documentRef: DocumentReference<T>, data: WithFieldValue<T>): this;
591540
set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): this;
@@ -633,18 +582,12 @@ export type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
633582

634583
// @public
635584
export class WriteBatch {
636-
;
637-
;
638-
;
639-
;
640-
;
641585
commit(): Promise<void>;
642586
delete(documentRef: DocumentReference<unknown>): WriteBatch;
643587
set<T>(documentRef: DocumentReference<T>, data: WithFieldValue<T>): WriteBatch;
644588
set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): WriteBatch;
645589
update<T>(documentRef: DocumentReference<T>, data: UpdateData<T>): WriteBatch;
646590
update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
647-
;
648591
}
649592

650593
// @public

0 commit comments

Comments
 (0)