app package

Firebase 應用程式

這個套件會協調不同 Firebase 元件之間的通訊

函式

函式 說明
功能(應用程式, ...)
deleteApp(應用程式) 算繪這個應用程式無法運作，並釋出所有相關聯服務的資源。
function()
getApps() 所有已初始化應用程式的 (唯讀) 陣列。
InitialApp() 建立並初始化 FirebaseApp 執行個體。
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant) 註冊程式庫的名稱和版本，以便進行平台記錄。
function(logCallback, ...)
onLog(logCallback, 選項) 設定所有 Firebase SDK 的記錄處理常式。
function(logLevel, ...)
setLogLevel(logLevel) 為所有 Firebase SDK 設定記錄層級。系統會擷取目前記錄層級上方所有的記錄類型 (也就是說，如果將記錄層級設為 info，系統會記錄錯誤，但不會記錄 debug 和 verbose 記錄)。
function(name, ...)
getApp(名稱) 擷取 FirebaseApp 執行個體。如果在沒有引數的情況下呼叫，則會傳回預設應用程式。提供應用程式名稱後，系統會傳回與該名稱對應的應用程式。如果擷取的應用程式尚未初始化，就會擲回例外狀況。
function(選項, ...)
InitialApp(選項, 名稱) 建立並初始化 FirebaseApp 執行個體。如需詳細說明，請參閱將 Firebase 新增至應用程式和初始化多個專案。
InitialApp(選項, config) 建立並初始化 FirebaseApp 執行個體。
InitialServerApp(選項, config) 建立及初始化 FirebaseServerApp 執行個體。FirebaseServerApp 與 FirebaseApp 類似，但僅適用於伺服器端轉譯環境。如果從瀏覽器環境叫用，初始化作業就會失敗。如需詳細說明，請參閱「將 Firebase 新增至應用程式」和「初始化多個專案」。

介面

介面 說明
Firebase 應用程式 FirebaseApp 會保留一組服務的初始化資訊。請勿直接呼叫這個建構函式。請改用 InitialApp() 建立應用程式。
FirebaseAppSettings 提供給 InitialApp() 的設定選項
Firebase 選項 Firebase 設定物件。包含服務所需的一組參數，能夠成功與 Firebase 伺服器 API 通訊，以及連結用戶端資料與 Firebase 專案和 Firebase 應用程式。通常在設定專案時，Firebase 控制台就會填入這個物件。另請參閱「瞭解 Firebase 設定物件」。
Firebase 伺服器應用程式 FirebaseServerApp 會保留一組在伺服器環境中運作的服務的初始化資訊。請勿直接呼叫這個建構函式。請改用 InitialServerApp() 建立應用程式。
FirebaseServerAppSettings 指派給 InitialServerApp() 的設定選項

變數

變數 說明
SDK_VERSION 目前的 SDK 版本。

function(應用程式, ...)

DeleteApp(應用程式)

算繪這個應用程式無法運作，並釋出所有相關聯服務的資源。

簽名：

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

參數

參數 類型 說明
應用程式 Firebase 應用程式

傳回：

承諾<void>

範例

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

function()

getApps()

所有已初始化應用程式的 (唯讀) 陣列。

簽名：

export declare function getApps(): FirebaseApp[];

傳回：

Firebase 應用程式[]

初始化應用程式()

建立並初始化 FirebaseApp 執行個體。

簽名：

export declare function initializeApp(): FirebaseApp;

傳回：

Firebase 應用程式

function(libraryKeyOrName, ...)

註冊版本(libraryKeyOrName, 版本, 變體)

註冊程式庫的名稱和版本，以便進行平台記錄。

簽名：

export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;

參數

參數 類型 說明
程式庫 KeyOrName 字串
version 字串 該程式庫的目前版本。
variant 字串 套件變化版本，例如節點、rn 等

傳回：

void

function(logCallback, ...)

onLog(logCallback, 選項)

設定所有 Firebase SDK 的記錄處理常式。

簽名：

