firebase-admin

Variables

• AppErrorCode
• SDK_VERSION

Functions

• applicationDefault()
• cert()
• deleteApp()
• getApp()
• getApps()
• initializeApp()
• refreshToken()

Classes

• FirebaseAppError
• FirebaseError

Interfaces

• App

  • name
  • options
• AppOptions

  • credential
  • databaseAuthVariableOverride
  • databaseURL
  • httpAgent
  • projectId
  • serviceAccountId
  • storageBucket
• Credential

  • getAccessToken()
• ErrorInfo

  • cause
  • code
  • httpResponse
  • message
• FirebaseArrayIndexError

  • error
  • index
• FirebaseError

  • cause
  • code
  • hasCode()
  • httpResponse
  • message
  • stack
  • toJSON()
• GoogleOAuthAccessToken

  • access_token
  • expires_in
• HttpResponse

  • data
  • headers
  • status
• ServiceAccount

  • clientEmail
  • privateKey
  • projectId

Type Aliases

• AppErrorCode

variable AppErrorCode

const AppErrorCode: {
    readonly APP_DELETED: 'app-deleted';
    readonly DUPLICATE_APP: 'duplicate-app';
    readonly INVALID_ARGUMENT: 'invalid-argument';
    readonly INTERNAL_ERROR: 'internal-error';
    readonly INVALID_APP_NAME: 'invalid-app-name';
    readonly INVALID_APP_OPTIONS: 'invalid-app-options';
    readonly INVALID_CREDENTIAL: 'invalid-credential';
    readonly NETWORK_ERROR: 'network-error';
    readonly NETWORK_TIMEOUT: 'network-timeout';
    readonly NO_APP: 'no-app';
    readonly UNABLE_TO_PARSE_RESPONSE: 'unable-to-parse-response';
};

• The constant mapping for valid App client error codes.

variable SDK_VERSION

const SDK_VERSION: string;

function applicationDefault

applicationDefault: (httpAgent?: Agent) => Credential;

• 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 firebase-admin.app#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.

  Parameter httpAgent

  Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

  Returns

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

  Example 1

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

function cert

cert: (
    serviceAccountPathOrObject: string | ServiceAccount,
    httpAgent?: Agent
) => Credential;

• 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 firebase-admin.app#initializeApp.

  See Initialize the SDK for more details.

  Parameter serviceAccountPathOrObject

  The path to a service account key JSON file or an object representing a service account key.

  Parameter httpAgent

  Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

  Returns

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

function deleteApp

deleteApp: (app: App) => Promise<void>;

• 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.

  Example 1

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

function getApp

getApp: (appName?: string) => App;

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

  Parameter appName

  Optional name of the App instance.

  Returns

  An existing App instance that matches the name provided.

  Throws

  FirebaseAppError if no App exists for the given name.

  Throws

  FirebaseAppError if the appName is malformed.

function getApps

getApps: () => App[];

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

  Returns

  An array containing all initialized apps.

function initializeApp

initializeApp: (options?: AppOptions, appName?: string) => App;

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

  Parameter options

  Optional A set of AppOptions for the App instance. If not present, initializeApp will try to initialize with the options from the FIREBASE_CONFIG environment variable. If the environment variable contains a string that starts with { it will be parsed as JSON, otherwise it will be assumed to be pointing to a file.

  Parameter appName

  Optional name of the App instance.

  Returns

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

  Throws

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

  Throws

  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.

function refreshToken

refreshToken: (
    refreshTokenPathOrObject: string | object,
    httpAgent?: Agent
) => Credential;

• 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 firebase-admin.app#initializeApp.

  See Initialize the SDK for more details.

  Parameter refreshTokenPathOrObject

  The path to a Google OAuth2 refresh token JSON file or an object representing a Google OAuth2 refresh token.

  Parameter httpAgent

  Optional HTTP Agent to be used when retrieving access tokens from Google token servers.

  Returns

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

  Example 1

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

type AppErrorCode

type AppErrorCode = (typeof AppErrorCode)[keyof typeof AppErrorCode];

• The type definition for valid App client error codes.