app package

برنامه Firebase

این بسته ارتباط بین اجزای مختلف Firebase را هماهنگ می کند

کارکرد

رابط ها

متغیرها

عملکرد (برنامه، ...)

حذف برنامه (برنامه)

این برنامه را غیرقابل استفاده می کند و منابع تمام سرویس های مرتبط را آزاد می کند.

امضا:

export declare function deleteApp(app: FirebaseApp): Promise<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[];

برمی گرداند:

Firebase App []

InitializeApp()

یک نمونه FirebaseApp را ایجاد و مقداردهی اولیه می کند.

امضا:

export declare function initializeApp(): FirebaseApp;

برمی گرداند:

Firebase App

تابع (libraryKeyOrName، ...)

registerVersion (libraryKeyOrName، نسخه، نوع)

نام و نسخه کتابخانه را برای اهداف ثبت پلت فرم ثبت می کند.

امضا:

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

مولفه های

برمی گرداند:

خالی

تابع (log Callback، ...)

onLog (logCallback، گزینه‌ها)

کنترل کننده گزارش را برای همه SDK های Firebase تنظیم می کند.

امضا:

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

مولفه های

برمی گرداند:

خالی

تابع (logLevel، ...)

setLogLevel(logLevel)

سطح گزارش را برای همه SDK های Firebase تنظیم می کند.

همه انواع گزارش‌های بالاتر از سطح گزارش فعلی ثبت می‌شوند (یعنی اگر سطح گزارش را روی info تنظیم کنید ، خطاها ثبت می شوند، اما گزارش های debug و verbose ثبت نمی شوند).

امضا:

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

مولفه های

برمی گرداند:

خالی

تابع (نام، ...)

getApp (نام)

یک نمونه FirebaseApp را بازیابی می کند.

هنگامی که بدون آرگومان فراخوانی می شود، برنامه پیش فرض برگردانده می شود. هنگامی که نام برنامه ارائه می شود، برنامه مربوط به آن نام برگردانده می شود.

اگر برنامه بازیابی شده هنوز مقداردهی اولیه نشده باشد، یک استثنا ایجاد می شود.

امضا:

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

مولفه های

برمی گرداند:

Firebase App

برنامه مربوط به نام برنامه ارائه شده. اگر نام برنامه ارائه نشده باشد، برنامه پیش فرض برگردانده می شود.

مثال 1

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

مثال 2

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

تابع (گزینه ها، ...)

InitializeApp (گزینه ها، نام)

یک نمونه FirebaseApp را ایجاد و مقداردهی اولیه می کند.

برای مستندات دقیق ، به افزودن Firebase به برنامه خود و راه‌اندازی چندین پروژه مراجعه کنید.

امضا:

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

مولفه های

برمی گرداند:

Firebase App

برنامه اولیه

مثال 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");

InitializeApp (گزینه ها، پیکربندی)

یک نمونه FirebaseApp را ایجاد و مقداردهی اولیه می کند.

امضا:

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

مولفه های

برمی گرداند:

Firebase App

InitializeServerApp (گزینه ها، پیکربندی)

یک نمونه FirebaseServerApp را ایجاد و مقداردهی اولیه می کند.

FirebaseServerApp مشابه FirebaseApp است ، اما فقط برای اجرا در محیط های رندر سمت سرور در نظر گرفته شده است. اگر از محیط مرورگر فراخوانی شود، مقداردهی اولیه ناموفق خواهد بود.

برای مستندات دقیق ، به افزودن Firebase به برنامه خود و راه‌اندازی چندین پروژه مراجعه کنید.

امضا:

export declare function initializeServerApp(options: FirebaseOptions | 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