Skip to content

Commit 24719ed

Browse files
author
Sankarsan Kampa
committed
Fixed some JSDoc return types
1 parent 5e246e5 commit 24719ed

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

src/Pokedex.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class Pokedex {
6565
/**
6666
* Returns an array of Pokémon Categories discovered in the Pokémon World.
6767
* @method getCategories
68-
* @returns {Promise<Object>} Resolves discovered Pokémon categories
68+
* @returns {Promise<Array>} Resolves discovered Pokémon categories
6969
* @example
7070
* pokedex.getCategories()
7171
* .then(categories => console.log(categories))
@@ -79,7 +79,7 @@ class Pokedex {
7979
/**
8080
* Returns an array of Pokémon Egg Groups discovered in the Pokémon World.
8181
* @method getEggGroups
82-
* @returns {Promise<Object>} Resolves discovered Pokémon egg groups
82+
* @returns {Promise<Array>} Resolves discovered Pokémon egg groups
8383
* @example
8484
* pokedex.getEggGroups()
8585
* .then(eggGroups => console.log(eggGroups))
@@ -108,7 +108,7 @@ class Pokedex {
108108
/**
109109
* Returns an array of Pokémon Evolution Stone names discovered in the Pokémon world.
110110
* @method getEvolutionStones
111-
* @returns {Promise<Object>} Resolves discovered Pokémon evolution stones
111+
* @returns {Promise<Array>} Resolves discovered Pokémon evolution stones
112112
* @example
113113
* pokedex.getEvolutionStones()
114114
* .then(evolutionStones => console.log(evolutionStones))
@@ -137,7 +137,7 @@ class Pokedex {
137137
/**
138138
* Returns an array of Pokémon League names known to us.
139139
* @method getEvolutionStones
140-
* @returns {Promise<Object>} Resolves discovered Pokémon leagues
140+
* @returns {Promise<Array>} Resolves discovered Pokémon leagues
141141
* @example
142142
* pokedex.getLeagues()
143143
* .then(leagues => console.log(leagues))
@@ -152,7 +152,7 @@ class Pokedex {
152152
* Returns an array of Pokémon objects containing all the forms of the Pokémon specified the name.
153153
* @method getPokemonByNumber
154154
* @param {String} name The name of the Pokémon
155-
* @returns {Promise<Object>} Resolves information about the specified Pokémon
155+
* @returns {Promise<Array>} Resolves information about the specified Pokémon
156156
* @example
157157
* // It's best practice to use encodeURIComponent() to encode the name
158158
* // string so the API server doesn't respond with 404.
@@ -169,7 +169,7 @@ class Pokedex {
169169
* Returns an array of Pokémon objects containing all the forms of the Pokémon specified the Pokédex number.
170170
* @method getPokemonByNumber
171171
* @param {Number} number The Pokédex number of the Pokémon
172-
* @returns {Promise<Object>} Resolves information about the specified Pokémon
172+
* @returns {Promise<Array>} Resolves information about the specified Pokémon
173173
* @example
174174
* pokedex.getPokemonByNumber(658)
175175
* .then(pokemon => console.log(pokemon))
@@ -197,7 +197,7 @@ class Pokedex {
197197
/**
198198
* Returns an array of Pokémon Types discovered in the Pokémon World.
199199
* @method getTypes
200-
* @returns {Promise<Object>} Resolves discovered Pokémon types
200+
* @returns {Promise<Array>} Resolves discovered Pokémon types
201201
* @example
202202
* pokedex.getTypes()
203203
* .then(types => console.log(types))

0 commit comments

Comments
 (0)