app package

Приложение Firebase

Этот пакет координирует связь между различными компонентами Firebase.

Функции

Интерфейсы

Переменные

функция (приложение, ...)

удалить приложение (приложение)

Делает это приложение непригодным для использования и освобождает ресурсы всех связанных служб.

Подпись:

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

Параметры

Возврат:

Обещание<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 []

инициализироватьПриложение()

Создает и инициализирует экземпляр FirebaseApp.

Подпись:

export declare function initializeApp(): FirebaseApp;

Возврат:

FirebaseApp

функция (libraryKeyOrName, ...)

RegisterVersion(libraryKeyOrName, версия, вариант)

Регистрирует имя и версию библиотеки для целей ведения журнала платформы.

Подпись:

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

Параметры

Возврат:

пустота

функция (logCallback, ...)

onLog(logCallback, параметры)

Устанавливает обработчик журналов для всех Firebase SDK.

Подпись:

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

Параметры

Возврат:

пустота

функция (logLevel, ...)

setLogLevel (уровень журнала)

Устанавливает уровень журнала для всех Firebase SDK.

Записываются все типы журналов выше текущего уровня журнала (т. е. если вы установили уровень журнала на info , ошибки регистрируются, но debug и verbose журналы — нет).

Подпись:

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

Параметры

Возврат:

пустота

функция (имя, ...)

getApp(имя)

Получает экземпляр FirebaseApp .

При вызове без аргументов возвращается приложение по умолчанию. Если указано имя приложения, возвращается приложение, соответствующее этому имени.

Исключение выдается, если извлекаемое приложение еще не инициализировано.

Подпись:

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

Параметры

Возврат:

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;

Параметры

Возврат:

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");

инициализироватьApp (параметры, конфигурация)

Создает и инициализирует экземпляр FirebaseApp.

Подпись:

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

Параметры

Возврат:

FirebaseApp

инициализироватьServerApp (параметры, конфигурация)

Создает и инициализирует экземпляр 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