@tutkli/jikan-ts 2.0.2 → 2.2.0
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 +32 -10
- package/dist/index.d.ts +924 -810
- package/dist/index.js +1 -1
- package/package.json +19 -23
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
</p>
|
|
14
14
|
|
|
15
|
-
> Jikan API wrapper for
|
|
15
|
+
> Jikan API wrapper for TypeScript and Node.js with built-in typing.
|
|
16
16
|
|
|
17
17
|
## Features
|
|
18
18
|
|
|
@@ -75,6 +75,20 @@ const animeClient = new AnimeClient({
|
|
|
75
75
|
);
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
+
### Custom Axios Instance
|
|
79
|
+
|
|
80
|
+
Jikan uses `axios` as an `http` client and if you are not satisfied with the default client settings, then you can build your instance by passing it to the optional `axiosInstance` argument
|
|
81
|
+
|
|
82
|
+
```ts
|
|
83
|
+
import { AnimeClient } from '@tutkli/jikan-ts';
|
|
84
|
+
import Axios from 'axios';
|
|
85
|
+
|
|
86
|
+
const animeClient = new AnimeClient({
|
|
87
|
+
axiosInstance: Axios.create({ ... })
|
|
88
|
+
}
|
|
89
|
+
);
|
|
90
|
+
```
|
|
91
|
+
|
|
78
92
|
For more information, check out the [axios-cache-interceptor Documentation](https://axios-cache-interceptor.js.org/).
|
|
79
93
|
|
|
80
94
|
### Logging
|
|
@@ -91,15 +105,23 @@ const animeClient = new AnimeClient({
|
|
|
91
105
|
|
|
92
106
|
## Available Clients
|
|
93
107
|
|
|
94
|
-
- AnimeClient
|
|
95
|
-
- CharactersClient
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
101
|
-
-
|
|
102
|
-
-
|
|
108
|
+
- [X] AnimeClient
|
|
109
|
+
- [X] CharactersClient
|
|
110
|
+
- [X] ClubsClient
|
|
111
|
+
- [X] GenresClient
|
|
112
|
+
- [X] MagazinesClient
|
|
113
|
+
- [X] MangaClient
|
|
114
|
+
- [ ] PeopleClient
|
|
115
|
+
- [ ] ProducersClient
|
|
116
|
+
- [X] RandomClient
|
|
117
|
+
- [ ] RecommendationsClient
|
|
118
|
+
- [ ] ReviewsClient
|
|
119
|
+
- [X] SchedulesClient
|
|
120
|
+
- [ ] UsersClient
|
|
121
|
+
- [X] SeasonsClient
|
|
122
|
+
- [X] TopClient
|
|
123
|
+
- [X] WatchClient
|
|
124
|
+
- [X] **JikanClient (Main client)**
|
|
103
125
|
|
|
104
126
|
## Leave you feedback
|
|
105
127
|
|