app package

Ứng dụng Firebase

Gói này điều phối hoạt động liên lạc giữa các thành phần Firebase khác nhau

Chức năng

Chức năng Sự miêu tả
chức năng (ứng dụng, ...)
xóaỨng dụng(ứng dụng) Làm cho ứng dụng này không thể sử dụng được và giải phóng tài nguyên của tất cả các dịch vụ liên quan.
chức năng()
getApps() Một mảng (chỉ đọc) gồm tất cả các ứng dụng được khởi tạo.
khởi tạoỨng dụng() Tạo và khởi tạo một phiên bản FirebaseApp.
hàm(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, phiên bản, biến thể) Đăng ký tên và phiên bản của thư viện cho mục đích ghi nhật ký nền tảng.
hàm(logCallback, ...)
onLog(logCallback, tùy chọn) Đặt trình xử lý nhật ký cho tất cả SDK Firebase.
hàm(logLevel, ...)
setLogLevel(logLevel) Đặt cấp độ nhật ký cho tất cả SDK Firebase. Tất cả các loại nhật ký trên cấp độ nhật ký hiện tại đều được ghi lại (tức là nếu bạn đặt cấp độ nhật ký thành info , các lỗi sẽ được ghi lại, nhưng nhật ký debugverbose thì không).
Tên chức năng, ...)
getApp(tên) Truy xuất phiên bản FirebaseApp . Khi được gọi mà không có đối số, ứng dụng mặc định sẽ được trả về. Khi tên ứng dụng được cung cấp, ứng dụng tương ứng với tên đó sẽ được trả về. Một ngoại lệ sẽ được đưa ra nếu ứng dụng đang được truy xuất chưa được khởi chạy.
chức năng (tùy chọn, ...)
khởi tạoApp(tùy chọn, tên) Tạo và khởi tạo phiên bản FirebaseApp . Xem Thêm Firebase vào ứng dụng của bạnKhởi tạo nhiều dự án để biết tài liệu chi tiết.
khởi tạoApp(tùy chọn, cấu hình) Tạo và khởi tạo một phiên bản FirebaseApp.

Giao diện

Giao diện Sự miêu tả
Ứng dụng Firebase Ứng dụng Firebase lưu giữ thông tin khởi tạo cho một tập hợp các dịch vụ. Đừng gọi trực tiếp hàm tạo này. Thay vào đó, hãy sử dụng initizeApp() để tạo một ứng dụng.
Cài đặt ứng dụng Firebase Các tùy chọn cấu hình được cung cấp cho initizeApp()
Tùy chọn Firebase Đối tượng cấu hình Firebase. Chứa một tập hợp các tham số mà các dịch vụ yêu cầu để giao tiếp thành công với API máy chủ Firebase và liên kết dữ liệu khách hàng với dự án Firebase và ứng dụng Firebase của bạn. Thông thường, đối tượng này được bảng điều khiển Firebase điền vào khi thiết lập dự án. Xem thêm: Tìm hiểu về đối tượng config Firebase .

Biến

Biến đổi Sự miêu tả
SDK_VERSION Phiên bản SDK hiện tại.

chức năng (ứng dụng, ...)

xóaỨng dụng(ứng dụng)

Làm cho ứng dụng này không thể sử dụng được và giải phóng tài nguyên của tất cả các dịch vụ liên quan.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
ứng dụng Ứng dụng Firebase

Trả về:

Hứa<void>

Ví dụ

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

chức năng()

getApps()

Một mảng (chỉ đọc) gồm tất cả các ứng dụng được khởi tạo.

Chữ ký:

export declare function getApps(): FirebaseApp[];

Trả về:

Ứng dụng Firebase []

khởi tạoỨng dụng()

Tạo và khởi tạo một phiên bản FirebaseApp.

Chữ ký:

export declare function initializeApp(): FirebaseApp;

Trả về:

Ứng dụng Firebase

hàm(libraryKeyOrName, ...)

registerVersion(libraryKeyOrName, phiên bản, biến thể)

Đăng ký tên và phiên bản của thư viện cho mục đích ghi nhật ký nền tảng.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
thư việnKeyOrName sợi dây
phiên bản sợi dây Phiên bản hiện tại của thư viện đó.
khác nhau sợi dây Biến thể gói, ví dụ: nút, rn, v.v.

Trả về:

trống rỗng

hàm(logCallback, ...)

onLog(logCallback, tùy chọn)

Đặt trình xử lý nhật ký cho tất cả SDK Firebase.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
logGọi lại LogGọi lại | vô giá trị Trình xử lý nhật ký tùy chỉnh tùy chọn thực thi mã người dùng bất cứ khi nào SDK Firebase thực hiện lệnh gọi ghi nhật ký.
tùy chọn Tùy chọn nhật ký

Trả về:

trống rỗng

hàm(logLevel, ...)

setLogLevel(logLevel)

Đặt cấp độ nhật ký cho tất cả SDK Firebase.

Tất cả các loại nhật ký trên cấp độ nhật ký hiện tại đều được ghi lại (tức là nếu bạn đặt cấp độ nhật ký thành info , lỗi được ghi lại, nhưng nhật ký debugverbose thì không).

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
mức đăng nhập LogLevelString

Trả về:

trống rỗng

Tên chức năng, ...)

getApp(tên)

Truy xuất phiên bản FirebaseApp .

Khi được gọi mà không có đối số, ứng dụng mặc định sẽ được trả về. Khi tên ứng dụng được cung cấp, ứng dụng tương ứng với tên đó sẽ được trả về.

Một ngoại lệ sẽ được đưa ra nếu ứng dụng đang được truy xuất chưa được khởi chạy.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tên sợi dây Tên tùy chọn của ứng dụng để trả về. Nếu không có tên nào được cung cấp thì mặc định là "[DEFAULT]" .

Trả về:

Ứng dụng Firebase

Ứng dụng tương ứng với tên ứng dụng được cung cấp. Nếu không có tên ứng dụng nào được cung cấp thì ứng dụng mặc định sẽ được trả về.

ví dụ 1

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

Ví dụ 2

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

chức năng (tùy chọn, ...)

khởi tạoApp(tùy chọn, tên)

Tạo và khởi tạo một phiên bản FirebaseApp .

Xem Thêm Firebase vào ứng dụng của bạnKhởi tạo nhiều dự án để biết tài liệu chi tiết.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn Tùy chọn Firebase Tùy chọn để định cấu hình dịch vụ của ứng dụng.
tên sợi dây Tên tùy chọn của ứng dụng để khởi tạo. Nếu không có tên nào được cung cấp thì mặc định là "[DEFAULT]" .

Trả về:

Ứng dụng Firebase

Ứng dụng được khởi tạo.

ví dụ 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
});

Ví dụ 2


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

khởi tạoApp(tùy chọn, cấu hình)

Tạo và khởi tạo phiên bản FirebaseApp.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tùy chọn Tùy chọn Firebase Tùy chọn để định cấu hình dịch vụ của ứng dụng.
cấu hình Cài đặt ứng dụng Firebase Cấu hình ứng dụng Firebase

Trả về:

Ứng dụng Firebase

SDK_VERSION

Phiên bản SDK hiện tại.

Chữ ký:

SDK_VERSION: string