fix: fix JSdoc, from Array<Hero> to Hero only

domingo1021 · Jul 6, 2024 · bef7e08 · bef7e08
1 parent aa0d958
commit bef7e08
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/src/modules/hero/hero.repository.impl.ts b/src/modules/hero/hero.repository.impl.ts
@@ -58,7 +58,7 @@ export class HeroRepositoryImpl implements HeroRepository {
 
   /**
    * @description Get single hero in cache-aside strategy: get cache first, if not exist, fetch from external API.
-   * @returns {Promise<Array<Hero>>}
+   * @returns {Promise<Hero>}
    * @throws {InternalServerErrorException}
    */
   async getHeroById(id: string): Promise<Hero> {
@@ -76,7 +76,7 @@ export class HeroRepositoryImpl implements HeroRepository {
 
   /**
    * @description Get single hero with profile in cache-aside strategy: get cache first, if not exist, fetch from external API.
-   * @returns {Promise<Array<Hero>>}
+   * @returns {Promise<Hero>}
    * @throws {InternalServerErrorException}
    */
   async getHeroWithProfileById(id: string): Promise<Hero> {

diff --git a/src/modules/hero/hero.service.ts b/src/modules/hero/hero.service.ts
@@ -22,7 +22,7 @@ export class HeroService {
    * @description Get single heroes with profile if authenticated, otherwise get single heroes only
    * @param {string} id - Hero ID
    * @param {boolean} isAuthenticated - Flag to determine if hero profile should be fetched
-   * @returns {Promise<Array<Hero>>}
+   * @returns {Promise<Hero>}
    * @throws {InternalServerErrorException}
    */
   async findById(id: string, isAuthenticated: boolean = false): Promise<Hero> {

diff --git a/src/modules/http/http.service.ts b/src/modules/http/http.service.ts
@@ -49,7 +49,7 @@ export class ExternalHttpService {
 
   /**
    * @description Get single hero from external api, throw if response is in invalid format / network error.
-   * @returns {Promise<Array<Hero>>}
+   * @returns {Promise<Hero>}
    * @throws {InternalServerErrorException}
    */
   async getHeroById(id: string): Promise<Hero> {
@@ -84,7 +84,7 @@ export class ExternalHttpService {
 
   /**
    * @description Get single hero profile, throw if response is in invalid format / network error.
-   * @returns {Promise<Array<HeroProfile>>}
+   * @returns {Promise<HeroProfile>}
    * @throws {InternalServerErrorException}
    */
   async getHeroProfileById(id: string): Promise<HeroProfile> {