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