@tutkli/jikan-ts 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -7
- package/dist/index.d.ts +870 -827
- package/dist/index.js +11 -1
- package/package.json +19 -29
- package/.githooks/pre-commit +0 -3
- package/.lintstagedrc.json +0 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,572 +1,600 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import { CacheOptions, InternalCacheRequestConfig, CacheAxiosResponse } from 'axios-cache-interceptor';
|
|
3
2
|
import { AxiosError } from 'axios';
|
|
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
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
}
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
}
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
3
|
+
|
|
4
|
+
interface JikanImages {
|
|
5
|
+
jpg: JikanImagesCollection;
|
|
6
|
+
webp?: JikanImagesCollection;
|
|
7
|
+
}
|
|
8
|
+
interface JikanImagesCollection {
|
|
9
|
+
image_url: string;
|
|
10
|
+
small_image_url?: string;
|
|
11
|
+
medium_image_url?: string;
|
|
12
|
+
large_image_url?: string;
|
|
13
|
+
maximum_image_url?: string;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
interface JikanPerson {
|
|
17
|
+
mal_id: number;
|
|
18
|
+
url: string;
|
|
19
|
+
images: JikanImages;
|
|
20
|
+
name: string;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
interface CommonCharacter {
|
|
24
|
+
character: CommonCharacterData & {
|
|
25
|
+
name: string;
|
|
26
|
+
};
|
|
27
|
+
role: CharacterRole;
|
|
28
|
+
}
|
|
29
|
+
interface CommonCharacterData {
|
|
30
|
+
mal_id: number;
|
|
31
|
+
url: string;
|
|
32
|
+
images: JikanImages;
|
|
33
|
+
}
|
|
34
|
+
interface CharacterVoiceActor {
|
|
35
|
+
person: JikanPerson;
|
|
36
|
+
language: string;
|
|
37
|
+
}
|
|
38
|
+
declare enum CharacterRole {
|
|
39
|
+
main = "Main",
|
|
40
|
+
supporting = "Supporting"
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
interface JikanMoreInfo {
|
|
44
|
+
moreinfo: string;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
interface JikanNews {
|
|
48
|
+
mal_id: number;
|
|
49
|
+
url: string;
|
|
50
|
+
title: string;
|
|
51
|
+
date: string;
|
|
52
|
+
author_username: string;
|
|
53
|
+
author_url: string;
|
|
54
|
+
forum_url: string;
|
|
55
|
+
images: JikanImages;
|
|
56
|
+
comments: number;
|
|
57
|
+
excerpt: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
interface Recommendation {
|
|
61
|
+
entry: RecommendationEntry;
|
|
62
|
+
}
|
|
63
|
+
interface RecommendationEntry {
|
|
64
|
+
mal_id: number;
|
|
65
|
+
url: string;
|
|
66
|
+
images: JikanImages;
|
|
67
|
+
title: string;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
interface JikanRelation {
|
|
71
|
+
relation: string;
|
|
72
|
+
entry: RelationEntry[];
|
|
73
|
+
}
|
|
74
|
+
interface RelationEntry {
|
|
75
|
+
mal_id: number;
|
|
76
|
+
type: string;
|
|
77
|
+
name: string;
|
|
78
|
+
url: string;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
interface JikanResource {
|
|
82
|
+
mal_id: number;
|
|
83
|
+
type: string;
|
|
84
|
+
name: string;
|
|
85
|
+
url: string;
|
|
86
|
+
}
|
|
87
|
+
interface JikanNamedResource {
|
|
88
|
+
name: string;
|
|
89
|
+
url: string;
|
|
90
|
+
}
|
|
91
|
+
interface JikanResourceTitle {
|
|
92
|
+
type: string;
|
|
93
|
+
title: string;
|
|
94
|
+
}
|
|
95
|
+
interface JikanResourcePeriod {
|
|
96
|
+
from: string;
|
|
97
|
+
to: string;
|
|
98
|
+
prop: {
|
|
99
|
+
from: {
|
|
100
|
+
day: number;
|
|
101
|
+
month: number;
|
|
102
|
+
year: number;
|
|
103
|
+
};
|
|
104
|
+
to: {
|
|
105
|
+
day: number;
|
|
106
|
+
month: number;
|
|
107
|
+
year: number;
|
|
108
|
+
};
|
|
109
|
+
string: string;
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
interface JikanResourceRelation {
|
|
113
|
+
relation: string;
|
|
114
|
+
entry: JikanResource[];
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
interface SeasonsListData {
|
|
118
|
+
year: number;
|
|
119
|
+
seasons: Array<keyof typeof AnimeSeason>;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
interface Statistics {
|
|
123
|
+
completed: number;
|
|
124
|
+
on_hold: number;
|
|
125
|
+
dropped: number;
|
|
126
|
+
total: number;
|
|
127
|
+
scores: StatisticsScore[];
|
|
128
|
+
}
|
|
129
|
+
interface StatisticsScore {
|
|
130
|
+
score: number;
|
|
131
|
+
votes: number;
|
|
132
|
+
percentage: number;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
interface AnimeCharacter extends CommonCharacter {
|
|
136
|
+
voice_actors: CharacterVoiceActor[];
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
interface AnimeEpisode {
|
|
140
|
+
mal_id: number;
|
|
141
|
+
url: string;
|
|
142
|
+
title: string;
|
|
143
|
+
title_japanese: string;
|
|
144
|
+
title_romanji: string;
|
|
145
|
+
duration: number;
|
|
146
|
+
aired: string;
|
|
147
|
+
filler: boolean;
|
|
148
|
+
recap: boolean;
|
|
149
|
+
forum_url: string;
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
interface AnimeForum {
|
|
153
|
+
mal_id: number;
|
|
154
|
+
url: string;
|
|
155
|
+
title: string;
|
|
156
|
+
date: string;
|
|
157
|
+
author_username: string;
|
|
158
|
+
author_url: string;
|
|
159
|
+
comments: number;
|
|
160
|
+
last_comment: {
|
|
161
|
+
url: string;
|
|
162
|
+
author_username: string;
|
|
163
|
+
author_url: string;
|
|
164
|
+
date: string;
|
|
165
|
+
};
|
|
166
|
+
}
|
|
167
|
+
type AnimeForumFilter = 'all' | 'episode' | 'other';
|
|
168
|
+
|
|
169
|
+
interface AnimePicture {
|
|
170
|
+
images: JikanImages;
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
interface AnimeStaff {
|
|
174
|
+
person: JikanPerson;
|
|
175
|
+
positions: string[];
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
interface AnimeStatistics extends Statistics {
|
|
179
|
+
watching: number;
|
|
180
|
+
plan_to_watch: number;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
interface AnimeVideos {
|
|
184
|
+
promo: AnimePromoVideo[];
|
|
185
|
+
episodes: AnimeEpisodeVideo[];
|
|
186
|
+
music_videos: AnimeMusicVideo[];
|
|
187
|
+
}
|
|
188
|
+
interface AnimePromoVideo {
|
|
189
|
+
title: string;
|
|
190
|
+
trailer: AnimeYoutubeVideo;
|
|
191
|
+
}
|
|
192
|
+
interface AnimeYoutubeVideo {
|
|
193
|
+
youtube_id: string;
|
|
194
|
+
url: string;
|
|
195
|
+
embed_url: string;
|
|
196
|
+
images?: JikanImagesCollection;
|
|
197
|
+
}
|
|
198
|
+
interface AnimeEpisodeVideo {
|
|
199
|
+
mal_id: number;
|
|
200
|
+
url: string;
|
|
201
|
+
title: string;
|
|
202
|
+
episode: string;
|
|
203
|
+
images: JikanImages;
|
|
204
|
+
}
|
|
205
|
+
interface AnimeMusicVideo {
|
|
206
|
+
title: string;
|
|
207
|
+
video: AnimeYoutubeVideo;
|
|
208
|
+
meta: AnimeVideoMeta;
|
|
209
|
+
}
|
|
210
|
+
interface AnimeVideoMeta {
|
|
211
|
+
title: string;
|
|
212
|
+
author: string;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
interface Anime {
|
|
216
|
+
mal_id: number;
|
|
217
|
+
url: string;
|
|
218
|
+
images: JikanImages;
|
|
219
|
+
trailer: AnimeYoutubeVideo;
|
|
220
|
+
approved: boolean;
|
|
221
|
+
titles: JikanResourceTitle[];
|
|
222
|
+
title: string;
|
|
223
|
+
title_english: string;
|
|
224
|
+
title_japanese: string;
|
|
225
|
+
title_synonyms: string[];
|
|
226
|
+
type: AnimeType;
|
|
227
|
+
source: string;
|
|
228
|
+
episodes: number;
|
|
229
|
+
status: AnimeStatus;
|
|
230
|
+
airing: boolean;
|
|
231
|
+
aired: JikanResourcePeriod;
|
|
232
|
+
duration: string;
|
|
233
|
+
rating: AnimeRating;
|
|
234
|
+
score: number;
|
|
235
|
+
scored_by: number;
|
|
236
|
+
rank: number;
|
|
237
|
+
popularity: number;
|
|
238
|
+
members: number;
|
|
239
|
+
favorites: number;
|
|
240
|
+
synopsis: string;
|
|
241
|
+
background: string;
|
|
242
|
+
season?: AnimeSeason;
|
|
243
|
+
year: number;
|
|
244
|
+
broadcast: AnimeBroadcast;
|
|
245
|
+
producers: JikanResource[];
|
|
246
|
+
licensors: JikanResource[];
|
|
247
|
+
studios: JikanResource[];
|
|
248
|
+
genres: JikanResource[];
|
|
249
|
+
explicit_genres: JikanResource[];
|
|
250
|
+
themes: JikanResource[];
|
|
251
|
+
demographics: JikanResource[];
|
|
252
|
+
relations?: JikanResourceRelation[];
|
|
253
|
+
theme?: AnimeTheme;
|
|
254
|
+
external?: JikanNamedResource[];
|
|
255
|
+
streaming: JikanNamedResource[];
|
|
256
|
+
}
|
|
257
|
+
interface AnimeBroadcast {
|
|
258
|
+
day: string;
|
|
259
|
+
time: string;
|
|
260
|
+
timezone: string;
|
|
261
|
+
string: string;
|
|
262
|
+
}
|
|
263
|
+
interface AnimeTheme {
|
|
264
|
+
openings: string[];
|
|
265
|
+
endings: string[];
|
|
266
|
+
}
|
|
267
|
+
declare enum AnimeType {
|
|
268
|
+
tv = "TV",
|
|
269
|
+
movie = "Movie",
|
|
270
|
+
ova = "Ova",
|
|
271
|
+
special = "Special",
|
|
272
|
+
ona = "Ona",
|
|
273
|
+
music = "Music"
|
|
274
|
+
}
|
|
275
|
+
declare enum AnimeStatus {
|
|
276
|
+
finished = "Finished Airing",
|
|
277
|
+
airing = "Currently Airing",
|
|
278
|
+
complete = "Complete",
|
|
279
|
+
upcoming = "Not yet aired"
|
|
280
|
+
}
|
|
281
|
+
declare enum AnimeRating {
|
|
282
|
+
g = "g",
|
|
283
|
+
pg = "pg",
|
|
284
|
+
pg13 = "pg13",
|
|
285
|
+
r17 = "r17",
|
|
286
|
+
r = "r",
|
|
287
|
+
rx = "rx"
|
|
288
|
+
}
|
|
289
|
+
declare enum AnimeSeason {
|
|
290
|
+
spring = "spring",
|
|
291
|
+
summer = "summer",
|
|
292
|
+
fall = "fall",
|
|
293
|
+
winter = "winter"
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
interface Character {
|
|
297
|
+
mal_id: number;
|
|
298
|
+
url: string;
|
|
299
|
+
images: JikanImages;
|
|
300
|
+
name: string;
|
|
301
|
+
name_kanji: string;
|
|
302
|
+
nicknames: string[];
|
|
303
|
+
favorites: number;
|
|
304
|
+
about: string;
|
|
305
|
+
anime: CharacterAnime[];
|
|
306
|
+
manga: CharacterManga[];
|
|
307
|
+
voices: CharacterVoiceActor[];
|
|
308
|
+
}
|
|
309
|
+
interface CharacterAnime {
|
|
310
|
+
role: CharacterRole;
|
|
311
|
+
anime: CommonCharacterData & {
|
|
312
|
+
title: string;
|
|
313
|
+
};
|
|
314
|
+
}
|
|
315
|
+
interface CharacterManga {
|
|
316
|
+
role: CharacterRole;
|
|
317
|
+
manga: CommonCharacterData & {
|
|
318
|
+
title: string;
|
|
319
|
+
};
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
interface Genre extends JikanNamedResource {
|
|
323
|
+
mal_id: number;
|
|
324
|
+
count: number;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
interface MangaStatistics extends Statistics {
|
|
328
|
+
reading: number;
|
|
329
|
+
plan_to_read: number;
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
interface Manga {
|
|
333
|
+
mal_id: number;
|
|
334
|
+
url: string;
|
|
335
|
+
images: JikanImages;
|
|
336
|
+
approved: boolean;
|
|
337
|
+
titles: JikanResourceTitle[];
|
|
338
|
+
title: string;
|
|
339
|
+
title_japanese: string;
|
|
340
|
+
title_synonyms?: string[];
|
|
341
|
+
type: MangaType;
|
|
342
|
+
chapters: number;
|
|
343
|
+
volumes: number;
|
|
344
|
+
status: MangaStatus;
|
|
345
|
+
publishing: boolean;
|
|
346
|
+
published: JikanResourcePeriod;
|
|
347
|
+
score: number;
|
|
348
|
+
scored_by: number;
|
|
349
|
+
rank: number;
|
|
350
|
+
popularity: number;
|
|
351
|
+
members: number;
|
|
352
|
+
favorites: number;
|
|
353
|
+
synopsis: string;
|
|
354
|
+
background: string;
|
|
355
|
+
authors: JikanResource[];
|
|
356
|
+
serializations: JikanResource[];
|
|
357
|
+
genres: JikanResource[];
|
|
358
|
+
explicit_genres: JikanResource[];
|
|
359
|
+
themes: JikanResource[];
|
|
360
|
+
demographics: JikanResource[];
|
|
361
|
+
relations?: JikanResourceRelation[];
|
|
362
|
+
external?: JikanNamedResource[];
|
|
363
|
+
}
|
|
364
|
+
declare enum MangaType {
|
|
365
|
+
manga = "Manga",
|
|
366
|
+
novel = "Novel",
|
|
367
|
+
lightnovel = "Lightnovel",
|
|
368
|
+
oneshot = "Oneshot",
|
|
369
|
+
doujin = "Doujin",
|
|
370
|
+
manhwa = "Manhwa",
|
|
371
|
+
manhua = "Manhua"
|
|
372
|
+
}
|
|
373
|
+
declare enum MangaStatus {
|
|
374
|
+
publishing = "Publishing",
|
|
375
|
+
complete = "Complete",
|
|
376
|
+
hiatus = "On Hiatus",
|
|
377
|
+
discontinued = "Discontinued",
|
|
378
|
+
upcoming = "Upcoming"
|
|
379
|
+
}
|
|
380
|
+
|
|
381
|
+
declare enum SortOptions {
|
|
382
|
+
asc = "asc",
|
|
383
|
+
desc = "desc"
|
|
384
|
+
}
|
|
385
|
+
declare enum SearchOrder {
|
|
386
|
+
mal_id = "mal_id",
|
|
387
|
+
title = "title",
|
|
388
|
+
start_date = "start_date",
|
|
389
|
+
end_date = "end_date",
|
|
390
|
+
score = "score",
|
|
391
|
+
scored_by = "scored_by",
|
|
392
|
+
rank = "rank",
|
|
393
|
+
popularity = "popularity",
|
|
394
|
+
members = "members",
|
|
395
|
+
favorites = "favorites"
|
|
396
|
+
}
|
|
397
|
+
declare enum AnimeSearchOrder {
|
|
398
|
+
type = "type",
|
|
399
|
+
rating = "rating",
|
|
400
|
+
episodes = "episodes"
|
|
401
|
+
}
|
|
402
|
+
declare enum AnimeSearchStatus {
|
|
403
|
+
airing = "airing",
|
|
404
|
+
complete = "complete",
|
|
405
|
+
upcoming = "upcoming"
|
|
406
|
+
}
|
|
407
|
+
declare enum MangaSearchOrder {
|
|
408
|
+
chapters = "chapters",
|
|
409
|
+
volumes = "volumes"
|
|
410
|
+
}
|
|
411
|
+
declare enum MangaSearchStatus {
|
|
412
|
+
publishing = "publishing",
|
|
413
|
+
complete = "complete",
|
|
414
|
+
hiatus = "hiatus",
|
|
415
|
+
discontinued = "discontinued",
|
|
416
|
+
upcoming = "upcoming"
|
|
417
|
+
}
|
|
418
|
+
interface JikanSearchParams {
|
|
419
|
+
q?: string;
|
|
420
|
+
page?: number;
|
|
421
|
+
limit?: number;
|
|
422
|
+
score?: number;
|
|
423
|
+
min_score?: number;
|
|
424
|
+
max_score?: number;
|
|
425
|
+
sfw?: boolean;
|
|
426
|
+
genres?: string;
|
|
427
|
+
genres_exclude?: string;
|
|
428
|
+
sort?: SortOptions | string;
|
|
429
|
+
letter?: string;
|
|
430
|
+
producers?: string;
|
|
431
|
+
start_date?: string;
|
|
432
|
+
end_date?: string;
|
|
433
|
+
unapproved?: boolean;
|
|
414
434
|
}
|
|
415
435
|
/**
|
|
416
436
|
* QueryParams used in **getMangaSearch** call
|
|
417
437
|
*
|
|
418
438
|
* See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/manga/operation/getMangaSearch)
|
|
419
439
|
*/
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
440
|
+
interface MangaSearchParams extends JikanSearchParams {
|
|
441
|
+
type?: MangaType | string;
|
|
442
|
+
status?: MangaSearchStatus | string;
|
|
443
|
+
order_by?: MangaSearchOrder | SearchOrder | string;
|
|
444
|
+
magazines?: string;
|
|
425
445
|
}
|
|
426
446
|
/**
|
|
427
447
|
* QueryParams used in **getAnimeSearch** call
|
|
428
448
|
*
|
|
429
449
|
* See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/anime/operation/getAnimeSearch)
|
|
430
450
|
*/
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
}
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
451
|
+
interface AnimeSearchParams extends JikanSearchParams {
|
|
452
|
+
type?: AnimeType | string;
|
|
453
|
+
status?: AnimeSearchStatus | string;
|
|
454
|
+
rating?: AnimeRating | string;
|
|
455
|
+
order_by?: AnimeSearchOrder | SearchOrder | string;
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
interface CharactersSearchParams {
|
|
459
|
+
page?: number;
|
|
460
|
+
limit?: number;
|
|
461
|
+
q?: string;
|
|
462
|
+
order_by?: CharactersSearchOrder;
|
|
463
|
+
sort?: SortOptions;
|
|
464
|
+
letter?: string;
|
|
465
|
+
}
|
|
466
|
+
declare enum CharactersSearchOrder {
|
|
467
|
+
mal_id = "mal_id",
|
|
468
|
+
name = "name",
|
|
469
|
+
favorites = "favorites"
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
declare enum GenresFilter {
|
|
473
|
+
genres = "genres",
|
|
474
|
+
explicit_genres = "explicit_genres",
|
|
475
|
+
theme = "themes",
|
|
476
|
+
demographics = "demographics"
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
interface SchedulesParams {
|
|
480
|
+
page?: number;
|
|
481
|
+
limit?: number;
|
|
482
|
+
filter?: SchedulesFilter;
|
|
483
|
+
kids?: boolean;
|
|
484
|
+
sfw?: boolean;
|
|
485
|
+
unapproved?: boolean;
|
|
486
|
+
}
|
|
487
|
+
declare enum SchedulesFilter {
|
|
488
|
+
monday = "monday",
|
|
489
|
+
tuesday = "tuesday",
|
|
490
|
+
wednesday = "wednesday",
|
|
491
|
+
thursday = "thursday",
|
|
492
|
+
friday = "friday",
|
|
493
|
+
unknown = "unknown",
|
|
494
|
+
other = "other"
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
interface JikanSeasonsParams {
|
|
498
|
+
page?: number;
|
|
499
|
+
limit?: number;
|
|
500
|
+
filter?: AnimeType;
|
|
477
501
|
}
|
|
478
502
|
/**
|
|
479
503
|
* QueryParams used in **getSeasonNow** call
|
|
480
504
|
*
|
|
481
505
|
*/
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
506
|
+
type SeasonNowParams = Omit<JikanSeasonsParams, 'filter'>;
|
|
507
|
+
|
|
508
|
+
declare enum TopAnimeFilter {
|
|
509
|
+
airing = "airing",
|
|
510
|
+
upcoming = "upcoming",
|
|
511
|
+
bypopularity = "bypopularity",
|
|
512
|
+
favorite = "favorite"
|
|
513
|
+
}
|
|
514
|
+
declare enum TopMangaFilter {
|
|
515
|
+
publishing = "publishing",
|
|
516
|
+
upcoming = "upcoming",
|
|
517
|
+
bypopularity = "bypopularity",
|
|
518
|
+
favorite = "favorite"
|
|
519
|
+
}
|
|
520
|
+
interface JikanTopParams {
|
|
521
|
+
page?: number;
|
|
522
|
+
limit?: number;
|
|
498
523
|
}
|
|
499
524
|
/**
|
|
500
525
|
* QueryParams used in **getTopAnime** call
|
|
501
526
|
*
|
|
502
527
|
* See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/top/operation/getTopAnime)
|
|
503
528
|
*/
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
529
|
+
interface AnimeTopParams extends JikanTopParams {
|
|
530
|
+
type?: AnimeType;
|
|
531
|
+
filter?: TopAnimeFilter;
|
|
507
532
|
}
|
|
508
533
|
/**
|
|
509
534
|
* QueryParams used in **getTopManga** call
|
|
510
535
|
*
|
|
511
536
|
* See also: [Jikan API Documentation](https://docs.api.jikan.moe/#tag/top/operation/getTopManga)
|
|
512
537
|
*/
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
538
|
+
interface MangaTopParams extends JikanTopParams {
|
|
539
|
+
type?: MangaType;
|
|
540
|
+
filter?: TopMangaFilter;
|
|
516
541
|
}
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
542
|
+
|
|
543
|
+
interface JikanPagination {
|
|
544
|
+
last_visible_page: number;
|
|
545
|
+
has_next_page: boolean;
|
|
546
|
+
items?: JikanPaginationItems;
|
|
521
547
|
}
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
548
|
+
interface JikanPaginationItems {
|
|
549
|
+
count: number;
|
|
550
|
+
total: number;
|
|
551
|
+
per_page: number;
|
|
526
552
|
}
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
553
|
+
interface JikanResponse<T> {
|
|
554
|
+
data: T;
|
|
555
|
+
pagination?: JikanPagination;
|
|
530
556
|
}
|
|
557
|
+
|
|
531
558
|
/**
|
|
532
559
|
* **Client Args**
|
|
533
560
|
*
|
|
534
561
|
* Used to pass optional configuration for logging and cache to the clients.
|
|
535
562
|
*/
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
563
|
+
interface ClientArgs {
|
|
564
|
+
/**
|
|
565
|
+
* **EnableLogging**
|
|
566
|
+
* Enables logging request responses.
|
|
567
|
+
*/
|
|
568
|
+
enableLogging: boolean;
|
|
569
|
+
/**
|
|
570
|
+
* **Axios Cache Options**
|
|
571
|
+
* Options for cache.
|
|
572
|
+
* @see https://axios-cache-interceptor.js.org/#/pages/configuration
|
|
573
|
+
*/
|
|
574
|
+
cacheOptions: Partial<CacheOptions>;
|
|
575
|
+
/**
|
|
576
|
+
* **Base URL**
|
|
577
|
+
* Location of the JikanAPI. Leave empty to use the official JikanAPI instance.
|
|
578
|
+
*/
|
|
579
|
+
baseURL: string;
|
|
553
580
|
}
|
|
554
581
|
/**
|
|
555
582
|
* **Base Client**
|
|
556
583
|
*
|
|
557
584
|
* This client is responsible for creating an Axios Instance and the cache and logging configurations
|
|
558
585
|
*/
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
586
|
+
declare abstract class BaseClient {
|
|
587
|
+
private api;
|
|
588
|
+
constructor(clientOptions?: Partial<ClientArgs>);
|
|
589
|
+
protected getResource<T>(endpoint: string, identifiers?: {
|
|
590
|
+
[key in string]: unknown;
|
|
591
|
+
}, params?: {
|
|
592
|
+
[key in string]: unknown;
|
|
593
|
+
}): Promise<T>;
|
|
594
|
+
private replaceIdentifiers;
|
|
595
|
+
private addLoggingInterceptors;
|
|
569
596
|
}
|
|
597
|
+
|
|
570
598
|
/**
|
|
571
599
|
* **Anime Client**
|
|
572
600
|
*
|
|
@@ -574,94 +602,95 @@ export declare abstract class BaseClient {
|
|
|
574
602
|
*
|
|
575
603
|
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
|
|
576
604
|
*/
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
605
|
+
declare class AnimeClient extends BaseClient {
|
|
606
|
+
/**
|
|
607
|
+
* Get complete anime resource data
|
|
608
|
+
* @param id anime id
|
|
609
|
+
*/
|
|
610
|
+
getAnimeFullById(id: number): Promise<JikanResponse<Anime>>;
|
|
611
|
+
/**
|
|
612
|
+
* Get anime resource
|
|
613
|
+
* @param id anime id
|
|
614
|
+
*/
|
|
615
|
+
getAnimeById(id: number): Promise<JikanResponse<Anime>>;
|
|
616
|
+
/**
|
|
617
|
+
* Get characters of a specific anime
|
|
618
|
+
* @param id anime id
|
|
619
|
+
*/
|
|
620
|
+
getAnimeCharacters(id: number): Promise<JikanResponse<AnimeCharacter[]>>;
|
|
621
|
+
/**
|
|
622
|
+
* Get staff of a specific Anime
|
|
623
|
+
* @param id anime id
|
|
624
|
+
*/
|
|
625
|
+
getAnimeStaff(id: number): Promise<JikanResponse<AnimeStaff[]>>;
|
|
626
|
+
/**
|
|
627
|
+
* Get a list of all the episodes of a specific anime
|
|
628
|
+
* @param id anime id
|
|
629
|
+
* @param page page number
|
|
630
|
+
*/
|
|
631
|
+
getAnimeEpisodes(id: number, page?: number): Promise<JikanResponse<AnimeEpisode[]>>;
|
|
632
|
+
/**
|
|
633
|
+
* Get a single episode of a specific anime by its id
|
|
634
|
+
* @param anime_id anime id
|
|
635
|
+
* @param episode_id episode id
|
|
636
|
+
*/
|
|
637
|
+
getAnimeEpisodeById(anime_id: number, episode_id: number): Promise<JikanResponse<AnimeEpisode>>;
|
|
638
|
+
/**
|
|
639
|
+
* Get a list of news articles related to the anime
|
|
640
|
+
* @param id anime id
|
|
641
|
+
* @param page page number
|
|
642
|
+
*/
|
|
643
|
+
getAnimeNews(id: number, page: number): Promise<JikanResponse<JikanNews[]>>;
|
|
644
|
+
/**
|
|
645
|
+
* Get a list of forum topics related to the anime
|
|
646
|
+
* @param id anime id
|
|
647
|
+
* @param filter forum filter
|
|
648
|
+
*/
|
|
649
|
+
getAnimeForum(id: number, filter?: AnimeForumFilter): Promise<JikanResponse<AnimeForum[]>>;
|
|
650
|
+
/**
|
|
651
|
+
* Get videos related to the anime
|
|
652
|
+
* @param id anime id
|
|
653
|
+
*/
|
|
654
|
+
getAnimeVideos(id: number): Promise<JikanResponse<AnimeVideos>>;
|
|
655
|
+
/**
|
|
656
|
+
* Get episode videos related to the anime
|
|
657
|
+
* @param id anime id
|
|
658
|
+
* @param page page number
|
|
659
|
+
*/
|
|
660
|
+
getAnimeEpisodeVideos(id: number, page?: number): Promise<JikanResponse<AnimeEpisodeVideo[]>>;
|
|
661
|
+
/**
|
|
662
|
+
* Get pictures related to the Anime
|
|
663
|
+
* @param id anime id
|
|
664
|
+
*/
|
|
665
|
+
getAnimePictures(id: number): Promise<JikanResponse<AnimePicture[]>>;
|
|
666
|
+
/**
|
|
667
|
+
* Get statistics related to the Anime
|
|
668
|
+
* @param id anime id
|
|
669
|
+
*/
|
|
670
|
+
getAnimeStatistics(id: number): Promise<JikanResponse<AnimeStatistics>>;
|
|
671
|
+
/**
|
|
672
|
+
* Get more info related to the anime
|
|
673
|
+
* @param id anime id
|
|
674
|
+
*/
|
|
675
|
+
getAnimeMoreInfo(id: number): Promise<JikanResponse<JikanMoreInfo>>;
|
|
676
|
+
/**
|
|
677
|
+
* Get recommendations based on the anime
|
|
678
|
+
* @param id anime id
|
|
679
|
+
*/
|
|
680
|
+
getAnimeRecommendations(id: number): Promise<JikanResponse<Recommendation[]>>;
|
|
681
|
+
/**
|
|
682
|
+
* Get anime relations
|
|
683
|
+
* @param id anime id
|
|
684
|
+
*/
|
|
685
|
+
getAnimeRelations(id: number): Promise<JikanResponse<JikanRelation[]>>;
|
|
686
|
+
/**
|
|
687
|
+
* Get all the Animes within the given filter. Returns all the Animes if no filters are given.
|
|
688
|
+
* @param searchParams Filter parameters
|
|
689
|
+
* @returns JikanResponse with Anime array data
|
|
690
|
+
*/
|
|
691
|
+
getAnimeSearch(searchParams?: Partial<AnimeSearchParams>): Promise<JikanResponse<Anime[]>>;
|
|
664
692
|
}
|
|
693
|
+
|
|
665
694
|
/**
|
|
666
695
|
* **Characters Client**
|
|
667
696
|
*
|
|
@@ -669,50 +698,51 @@ export declare class AnimeClient extends BaseClient {
|
|
|
669
698
|
*
|
|
670
699
|
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
|
|
671
700
|
*/
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
701
|
+
declare class CharactersClient extends BaseClient {
|
|
702
|
+
/**
|
|
703
|
+
* Get complete Character data
|
|
704
|
+
* @param id The Character ID
|
|
705
|
+
* @returns JikanResponse with Character data
|
|
706
|
+
*/
|
|
707
|
+
getCharacterFullById(id: number): Promise<JikanResponse<Character>>;
|
|
708
|
+
/**
|
|
709
|
+
* Get Character data
|
|
710
|
+
* @param id The Character ID
|
|
711
|
+
* @returns JikanResponse with Character data
|
|
712
|
+
*/
|
|
713
|
+
getCharacterById(id: number): Promise<JikanResponse<Character>>;
|
|
714
|
+
/**
|
|
715
|
+
* Get Character anime data
|
|
716
|
+
* @param id The Character ID
|
|
717
|
+
* @returns JikanResponse with CharacterAnime data
|
|
718
|
+
*/
|
|
719
|
+
getCharacterAnime(id: number): Promise<JikanResponse<CharacterAnime[]>>;
|
|
720
|
+
/**
|
|
721
|
+
* Get Character manga data
|
|
722
|
+
* @param id The Character ID
|
|
723
|
+
* @returns JikanResponse with CharacterManga data
|
|
724
|
+
*/
|
|
725
|
+
getCharacterManga(id: number): Promise<JikanResponse<CharacterManga[]>>;
|
|
726
|
+
/**
|
|
727
|
+
* Get Character voices data
|
|
728
|
+
* @param id The Character ID
|
|
729
|
+
* @returns JikanResponse with CharacterVoiceActor data
|
|
730
|
+
*/
|
|
731
|
+
getCharacterVoiceActors(id: number): Promise<JikanResponse<CharacterVoiceActor[]>>;
|
|
732
|
+
/**
|
|
733
|
+
* Get Character pictures data
|
|
734
|
+
* @param id The Character ID
|
|
735
|
+
* @returns JikanResponse with JikanImagesCollection data
|
|
736
|
+
*/
|
|
737
|
+
getCharacterPictures(id: number): Promise<JikanResponse<JikanImagesCollection[]>>;
|
|
738
|
+
/**
|
|
739
|
+
* Get all the Characters within the given filter. Returns all Characters if no filters are given.
|
|
740
|
+
@param searchParams Filter parameters
|
|
741
|
+
* @returns JikanResponse with Character array data
|
|
742
|
+
*/
|
|
743
|
+
getCharacterSearch(searchParams: Partial<CharactersSearchParams>): Promise<JikanResponse<Character[]>>;
|
|
715
744
|
}
|
|
745
|
+
|
|
716
746
|
/**
|
|
717
747
|
* **Genres Client**
|
|
718
748
|
*
|
|
@@ -720,18 +750,19 @@ export declare class CharactersClient extends BaseClient {
|
|
|
720
750
|
*
|
|
721
751
|
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
|
|
722
752
|
*/
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
753
|
+
declare class GenresClient extends BaseClient {
|
|
754
|
+
/**
|
|
755
|
+
* Get Anime genres
|
|
756
|
+
* @param filter Type of the desired genres
|
|
757
|
+
*/
|
|
758
|
+
getAnimeGenres(filter?: GenresFilter): Promise<JikanResponse<Genre[]>>;
|
|
759
|
+
/**
|
|
760
|
+
* Get Manga genres
|
|
761
|
+
* @param filter Type of the desired genres
|
|
762
|
+
*/
|
|
763
|
+
getMangaGenres(filter?: GenresFilter): Promise<JikanResponse<Genre[]>>;
|
|
734
764
|
}
|
|
765
|
+
|
|
735
766
|
/**
|
|
736
767
|
* **Manga Client**
|
|
737
768
|
*
|
|
@@ -739,50 +770,51 @@ export declare class GenresClient extends BaseClient {
|
|
|
739
770
|
*
|
|
740
771
|
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
|
|
741
772
|
*/
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
773
|
+
declare class MangaClient extends BaseClient {
|
|
774
|
+
/**
|
|
775
|
+
* Get a Manga with full information by its ID
|
|
776
|
+
* @param id The Manga ID
|
|
777
|
+
* @returns JikanResponse with Manga data
|
|
778
|
+
*/
|
|
779
|
+
getMangaFullById(id: number): Promise<JikanResponse<Manga>>;
|
|
780
|
+
/**
|
|
781
|
+
* Get a Manga by its ID
|
|
782
|
+
* @param id The Manga ID
|
|
783
|
+
* @returns JikanResponse with Manga data
|
|
784
|
+
*/
|
|
785
|
+
getMangaById(id: number): Promise<JikanResponse<Manga>>;
|
|
786
|
+
/**
|
|
787
|
+
* Get Characters of a specific Manga
|
|
788
|
+
* @param id The Manga ID
|
|
789
|
+
* @returns JikanResponse with CommonCharacter array data
|
|
790
|
+
*/
|
|
791
|
+
getMangaCharacters(id: number): Promise<JikanResponse<CommonCharacter[]>>;
|
|
792
|
+
/**
|
|
793
|
+
* Get Pictures related to a specific Manga
|
|
794
|
+
* @param id The Manga ID
|
|
795
|
+
* @returns JikanResponse with JikanImages array data
|
|
796
|
+
*/
|
|
797
|
+
getMangaPictures(id: number): Promise<JikanResponse<JikanImages[]>>;
|
|
798
|
+
/**
|
|
799
|
+
* Get Statistics related to a specific Manga
|
|
800
|
+
* @param id The Manga ID
|
|
801
|
+
* @returns JikanResponse with MangaStatistics data
|
|
802
|
+
*/
|
|
803
|
+
getMangaStatistics(id: number): Promise<JikanResponse<MangaStatistics>>;
|
|
804
|
+
/**
|
|
805
|
+
* Get Recommendations related to a specific Manga
|
|
806
|
+
* @param id The Manga ID
|
|
807
|
+
* @returns JikanResponse with Recommendation array data
|
|
808
|
+
*/
|
|
809
|
+
getMangaRecommendations(id: number): Promise<JikanResponse<Recommendation[]>>;
|
|
810
|
+
/**
|
|
811
|
+
* Get all the filtered Mangas. Returns all the Mangas if no filters are given.
|
|
812
|
+
* @param searchParams Filter parameters
|
|
813
|
+
* @returns JikanResponse with Manga array data
|
|
814
|
+
*/
|
|
815
|
+
getMangaSearch(searchParams?: Partial<MangaSearchParams>): Promise<JikanResponse<Manga[]>>;
|
|
785
816
|
}
|
|
817
|
+
|
|
786
818
|
/**
|
|
787
819
|
* **Schedules Client**
|
|
788
820
|
*
|
|
@@ -790,14 +822,15 @@ export declare class MangaClient extends BaseClient {
|
|
|
790
822
|
*
|
|
791
823
|
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
|
|
792
824
|
*/
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
825
|
+
declare class SchedulesClient extends BaseClient {
|
|
826
|
+
/**
|
|
827
|
+
* Returns weekly schedule
|
|
828
|
+
* @param searchParams Filter parameters
|
|
829
|
+
* @returns JikanResponse with Anime array data
|
|
830
|
+
*/
|
|
831
|
+
getSchedules(searchParams?: Partial<SchedulesParams>): Promise<JikanResponse<Anime[]>>;
|
|
800
832
|
}
|
|
833
|
+
|
|
801
834
|
/**
|
|
802
835
|
* **Seasons Client**
|
|
803
836
|
*
|
|
@@ -805,33 +838,34 @@ export declare class SchedulesClient extends BaseClient {
|
|
|
805
838
|
*
|
|
806
839
|
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
|
|
807
840
|
*/
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
841
|
+
declare class SeasonsClient extends BaseClient {
|
|
842
|
+
/**
|
|
843
|
+
* Get the seasonal anime by year and season
|
|
844
|
+
* @param year Season year
|
|
845
|
+
* @param season Season value
|
|
846
|
+
* @param searchParams Filter parameters
|
|
847
|
+
* @returns JikanResponse with Anime array data
|
|
848
|
+
*/
|
|
849
|
+
getSeason(year: number, season: AnimeSeason, searchParams?: Partial<JikanSeasonsParams>): Promise<JikanResponse<Anime[]>>;
|
|
850
|
+
/**
|
|
851
|
+
* Get current seasonal anime
|
|
852
|
+
* @param searchParams Filter parameters
|
|
853
|
+
* @returns JikanResponse with Anime array data
|
|
854
|
+
*/
|
|
855
|
+
getSeasonNow(searchParams?: Partial<SeasonNowParams>): Promise<JikanResponse<Anime[]>>;
|
|
856
|
+
/**
|
|
857
|
+
* Get available list of seasons
|
|
858
|
+
* @returns JikanResponse with Seasons array data
|
|
859
|
+
*/
|
|
860
|
+
getSeasonsList(): Promise<JikanResponse<SeasonsListData[]>>;
|
|
861
|
+
/**
|
|
862
|
+
* Get upcoming season's anime
|
|
863
|
+
* @param searchParams Filter parameters
|
|
864
|
+
* @returns JikanResponse with Anime array data
|
|
865
|
+
*/
|
|
866
|
+
getSeasonUpcoming(searchParams?: Partial<JikanSeasonsParams>): Promise<JikanResponse<Anime[]>>;
|
|
834
867
|
}
|
|
868
|
+
|
|
835
869
|
/**
|
|
836
870
|
* **Top Client**
|
|
837
871
|
*
|
|
@@ -839,20 +873,21 @@ export declare class SeasonsClient extends BaseClient {
|
|
|
839
873
|
*
|
|
840
874
|
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
|
|
841
875
|
*/
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
876
|
+
declare class TopClient extends BaseClient {
|
|
877
|
+
/**
|
|
878
|
+
* Get the top Animes
|
|
879
|
+
* @param searchParams Filter parameters
|
|
880
|
+
* @returns JikanResponse with Anime array data
|
|
881
|
+
*/
|
|
882
|
+
getTopAnime(searchParams?: Partial<AnimeTopParams>): Promise<JikanResponse<Anime[]>>;
|
|
883
|
+
/**
|
|
884
|
+
* Get the top Mangas
|
|
885
|
+
* @param searchParams Filter parameters
|
|
886
|
+
* @returns JikanResponse with Manga array data
|
|
887
|
+
*/
|
|
888
|
+
getTopManga(searchParams?: Partial<MangaTopParams>): Promise<JikanResponse<Manga[]>>;
|
|
855
889
|
}
|
|
890
|
+
|
|
856
891
|
/**
|
|
857
892
|
* **Jikan Client**
|
|
858
893
|
*
|
|
@@ -860,77 +895,85 @@ export declare class TopClient extends BaseClient {
|
|
|
860
895
|
*
|
|
861
896
|
* See also: [Jikan Documentation](https://docs.api.jikan.moe/)
|
|
862
897
|
*/
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
}
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
}
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
}
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
}
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
}
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
}
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
898
|
+
declare class JikanClient {
|
|
899
|
+
anime: AnimeClient;
|
|
900
|
+
characters: CharactersClient;
|
|
901
|
+
genres: GenresClient;
|
|
902
|
+
manga: MangaClient;
|
|
903
|
+
top: TopClient;
|
|
904
|
+
schedules: SchedulesClient;
|
|
905
|
+
seasons: SeasonsClient;
|
|
906
|
+
constructor(clientOptions?: Partial<ClientArgs>);
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
declare const handleRequest: (requestConfig: InternalCacheRequestConfig) => InternalCacheRequestConfig;
|
|
910
|
+
declare const handleRequestError: (error: AxiosError) => Promise<AxiosError>;
|
|
911
|
+
declare const handleResponse: (response: CacheAxiosResponse) => CacheAxiosResponse;
|
|
912
|
+
declare const handleResponseError: (error: AxiosError) => Promise<AxiosError>;
|
|
913
|
+
|
|
914
|
+
declare enum BaseURL {
|
|
915
|
+
REST = "https://api.jikan.moe/v4"
|
|
916
|
+
}
|
|
917
|
+
|
|
918
|
+
declare enum AnimeEndpoints {
|
|
919
|
+
AnimeFullById = "/anime/{id}/full",
|
|
920
|
+
AnimeById = "/anime/{id}",
|
|
921
|
+
AnimeCharacters = "/anime/{id}/characters",
|
|
922
|
+
AnimeStaff = "/anime/{id}/staff",
|
|
923
|
+
AnimeEpisodes = "/anime/{id}/episodes",
|
|
924
|
+
AnimeEpisodeById = "/anime/{id}/episodes/{episode}",
|
|
925
|
+
AnimeNews = "/anime/{id}/news",
|
|
926
|
+
AnimeForum = "/anime/{id}/forum",
|
|
927
|
+
AnimeVideos = "/anime/{id}/videos",
|
|
928
|
+
AnimeVideosEpisodes = "/anime/{id}/videos/episodes",
|
|
929
|
+
AnimePictures = "/anime/{id}/pictures",
|
|
930
|
+
AnimeStatistics = "/anime/{id}/statistics",
|
|
931
|
+
AnimeMoreInfo = "/anime/{id}/moreinfo",
|
|
932
|
+
AnimeRecommendations = "/anime/{id}/recommendations",
|
|
933
|
+
AnimeUserUpdates = "/anime/{id}/userupdates",
|
|
934
|
+
AnimeReviews = "/anime/{id}/reviews",
|
|
935
|
+
AnimeRelations = "/anime/{id}/relations",
|
|
936
|
+
AnimeThemes = "/anime/{id}/themes",
|
|
937
|
+
AnimeExternal = "/anime/{id}/external",
|
|
938
|
+
AnimeStreaming = "/anime/{id}/streaming",
|
|
939
|
+
AnimeSearch = "/anime"
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
declare enum CharactersEndpoints {
|
|
943
|
+
CharacterFullById = "/characters/{id}/full",
|
|
944
|
+
CharacterById = "/characters/{id}",
|
|
945
|
+
CharacterAnime = "/characters/{id}/anime",
|
|
946
|
+
CharactersManga = "/characters/{id}/manga",
|
|
947
|
+
CharacterVoiceActors = "/characters/{id}/voices",
|
|
948
|
+
CharacterPictures = "/characters/{id}/pictures",
|
|
949
|
+
CharacterSearch = "/characters"
|
|
950
|
+
}
|
|
951
|
+
|
|
952
|
+
declare enum GenresEndpoints {
|
|
953
|
+
AnimeGenres = "/genres/anime",
|
|
954
|
+
MangaGenres = "genres/manga"
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
declare enum MangaEndpoints {
|
|
958
|
+
MangaSearch = "/manga",
|
|
959
|
+
MangaFullById = "/manga/{id}/full",
|
|
960
|
+
MangaById = "/manga/{id}",
|
|
961
|
+
MangaCharacters = "/manga/{id}/characters",
|
|
962
|
+
MangaPictures = "/manga/{id}/pictures",
|
|
963
|
+
MangaStatistics = "/manga/{id}/statistics",
|
|
964
|
+
MangaRecommendations = "/manga/{id}/recommendations"
|
|
965
|
+
}
|
|
966
|
+
|
|
967
|
+
declare enum SeasonsEndpoints {
|
|
968
|
+
Season = "/seasons/{year}/{season}",
|
|
969
|
+
SeasonNow = "/seasons/now",
|
|
970
|
+
SeasonsList = "/seasons",
|
|
971
|
+
SeasonUpcoming = "/seasons/upcoming"
|
|
972
|
+
}
|
|
973
|
+
|
|
974
|
+
declare enum TopEndpoints {
|
|
975
|
+
TopAnime = "/top/anime",
|
|
976
|
+
TopManga = "/top/manga"
|
|
977
|
+
}
|
|
978
|
+
|
|
979
|
+
export { type Anime, type AnimeBroadcast, type AnimeCharacter, AnimeClient, AnimeEndpoints, type AnimeEpisode, type AnimeEpisodeVideo, type AnimeForum, type AnimeForumFilter, type AnimeMusicVideo, type AnimePicture, type AnimePromoVideo, AnimeRating, AnimeSearchOrder, type AnimeSearchParams, AnimeSearchStatus, AnimeSeason, type AnimeStaff, type AnimeStatistics, AnimeStatus, type AnimeTheme, type AnimeTopParams, AnimeType, type AnimeVideoMeta, type AnimeVideos, type AnimeYoutubeVideo, BaseClient, BaseURL, type Character, type CharacterAnime, type CharacterManga, CharacterRole, type CharacterVoiceActor, CharactersClient, CharactersEndpoints, CharactersSearchOrder, type CharactersSearchParams, type ClientArgs, type CommonCharacter, type CommonCharacterData, type Genre, GenresClient, GenresEndpoints, GenresFilter, JikanClient, type JikanImages, type JikanImagesCollection, type JikanMoreInfo, type JikanNamedResource, type JikanNews, type JikanPagination, type JikanPaginationItems, type JikanPerson, type JikanRelation, type JikanResource, type JikanResourcePeriod, type JikanResourceRelation, type JikanResourceTitle, type JikanResponse, type JikanSearchParams, type JikanSeasonsParams, type JikanTopParams, type Manga, MangaClient, MangaEndpoints, MangaSearchOrder, type MangaSearchParams, MangaSearchStatus, type MangaStatistics, MangaStatus, type MangaTopParams, MangaType, type Recommendation, type RecommendationEntry, type RelationEntry, SchedulesClient, SchedulesFilter, type SchedulesParams, SearchOrder, type SeasonNowParams, SeasonsClient, SeasonsEndpoints, type SeasonsListData, SortOptions, type Statistics, type StatisticsScore, TopAnimeFilter, TopClient, TopEndpoints, TopMangaFilter, handleRequest, handleRequestError, handleResponse, handleResponseError };
|