• get analytics(): object
  • Returns object

    • event:

      Select analytics events to listen to for events.


  • get auth(): object
  • Returns object

    • user:

      Handle events related to Firebase authentication users.


  • get crashlytics(): object
  • Returns object

    • issue:

      Handle events related to Crashlytics issues. An issue in Crashlytics is an aggregation of crashes which have a shared root cause.


  • get database(): object
  • Returns object

    • instance:

      Selects a database instance that will trigger the function. If omitted, will pick the default database for your project.

    • ref:

      Select Firebase Realtime Database Reference to listen to.

      This method behaves very similarly to the method of the same name in the client and Admin Firebase SDKs. Any change to the Database that affects the data at or below the provided path will fire an event in Cloud Functions.

      There are three important differences between listening to a Realtime Database event in Cloud Functions and using the Realtime Database in the client and Admin SDKs:

      1. Cloud Functions allows wildcards in the path name. Any path component in curly brackets ({}) is a wildcard that matches all strings. The value that matched a certain invocation of a Cloud Function is returned as part of the context.params object. For example, ref("messages/{messageId}") matches changes at /messages/message1 or /messages/message2, resulting in context.params.messageId being set to "message1" or "message2", respectively.
      2. Cloud Functions do not fire an event for data that already existed before the Cloud Function was deployed.
      3. Cloud Function events have access to more information, including information about the user who triggered the Cloud Function.


  • get firestore(): object
  • Returns object

    • document:

      Listen for events on a Firestore document. A Firestore document contains a set of key-value pairs and may contain subcollections and nested objects.


  • get https(): object
  • Returns object

    • onCall: function
      • Declares a callable method for clients to call using a Firebase SDK.


        • handler: function

          A method that takes a data and context and returns a value.

        Returns HttpsFunction

    • onRequest: function
      • Handle HTTP requests.


        • handler: function

          A function that takes a request and response object, same signature as an Express app.

            • (req: express.Request, resp: express.Response): void
            • Parameters

              • req: express.Request
              • resp: express.Response

              Returns void

        Returns HttpsFunction


  • get pubsub(): object
  • Returns object

    • topic:

      Select Cloud Pub/Sub topic to listen to.


  • get remoteConfig(): object


  • get storage(): object
  • Returns object

    • bucket:

      The optional bucket function allows you to choose which buckets' events to handle. This step can be bypassed by calling object() directly, which will use the default Cloud Storage for Firebase bucket.

    • object:

      Handle events related to Cloud Storage objects.


  • get testLab(): object
  • Returns object

    • testMatrix: