firebase-admin.app package

Firebase 應用程式和 SDK 初始化。

函式

函式 說明
applicationDefault(httpAgent) 傳回透過 Google 應用程式預設憑證建立的憑證，授予 Firebase 服務的管理員存取權。這組憑證可用於呼叫 initializeApp()。Google 應用程式預設憑證適用於所有 Google 基礎架構，例如 Google App Engine 和 Google Compute Engine。詳情請參閱「初始化 SDK」。
cert(serviceAccountPathOrObject, httpAgent) 傳回透過指定服務帳戶建立的憑證，該憑證會授予 Firebase 服務的管理員存取權。這組憑證可用於對 initializeApp() 的呼叫。詳情請參閱「初始化 SDK」。
deleteApp(應用程式) 將此 App 顯示為無法使用，並釋放所有相關聯服務的資源 (但並「不會」清除任何後端資源)。在本機執行 SDK 時，必須呼叫此方法，以確保程序可順利終止。
getApp(appName)
getApps()
InitialApp(options, appName)
refreshToken(refreshTokenPathOrObject, httpAgent) 傳回透過所提供的更新權杖建立的憑證，該憑證會授予 Firebase 服務的管理員存取權。這組憑證可用於對 initializeApp() 的呼叫。詳情請參閱「初始化 SDK」。

介面

介面 說明
應用程式 Firebase 應用程式會保留一組服務的初始化資訊。
應用程式選項 可傳遞給 initializeApp() 的可用選項。
憑證 這個介面提供用於驗證 Firebase 服務的 Google OAuth2 存取權杖。在大多數情況下，您不需要自行導入這項權杖，可以改用 firebase-admin/app 模組提供的預設導入方式。
FirebaseArrayIndexError 複合類型，包含 FirebaseError 物件，以及可用來取得錯誤項目的索引。
FirebaseError FirebaseError 是標準 JavaScript Error 物件的子類別。除了訊息字串和堆疊追蹤之外，其中包含字串程式碼。
GoogleOAuthAccessToken Google OAuth 2.0 存取權杖介面。
服務帳戶

變數

變數 說明
SDK_VERSION

applicationDefault(httpAgent)

傳回透過 Google 應用程式預設憑證建立的憑證，授予 Firebase 服務的管理員存取權。這組憑證可用於 initializeApp() 的呼叫。

任何 Google 基礎架構都提供 Google 應用程式預設憑證，例如 Google App Engine 和 Google Compute Engine。

詳情請參閱「初始化 SDK」。

簽名：

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

參數

參數 類型 說明
httpAgent 代理程式 從 Google 權杖伺服器擷取存取權杖時，此為選用 HTTP 代理程式。

傳回：

憑證

透過 Google 應用程式預設憑證驗證的憑證，可用於初始化應用程式。

範例

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

cert(serviceAccountPathOrObject, httpAgent)

傳回透過指定服務帳戶建立的憑證，該憑證會授予 Firebase 服務的管理員存取權。這組憑證可用於 initializeApp() 的呼叫。

詳情請參閱「初始化 SDK」。

簽名：

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

參數

參數 類型 說明
serviceAccountPathOrObject string | ServiceAccount 服務帳戶金鑰 JSON 檔案或代表服務帳戶金鑰的物件路徑。
httpAgent 代理程式 從 Google 權杖伺服器擷取存取權杖時，此為選用 HTTP 代理程式。

傳回：

憑證

透過所提供的服務帳戶驗證的憑證，可用於初始化應用程式。

範例 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"
});

範例 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(應用程式)

將此 App 顯示為無法使用，並釋放所有相關聯服務的資源 (但並「不會」清除任何後端資源)。在本機執行 SDK 時，必須呼叫此方法，以確保程序可順利終止。

簽名：

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

參數

參數 類型 說明
app 應用程式

傳回：

承諾<void>

範例

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

getApp(appName)

簽名：

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

參數

參數 類型 說明
應用程式名稱 字串

傳回：

應用程式

getApps()

簽名：

export declare function getApps(): App[];

傳回：

應用程式[]

InitialApp(options, appName)

簽名：

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

參數

參數 類型 說明
選項 應用程式選項
應用程式名稱 字串

傳回：

應用程式

updateToken(refreshTokenPathOrObject, httpAgent)

傳回透過所提供的更新權杖建立的憑證，該憑證會授予 Firebase 服務的管理員存取權。這組憑證可用於 initializeApp() 的呼叫。

詳情請參閱「初始化 SDK」。

簽名：

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

參數

參數 類型 說明
重新整理權杖路徑或物件 string | 物件 Google OAuth2 更新權杖 JSON 檔案或代表 Google OAuth2 更新權杖的物件路徑。
httpAgent 代理程式 從 Google 權杖伺服器擷取存取權杖時，此為選用 HTTP 代理程式。

傳回：

憑證

透過所提供的服務帳戶驗證的憑證，可用於初始化應用程式。

範例

// 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

簽名：

SDK_VERSION: string