Skip to content

Commit 42e053f

Browse files
NaramsimNaramsim
authored
Merge pull request #52 from climaxmba/types
Types Declaration (Modified)
2 parents 94e47a7 + 5d1eed3 commit 42e053f

File tree

3 files changed

+120
-2
lines changed

3 files changed

+120
-2
lines changed

‎index.d.ts‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
declare module "pokeapi-js-wrapper" {
2+
export class Pokedex {
3+
constructor(config?: {
4+
protocol: string,
5+
hostName: string,
6+
versionPath: string,
7+
offset: number
8+
limit: number,
9+
timeout: number,
10+
cache: boolean,
11+
cacheImages: boolean
12+
});
13+
14+
getBerryByName(name: string | number | string[] | number[]): Promise<object>;
15+
getBerryFirmnessByName(name: string | string[]): Promise<object>;
16+
getBerryFlavorByName(name: string | number | string[] | number[]): Promise<object>;
17+
getContestTypeByName(name: string | number | string[] | number[]): Promise<object>;
18+
getContestEffectById(id: number | number[]): Promise<object>;
19+
getSuperContestEffectById(id: number | number[]): Promise<object>;
20+
getEncounterMethodByName(name: string | number | string[] | number[]): Promise<object>;
21+
getEncounterConditionByName(name: string | number | string[] | number[]): Promise<object>;
22+
getEncounterConditionValueByName(name: string | number | string[] | number[]): Promise<object>;
23+
getEvolutionChainById(id: number | number[]): Promise<object>;
24+
getEvolutionTriggerByName(name: string | number | string[] | number[]): Promise<object>;
25+
getGenerationByName(name: string | number | string[] | number[]): Promise<object>;
26+
getPokedexByName(name: string | number | string[] | number[]): Promise<object>;
27+
getVersionByName(name: string | number | string[] | number[]): Promise<object>;
28+
getVersionGroupByName(name: string | number | string[] | number[]): Promise<object>;
29+
getItemByName(name: string | number | string[] | number[]): Promise<object>;
30+
getItemAttributeByName(name: string | number | string[] | number[]): Promise<object>;
31+
getItemCategoryByName(name: string | number | string[] | number[]): Promise<object>;
32+
getItemFlingEffectByName(name: string | number | string[] | number[]): Promise<object>;
33+
getItemPocketByName(name: string | number | string[] | number[]): Promise<object>;
34+
getMachineById(id: number | number[]): Promise<object>;
35+
getMoveByName(name: string | number | string[] | number[]): Promise<object>;
36+
getMoveAilmentByName(name: string | number | string[] | number[]): Promise<object>;
37+
getMoveBattleStyleByName(name: string | number | string[] | number[]): Promise<object>;
38+
getMoveCategoryByName(name: string | number | string[] | number[]): Promise<object>;
39+
getMoveDamageClassByName(name: string | number | string[] | number[]): Promise<object>;
40+
getMoveLearnMethodByName(name: string | number | string[] | number[]): Promise<object>;
41+
getMoveTargetByName(name: string | number | string[] | number[]): Promise<object>;
42+
getLocationByName(name: string | number | string[] | number[]): Promise<object>;
43+
getLocationAreaByName(name: string | number | string[] | number[]): Promise<object>;
44+
getPalParkAreaByName(name: string | number | string[] | number[]): Promise<object>;
45+
getRegionByName(name: string | number | string[] | number[]): Promise<object>;
46+
getAbilityByName(name: string | number | string[] | number[]): Promise<object>;
47+
getCharacteristicById(id: number | number[]): Promise<object>;
48+
getEggGroupByName(name: string | number | string[] | number[]): Promise<object>;
49+
getGenderByName(name: string | number | string[] | number[]): Promise<object>;
50+
getGrowthRateByName(name: string | number | string[] | number[]): Promise<object>;
51+
getNatureByName(name: string | number | string[] | number[]): Promise<object>;
52+
getPokeathlonStatByName(name: string | number | string[] | number[]): Promise<object>;
53+
getPokemonByName(name: string | number | string[] | number[]): Promise<object>;
54+
getPokemonEncounterAreasByName(name: string | number | string[] | number[]): Promise<object>;
55+
getPokemonColorByName(name: string | number | string[] | number[]): Promise<object>;
56+
getPokemonFormByName(name: string | number | string[] | number[]): Promise<object>;
57+
getPokemonHabitatByName(name: string | number | string[] | number[]): Promise<object>;
58+
getPokemonShapeByName(name: string | number | string[] | number[]): Promise<object>;
59+
getPokemonSpeciesByName(name: string | number | string[] | number[]): Promise<object>;
60+
getStatByName(name: string | number | string[] | number[]): Promise<object>;
61+
getTypeByName(name: string | number | string[] | number[]): Promise<object>;
62+
getLanguageByName(name: string | number | string[] | number[]): Promise<object>;
63+
64+
getEndpointsList(dict?: { offset: number, limit: number }): Promise<object>;
65+
getBerriesList(dict?: { offset: number, limit: number }): Promise<object>;
66+
getBerriesFirmnesssList(dict?: { offset: number, limit: number }): Promise<object>;
67+
getBerriesFlavorsList(dict?: { offset: number, limit: number }): Promise<object>;
68+
getContestTypesList(dict?: { offset: number, limit: number }): Promise<object>;
69+
getContestEffectsList(dict?: { offset: number, limit: number }): Promise<object>;
70+
getSuperContestEffectsList(dict?: { offset: number, limit: number }): Promise<object>;
71+
getEncounterMethodsList(dict?: { offset: number, limit: number }): Promise<object>;
72+
getEncounterConditionsList(dict?: { offset: number, limit: number }): Promise<object>;
73+
getEncounterConditionValuesList(dict?: { offset: number, limit: number }): Promise<object>;
74+
getEvolutionChainsList(dict?: { offset: number, limit: number }): Promise<object>;
75+
getEvolutionTriggersList(dict?: { offset: number, limit: number }): Promise<object>;
76+
getGenerationsList(dict?: { offset: number, limit: number }): Promise<object>;
77+
getPokedexsList(dict?: { offset: number, limit: number }): Promise<object>;
78+
getVersionsList(dict?: { offset: number, limit: number }): Promise<object>;
79+
getVersionGroupsList(dict?: { offset: number, limit: number }): Promise<object>;
80+
getItemsList(dict?: { offset: number, limit: number }): Promise<object>;
81+
getItemAttributesList(dict?: { offset: number, limit: number }): Promise<object>;
82+
getItemCategoriesList(dict?: { offset: number, limit: number }): Promise<object>;
83+
getItemFlingEffectsList(dict?: { offset: number, limit: number }): Promise<object>;
84+
getItemPocketsList(dict?: { offset: number, limit: number }): Promise<object>;
85+
getMachinesList(dict?: { offset: number, limit: number }): Promise<object>;
86+
getMovesList(dict?: { offset: number, limit: number }): Promise<object>;
87+
getMoveAilmentsList(dict?: { offset: number, limit: number }): Promise<object>;
88+
getMoveBattleStylesList(dict?: { offset: number, limit: number }): Promise<object>;
89+
getMoveCategoriesList(dict?: { offset: number, limit: number }): Promise<object>;
90+
getMoveDamageClassesList(dict?: { offset: number, limit: number }): Promise<object>;
91+
getMoveLearnMethodsList(dict?: { offset: number, limit: number }): Promise<object>;
92+
getMoveTargetsList(dict?: { offset: number, limit: number }): Promise<object>;
93+
getLocationsList(dict?: { offset: number, limit: number }): Promise<object>;
94+
getLocationAreasList(dict?: { offset: number, limit: number }): Promise<object>;
95+
getPalParkAreasList(dict?: { offset: number, limit: number }): Promise<object>;
96+
getRegionsList(dict?: { offset: number, limit: number }): Promise<object>;
97+
getAbilitiesList(dict?: { offset: number, limit: number }): Promise<object>;
98+
getCharacteristicsList(dict?: { offset: number, limit: number }): Promise<object>;
99+
getEggGroupsList(dict?: { offset: number, limit: number }): Promise<object>;
100+
getGendersList(dict?: { offset: number, limit: number }): Promise<object>;
101+
getGrowthRatesList(dict?: { offset: number, limit: number }): Promise<object>;
102+
getNaturesList(dict?: { offset: number, limit: number }): Promise<object>;
103+
getPokeathlonStatsList(dict?: { offset: number, limit: number }): Promise<object>;
104+
getPokemonsList(dict?: { offset: number, limit: number }): Promise<object>;
105+
getPokemonColorsList(dict?: { offset: number, limit: number }): Promise<object>;
106+
getPokemonFormsList(dict?: { offset: number, limit: number }): Promise<object>;
107+
getPokemonHabitatsList(dict?: { offset: number, limit: number }): Promise<object>;
108+
getPokemonShapesList(dict?: { offset: number, limit: number }): Promise<object>;
109+
getPokemonSpeciesList(dict?: { offset: number, limit: number }): Promise<object>;
110+
getStatsList(dict?: { offset: number, limit: number }): Promise<object>;
111+
getTypesList(dict?: { offset: number, limit: number }): Promise<object>;
112+
getLanguagesList(dict?: { offset: number, limit: number }): Promise<object>;
113+
114+
resource(param: string | string[]): Promise<object>;
115+
}
116+
}

‎package-lock.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"files": [
88
"dist/index.js",
99
"dist/pokeapi-js-wrapper-sw.js",
10-
"src/*"
10+
"src/*",
11+
"index.d.ts"
1112
],
1213
"scripts": {
1314
"build": "webpack",
@@ -38,6 +39,7 @@
3839
"url": "https://github.com/PokeAPI/pokeapi-js-wrapper/issues"
3940
},
4041
"homepage": "https://github.com/PokeAPI/pokeapi-js-wrapper#readme",
42+
"types": "./index.d.ts",
4143
"dependencies": {
4244
"axios": "^0.24.0",
4345
"localforage": "^1.10.0"

0 commit comments

Comments
 (0)