Cloud Function in Typescript

The functions framework expect a index.js in the local directory. I’m writing my functions in Typescript and test it locally with nodemon, ts-node and a ts file, which starts the express server.

Is there a better way than running tsc every time something changes and then start the functions-framework?

[paulwoelfel]

My solution right now is to use tsc-watch and the following command:

npx tsc-watch --onSuccess 'npx @google-cloud/functions-framework --function-target=main --port=8080 --function-signature-type=http'

In the local directory I created index.js, which loads the transpiled js:

const cloudFunctions = require("./dist");

Object.keys(cloudFunctions).forEach(
  key => (exports[key] = cloudFunctions[key])
);

And that’s the tsconfig.json

{
  "compilerOptions": {
    "outDir": "./dist",
    "target": "es2018",
    "lib": ["dom", "es2018"],
    "module": "commonjs",
    "esModuleInterop": true,
    "pretty": true,
    "sourceMap": true
  },
  "include": ["./src/**/*"],
  "exclude": ["node_modules"]
}

[fernandofleury]

This is how I’m achieving it using nodemon:

{
  "start": "functions-framework --target=event",
  "watch": "concurrently -k -p \"[{name}]\" -n \"TypeScript,Node\" -c \"yellow.bold,cyan.bold,green.bold\" \"npm run watch-ts\" \"npm run watch-node\"",
  "watch-node": "nodemon --watch ./build/ --exec npm run start",
  "watch-ts": "tsc -w"
}

It’s a bit verbose I have to say, but it’s also following the official TS node boilerplate.