app package

Приложение Firebase

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

Функции

Функция Описание
функция (приложение, ...)
удалить приложение (приложение) Делает это приложение непригодным для использования и освобождает ресурсы всех связанных служб.
функция()
getApps() Массив всех инициализированных приложений (только для чтения).
инициализироватьПриложение() Создает и инициализирует экземпляр FirebaseApp.
функция (libraryKeyOrName, ...)
RegisterVersion(libraryKeyOrName, версия, вариант) Регистрирует имя и версию библиотеки для целей ведения журнала платформы.
функция (logCallback, ...)
onLog(logCallback, параметры) Устанавливает обработчик журналов для всех Firebase SDK.
функция (logLevel, ...)
setLogLevel (уровень журнала) Устанавливает уровень журнала для всех Firebase SDK. Записываются все типы журналов выше текущего уровня журнала (т. е. если вы установите уровень журнала info , ошибки регистрируются, а журналы debug и verbose журналы — нет).
функция(имя, ...)
getApp(имя) Получает экземпляр FirebaseApp . При вызове без аргументов возвращается приложение по умолчанию. Если указано имя приложения, возвращается приложение, соответствующее этому имени. Исключение выдается, если извлекаемое приложение еще не инициализировано.
функция(опции, ...)
инициализироватьПриложение (опции, имя) Создает и инициализирует экземпляр FirebaseApp . Подробную документацию см. в разделах «Добавление Firebase в ваше приложение» и «Инициализация нескольких проектов» .
инициализировать приложение (параметры, конфигурация) Создает и инициализирует экземпляр FirebaseApp.
инициализироватьServerApp (параметры, конфигурация) Создает и инициализирует экземпляр FirebaseServerApp . FirebaseServerApp похож на FirebaseApp , но предназначен для выполнения только в средах рендеринга на стороне сервера. Инициализация завершится неудачно, если она будет вызвана из среды браузера. Подробную документацию см. в разделах «Добавление Firebase в ваше приложение» и «Инициализация нескольких проектов» .

Интерфейсы

Интерфейс Описание
FirebaseApp FirebaseApp хранит информацию об инициализации набора сервисов. Не вызывайте этот конструктор напрямую. Вместо этого используйте InitializeApp() для создания приложения.
Настройки приложения Firebase Параметры конфигурации, заданные для инициализацииApp()
Параметры Firebase Объект конфигурации Firebase. Содержит набор параметров, необходимых службам для успешного взаимодействия с API-интерфейсами сервера Firebase и для связывания данных клиента с вашим проектом Firebase и приложением Firebase. Обычно этот объект заполняется консолью Firebase при настройке проекта. См. также: Узнайте об объекте конфигурации Firebase. .
FirebaseServerApp FirebaseServerApp содержит информацию об инициализации набора сервисов, работающих в серверных средах. Не вызывайте этот конструктор напрямую. Вместо этого используйте InitializeServerApp() для создания приложения.
Настройки FirebaseServerAppSettings Параметры конфигурации, заданные для инициализацииServerApp()

Переменные

Переменная Описание
SDK_VERSION Текущая версия SDK.

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

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

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

Подпись:

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 []

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

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

Подпись:

export declare function initializeApp(): FirebaseApp;

Возврат:

FirebaseApp

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

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

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

Подпись:

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

Параметры

Параметр Тип Описание
библиотекаKeyOrName нить
версия нить Текущая версия этой библиотеки.
вариант нить Вариант связки, например, узел, р-н и т. д.

Возврат:

пустота

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

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

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

Подпись:

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

Параметры

Параметр Тип Описание
logОбратный вызов Журнал обратного вызова | нулевой Дополнительный пользовательский обработчик журнала, который выполняет пользовательский код всякий раз, когда Firebase SDK выполняет вызов журнала.
параметры Параметры журнала

Возврат:

пустота

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

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

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

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

Подпись:

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

Параметры

Параметр Тип Описание
уровень журнала Строка уровня журнала

Возврат:

пустота

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

getApp(имя)

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

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

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

Подпись:

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

Параметры

Параметр Тип Описание
имя нить Необязательное имя возвращаемого приложения. Если имя не указано, по умолчанию используется "[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;

Параметры

Параметр Тип Описание
параметры Параметры Firebase Параметры настройки служб приложения.
имя нить Необязательное имя приложения для инициализации. Если имя не указано, по умолчанию используется "[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");

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

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

Подпись:

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

Параметры

Параметр Тип Описание
параметры Параметры Firebase Параметры настройки служб приложения.
конфигурация Настройки приложения Firebase Конфигурация FirebaseApp

Возврат:

FirebaseApp

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

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

FirebaseServerApp похож на FirebaseApp , но предназначен для выполнения только в средах рендеринга на стороне сервера. Инициализация завершится неудачно, если она будет вызвана из среды браузера.

Подробную документацию см. в разделах «Добавление Firebase в ваше приложение» и «Инициализация нескольких проектов» .

Подпись:

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

Параметры

Параметр Тип Описание
параметры Параметры Firebase | FirebaseApp Firebase.AppOptions для настройки служб приложения или экземпляр FirebaseApp , содержащий AppOptions .
конфигурация Настройки 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