Détail du package

firebase-functions

firebase3.6mMIT7.0.0

Firebase SDK for Cloud Functions

firebase, functions, google, cloud

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.

Learn more

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

Here are some resources to get help:

If the official documentation doesn't help, try asking through our official support channels

Please avoid double posting across multiple channels!

Usage

// functions/index.js
const { onValueCreated } = require("firebase-functions/database");
const logger = require("firebase-functions/logger");
const notifyUsers = require("./notify-users");

exports.newPost = onValueCreated({ ref: "/posts/{postId}" }, (event) => {
  logger.info("Received new post with ID:", event.params.postId);
  return notifyUsers(event.data.val());
});

Contributing

To contribute a change, check out the contributing guide.

License

© Google, 2017. Licensed under The MIT License.

changelog

  • BREAKING: Drop support for Node.js 16. Minimum supported version is now Node.js 18. (#1747)
  • BREAKING: Remove deprecated functions.config() API. Use params module for environment variables instead. (#1748)
  • BREAKING: Upgrade to TypeScript v5 and target ES2022. (#1746)
  • BREAKING: Unhandled errors in async onRequest handlers in the Emulator now return a 500 error immediately. (#1755)
  • Add support for ESM (ECMAScript Modules) alongside CommonJS. (#1750)
  • Add onMutationExecuted() trigger for Firebase Data Connect. (#1727)
  • BREAKING: Rename v1 Event to LegacyEvent to avoid api-extractor conflict. (#1767)