Hide implementation of defineFloat. (#1341)

Firebase CLI doesn't support defineFloat yet (firebase/firebase-tools#5433).
firebase · Jan 19, 2023 · a10dd78 · a10dd78
1 parent 7481764
commit a10dd78
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,4 @@
 - Allow Functions to specify vpcConnector as a string parameter (#1329)
 - Upgrade jsonwebtoken to version 9 (#1336)
 - Adds 'eventarcpublishing' as required API to custom event function
+- Hide type information of defineFloat in params module - it's not supported yet (#1341)
diff --git a/src/params/index.ts b/src/params/index.ts
@@ -159,6 +159,8 @@ export function defineInt(name: string, options: ParamOptions<number> = {}): Int
  * @param name The name of the environment variable to use to load the param.
  * @param options Configuration options for the param.
  * @returns A Param with a `number` return type for `.value`.
+ *
+ * @internal
  */
 export function defineFloat(name: string, options: ParamOptions<number> = {}): FloatParam {
   const param = new FloatParam(name, options);