Skip to content

Commit

Permalink
TASK: Deprecate I18nRegistry.translate
Browse files Browse the repository at this point in the history
  • Loading branch information
grebaldi authored and markusguenther committed Dec 13, 2024
1 parent 8647a23 commit e3ddaf9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/neos-ui-i18n/src/registry/I18nRegistry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export class I18nRegistry extends SynchronousRegistry<unknown> {
* If no translation string can be found for the given id, the fully
* qualified translation address will be returned.
*
* @deprecated Use `import {tranlsate} from '@neos-project/neos-ui-i18n'` instead
* @param {string} transUnitIdOrFullyQualifiedTranslationAddress A trans-unit id or a fully qualified translation address
*/
translate(transUnitIdOrFullyQualifiedTranslationAddress: string): string;
Expand All @@ -46,6 +47,7 @@ export class I18nRegistry extends SynchronousRegistry<unknown> {
* If no translation string can be found for the given id, the given
* fallback value will be returned.
*
* @deprecated Use `import {tranlsate} from '@neos-project/neos-ui-i18n'` instead
* @param {string} transUnitIdOrFullyQualifiedTranslationAddress A trans-unit id or a fully qualified translation address
* @param {string} fallback The string that shall be displayed, when no translation string could be found.
*/
Expand All @@ -67,6 +69,7 @@ export class I18nRegistry extends SynchronousRegistry<unknown> {
* (e.g.: "{0}", or "{somePlaceholder}"), the placeholders will be replaced
* with the corresponding values that were passed as parameters.
*
* @deprecated Use `import {tranlsate} from '@neos-project/neos-ui-i18n'` instead
* @param {string} transUnitIdOrFullyQualifiedTranslationAddress The fully qualified translation address, that follows the format "{Package.Key:SourceName:trans.unit.id}"
* @param {undefined|string} fallback The string that shall be displayed, when no translation string could be found.
* @param {LegacyParameters} parameters The values to replace substitution placeholders with in the translation string
Expand All @@ -91,6 +94,7 @@ export class I18nRegistry extends SynchronousRegistry<unknown> {
* (e.g.: "{0}", or "{somePlaceholder}"), the placeholders will be replaced
* with the corresponding values that were passed as parameters.
*
* @deprecated Use `import {tranlsate} from '@neos-project/neos-ui-i18n'` instead
* @param {string} transUnitId The trans-unit id
* @param {undefined|string} fallback The string that shall be displayed, when no translation string could be found.
* @param {LegacyParameters} parameters The values to replace substitution placeholders with in the translation string
Expand Down Expand Up @@ -118,6 +122,7 @@ export class I18nRegistry extends SynchronousRegistry<unknown> {
* (e.g.: "{0}", or "{somePlaceholder}"), the placeholders will be replaced
* with the corresponding values that were passed as parameters.
*
* @deprecated Use `import {tranlsate} from '@neos-project/neos-ui-i18n'` instead
* @param {string} transUnitId The trans-unit id
* @param {undefined|string} fallback The string that shall be displayed, when no translation string could be found.
* @param {LegacyParameters} parameters The values to replace substitution placeholders with in the translation string
Expand Down Expand Up @@ -151,6 +156,7 @@ export class I18nRegistry extends SynchronousRegistry<unknown> {
* (e.g.: "{0}", or "{somePlaceholder}"), the placeholders will be replaced
* with the corresponding values that were passed as parameters.
*
* @deprecated Use `import {tranlsate} from '@neos-project/neos-ui-i18n'` instead
* @param {string} transUnitId The trans-unit id
* @param {undefined|string} fallback The string that shall be displayed, when no translation string could be found.
* @param {LegacyParameters} parameters The values to replace substitution placeholders with in the translation string
Expand Down

0 comments on commit e3ddaf9

Please sign in to comment.