search

forcedotcom / lightning-language-server

LWC and Aura Language Servers - shipped as part of the Salesforce VSCode Extensions
https://forcedotcom.github.io/salesforcedx-vscode/
BSD 3-Clause "New" or "Revised" License
33 stars 49 forks source link

bugfix/message service typings file contains incorrect default parameter value for subscribe method #546

Closed jlawrence124 closed 1 year ago

jlawrence124 commented 1 year ago

What does this PR do?

This PR changes the subscriberOptions parameter in lightning/messageService to be optional. It also fixes the JSDocs to use the optional parameter format.

JSDocs: https://jsdoc.app/tags-param.html#optional-parameters-and-default-values

What issues does this PR fix or reference?

This PR fixes type annotation suggestions in VSCode for the subscribe function of lightning/messageService. This will bring the code in line with the Salesforce documentation.

Issue here: https://github.com/forcedotcom/lightning-language-server/issues/545

randi274 commented 1 year ago

Hey @jlawrence124 thanks for the quick report & fix on this! I've run through the QA on it, and just need someone on my team to confirm and we'll be good to go. #547 will close this and the open issue once that's merged in. Cheers!

jlawrence124 commented 1 year ago

Thanks so much @randi274, appreciate your quick review as well!