|
1 | 1 | # @untidy/thetvdb
|
2 | 2 |
|
| 3 | +## 1.0.0 |
| 4 | + |
| 5 | +### Major Changes |
| 6 | + |
| 7 | +- 68f97ff: We strongly recommend visiting the new [website](https://untidy-thetvdb.netlify.app) for guidance on |
| 8 | + updating your code to the latest stable major version, 1.0.0. In this version, we have addressed |
| 9 | + almost all return types and missing properties, and added previously undocumented queries that were |
| 10 | + not included in the original API documentation. |
| 11 | + |
| 12 | + We have also enhanced the methods to specifically handle a particular endpoint along with their |
| 13 | + paths or queries. For instance, in the previous version, if a user wanted to request a specific |
| 14 | + movie's extended record, they would write something like this: |
| 15 | + |
| 16 | + ```js |
| 17 | + import { TheTVDB } from "@untidy/thetvdb"; |
| 18 | + |
| 19 | + const client = new TheTVDB("access token"); |
| 20 | + await client.getMovie({ id: "3646", extended: true }); |
| 21 | + ``` |
| 22 | + |
| 23 | + Now, with the new rewrite, there's no need to specify the `extended` argument or even the `id`. |
| 24 | + |
| 25 | + ```js |
| 26 | + import { TheTVDB } from "@untidy/thetvdb"; |
| 27 | + |
| 28 | + const client = new TheTVDB("access token"); |
| 29 | + await client.movieByIdExtended("12586"); |
| 30 | + ``` |
| 31 | + |
| 32 | + These changes streamline the code and provide a more intuitive and concise syntax for accessing |
| 33 | + movie extended records. |
| 34 | + |
| 35 | + BREAKING CHANGES |
| 36 | + |
| 37 | + - major: Single class only (previously TheTVDB & TheTVDBExtended). |
| 38 | + - major: Rewrite return, entity and other types and export them. |
| 39 | + - major: Rewrite methods for better handling of requests depending on the specific endpoint. |
| 40 | + - major: support to update your token. |
| 41 | + - major: bump minimum version of `Node.js` required `18.17.0`. |
| 42 | + - major: Only throw `Errors` if the response is not `ok` or the `token` validation fails (previously |
| 43 | + strictly throws an error if you miss an specific argument, now this is handle by the consumers of |
| 44 | + this package). |
| 45 | + - feat: add `jsdoc` for better documentation and examples of usage with the new |
| 46 | + [site](https://untidy-thetvdb.netlify.app). |
| 47 | + - feat: support more endpoints |
| 48 | + [reference](https://untidy-thetvdb.netlify.app/guides/supported-endpoints). |
| 49 | + - feat: support to update your token. |
| 50 | + |
3 | 51 | ## 0.5.0
|
4 | 52 |
|
5 | 53 | ### Minor Changes
|
|
0 commit comments