feat: Overload translate function to either allow number or placeholder as third arg #854
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…er as third arg
It makes no sense for the singular translate method to allow both at the
same time. It causes developers to add a `undefined` just to be able to
pass option. So allow one of both as the third parameter and deprecate
the 5-parameters overload so we can remove it in v4.
Before:
```js
translate('app', 'Number: %n', undefined, 4)
translate('app', 'Hello {name}', { name: 'John' })
translate('app', 'See our {linkStart}documentation{linkEnd}.', { ... }, undefined, { escape: false })
```
After:
```js
translate('app', 'Number: %n', 4)
translate('app', 'Hello {name}', { name: 'John' })
translate('app', 'See our {linkStart}documentation{linkEnd}.', { ... }, { escape: false })
```
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
susnux
added
type: enhancement
ShGKme
approved these changes
Feb 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It makes no sense for the singular translate method to allow both at the same time. It causes developers to add a
undefinedjust to be able to pass option. So allow one of both as the third parameter and deprecate the 5-parameters overload so we can remove it in v4.Before:
After: