-
-
Notifications
You must be signed in to change notification settings - Fork 84
/
index.d.ts
102 lines (79 loc) · 1.62 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
declare namespace pokemon {
type Language =
| 'de'
| 'en'
| 'fr'
| 'es'
| 'ja'
| 'ko'
| 'ru'
| 'th'
| 'zh-Hans'
| 'zh-Hant';
}
declare const pokemon: {
/**
Get all Pokémon names.
@param language - Language code to retrieve the Pokémon for.
@example
```
import pokemon = require('pokemon');
pokemon.all();
//=> ['Bulbasaur', …]
pokemon.all('de');
//=> ['Bisasam', …]
```
*/
all(language?: pokemon.Language): readonly string[];
/**
Get random Pokémon name.
@param language - Language code to retrieve the Pokémon for.
@example
```
import pokemon = require('pokemon');
pokemon.random();
//=> 'Vigoroth'
pokemon.random('de');
//=> 'Muntier'
```
*/
random(language?: pokemon.Language): string;
/**
Get Pokémon name from ID.
@param id - The ID of a Pokémon, retrieved via `getId()`.
@param language - Language code to retrieve the Pokémon for.
@example
```
import pokemon = require('pokemon');
pokemon.getName(100);
//=> 'Voltorb'
pokemon.getName(100, 'de');
//=> 'Voltobal'
```
*/
getName(id: number, language?: pokemon.Language): string;
/**
Get Pokémon ID from name.
@param name - The Pokémon name in the `language` locale.
@param language - Language code to retrieve the Pokémon for.
@example
```
import pokemon = require('pokemon');
pokemon.getId('Snorlax');
//=> 143
pokemon.getId('Relaxo', 'de');
//=> 143
```
*/
getId(name: string, language?: pokemon.Language): number;
/**
@example
```
import pokemon = require('pokemon');
pokemon.languages.has('ja');
//=> true
```
*/
readonly languages: ReadonlySet<string>;
};
export = pokemon;