fix: message service typings file contains incorrect default parameter value for subscribe method

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

31 stars 48 forks source link

fix: message service typings file contains incorrect default parameter value for subscribe method #547

Closed randi274 closed 1 year ago

randi274 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?

Closes #546 Closes #545

randi274 commented 1 year ago

For QA, confirmed subscriberOptions was required before the fix:

Confirmed the fix made the param optional:

And for good measure reviewed publish was still good with only the first two params: