firebase-admin.app package

Firebase App and SDK initialization.

Functions

let app;
try {
  app = getApp("myApp");
} catch (error) {
  app = initializeApp({ credential: myCredential }, "myApp");
}

| | refreshToken(refreshTokenPathOrObject, httpAgent) | Returns a credential created from the provided refresh token that grants admin access to Firebase services. This credential can be used in the call to initializeApp().See Initialize the SDK for more details. |

Classes

Interfaces

Variables

applicationDefault(httpAgent)

Returns a credential created from the Google Application Default Credentials that grants admin access to Firebase services. This credential can be used in the call to initializeApp().

Google Application Default Credentials are available on any Google infrastructure, such as Google App Engine and Google Compute Engine.

See Initialize the SDK for more details.

Signature:

export declare function applicationDefault(httpAgent?: Agent): Credential;

Parameters

Returns:

Credential

A credential authenticated via Google Application Default Credentials that can be used to initialize an app.

Example

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

cert(serviceAccountPathOrObject, httpAgent)

Returns a credential created from the provided service account that grants admin access to Firebase services. This credential can be used in the call to initializeApp().

See Initialize the SDK for more details.

Signature:

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

Parameters

Returns:

Credential

A credential authenticated via the provided service account that can be used to initialize an app.

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

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

deleteApp(app)

Renders this given App unusable and frees the resources of all associated services (though it does *not* clean up any backend resources). When running the SDK locally, this method must be called to ensure graceful termination of the process.

Signature:

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

Parameters

Returns:

Promise<void>

Example

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

getApp(appName)

Returns an existing App instance for the provided name. If no name is provided the the default app name is used.

Signature:

export declare function getApp(appName?: string): App;

Parameters

Returns:

App

An existing App instance that matches the name provided.

Exceptions

FirebaseAppError if no App exists for the given name.

FirebaseAppError if the appName is malformed.

getApps()

A (read-only) array of all initialized apps.

Signature:

export declare function getApps(): App[];

Returns:

App[]

An array containing all initialized apps.

initializeApp(options, appName)

Initializes the App instance.

Creates a new instance of App if one doesn't exist, or returns an existing App instance if one exists with the same appName and options.

Note, due to the inablity to compare http.Agent objects and Credential objects, this function cannot support idempotency if either of options.httpAgent or options.credential are defined. When either is defined, subsequent invocations will throw a FirebaseAppError instead of returning an App object.

For example, to safely initialize an app that may already exist:

let app;
try {
  app = getApp("myApp");
} catch (error) {
  app = initializeApp({ credential: myCredential }, "myApp");
}

Signature:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

Parameters

Returns:

App

A new App instance, or the existing App if the instance already exists with the provided configuration.

Exceptions

FirebaseAppError if an App with the same name has already been initialized with a different set of AppOptions.

FirebaseAppError if an existing App exists and options.httpAgent or options.credential are defined. This is due to the function's inability to determine if the existing App's options equate to the options parameter of this function. It's recommended to use getApp() or getApps() if your implementation uses either of these two fields in AppOptions.

refreshToken(refreshTokenPathOrObject, httpAgent)

Returns a credential created from the provided refresh token that grants admin access to Firebase services. This credential can be used in the call to initializeApp().

See Initialize the SDK for more details.

Signature:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

Parameters

Returns:

Credential

A credential authenticated via the provided service account that can be used to initialize an app.

Example

// 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

Signature:

SDK_VERSION: string