JSPM

  • Created
  • Published
  • Downloads 577936
  • Score
    100M100P100Q172890F
  • License MIT

Firebase SDK for Cloud Functions

Package Exports

  • firebase-functions
  • firebase-functions/lib/encoder
  • firebase-functions/lib/providers/https

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (firebase-functions) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Firebase SDK for Cloud Functions

The firebase-functions package provides an SDK for defining Cloud Functions for Firebase.

Cloud Functions is a hosted, private, and scalable Node.js environment where you can run JavaScript code. The Firebase SDK for Cloud Functions integrates the Firebase platform by letting you write code that responds to events and invokes functionality exposed by other Firebase features.

This is a Beta release of Google Cloud Functions. This API might be changed in backward-incompatible ways and is not subject to any SLA or deprecation policy.

Learn more

Learn more about the Firebase SDK for Cloud Functions in the Firebase documentation or check out our samples.

Usage

// functions/index.js
var functions = require('firebase-functions');
var notifyUsers = require('./notify-users');

exports.newPost = functions.database
  .ref('/posts/{postId}')
  .onWrite(function(event) {
    // only execute function on creation
    if (!event.data.previous.exists()) {
      notifyUsers(event.data.val());
    }
  });

Contributing

To contribute a change, check out the contributing guide.

License

© Google, 2017. Licensed under The MIT License.