Skip to content

Remove unusable list param definition function from autocompletion #1233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 5, 2022

Conversation

Berlioz
Copy link
Contributor

@Berlioz Berlioz commented Sep 15, 2022

No description provided.

@Berlioz Berlioz requested a review from taeold September 15, 2022 18:55
@@ -134,6 +134,7 @@ export function defineFloat(name: string, options: ParamOptions<number> = {}): F
/**
* Declare a list param (array of strings).
*
* @hiddden
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think hidden works 🤔. You need to make it @internal or just get rid of the the implementation.

@inlined
Copy link
Member

inlined commented Oct 3, 2022

Quick notes:

  1. @hidden hides the API from VS Code's code complete while allowing the syntax
  2. @alpha hides the API from API docs (I believe)
  3. @internal drops the API from module exports

If we depend on the API inside the firebase-functions binary, I don't recall if we can actually use @internal. Test before you release.

@Berlioz
Copy link
Contributor Author

Berlioz commented Oct 5, 2022

We're axing the function entirely, not making it as hidden, but that explanation was helpful.

@Berlioz Berlioz merged commit 4298cc8 into launch.next Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants