app package

Aplikasi Firebase

Paket ini mengoordinasikan komunikasi antara berbagai komponen Firebase

Fungsi

Fungsi Keterangan
fungsi(aplikasi, ...)
hapus Aplikasi (aplikasi) Menjadikan aplikasi ini tidak dapat digunakan dan membebaskan sumber daya dari semua layanan terkait.
fungsi()
dapatkan Aplikasi() Array (hanya baca) dari semua aplikasi yang diinisialisasi.
inisialisasi Aplikasi() Membuat dan menginisialisasi instance FirebaseApp.
fungsi(perpustakaanKeyOrName, ...)
registerVersion(libraryKeyOrName, versi, varian) Mendaftarkan nama dan versi perpustakaan untuk tujuan pencatatan platform.
fungsi(logCallback, ...)
onLog(logCallback, opsi) Menetapkan pengendali log untuk semua Firebase SDK.
fungsi(tingkat log, ...)
setLogLevel(logLevel) Menetapkan level log untuk semua Firebase SDK. Semua jenis log di atas tingkat log saat ini ditangkap (yaitu jika Anda mengatur tingkat log ke info , kesalahan akan dicatat, namun log debug dan verbose tidak).
fungsi(nama, ...)
dapatkan Aplikasi (nama) Mengambil instance FirebaseApp . Saat dipanggil tanpa argumen, aplikasi default dikembalikan. Ketika nama aplikasi diberikan, aplikasi yang sesuai dengan nama tersebut akan dikembalikan. Pengecualian diberikan jika aplikasi yang diambil belum diinisialisasi.
fungsi(pilihan, ...)
inisialisasi Aplikasi (opsi, nama) Membuat dan menginisialisasi instance FirebaseApp . Lihat Menambahkan Firebase ke aplikasi Anda dan Menginisialisasi beberapa proyek untuk dokumentasi detailnya.
inisialisasi Aplikasi (opsi, konfigurasi) Membuat dan menginisialisasi instance FirebaseApp.

Antarmuka

Antarmuka Keterangan
Aplikasi Firebase FirebaseApp menyimpan informasi inisialisasi untuk kumpulan layanan. Jangan panggil konstruktor ini secara langsung. Sebagai gantinya, gunakan inisialisasiApp() untuk membuat aplikasi.
Pengaturan FirebaseApp Opsi konfigurasi diberikan ke inisialisasiApp()
Opsi Firebase Objek konfigurasi Firebase. Berisi serangkaian parameter yang diperlukan oleh layanan agar berhasil berkomunikasi dengan API server Firebase dan untuk mengaitkan data klien dengan proyek Firebase dan aplikasi Firebase Anda. Biasanya objek ini diisi oleh Firebase console pada penyiapan proyek. Lihat juga: Pelajari objek konfigurasi Firebase .

Variabel

Variabel Keterangan
SDK_VERSION Versi SDK saat ini.

fungsi(aplikasi, ...)

hapus Aplikasi (aplikasi)

Menjadikan aplikasi ini tidak dapat digunakan dan membebaskan sumber daya dari semua layanan terkait.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
aplikasi Aplikasi Firebase

Pengembalian:

Janji<batal>

Contoh

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

fungsi()

dapatkan Aplikasi()

Array (hanya baca) dari semua aplikasi yang diinisialisasi.

Tanda tangan:

export declare function getApps(): FirebaseApp[];

Pengembalian:

Aplikasi Firebase []

inisialisasi Aplikasi()

Membuat dan menginisialisasi instance FirebaseApp.

Tanda tangan:

export declare function initializeApp(): FirebaseApp;

Pengembalian:

Aplikasi Firebase

fungsi(perpustakaanKeyOrName, ...)

registerVersion(libraryKeyOrName, versi, varian)

Mendaftarkan nama dan versi perpustakaan untuk tujuan pencatatan platform.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
perpustakaanKeyOrName rangkaian
Versi: kapan rangkaian Versi terkini dari perpustakaan itu.
varian rangkaian Varian bundel, misalnya node, rn, dll.

Pengembalian:

ruang kosong

fungsi(logCallback, ...)

onLog(logCallback, opsi)

Menetapkan pengendali log untuk semua Firebase SDK.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
logPanggilan Balik LogPanggilan Balik | batal Penangan log kustom opsional yang mengeksekusi kode pengguna setiap kali Firebase SDK melakukan panggilan logging.
pilihan Opsi Log

Pengembalian:

ruang kosong

fungsi(tingkat log, ...)

setLogLevel(logLevel)

Menetapkan level log untuk semua Firebase SDK.

Semua jenis log di atas tingkat log saat ini ditangkap (yaitu jika Anda mengatur tingkat log ke info , kesalahan dicatat, tetapi log debug dan verbose tidak).

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
tingkat log LogLevelString

Pengembalian:

ruang kosong

fungsi(nama, ...)

dapatkan Aplikasi (nama)

Mengambil instance FirebaseApp .

Saat dipanggil tanpa argumen, aplikasi default dikembalikan. Ketika nama aplikasi diberikan, aplikasi yang sesuai dengan nama tersebut akan dikembalikan.

Pengecualian diberikan jika aplikasi yang diambil belum diinisialisasi.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
nama rangkaian Nama opsional aplikasi yang akan dikembalikan. Jika tidak ada nama yang diberikan, defaultnya adalah "[DEFAULT]" .

Pengembalian:

Aplikasi Firebase

Aplikasi yang sesuai dengan nama aplikasi yang disediakan. Jika tidak ada nama aplikasi yang diberikan, aplikasi default akan dikembalikan.

Contoh 1

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

Contoh 2

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

fungsi(pilihan, ...)

inisialisasi Aplikasi (opsi, nama)

Membuat dan menginisialisasi instance FirebaseApp .

Lihat Menambahkan Firebase ke aplikasi Anda dan Menginisialisasi beberapa proyek untuk dokumentasi detailnya.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
pilihan Opsi Firebase Opsi untuk mengonfigurasi layanan aplikasi.
nama rangkaian Nama opsional aplikasi yang akan diinisialisasi. Jika tidak ada nama yang diberikan, defaultnya adalah "[DEFAULT]" .

Pengembalian:

Aplikasi Firebase

Aplikasi yang diinisialisasi.

Contoh 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
});

Contoh 2


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

inisialisasi Aplikasi (opsi, konfigurasi)

Membuat dan menginisialisasi instance FirebaseApp.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
pilihan Opsi Firebase Opsi untuk mengonfigurasi layanan aplikasi.
konfigurasi Pengaturan FirebaseApp Konfigurasi FirebaseApp

Pengembalian:

Aplikasi Firebase

SDK_VERSION

Versi SDK saat ini.

Tanda tangan:

SDK_VERSION: string