Skip to content

Update Firestore type names #5135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 27, 2021
Merged

Update Firestore type names #5135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4b065a3
Update Firestore type names
Feiyang1 Jul 9, 2021
1da4509
update firestore lite names
Feiyang1 Jul 22, 2021
3138052
Merge branch 'master' into fei-type-names
Feiyang1 Jul 22, 2021
51c3b00
update api reports
Feiyang1 Jul 22, 2021
e4a6506
address comments
Feiyang1 Jul 23, 2021
96cb683
address comments
Feiyang1 Jul 23, 2021
69bc6ac
add periods
Feiyang1 Jul 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions common/api-review/firestore-lite.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

```ts

import { EmulatorMockTokenOptions } from '@firebase/util';
import { FirebaseApp } from '@firebase/app-exp';
import { LogLevelString as LogLevel } from '@firebase/logger';

Expand All @@ -27,7 +28,7 @@ export class Bytes {
}

// @public
export function collection(firestore: FirebaseFirestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;
export function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;

// @public
export function collection(reference: CollectionReference<unknown>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;
Expand All @@ -36,7 +37,7 @@ export function collection(reference: CollectionReference<unknown>, path: string
export function collection(reference: DocumentReference, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;

// @public
export function collectionGroup(firestore: FirebaseFirestore, collectionId: string): Query<DocumentData>;
export function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData>;

// @public
export class CollectionReference<T = DocumentData> extends Query<T> {
Expand All @@ -48,14 +49,19 @@ export class CollectionReference<T = DocumentData> extends Query<T> {
withConverter(converter: null): CollectionReference<DocumentData>;
}

// @public
export function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions;
}): void;

// @public
export function deleteDoc(reference: DocumentReference<unknown>): Promise<void>;

// @public
export function deleteField(): FieldValue;

// @public
export function doc(firestore: FirebaseFirestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData>;
export function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData>;

// @public
export function doc<T>(reference: CollectionReference<T>, path?: string, ...pathSegments: string[]): DocumentReference<T>;
Expand All @@ -73,7 +79,8 @@ export function documentId(): FieldPath;

// @public
export class DocumentReference<T = DocumentData> {
readonly firestore: FirebaseFirestore;
readonly converter: FirestoreDataConverter<T> | null;
readonly firestore: Firestore;
get id(): string;
get parent(): CollectionReference<T>;
get path(): string;
Expand Down Expand Up @@ -116,9 +123,10 @@ export abstract class FieldValue {
}

// @public
export class FirebaseFirestore {
export class Firestore {
get app(): FirebaseApp;
toJSON(): object;
type: 'firestore-lite' | 'firestore';
}

// @public
Expand Down Expand Up @@ -158,13 +166,13 @@ export function getDoc<T>(reference: DocumentReference<T>): Promise<DocumentSnap
export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;

// @public
export function getFirestore(app?: FirebaseApp): FirebaseFirestore;
export function getFirestore(app?: FirebaseApp): Firestore;

// @public
export function increment(n: number): FieldValue;

// @public
export function initializeFirestore(app: FirebaseApp, settings: Settings): FirebaseFirestore;
export function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

// @public
export function limit(limit: number): QueryConstraint;
Expand All @@ -183,7 +191,8 @@ export type OrderByDirection = 'desc' | 'asc';
// @public
export class Query<T = DocumentData> {
protected constructor();
readonly firestore: FirebaseFirestore;
readonly converter: FirestoreDataConverter<T> | null;
readonly firestore: Firestore;
readonly type: 'query' | 'collection';
withConverter(converter: null): Query<DocumentData>;
withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
Expand Down Expand Up @@ -222,7 +231,7 @@ export class QuerySnapshot<T = DocumentData> {
export function refEqual<T>(left: DocumentReference<T> | CollectionReference<T>, right: DocumentReference<T> | CollectionReference<T>): boolean;

// @public
export function runTransaction<T>(firestore: FirebaseFirestore, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;
export function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;

// @public
export function serverTimestamp(): FieldValue;
Expand Down Expand Up @@ -266,7 +275,7 @@ export function startAt(snapshot: DocumentSnapshot<unknown>): QueryConstraint;
export function startAt(...fieldValues: unknown[]): QueryConstraint;

// @public
export function terminate(firestore: FirebaseFirestore): Promise<void>;
export function terminate(firestore: Firestore): Promise<void>;

// @public
export class Timestamp {
Expand Down Expand Up @@ -310,9 +319,6 @@ export function updateDoc(reference: DocumentReference<unknown>, data: UpdateDat
// @public
export function updateDoc(reference: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

// @public
export function useFirestoreEmulator(firestore: FirebaseFirestore, host: string, port: number): void;

// @public
export function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryConstraint;

Expand All @@ -330,9 +336,7 @@ export class WriteBatch {
}

// @public
export function writeBatch(firestore: FirebaseFirestore): WriteBatch;

export function writeBatch(firestore: Firestore): WriteBatch;

// (No @packageDocumentation comment for this package)

```
Loading