app package

Firebase 應用程式

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

函式

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

介面

介面 說明
FirebaseApp FirebaseApp 會保留一組服務的初始化資訊。請勿直接呼叫此建構函式。請改用 initializeApp() 建立應用程式。
FirebaseAppSettings initializeApp() 的設定選項
FirebaseOptions Firebase 設定物件。包含服務需要的一組參數,才能成功與 Firebase 伺服器 API 通訊,以及將用戶端資料與 Firebase 專案和 Firebase 應用程式建立關聯。一般來說,在設定專案時,這個物件會由 Firebase 控制台填入。另請參閱:瞭解 Firebase 設定物件
FirebaseServerApp FirebaseServerApp 會保留初始化資訊,用於在伺服器環境中運作的一系列服務。請勿直接呼叫此建構函式。請改用 initializeServerApp() 建立應用程式。
FirebaseServerAppSettings initializeServerApp() 的設定選項

變數

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

function(app, ...)

deleteApp(應用程式)

顯示這個應用程式無法使用,並釋放所有相關聯服務的資源。

Signature:

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

參數

參數 類型 說明
app FirebaseApp

傳回:

Promise<void>

範例

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

函式

getApps()

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

Signature:

export declare function getApps(): FirebaseApp[];

傳回:

FirebaseApp[]

initializeApp()

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

Signature:

export declare function initializeApp(): FirebaseApp;

傳回:

FirebaseApp

function(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

註冊程式庫名稱和版本,以便記錄平台。

Signature:

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

參數

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

傳回:

void

function(logCallback, ...)

onLog(logCallback, 選項)

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

Signature:

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

參數

參數 類型 說明
logCallback LogCallback | null 選用的自訂記錄處理常式,每當 Firebase SDK 發出記錄呼叫時,就會執行使用者程式碼。
選項 LogOptions

傳回:

void

function(logLevel, ...)

setLogLevel(logLevel)

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

系統會擷取目前記錄層級上方的所有記錄類型 (也就是說,如果您將記錄層級設為 info,系統會記錄錯誤,但不會記錄 debugverbose 記錄)。

Signature:

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

參數

參數 類型 說明
logLevel LogLevelString

傳回:

void

function(名稱, ...)

getApp(名稱)

擷取 FirebaseApp 執行個體。

如果在沒有引數的情況下呼叫,系統會傳回預設的應用程式。提供應用程式名稱時,系統會傳回與該名稱對應的應用程式。

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

Signature:

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

參數

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

傳回:

FirebaseApp

與指定應用程式名稱相對應的應用程式。如未提供應用程式名稱,系統會傳回預設應用程式。

範例 1

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

範例 2

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

function(options, ...)

InitialApp(選項, 名稱)

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

詳情請參閱「將 Firebase 新增至應用程式」和「初始化多個專案」這兩篇文章。

Signature:

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

參數

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

傳回:

FirebaseApp

已初始化的應用程式。

範例 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(options, config)

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

Signature:

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

參數

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

傳回:

FirebaseApp

InitialServerApp(選項, 設定)

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

FirebaseServerAppFirebaseApp 類似,但僅用於在伺服器端的算繪環境中執行。如果是從瀏覽器環境叫用,初始化作業會失敗。

詳情請參閱「將 Firebase 新增至應用程式」和「初始化多個專案」這兩篇文章。

Signature:

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

參數

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

傳回:

FirebaseServerApp

初始化的 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_VERSION

目前的 SDK 版本。

Signature:

SDK_VERSION: string