firebase-admin.app package

Inicjowanie aplikacji Firebase i pakietu SDK.

Funkcje

Zajęcia

Interfejsy

Zmienne

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 można użyć w wywołaniu initializeApp().

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

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

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

Parametry

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą domyślnych danych logowania aplikacji Google, których można użyć 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 przyznają dostęp administracyjny do usług Firebase. Tych danych można użyć w wywołaniu initializeApp().

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

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

Parametry

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą podanego konta usługi, których można użyć 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)

Renderuje dane App i uwalnia zasoby wszystkich powiązanych usług (chociaż *nie* czyści zasobów backendu). W przypadku lokalnego uruchamiania pakietu SDK ta metoda musi być wywołana, aby zapewnić płynne zakończenie procesu.

Podpis:

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

Parametry

Zwroty:

Obietnica<void>

Przykład

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

getApp(nazwaaplikacji)

Podpis:

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

Parametry

Zwroty:

Aplikacja

getApps()

Podpis:

export declare function getApps(): App[];

Zwroty:

Aplikacja[]

inicjujApp(opcje, nazwa_aplikacji)

Podpis:

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

Parametry

Zwroty:

Aplikacja

OdświeżToken(refreshTokenPathOrObject, httpAgent)

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

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

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

Parametry

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą podanego konta usługi, których można użyć 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