Ponowny eksport z zewnętrznego interfejsu API
Poniższe zewnętrznie zdefiniowane interfejsy API zostaną dla wygody ponownie wyeksportowane z punktu wejścia tego modułu.
| Symbol | Opis |
|---|---|
| BulkWriter, | Typ BulkWriter z pakietu @google-cloud/firestore. |
| AggregateField, | Typ AggregateField z pakietu @google-cloud/firestore. |
| BulkWriterOptions (w języku angielskim) | Typ BulkWriterOptions z pakietu @google-cloud/firestore. |
| Pakiet BundleBuilder | Typ BundleBuilder z pakietu @google-cloud/firestore. |
| CollectionGroup | Typ CollectionGroup z pakietu @google-cloud/firestore. |
| Odniesienie do kolekcji | Typ CollectionReference z pakietu @google-cloud/firestore. |
| Zmiana dokumentu | Typ DocumentChange z pakietu @google-cloud/firestore. |
| DocumentData | Typ DocumentData z pakietu @google-cloud/firestore. |
| DocumentReference | Typ DocumentReference z pakietu @google-cloud/firestore. |
| DocumentSnapshot | Typ DocumentSnapshot z pakietu @google-cloud/firestore. |
| FieldPath | Typ FieldPath z pakietu @google-cloud/firestore. |
| Wartość pola | Typ FieldValue z pakietu @google-cloud/firestore. |
| Filtr | Typ Filter z pakietu @google-cloud/firestore. |
| Firestore | Typ Firestore z pakietu @google-cloud/firestore. |
| FirestoreDataConverter | Typ FirestoreDataConverter z pakietu @google-cloud/firestore. |
| GeoPoint | Typ GeoPoint z pakietu @google-cloud/firestore. |
| Stan Grpc | Typ GrpcStatus z pakietu @google-cloud/firestore. |
| Warunek wstępny | Typ Precondition z pakietu @google-cloud/firestore. |
| Zapytanie | Typ Query z pakietu @google-cloud/firestore. |
| QueryDocumentSnapshot | Typ QueryDocumentSnapshot z pakietu @google-cloud/firestore. |
| QueryPartition | Typ QueryPartition z pakietu @google-cloud/firestore. |
| Zrzut zapytania | Typ QuerySnapshot z pakietu @google-cloud/firestore. |
| ReadOptions | Typ ReadOptions z pakietu @google-cloud/firestore. |
| SetOptions | Typ SetOptions z pakietu @google-cloud/firestore. |
| Sygnatura czasowa | Typ Timestamp z pakietu @google-cloud/firestore. |
| Transakcja | Typ Transaction z pakietu @google-cloud/firestore. |
| Zapis wsadowy | Typ WriteBatch z pakietu @google-cloud/firestore. |
| zapis wyniku | Typ WriteResult z pakietu @google-cloud/firestore. |
| setLogFunction | setLogFunction z pakietu @google-cloud/firestore. |
i Cloud Firestore.
Funkcje
| Funkcja | Opis |
|---|---|
| getFirestore(), | Pobiera domyślną usługę Firestore dla aplikacji domyślnej. |
| getFirestore(aplikacja) | Pobiera domyślną usługę Firestore dla danej aplikacji. |
| getFirestore(databaseId) | (BETA) Pobiera o nazwie Firestore dla aplikacji domyślnej. |
| getFirestore(aplikacja; identyfikator bazy danych) | (BETA) Pobiera o nazwie usługę Firestore dla danej aplikacji. |
| initializeFirestore(aplikacja, ustawienia) | Pobiera domyślną usługę Firestore dla danej aplikacji i przekazuje dodatkowe parametry do jej konstruktora. |
| initializeFirestore(aplikacja, ustawienia, identyfikator bazy danych) | (BETA) Pobiera dla danej aplikacji wskazaną usługę Firestore, przekazując do jej konstruktora dodatkowe parametry. |
Zajęcia
| Klasa | Opis |
|---|---|
| Błąd FirebaseFirestore | Struktura kodów błędów w Firebase Firestore. Spowoduje to rozszerzenie błędu FirebaseError. |
Interfejsy
| Interfejs | Opis |
|---|---|
| Ustawienia Firestore | Ustawienia przekazywane do konstruktora Firestore. |
getFirestore()
Pobiera domyślną usługę Firestore dla aplikacji domyślnej.
Podpis:
export declare function getFirestore(): Firestore;
Zwroty:
Firestore
Domyślna usługa Firestore dla domyślnej aplikacji.
Przykład
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(aplikacja)
Pobiera domyślną usługę Firestore dla danej aplikacji.
Podpis:
export declare function getFirestore(app: App): Firestore;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| aplikacja | Aplikacja | którą usługę Firestore zwrócić. |
Zwroty:
Firestore
Domyślna usługa Firestore powiązana z udostępnioną aplikacją.
Przykład
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(databaseId)
Ten interfejs API jest dostępny w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.
Pobiera usługę Firestore dla aplikacji domyślnej.
Podpis:
export declare function getFirestore(databaseId: string): Firestore;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| identyfikator bazy danych | ciąg znaków | nazwę bazy danych do zwrócenia. |
Zwroty:
Firestore
Usługa Firestore dla domyślnej aplikacji.
Przykład
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(aplikacja; identyfikator bazy danych)
Ten interfejs API jest dostępny w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.
Pobiera dla danej aplikacji usługę o nazwie Firestore.
Podpis:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| aplikacja | Aplikacja | którą usługę Firestore zwrócić. |
| identyfikator bazy danych | ciąg znaków | nazwę bazy danych do zwrócenia. |
Zwroty:
Firestore
Nazwa usługi Firestore powiązana z udostępnioną aplikacją.
Przykład
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
zainicjujFirestore(aplikacja; ustawienia)
Pobiera domyślną usługę Firestore dla danej aplikacji i przekazuje dodatkowe parametry do jej konstruktora.
Podpis:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| aplikacja | Aplikacja | którą usługę Firestore zwrócić. |
| ustawienia | Ustawienia Firestore | Obiekt ustawień, który ma zostać przekazany do konstruktora. |
Zwroty:
Firestore
Domyślna usługa Firestore powiązana z udostępnioną aplikacją i ustawieniami.
Przykład
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
zainicjujFirestore(aplikacja; ustawienia; identyfikator_bazy danych)
Ten interfejs API jest dostępny w wersji testowej dla deweloperów i może się zmienić w zależności od otrzymanych opinii. Nie używaj tego interfejsu API w środowisku produkcyjnym.
Pobiera dla danej aplikacji nazwę usługi Firestore, przekazując dodatkowe parametry do jej konstruktora.
Podpis:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| aplikacja | Aplikacja | którą usługę Firestore zwrócić. |
| ustawienia | Ustawienia Firestore | Obiekt ustawień, który ma zostać przekazany do konstruktora. |
| identyfikator bazy danych | ciąg znaków | nazwę bazy danych do zwrócenia. |
Zwroty:
Firestore
Usługa o nazwie Firestore powiązana z udostępnioną aplikacją i ustawieniami.
Przykład
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');