Repository files navigation

Create & test Firebase Cloud Functions in TypeScript

This starter allows you to create & testFirebase Cloud Functions inTypeScript.

Get theChangelog.

• 1 Project structure
• 2 Customizing
• 3 Testing
• 4 Building
• 5 Publishing
• 6 What it is important to know

• functions:
  • src folder for the Functions
    • index.ts entry point for all your Firebase Functions
  • tests folder for theMocha tests
  • package.jsonnpm options
  • rollup.config.jsRollup configuration for building the ES bundle
  • tsconfig.jsonTypeScript compiler options
  • .mocharc.jsonMocha options
  • .eslintrc.jsonESLint configuration
• .firebaserc: Firebase projects

1. UpdateFirebase CLI.

2. Update.firebaserc with yourproject-id.

3. Add your Firebase Functions toindex.ts and create different files for each one.

4. Update inrollup.config.js file external dependencies with those that actually you use to build the ES bundle.

5. Create unit tests intests folder.

The following command runs unit tests usingMocha that are in thetests folder:

npmtest

Starttsc compiler withwatch option:

npm run build:dev

Start the emulatorfirebase emulators:start --only functions

npm run serve:dev

For the other supported emulators, please refer to the official documentation:Run Functions Locally

The following command:

npm run build

createslib folder with the file of distribution:

└── functions    └──lib        └── index.js

npm run deploy

1. Node.js

   The engine inpackage.json is set toNode.js 16

2. ES Modules

   Node.js 16 supports ES Modules: so you have"type": "module" inpackage.json,format: 'es' inrollup.config.js andtsconfig.js used bytsc compiler targets ES2021 with ES2020 modules

3. Bundling withRollup

   Firebase Cloud Functions do not require the deployment of a single bundle. In any case the building withRollup offers some advantages:

   • Tree shaking of unused code
   • No request for other files at runtime

MIT