refactor: result types with optional any for get, instant, stream, getStreamOnTranslationChange

Author: CodeAndWeb

projects/ngx-translate/src/lib/translate.service.ts

@@ -30,7 +30,8 @@ export type InterpolationParameters = Record<string, any>;
 export type StrictTranslation = string | StrictTranslation[] | TranslationObject | undefined | null;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type Translation<T = any> = StrictTranslation | T;
+export type AnyTranslation = any;
+export type Translation<T = AnyTranslation> = StrictTranslation | T;
 
 export interface TranslationObject {
     [key: string]: StrictTranslation;
@@ -98,28 +99,28 @@ export abstract class ITranslateService {
     public abstract reloadLang(lang: Language): Observable<InterpolatableTranslationObject>;
     public abstract resetLang(lang: Language): void;
 
-    public abstract instant(
+    public abstract instant<T = AnyTranslation>(
         key: string | string[],
         interpolateParams?: InterpolationParameters,
-    ): Translation;
-    public abstract stream(
+    ): Translation<T>;
+    public abstract stream<T = AnyTranslation>(
         key: string | string[],
         interpolateParams?: InterpolationParameters,
-    ): Observable<Translation>;
-    public abstract getStreamOnTranslationChange(
+    ): Observable<Translation<T>>;
+    public abstract getStreamOnTranslationChange<T = AnyTranslation>(
         key: string | string[],
         interpolateParams?: InterpolationParameters,
-    ): Observable<Translation>;
+    ): Observable<Translation<T>>;
 
     public abstract set(
         key: string,
         translation: string | TranslationObject,
         lang?: Language,
     ): void;
-    public abstract get(
+    public abstract get<T = AnyTranslation>(
         key: string | string[],
         interpolateParams?: InterpolationParameters,
-    ): Observable<Translation>;
+    ): Observable<Translation<T>>;
 
     public abstract setTranslation(
         lang: Language,
@@ -185,7 +186,7 @@ export class TranslateService implements ITranslateService {
     private missingTranslationHandler = inject(MissingTranslationHandler);
     private store: TranslateStore = inject(TranslateStore);
 
-    private readonly extend:boolean = false;
+    private readonly extend: boolean = false;
 
     /**
      * An Observable to listen to translation change events
@@ -506,10 +507,10 @@ export class TranslateService implements ITranslateService {
      * Gets the translated value of a key (or an array of keys)
      * @returns the translated key, or an object of translated keys
      */
-    public get(
+    public get<T = AnyTranslation>(
         key: string | string[],
         interpolateParams?: InterpolationParameters,
-    ): Observable<Translation> {
+    ): Observable<Translation<T>> {
         if (!isDefinedAndNotNull(key) || !key.length) {
             throw new Error(`Parameter "key" is required and cannot be empty`);
         }
@@ -530,10 +531,10 @@ export class TranslateService implements ITranslateService {
      * whenever the translation changes.
      * @returns A stream of the translated key, or an object of translated keys
      */
-    public getStreamOnTranslationChange(
+    public getStreamOnTranslationChange<T = AnyTranslation>(
         key: string | string[],
         interpolateParams?: InterpolationParameters,
-    ): Observable<Translation> {
+    ): Observable<Translation<T>> {
         if (!isDefinedAndNotNull(key) || !key.length) {
             throw new Error(`Parameter "key" is required and cannot be empty`);
         }
@@ -554,10 +555,10 @@ export class TranslateService implements ITranslateService {
      * whenever the language changes.
      * @returns A stream of the translated key, or an object of translated keys
      */
-    public stream(
+    public stream<T = AnyTranslation>(
         key: string | string[],
         interpolateParams?: InterpolationParameters,
-    ): Observable<Translation> {
+    ): Observable<Translation<T>> {
         if (!isDefinedAndNotNull(key) || !key.length) {
             throw new Error(`Parameter "key" required`);
         }
@@ -578,8 +579,7 @@ export class TranslateService implements ITranslateService {
      * All rules regarding the current language, the preferred language of even fallback languages
      * will be used except any promise handling.
      */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    public instant<T = any>(
+    public instant<T = AnyTranslation>(
         key: string | string[],
         interpolateParams?: InterpolationParameters,
     ): Translation<T> {