diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..b9eb304 --- /dev/null +++ b/index.d.ts @@ -0,0 +1,116 @@ +declare module "pokeapi-js-wrapper" { + export class Pokedex { + constructor(config?: { + protocol: string, + hostName: string, + versionPath: string, + offset: number + limit: number, + timeout: number, + cache: boolean, + cacheImages: boolean + }); + + getBerryByName(name: string | number | string[] | number[]): Promise; + getBerryFirmnessByName(name: string | string[]): Promise; + getBerryFlavorByName(name: string | number | string[] | number[]): Promise; + getContestTypeByName(name: string | number | string[] | number[]): Promise; + getContestEffectById(id: number | number[]): Promise; + getSuperContestEffectById(id: number | number[]): Promise; + getEncounterMethodByName(name: string | number | string[] | number[]): Promise; + getEncounterConditionByName(name: string | number | string[] | number[]): Promise; + getEncounterConditionValueByName(name: string | number | string[] | number[]): Promise; + getEvolutionChainById(id: number | number[]): Promise; + getEvolutionTriggerByName(name: string | number | string[] | number[]): Promise; + getGenerationByName(name: string | number | string[] | number[]): Promise; + getPokedexByName(name: string | number | string[] | number[]): Promise; + getVersionByName(name: string | number | string[] | number[]): Promise; + getVersionGroupByName(name: string | number | string[] | number[]): Promise; + getItemByName(name: string | number | string[] | number[]): Promise; + getItemAttributeByName(name: string | number | string[] | number[]): Promise; + getItemCategoryByName(name: string | number | string[] | number[]): Promise; + getItemFlingEffectByName(name: string | number | string[] | number[]): Promise; + getItemPocketByName(name: string | number | string[] | number[]): Promise; + getMachineById(id: number | number[]): Promise; + getMoveByName(name: string | number | string[] | number[]): Promise; + getMoveAilmentByName(name: string | number | string[] | number[]): Promise; + getMoveBattleStyleByName(name: string | number | string[] | number[]): Promise; + getMoveCategoryByName(name: string | number | string[] | number[]): Promise; + getMoveDamageClassByName(name: string | number | string[] | number[]): Promise; + getMoveLearnMethodByName(name: string | number | string[] | number[]): Promise; + getMoveTargetByName(name: string | number | string[] | number[]): Promise; + getLocationByName(name: string | number | string[] | number[]): Promise; + getLocationAreaByName(name: string | number | string[] | number[]): Promise; + getPalParkAreaByName(name: string | number | string[] | number[]): Promise; + getRegionByName(name: string | number | string[] | number[]): Promise; + getAbilityByName(name: string | number | string[] | number[]): Promise; + getCharacteristicById(id: number | number[]): Promise; + getEggGroupByName(name: string | number | string[] | number[]): Promise; + getGenderByName(name: string | number | string[] | number[]): Promise; + getGrowthRateByName(name: string | number | string[] | number[]): Promise; + getNatureByName(name: string | number | string[] | number[]): Promise; + getPokeathlonStatByName(name: string | number | string[] | number[]): Promise; + getPokemonByName(name: string | number | string[] | number[]): Promise; + getPokemonEncounterAreasByName(name: string | number | string[] | number[]): Promise; + getPokemonColorByName(name: string | number | string[] | number[]): Promise; + getPokemonFormByName(name: string | number | string[] | number[]): Promise; + getPokemonHabitatByName(name: string | number | string[] | number[]): Promise; + getPokemonShapeByName(name: string | number | string[] | number[]): Promise; + getPokemonSpeciesByName(name: string | number | string[] | number[]): Promise; + getStatByName(name: string | number | string[] | number[]): Promise; + getTypeByName(name: string | number | string[] | number[]): Promise; + getLanguageByName(name: string | number | string[] | number[]): Promise; + + getEndpointsList(dict?: { offset: number, limit: number }): Promise; + getBerriesList(dict?: { offset: number, limit: number }): Promise; + getBerriesFirmnesssList(dict?: { offset: number, limit: number }): Promise; + getBerriesFlavorsList(dict?: { offset: number, limit: number }): Promise; + getContestTypesList(dict?: { offset: number, limit: number }): Promise; + getContestEffectsList(dict?: { offset: number, limit: number }): Promise; + getSuperContestEffectsList(dict?: { offset: number, limit: number }): Promise; + getEncounterMethodsList(dict?: { offset: number, limit: number }): Promise; + getEncounterConditionsList(dict?: { offset: number, limit: number }): Promise; + getEncounterConditionValuesList(dict?: { offset: number, limit: number }): Promise; + getEvolutionChainsList(dict?: { offset: number, limit: number }): Promise; + getEvolutionTriggersList(dict?: { offset: number, limit: number }): Promise; + getGenerationsList(dict?: { offset: number, limit: number }): Promise; + getPokedexsList(dict?: { offset: number, limit: number }): Promise; + getVersionsList(dict?: { offset: number, limit: number }): Promise; + getVersionGroupsList(dict?: { offset: number, limit: number }): Promise; + getItemsList(dict?: { offset: number, limit: number }): Promise; + getItemAttributesList(dict?: { offset: number, limit: number }): Promise; + getItemCategoriesList(dict?: { offset: number, limit: number }): Promise; + getItemFlingEffectsList(dict?: { offset: number, limit: number }): Promise; + getItemPocketsList(dict?: { offset: number, limit: number }): Promise; + getMachinesList(dict?: { offset: number, limit: number }): Promise; + getMovesList(dict?: { offset: number, limit: number }): Promise; + getMoveAilmentsList(dict?: { offset: number, limit: number }): Promise; + getMoveBattleStylesList(dict?: { offset: number, limit: number }): Promise; + getMoveCategoriesList(dict?: { offset: number, limit: number }): Promise; + getMoveDamageClassesList(dict?: { offset: number, limit: number }): Promise; + getMoveLearnMethodsList(dict?: { offset: number, limit: number }): Promise; + getMoveTargetsList(dict?: { offset: number, limit: number }): Promise; + getLocationsList(dict?: { offset: number, limit: number }): Promise; + getLocationAreasList(dict?: { offset: number, limit: number }): Promise; + getPalParkAreasList(dict?: { offset: number, limit: number }): Promise; + getRegionsList(dict?: { offset: number, limit: number }): Promise; + getAbilitiesList(dict?: { offset: number, limit: number }): Promise; + getCharacteristicsList(dict?: { offset: number, limit: number }): Promise; + getEggGroupsList(dict?: { offset: number, limit: number }): Promise; + getGendersList(dict?: { offset: number, limit: number }): Promise; + getGrowthRatesList(dict?: { offset: number, limit: number }): Promise; + getNaturesList(dict?: { offset: number, limit: number }): Promise; + getPokeathlonStatsList(dict?: { offset: number, limit: number }): Promise; + getPokemonsList(dict?: { offset: number, limit: number }): Promise; + getPokemonColorsList(dict?: { offset: number, limit: number }): Promise; + getPokemonFormsList(dict?: { offset: number, limit: number }): Promise; + getPokemonHabitatsList(dict?: { offset: number, limit: number }): Promise; + getPokemonShapesList(dict?: { offset: number, limit: number }): Promise; + getPokemonSpeciesList(dict?: { offset: number, limit: number }): Promise; + getStatsList(dict?: { offset: number, limit: number }): Promise; + getTypesList(dict?: { offset: number, limit: number }): Promise; + getLanguagesList(dict?: { offset: number, limit: number }): Promise; + + resource(param: string | string[]): Promise; + } +} diff --git a/package-lock.json b/package-lock.json index e347251..7abfac5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5366,4 +5366,4 @@ } } } -} +} \ No newline at end of file diff --git a/package.json b/package.json index 2f9ef14..e2f5c19 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,8 @@ "files": [ "dist/index.js", "dist/pokeapi-js-wrapper-sw.js", - "src/*" + "src/*", + "index.d.ts" ], "scripts": { "build": "webpack", @@ -38,6 +39,7 @@ "url": "https://github.com/PokeAPI/pokeapi-js-wrapper/issues" }, "homepage": "https://github.com/PokeAPI/pokeapi-js-wrapper#readme", + "types": "./index.d.ts", "dependencies": { "axios": "^0.24.0", "localforage": "^1.10.0"