Utillity
Language resource and PokéAPI's common models. TS-PokéAPI utility helpers.
Language
Languages for translations of API resource information.
| Property | Type | Required | Description |
|---|
id | number | Yes | The identifier for this resource. |
name | string | Yes | The identifier for this resource. |
names | Array<Name> | Yes | The identifier for this resource. |
official | boolean | Yes | Whether or not the games are published in this language. |
iso639 | string | Yes | The two-letter code of the country where this language is spoken. Note that it is not unique. |
iso3166 | string | Yes | The two-letter code of the language. Note that it is not unique. |
Common
APIResource
| Property | Type | Required | Description |
|---|
url | string | Yes | The URL of the referenced resource. |
Description
| Property | Type | Required | Description |
|---|
description | string | Yes | The localized description for an API resource in a specific language. |
language | NamedAPIResource | Yes | The language this name is in. |
Effect
| Property | Type | Required | Description |
|---|
effect | string | Yes | The localized effect text for an API resource in a specific language. |
language | NamedAPIResource | Yes | The language this name is in. |
Encounter
| Property | Type | Required | Description |
|---|
min_level | number | Yes | The lowest level the Pokémon could be encountered at. |
max_level | number | Yes | The highest level the Pokémon could be encountered at. |
chance | number | Yes | Percent chance that this encounter will occur. |
method | NamedAPIResource | Yes | The method by which this encounter happens. |
condition_values | Array<NamedAPIResource> | Yes | A list of condition values that must be in effect for this encounter to occur. |
FlavorText
| Property | Type | Required | Description |
|---|
flavor_text | string | Yes | The localized flavor text for an API resource in a specific language. Note that this text is left unprocessed as it is found in game files. This means that it contains special characters that one might want to replace with their visible decodable version. |
language | NamedAPIResource | Yes | The language this name is in. |
version | NamedAPIResource | Yes | The game version this flavor text is extracted from. |
GenerationGameIndex
| Property | Type | Required | Description |
|---|
game_index | number | Yes | The internal id of an API resource within game data. |
generation | NamedAPIResource | Yes | The generation relevent to this game index. |
MachineVersionDetail
| Property | Type | Required | Description |
|---|
machine | APIResource | Yes | The machine that teaches a move from an item. |
version_group | NamedAPIResource | Yes | The version group of this specific machine. |
Name
| Property | Type | Required | Description |
|---|
url | string | Yes | The URL of the referenced resource. |
language | NamedAPIResource | Yes | The language this name is in. |
NamedAPIResource
| Property | Type | Required | Description |
|---|
url | string | Yes | The URL of the referenced resource. |
name | string | Yes | The name of the referenced resource. |
VerboseEffect
| Property | Type | Required | Description |
|---|
effect | string | Yes | The localized effect text for an API resource in a specific language. |
short_effect | string | Yes | The localized effect text in brief. |
language | NamedAPIResource | Yes | The language this effect is in. |
VersionEncounterDetail
| Property | Type | Required | Description |
|---|
version | NamedAPIResource | Yes | The game version this encounter happens in. |
max_chance | number | Yes | The total percentage of all encounter potential. |
encounter_details | Array<Encounter> | Yes | A list of encounters and their specifics. |
VersionGameIndex
| Property | Type | Required | Description |
|---|
game_index | number | Yes | The internal id of an API resource within game data. |
version | NamedAPIResource | Yes | The version relevent to this game index. |
VersionGroupFlavorText
| Property | Type | Required | Description |
|---|
text | string | Yes | The localized name for an API resource in a specific language. |
language | NamedAPIResource | Yes | The language this flavor text is in. |
version_group | NamedAPIResource | Yes | The version group which uses this flavor text. |
Other
Other interfaces and data structures exclusive from TS-PokéAPI to help you handle PokéAPI resource responses.
GenderId
PaginatedResult
| Property | Type | Required | Description |
|---|
count | number | Yes | The total number of resources available from this API. |
next | string, or null | Yes | The URL for the next page in the list. |
previous | string, or null | Yes | The URL for the previous page in the list. |
results | Array<NamedAPIResource> | Yes | A list of named API resources. |
RelativePhysicalStatEvolution
An enumeration of string values for each Pokémon type's name.
Properties
| Name | Value |
|---|
| RelativePhysicalStatEvolution.ATK_GT_DEF | 1 |
| RelativePhysicalStatEvolution.ATK_EQ_DEF | 0 |
| RelativePhysicalStatEvolution.ATK_LT_DEF | -1 |
SubCollectionResource
An enumeration of string values for each PokéApi resources that has a subcollection endpoint.
| Types |
|---|
enum('pokemon-location-area') |
TimeOfDay
An enumeration of string values for each Pokémon type's name.
Properties
| Name | Value |
|---|
| TimeOfDay.DAY | 'day' |
| TimeOfDay.NIGHT | 'night' |
| TimeOfDay.DUSK | 'dusk' |
An enumeration of string values for each PokéApi resources that returns only resource url data without name.
| Types |
|---|
enum('machine', 'characteristic', 'contest-effect', 'evolution-chain', 'super-contest-effect') |