Using cloud function parameterized configuration with Typescript

Question

I'm trying to follow this documentation to use parameterized configuration in my Firebase cloud functions.

The example they give is in Javascript, in particular in how they import defineInt and defineString from firebase-functions/params.

const { defineInt, defineString } = require('firebase-functions/params');

But all my functions code is in Typescript so I tried to translate that into:

import {defineInt} from "firebase-functions/lib/params";

Since apparently firebase-functions/params cannot be resolved.

But then when I try to deploy my functions, I get the following error message:

Error: Failed to load function definition from source: Failed to generate manifest from function source: Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: Package subpath './lib/params' is not defined by "exports" in /Users/sarbogast/dev/blindly/blindly/functions/node_modules/firebase-functions/package.json

Any idea what's the proper way to import those functions in Typescript?

I'm running into the same problem. You're importing correctly from a syntax point of view, but it seems that there is no such module. Package subpath './params' is not defined by "exports" in /Users/.../functions/node_modules/firebase-functions/package.json — Raphael Rafatpanah
– Raphael Rafatpanah, Commented Oct 28, 2022 at 2:30

Sebastien · Accepted Answer · 2022-10-30 07:42:54Z

3

The following import should resolve the issue:

import { https } from "firebase-functions/v1";
import { defineString } from "firebase-functions/params"; // no /lib

const welcomeMessage = defineString("WELCOME_MESSAGE");

export const hello = https.onRequest((request, response) => {
  response.send("Message: " + welcomeMessage);
});

Dependencies:

"firebase-admin": "^11.2.0",
"firebase-functions": "^4.0.1"

And given that the error is an eslint one and it doesn't make sense in that context, adding the following to .eslintrc.js turns the blocking error into a more persmissive warning:

module.exports = {
    ...
    rules: {
        ...
        "import/no-unresolved": "warn",
    },
};

edited Oct 30, 2022 at 7:42

Sebastien

4,5456 gold badges46 silver badges88 bronze badges

answered Oct 29, 2022 at 17:34

Dharmaraj

51.3k8 gold badges67 silver badges100 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

akauppi Over a year ago

You should have welcomeMessage.value(), when inside the .onRequest, right?

José Luis Raffalli Over a year ago

I had the same issue when targeting the "latest" version. Rolled back to this version fixed the import issue.

sifatul · Accepted Answer · 2023-01-04 08:15:54Z

3

I was having the same issue with the following firebase functions SDK (node: 16.x.x)

"firebase-admin": "^10.0.2",
"firebase-functions": "^3.18.0"

I changed how I imported the defineSecret and it's now working. I didn't have to change the .eslintrc either

import { defineSecret } from "firebase-functions/v2/params"

answered Jan 4, 2023 at 8:15

sifatul

314 bronze badges

Collectives™ on Stack Overflow

Using cloud function parameterized configuration with Typescript

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related