Инициализация приложения Firebase и SDK.
Функции
| Функция | Описание |
|---|---|
| Приложение по умолчанию (httpAgent) | Возвращает учетные данные, созданные на основе учетных данных приложения Google по умолчанию , которые предоставляют администратору доступ к сервисам Firebase. Эти учетные данные можно использовать при вызове InitializeApp(). . Учетные данные приложения Google по умолчанию доступны в любой инфраструктуре Google, например в Google App Engine и Google Compute Engine. Дополнительные сведения см. в разделе Инициализация SDK . |
| сертификат (serviceAccountPathOrObject, httpAgent) | Возвращает учетные данные, созданные на основе предоставленной учетной записи службы, которые предоставляют администраторский доступ к службам Firebase. Эти учетные данные можно использовать при вызове InitializeApp(). . Дополнительные сведения см. в разделе Инициализация SDK . |
| удалить приложение (приложение) | Делает данное App непригодным для использования и освобождает ресурсы всех связанных служб (хотя оно *не* очищает какие-либо серверные ресурсы). При локальном запуске SDK этот метод необходимо вызвать, чтобы обеспечить корректное завершение процесса. |
| getApp(имя приложения) | |
| getApps() | |
| инициализироватьПриложение (опции, имя_приложения) | |
| обновитьToken (refreshTokenPathOrObject, httpAgent) | Возвращает учетные данные, созданные на основе предоставленного токена обновления, которые предоставляют администратору доступ к сервисам Firebase. Эти учетные данные можно использовать при вызове InitializeApp(). . Дополнительные сведения см. в разделе Инициализация SDK . |
Классы
| Сорт | Описание |
|---|---|
| AppErrorCodes | Коды ошибок клиента приложения и их сообщения по умолчанию. |
| FirebaseAppError | Структура кода ошибки приложения Firebase. Это расширяет PrefixedFirebaseError. |
Интерфейсы
| Интерфейс | Описание |
|---|---|
| Приложение | Приложение Firebase содержит информацию об инициализации набора сервисов. |
| Параметры приложения | Доступные параметры для передачи в InitializeApp() . |
| Полномочия | Интерфейс, предоставляющий токены доступа Google OAuth2, используемые для аутентификации в сервисах Firebase. В большинстве случаев вам не нужно будет реализовывать это самостоятельно, вместо этого вы можете использовать реализации по умолчанию, предоставляемые модулем firebase-admin/app . |
| FirebaseArrayIndexError | Составной тип, который включает в себя как объект FirebaseError , так и индекс, который можно использовать для получения элемента с ошибкой. |
| FirebaseError | FirebaseError — это подкласс стандартного объекта Error JavaScript. Помимо строки сообщения и трассировки стека, он содержит строковый код. |
| Токен GoogleOAuthAccess | Интерфейс для токенов доступа Google OAuth 2.0. |
| Сервисаккаунт |
Переменные
| Переменная | Описание |
|---|---|
| SDK_VERSION |
Приложение по умолчанию (httpAgent)
Возвращает учетные данные, созданные на основе учетных данных приложения Google по умолчанию , которые предоставляют администратору доступ к сервисам Firebase. Эти учетные данные можно использовать при вызове InitializeApp(). .
Учетные данные приложения Google по умолчанию доступны в любой инфраструктуре Google, например в Google App Engine и Google Compute Engine.
Дополнительные сведения см. в разделе Инициализация SDK .
Подпись:
export declare function applicationDefault(httpAgent?: Agent): Credential;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| HTTPАгент | Агент | Дополнительный HTTP-агент , который будет использоваться при получении токенов доступа с серверов токенов Google. |
Возврат:
Учетные данные, аутентифицированные с помощью учетных данных приложения Google по умолчанию, которые можно использовать для инициализации приложения.
Пример
initializeApp({
credential: applicationDefault(),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
сертификат (serviceAccountPathOrObject, httpAgent)
Возвращает учетные данные, созданные на основе предоставленной учетной записи службы, которые предоставляют администраторский доступ к службам Firebase. Эти учетные данные можно использовать при вызове InitializeApp(). .
Дополнительные сведения см. в разделе Инициализация SDK .
Подпись:
export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| СервисАккаунтПатОрОбжект | строка | Сервисаккаунт | Путь к JSON-файлу ключа учетной записи службы или объекту, представляющему ключ учетной записи службы. |
| HTTPАгент | Агент | Дополнительный HTTP-агент , который будет использоваться при получении токенов доступа с серверов токенов Google. |
Возврат:
Учетные данные, аутентифицированные через предоставленную учетную запись службы, которые можно использовать для инициализации приложения.
Пример 1
// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
credential: cert(serviceAccount),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
Пример 2
// Providing a service account object inline
initializeApp({
credential: cert({
projectId: "<PROJECT_ID>",
clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
}),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
удалить приложение (приложение)
Делает данное App непригодным для использования и освобождает ресурсы всех связанных служб (хотя оно *не* очищает какие-либо серверные ресурсы). При локальном запуске SDK этот метод необходимо вызвать, чтобы обеспечить корректное завершение процесса.
Подпись:
export declare function deleteApp(app: App): Promise<void>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| приложение | Приложение |
Возврат:
Обещание<void>
Пример
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
getApp(имя приложения)
Подпись:
export declare function getApp(appName?: string): App;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| имя приложения | нить |
Возврат:
getApps()
Подпись:
export declare function getApps(): App[];
Возврат:
Приложение []
инициализироватьПриложение (опции, имя_приложения)
Подпись:
export declare function initializeApp(options?: AppOptions, appName?: string): App;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| параметры | Параметры приложения | |
| имя приложения | нить |
Возврат:
обновитьToken (refreshTokenPathOrObject, httpAgent)
Возвращает учетные данные, созданные на основе предоставленного токена обновления, которые предоставляют администратору доступ к сервисам Firebase. Эти учетные данные можно использовать при вызове InitializeApp(). .
Дополнительные сведения см. в разделе Инициализация SDK .
Подпись:
export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| обновитьTokenPathOrObject | строка | объект | Путь к JSON-файлу токена обновления Google OAuth2 или объекту, представляющему токен обновления Google OAuth2. |
| HTTPАгент | Агент | Дополнительный HTTP-агент , который будет использоваться при получении токенов доступа с серверов токенов Google. |
Возврат:
Учетные данные, аутентифицированные через предоставленную учетную запись службы, которые можно использовать для инициализации приложения.
Пример
// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
credential: refreshToken(refreshToken),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
SDK_VERSION
Подпись:
SDK_VERSION: string