export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;

參數

參數 類型 說明
記錄回呼 LogCallback |空值 選用的自訂記錄處理常式，在 Firebase SDK 每次發出記錄呼叫時執行使用者程式碼。
選項 記錄選項

傳回：

void

function(logLevel, ...)

setLogLevel(logLevel)

設定所有 Firebase SDK 的記錄層級。

系統會擷取目前記錄層級以上的所有記錄類型 (也就是說，如果將記錄層級設為 info，則系統會記錄錯誤，但不會記錄 debug 和 verbose 記錄)。

簽名：

export declare function setLogLevel(logLevel: LogLevelString): void;

參數

參數 類型 說明
logLevel LogLevelString

傳回：

void

function(名稱, ...)

getApp(名稱)

擷取 FirebaseApp 執行個體。

在沒有引數的情況下呼叫時，會傳回預設應用程式。提供應用程式名稱後，系統會傳回與這個名稱相應的應用程式。

如果擷取的應用程式尚未初始化，就會擲回例外狀況。

簽名：

export declare function getApp(name?: string): FirebaseApp;

參數

參數 類型 說明
名稱 字串 要傳回的應用程式名稱 (選用)。如果未提供名稱，預設值為 "[DEFAULT]"。

傳回：

Firebase 應用程式

與所提供應用程式名稱對應的應用程式。如未提供應用程式名稱，系統會傳回預設應用程式。

範例 1

// Return the default app
const app = getApp();

範例 2

// Return a named app
const otherApp = getApp("otherApp");

function(選項, ...)

InitialApp(選項, 名稱)

建立並初始化 FirebaseApp 執行個體。

如需詳細說明文件，請參閱「將 Firebase 新增至應用程式」和「初始化多個專案」。

簽名：

export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;

參數

參數 類型 說明
選項 Firebase 選項 設定應用程式服務的選項。
名稱 字串 要初始化的應用程式名稱 (選用)。如果未提供名稱，預設值為 "[DEFAULT]"。

傳回：

Firebase 應用程式

已初始化的應用程式。

範例 1


// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
  apiKey: "AIza....",                             // Auth / General Use
  authDomain: "YOUR_APP.firebaseapp.com",         // Auth with popup/redirect
  databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
  storageBucket: "YOUR_APP.appspot.com",          // Storage
  messagingSenderId: "123456789"                  // Cloud Messaging
});

範例 2


// Initialize another app
const otherApp = initializeApp({
  databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
  storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");

InitialApp(選項, config)

建立並初始化 FirebaseApp 執行個體。

簽名：

export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;

參數

參數 類型 說明
選項 Firebase 選項 設定應用程式服務的選項。
config FirebaseAppSettings FirebaseApp 設定

傳回：

Firebase 應用程式

InitialServerApp(選項, 設定)

建立並初始化 FirebaseServerApp 執行個體。

FirebaseServerApp 與 FirebaseApp 類似，但僅適用於伺服器端轉譯環境。如果從瀏覽器環境叫用，初始化作業會失敗。

如需詳細說明文件，請參閱「將 Firebase 新增至應用程式」和「初始化多個專案」。

簽名：

export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;

參數

參數 類型 說明
選項 FirebaseOptions：Firebase 應用程式 Firebase.AppOptions 可設定應用程式服務，或是包含 AppOptions 的 FirebaseApp 執行個體。
config FirebaseServerAppSettings FirebaseServerApp 設定。

傳回：

Firebase 伺服器應用程式

初始化 FirebaseServerApp。

範例


// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
    apiKey: "AIza....",                             // Auth / General Use
    authDomain: "YOUR_APP.firebaseapp.com",         // Auth with popup/redirect
    databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
    storageBucket: "YOUR_APP.appspot.com",          // Storage
    messagingSenderId: "123456789"                  // Cloud Messaging
  },
  {
   authIdToken: "Your Auth ID Token"
  });

SDK 版本

目前的 SDK 版本。

簽名：

SDK_VERSION: string