firebase / firebase-functions

Firebase SDK for Cloud Functions
https://firebase.google.com/docs/functions/
MIT License
1.01k stars 202 forks source link

Consider exporting `SecretParam` type #1549

Closed vajahath closed 2 months ago

vajahath commented 2 months ago

Related issues

A PR is already open for this: https://github.com/firebase/firebase-functions/pull/1350 (Feb 2023)

So we can do:

import { SecretParam } from "firebase-functions/params";

[REQUIRED] Version info

node:

firebase-functions:

firebase-tools:

firebase-admin:

[REQUIRED] Test case

[REQUIRED] Steps to reproduce

[REQUIRED] Expected behavior

[REQUIRED] Actual behavior

Were you able to successfully deploy your functions?

google-oss-bot commented 2 months ago

I found a few problems with this issue:

colerogers commented 2 months ago

Hi @vajahath thanks for opening this issue & the associated PR. Historically, we don't like to export our internal types/interfaces because we can change implementation details without having to do a breaking change release. We created defineSecret as the public interface for customers to use. I'm curious to what issue this solves for you?

vajahath commented 2 months ago

I'm convinced. This can be closed.

@YannicEl do you have any comments? (Based on your comments from the PR)