fix(docs): add pokeapi liks to docs

Gabb-c · Jul 16, 2021 · a6c42f5 · a6c42f5
1 parent 3998166
commit a6c42f5
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 63 deletions.
diff --git a/src/clients/berry.client.ts b/src/clients/berry.client.ts
@@ -7,9 +7,9 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Berry Client
  *
  * Client used to access the Berry Endpoints:
- *  - Berries
- *  - Berry Firmnesses
- *  - Berry Flavors
+ *  - [Berries](https://pokeapi.co/docs/v2#berries)
+ *  - [Berry Firmnesses](https://pokeapi.co/docs/v2#berry-firmnesses)
+ *  - [Berry Flavors](https://pokeapi.co/docs/v2#berry-flavors)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#berries-section)
  */

diff --git a/src/clients/contest.client.ts b/src/clients/contest.client.ts
@@ -7,9 +7,9 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Contest Client
  *
  * Client used to access the Contest Endpoints:
- *  - Contest Types
- *  - Contest Effects
- *  - Super Contest Effects
+ *  - [Contest Types](https://pokeapi.co/docs/v2#contest-types)
+ *  - [Contest Effects](https://pokeapi.co/docs/v2#contest-effects)
+ *  - [Super Contest Effects](https://pokeapi.co/docs/v2#super-contest-effects)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#contests-section)
  */

diff --git a/src/clients/encounter.client.ts b/src/clients/encounter.client.ts
@@ -12,9 +12,9 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Encounter Client
  *
  * Client used to access the Encounter Endpoints:
- *  - Encounter Methods
- *  - Encounter Conditions
- *  - Encounter Condition Values
+ *  - [Encounter Methods](https://pokeapi.co/docs/v2#encounter-methods)
+ *  - [Encounter Conditions](https://pokeapi.co/docs/v2#encounter-conditions)
+ *  - [Encounter Condition Values](https://pokeapi.co/docs/v2#encounter-condition-values)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#encounters-section)
  */

diff --git a/src/clients/evolution.client.ts b/src/clients/evolution.client.ts
@@ -7,8 +7,8 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Evolution Client
  *
  * Client used to access the Berry Endpoints:
- *  - Evolution Chains
- *  - Evolution Triggers
+ *  - [Evolution Chains](https://pokeapi.co/docs/v2#evolution-chains)
+ *  - [Evolution Triggers](https://pokeapi.co/docs/v2#evolution-triggers)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#evolution-section)
  */

diff --git a/src/clients/game.client.ts b/src/clients/game.client.ts
@@ -7,10 +7,10 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Game Client
  *
  * Client used to access the Game Endpoints:
- *  - Generations
- *  - Pokedexes
- *  - Versions
- *  - Version Groups
+ *  - [Generations](https://pokeapi.co/docs/v2#generations)
+ *  - [Pokedexes](https://pokeapi.co/docs/v2#pokedexes)
+ *  - [Versions](https://pokeapi.co/docs/v2#version)
+ *  - [Version Groups](https://pokeapi.co/docs/v2#version-groups)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#games-section)
  */

diff --git a/src/clients/item.client.ts b/src/clients/item.client.ts
@@ -14,11 +14,11 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Item Client
  *
  * Client used to access the Item Endpoints:
- *  - Item
- *  - Item Attributes
- *  - Item Categories
- *  - Item Filing Effects
- *  - Item Pockets
+ *  - [Item](https://pokeapi.co/docs/v2#item)
+ *  - [Item Attributes](https://pokeapi.co/docs/v2#item-attributes)
+ *  - [Item Categories](https://pokeapi.co/docs/v2#item-categories)
+ *  - [Item Filing Effects](https://pokeapi.co/docs/v2#item-fling-effects)
+ *  - [Item Pockets](https://pokeapi.co/docs/v2#item-pockets)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#items-section)
  */
@@ -211,9 +211,7 @@ export class ItemClient extends BaseClient {
       this.api
         .get(`${Endpoints.ItemCategory}?offset=${offset || 0}&limit=${limit || 20}`)
         .then((response: AxiosResponse<NamedAPIResourceList>) => resolve(response.data))
-        .catch((error: AxiosError<string>) => {
-          reject(error);
-        });
+        .catch((error: AxiosError<string>) => reject(error));
     });
   }
 

diff --git a/src/clients/location.client.ts b/src/clients/location.client.ts
@@ -7,10 +7,10 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Location Client
  *
  * Client used to access the Location Endpoints:
- *  - Locations
- *  - Location Areas
- *  - Pal Park Areas
- *  - Regions
+ *  - [Locations](https://pokeapi.co/docs/v2#locations)
+ *  - [Location Areas](https://pokeapi.co/docs/v2#location-areas)
+ *  - [Pal Park Areas](https://pokeapi.co/docs/v2#pal-park-areas)
+ *  - [Regions](https://pokeapi.co/docs/v2#regions)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#locations-section)
  */

diff --git a/src/clients/machine.client.ts b/src/clients/machine.client.ts
@@ -7,7 +7,7 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Machine Client
  *
  * Client used to access the Machine Endpoints:
- *  - Machines
+ *  - [Machines](https://pokeapi.co/docs/v2#machines)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#machines-section)
  */

diff --git a/src/clients/main.client.ts b/src/clients/main.client.ts
@@ -14,17 +14,17 @@ import { PokemonClient } from './pokemon.client';
  * ### Main Client
  *
  * The main client used to access all the PokéAPI Endpoints:
- *  - Berries
- *  - Contests
- *  - Encounters
- *  - Evolution
- *  - Games
- *  - Items
- *  - Locations
- *  - Machines
- *  - Moves
- *  - Pokémon
- *  - Utility
+ *  - [Berries](https://pokeapi.co/docs/v2#berries-section)
+ *  - [Contests](https://pokeapi.co/docs/v2#contests-section)
+ *  - [Encounters](https://pokeapi.co/docs/v2#encounters-section)
+ *  - [Evolution](https://pokeapi.co/docs/v2#evolution-section)
+ *  - [Games](https://pokeapi.co/docs/v2#games-section)
+ *  - [Items](https://pokeapi.co/docs/v2#items-section)
+ *  - [Locations](https://pokeapi.co/docs/v2#locations-section)
+ *  - [Machines](https://pokeapi.co/docs/v2#machines-section)
+ *  - [Moves](https://pokeapi.co/docs/v2#moves-section)
+ *  - [Pokémon](https://pokeapi.co/docs/v2#pokemon-section)
+ *  - [Utility](https://pokeapi.co/docs/v2#utility-section)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2)
  */

diff --git a/src/clients/move.client.ts b/src/clients/move.client.ts
@@ -16,13 +16,13 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Move Client
  *
  * Client used to access the Move Endpoints:
- *  - Moves
- *  - Move Ailments
- *  - Move Battle Styles
- *  - Move Categories
- *  - Move Damage Classes
- *  - Move Learn Methods
- *  - Move Move Targets
+ *  - [Moves](https://pokeapi.co/docs/v2#moves)
+ *  - [Move Ailments](https://pokeapi.co/docs/v2#move-ailments)
+ *  - [Move Battle Styles](https://pokeapi.co/docs/v2#move-battle-styles)
+ *  - [Move Categories](https://pokeapi.co/docs/v2#move-categories)
+ *  - [Move Damage Classes](https://pokeapi.co/docs/v2#move-damage-classes)
+ *  - [Move Learn Methods](https://pokeapi.co/docs/v2#move-learn-methods)
+ *  - [Move Move Targets](https://pokeapi.co/docs/v2#move-targets)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#moves-section)
  */

diff --git a/src/clients/pokemon.client.ts b/src/clients/pokemon.client.ts
@@ -25,22 +25,22 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Pokemon Client
  *
  * Client used to access the Pokemon Endpoints:
- *  - Abilities
- *  - Characteristics
- *  - Egg Groups
- *  - Genders
- *  - Growth Rates
- *  - Natures
- *  - Pokeathlon Stats
- *  - Pokemon
- *  - Pokemon Location Areas
- *  - Pokemon Colors
- *  - Pokemon Forms
- *  - Pokemon Habitats
- *  - Pokemon Shapes
- *  - Pokemon Species
- *  - Stats
- *  - Types
+ *  - [Abilities](https://pokeapi.co/docs/v2#abilities)
+ *  - [Characteristics](https://pokeapi.co/docs/v2#characteristics)
+ *  - [Egg Groups](https://pokeapi.co/docs/v2#egg-groups)
+ *  - [Genders](https://pokeapi.co/docs/v2#genders)
+ *  - [Growth Rates](https://pokeapi.co/docs/v2#growth-rates)
+ *  - [Natures](https://pokeapi.co/docs/v2#natures)
+ *  - [Pokeathlon Stats](https://pokeapi.co/docs/v2#pokeathlon-stats)
+ *  - [Pokemon](https://pokeapi.co/docs/v2#pokemon)
+ *  - [Pokemon Location Areas](https://pokeapi.co/docs/v2#pokemon-location-areas)
+ *  - [Pokemon Colors](https://pokeapi.co/docs/v2#pokemon-colors)
+ *  - [Pokemon Forms](https://pokeapi.co/docs/v2#pokemon-forms)
+ *  - [Pokemon Habitats](https://pokeapi.co/docs/v2#pokemon-habitats)
+ *  - [Pokemon Shapes](https://pokeapi.co/docs/v2#pokemon-shapes)
+ *  - [Pokemon Species](https://pokeapi.co/docs/v2#pokemon-species)
+ *  - [Stats](https://pokeapi.co/docs/v2#stats)
+ *  - [Types](https://pokeapi.co/docs/v2#types)
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#pokemon-section)
  */

diff --git a/src/clients/utility.client.ts b/src/clients/utility.client.ts
@@ -7,7 +7,7 @@ import { BaseClient, ClientArgs } from '../structures/base';
  * ### Utility Client
  *
  * Client used to access the Utility Endpoints:
- *  - Languages
+ *  - [Languages](https://pokeapi.co/docs/v2#utility-section)
  *  - Resources
  * ---
  * See [PokéAPI Documentation](https://pokeapi.co/docs/v2#utility-section)