Exporting Param classes to allow their import from firebase-functions/params #1455
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Exported Param classes:
BooleanParam
,FloatParam
,IntParam
,SecretParam
,StringParam
, andListParam
.Upon creating stubs using various tools to test my cloud functions which use firebase-functions, I faced an issue where I could not mock
defineSecret
as it was called too early. I could stub it before importing the function file, but it would impair the coding conventions, and cause more effort.As a result, I tried to import
SecretParam
and tried to stub its prototype. Upon running, I had an errorPackage subpath './lib/params/types' is not defined by "exports"
which is reasonable as it is not exported by default and rather used as a local class.Despite presumably being a DX choice (to avoid wrongfully creating params), it causes trouble and limits the users' ability to interact with the library.
This PR doesn't break any existing code.
Code sample
Here's an example in TypeScript of creating a stub with the
sinon
library