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) 使此给定的 App 无法使用，并释放所有关联服务的资源（尽管 *不会* 清理任何后端资源）。在本地运行 SDK 时，必须调用此方法，以确保正常终止进程。
getApp(appName)
getApps()
initializeApp(options, appName)
refreshToken(refreshTokenPathOrObject, httpAgent) 返回使用提供的刷新令牌创建的凭据，该凭据会授予 Firebase 服务的管理员访问权限。此凭据可用于调用 initializeApp()。如需了解详情，请参阅初始化 SDK。

类

类 说明
AppErrorCodes 应用客户端错误代码及其默认消息。
FirebaseAppError Firebase 应用错误代码结构。这会扩展 PrefixedFirebaseError。

接口

接口 说明
应用 Firebase 应用保存一系列服务的初始化信息。
AppOptions 传递给 initializeApp() 的可用选项。
凭据 此接口提供用于进行 Firebase 服务身份验证的 Google OAuth2 访问令牌。在大多数情况下，您无需自行实现此接口，而是可以使用 firebase-admin/app 模块提供的默认实现。
FirebaseArrayIndexError 包含 FirebaseError 对象和可用于获取错误项的索引的复合类型。
FirebaseError FirebaseError 是标准 JavaScript Error 对象的子类。除了消息字符串和堆栈轨迹之外，它还包含字符串代码。
GoogleOAuthAccessToken Google OAuth 2.0 访问令牌的界面。
服务账号

变量

变量 说明
SDK_VERSION

应用程序默认(httpAgent)

返回通过 Google 应用默认凭据创建的凭据，用于授予对 Firebase 服务的管理员访问权限。此凭据可用于调用 initializeApp()。

Google 应用默认凭据可用于任何 Google 基础架构，例如 Google App Engine 和 Google Compute Engine。

如需了解详情，请参阅初始化 SDK。

签名：

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

参数

参数 类型 说明
http 代理 代理 （可选）从 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 字符串 |服务账号 指向服务账号密钥 JSON 文件或表示服务账号密钥的对象的路径。
http 代理 代理 （可选）从 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>;

参数

参数 类型 说明
应用 应用

返回：

承诺<void>

示例

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

getApp(应用名称)

签名：

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

参数

参数 类型 说明
appName 字符串

返回：

应用

getApps()

签名：

export declare function getApps(): App[];

返回：

应用[]

initializeApp(options, appName)

签名：

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

参数

参数 类型 说明
选项 AppOptions
appName 字符串

返回：

应用

refreshToken(refreshTokenPathOrObject, httpAgent)

返回使用提供的刷新令牌创建的凭据，该凭据会授予 Firebase 服务的管理员访问权限。此凭据可用于调用 initializeApp()。

如需了解详情，请参阅初始化 SDK。

签名：

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

参数

参数 类型 说明
refreshTokenPathOrObject 字符串 |对象 指向 Google OAuth2 刷新令牌 JSON 文件或表示 Google OAuth2 刷新令牌的对象的路径。
http 代理 代理 （可选）从 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