firebase-admin.app package

Inicjowanie aplikacji Firebase i pakietu SDK.

Funkcje

Funkcja Opis
applicationDefault(httpAgent) Zwraca dane logowania utworzone na podstawie domyślnych danych logowania aplikacji Google, które przyznają dostęp administracyjny do usług Firebase. Tych danych logowania można używać w wywołaniu funkcji initializeApp().Domyślne dane logowania aplikacji Google są dostępne w dowolnej infrastrukturze Google, takiej jak Google App Engine i Google Compute Engine.Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.
cert(serviceAccountPathOrObject, httpAgent) Zwraca dane logowania utworzone z podanego konta usługi, które przyznaje dostęp administracyjny do usług Firebase. Tych danych logowania można używać w wywołaniu funkcji initializeApp().Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.
deleteApp(app) Uniemożliwia użycie zasobu App i zwalnia zasoby wszystkich powiązanych usług (*nie* oczyszcza żadnych zasobów backendu). W przypadku lokalnego uruchamiania pakietu SDK ta metoda musi zostać wywołana, aby zapewnić płynne zakończenie procesu.
getApp(nazwa_aplikacji),
getApps(),
initializeApp(options; appName)
refreshToken(refreshTokenPathOrObject, httpAgent) Zwraca dane logowania utworzone z podanego tokena odświeżania, który zapewnia dostęp administracyjny do usług Firebase. Tych danych logowania można używać w wywołaniu funkcji initializeApp().Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Interfejsy

Interfejs Opis
Aplikacja Aplikacja Firebase zawiera informacje o inicjowaniu zbioru usług.
Opcje aplikacji Dostępne opcje przekazywania do metody initializeApp().
Dane logowania Interfejs udostępniający tokeny dostępu Google OAuth2 służące do uwierzytelniania w usługach Firebase.W większości przypadków nie musisz implementować tego narzędzia samodzielnie i zamiast tego możesz skorzystać z domyślnych implementacji dostępnych w module firebase-admin/app.
FirebasetablicaIndexError Typ złożony: zawiera zarówno obiekt FirebaseError, jak i indeks, za pomocą których można uzyskać nieprawidłowy element.
Błąd Firebase FirebaseError to podklasa standardowego obiektu JavaScript Error. Oprócz ciągu znaków wiadomości i zrzutu stosu zawiera on kod ciągu znaków.
GoogleOAuthAccessToken Interfejs tokenów dostępu Google OAuth 2.0.
Konto usługi

Zmienne

Zmienna Opis
SDK_VERSION

applicationDefault(httpAgent)

Zwraca dane logowania utworzone na podstawie domyślnych danych logowania aplikacji Google, które przyznają dostęp administracyjny do usług Firebase. Tych danych logowania można używać w wywołaniu funkcji initializeApp().

Domyślne dane logowania aplikacji Google są dostępne w dowolnej infrastrukturze Google, takiej jak Google App Engine i Google Compute Engine.

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

export declare function applicationDefault(httpAgent?: Agent): Credential;

Parametry

Parametr Typ Opis
Agent http Agent Opcjonalny agent HTTP używany podczas pobierania tokenów dostępu z serwerów tokenów Google.

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą domyślnych danych logowania aplikacji Google, które można wykorzystać do zainicjowania aplikacji.

Przykład

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

cert(serviceAccountPathOrObject, httpAgent)

Zwraca dane logowania utworzone z podanego konta usługi, które przyznaje dostęp administracyjny do usług Firebase. Tych danych logowania można używać w wywołaniu funkcji initializeApp().

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

Parametry

Parametr Typ Opis
serviceAccountPathOrObject ciąg znaków | ServiceAccount Ścieżka do pliku JSON klucza konta usługi lub obiektu reprezentującego klucz konta usługi.
Agent http Agent Opcjonalny agent HTTP używany podczas pobierania tokenów dostępu z serwerów tokenów Google.

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą podanego konta usługi, które mogą zostać użyte do zainicjowania aplikacji.

Przykład 1

// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
  credential: cert(serviceAccount),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

Przykład 2

// Providing a service account object inline
initializeApp({
  credential: cert({
    projectId: "<PROJECT_ID>",
    clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
    privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
  }),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

deleteApp(aplikacja)

Uniemożliwia użycie zasobu App i zwalnia zasoby wszystkich powiązanych usług (*nie* oczyszcza żadnych zasobów backendu). W przypadku lokalnego uruchamiania pakietu SDK ta metoda musi zostać wywołana, aby zapewnić płynne zakończenie procesu.

Podpis:

export declare function deleteApp(app: App): Promise<void>;

Parametry

Parametr Typ Opis
aplikacja Aplikacja

Zwroty:

Obietnica<void>

Przykład

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

getApp(nazwa_aplikacji)

Podpis:

export declare function getApp(appName?: string): App;

Parametry

Parametr Typ Opis
Nazwaaplikacji string,

Zwroty:

Aplikacja

getApps()

Podpis:

export declare function getApps(): App[];

Zwroty:

Aplikacja[]

zainicjujApp(opcje; nazwaaplikacji)

Podpis:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

Parametry

Parametr Typ Opis
opcje Opcje aplikacji
Nazwaaplikacji string,

Zwroty:

Aplikacja

OdświeżToken(refreshTokenPathOrObject, httpAgent)

Zwraca dane logowania utworzone z podanego tokena odświeżania, który zapewnia dostęp administracyjny do usług Firebase. Tych danych logowania można używać w wywołaniu funkcji initializeApp().

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

Parametry

Parametr Typ Opis
OdświeżTokenPathOrObject ciąg | obiekt Ścieżka do pliku JSON tokena odświeżania Google OAuth2 lub obiektu reprezentującego token odświeżania Google OAuth2.
Agent http Agent Opcjonalny agent HTTP używany podczas pobierania tokenów dostępu z serwerów tokenów Google.

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą podanego konta usługi, które mogą zostać użyte do zainicjowania aplikacji.

Przykład

// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
  credential: refreshToken(refreshToken),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

SDK_VERSION

Podpis:

SDK_VERSION: string