このページは Cloud Translation API によって翻訳されました。

app package

Firebase アプリ

このパッケージは、さまざまな Firebase コンポーネント間の通信を調整します。

関数

関数	説明
function(app, ...)
deleteApp(app)	このアプリを使用できないようにし、関連付けられているすべてのサービスのリソースを解放します。
function（）
getApps()	初期化されたすべてのアプリの（読み取り専用）配列。
InitializeApp()	FirebaseApp インスタンスを作成して初期化します。
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)	プラットフォームロギング用にライブラリの名前とバージョンを登録します。
function(logCallback, ...)
onLog(logCallback, options)	すべての Firebase SDK のログハンドラを設定します。
function(logLevel, ...) を参照してください。
setLogLevel(logLevel)	すべての Firebase SDK のログレベルを設定します。現在のログレベルを超えるすべてのログタイプがキャプチャされます（つまり、ログレベルを `info` に設定すると、エラーはログに記録されますが、`debug` と `verbose` のログは記録されません）。
function(name, ...)
getApp(name)	FirebaseApp インスタンスを取得します。引数なしで呼び出すと、デフォルトのアプリが返されます。アプリ名を指定すると、その名前に対応するアプリが返されます。取得されるアプリがまだ初期化されていない場合は、例外がスローされます。
function(options, ...)
InitializeApp(options, name)	FirebaseApp インスタンスを作成して初期化します。詳細については、アプリに Firebase を追加すると複数のプロジェクトを初期化するをご覧ください。
InitializeApp(options, config)	FirebaseApp インスタンスを作成して初期化します。
InitializeServerApp(options, config)	FirebaseServerApp インスタンスを作成して初期化します。`FirebaseServerApp` は `FirebaseApp` に似ていますが、サーバー側のレンダリング環境での実行のみを目的としています。初期化は、ブラウザ環境から呼び出すと失敗します。詳しくは、アプリに Firebase を追加すると複数のプロジェクトを初期化するをご覧ください。

インターフェース

インターフェース	説明
FirebaseApp	FirebaseApp は、サービスのコレクションの初期化情報を保持します。このコンストラクタを直接呼び出さないでください。代わりに、InitializeApp() を使用してアプリを作成します。
FirebaseAppSettings	InitializeApp() に指定された構成オプション
FirebaseOptions	Firebase 構成オブジェクト。サービスが Firebase Server API と正常に通信し、クライアントデータを Firebase プロジェクトと Firebase アプリケーションに関連付けるために必要な一連のパラメータが含まれています。通常、このオブジェクトはプロジェクトの設定時に Firebase コンソールによって入力されます。Firebase 構成オブジェクトの詳細もご覧ください。
FirebaseServerApp	FirebaseServerApp は、サーバー環境で実行されるサービスのコレクションの初期化情報を保持します。このコンストラクタを直接呼び出さないでください。代わりに、InitializeServerApp() を使用してアプリを作成します。
FirebaseServerAppSettings	InitializeServerApp() に指定された構成オプション

変数

変数	説明
SDK_VERSION	現在の SDK バージョン。

関数（アプリ、...）

deleteApp(app)

このアプリを使用できないようにし、関連付けられているすべてのサービスのリソースを解放します。

署名:

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

パラメータ

パラメータ	型	説明
アプリ	FirebaseApp

戻り値:

約束 <void>

例

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

関数

getApps()

初期化されたすべてのアプリの（読み取り専用）配列。

署名:

export declare function getApps(): FirebaseApp[];

戻り値:

FirebaseApp[]

初期化 App()

FirebaseApp インスタンスを作成して初期化します。

署名:

export declare function initializeApp(): FirebaseApp;

戻り値:

FirebaseApp

function(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, version, variant)

プラットフォームロギング用にライブラリの名前とバージョンを登録します。

署名:

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

パラメータ

パラメータ	型	説明
LibraryKeyOrName	文字列
version	文字列	そのライブラリの現在のバージョン。
variant	文字列	バンドルバリアント（node、rn など）

戻り値:

void

function(logCallback, ...)

onLog(logCallback, options)

すべての Firebase SDK のログハンドラを設定します。

署名:

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

パラメータ

パラメータ	型	説明
logCallback	LogCallback \|null	Firebase SDK がロギング呼び出しを行うたびにユーザーコードを実行するオプションのカスタムログハンドラ。
オプション	ログオプション

戻り値:

void

function(logLevel, ...)

setLogLevel(logLevel)

すべての Firebase SDK のログレベルを設定します。

現在のログレベルを超えるすべてのログタイプがキャプチャされます（つまり、ログレベルを info に設定すると、エラーはログに記録されますが、debug と verbose のログは記録されません）。

署名:

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

パラメータ

パラメータ	型	説明
logLevel	ログレベル文字列

戻り値:

void

function(name, ...)

getApp(name)

FirebaseApp インスタンスを取得します。

引数なしで呼び出すと、デフォルトのアプリが返されます。アプリ名を指定すると、その名前に対応するアプリが返されます。

取得したアプリがまだ初期化されていない場合は、例外がスローされます。

署名:

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

パラメータ

パラメータ	型	説明
name	文字列	返されるアプリの名前（省略可）。名前を指定しない場合、デフォルトは `"[DEFAULT]"` です。

戻り値:

FirebaseApp

指定されたアプリ名に対応するアプリ。アプリ名を指定しない場合は、デフォルトのアプリが返されます。

例 1

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

例 2

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

関数(オプション, ...)

初期化アプリ(オプション, 名前)

FirebaseApp インスタンスを作成して初期化します。

詳しくは、アプリに Firebase を追加すると複数のプロジェクトを初期化するをご覧ください。

署名:

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

パラメータ

パラメータ	型	説明
オプション	FirebaseOptions	アプリのサービスを構成するオプション。
name	文字列	初期化するアプリの任意の名前。名前を指定しない場合、デフォルトは `"[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");

terraformApp(オプション, 構成)

FirebaseApp インスタンスを作成して初期化します。

署名:

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

パラメータ

パラメータ	型	説明
オプション	FirebaseOptions	アプリのサービスを構成するオプション。
config	FirebaseAppSettings	Firebase アプリの構成

戻り値:

FirebaseApp

初期化 ServerApp(オプション, 構成)

FirebaseServerApp インスタンスを作成して初期化します。

FirebaseServerApp は FirebaseApp に似ていますが、サーバーサイドのレンダリング環境での実行のみを対象としています。ブラウザ環境から初期化しようとすると、失敗します。

詳しくは、アプリに Firebase を追加すると複数のプロジェクトを初期化するをご覧ください。

署名:

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

パラメータ

パラメータ	型	説明
オプション	FirebaseOptions \|Firebase アプリ	`Firebase.AppOptions`: アプリのサービスを設定するか、`AppOptions` を含む `FirebaseApp` インスタンスを設定します。
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 バージョン。

署名:

SDK_VERSION: string