Skip to content

Commit

Permalink
fix: new json format is broken
Browse files Browse the repository at this point in the history
  • Loading branch information
falsepopsky authored Jan 20, 2024
1 parent 26a1759 commit fc9b76c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"plugins": ["prettier-plugin-astro", "prettier-plugin-tailwindcss"],
"overrides": [
{ "files": "*.md", "options": { "printWidth": 100, "proseWrap": "always" } },
{ "files": "*.json", "options": { "trailingComma": "none" } },
{ "files": "*.yaml", "options": { "singleQuote": false, "printWidth": 100, "proseWrap": "never" } },
{ "files": "*.astro", "options": { "parser": "astro", "astroAllowShorthand": true } }
]
Expand Down
26 changes: 13 additions & 13 deletions packages/api/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@

### Major Changes

- 68f97ff: We strongly recommend visiting the new [website](https://untidy-thetvdb.netlify.app) for guidance on
updating your code to the latest stable major version, 1.0.0. In this version, we have addressed
almost all return types and missing properties, and added previously undocumented queries that were
not included in the original API documentation.
- 68f97ff: We strongly recommend visiting the new [website](https://untidy-thetvdb.netlify.app) for
guidance on updating your code to the latest stable major version, 1.0.0. In this version, we have
addressed almost all return types and missing properties, and added previously undocumented
queries that were not included in the original API documentation.

We have also enhanced the methods to specifically handle a particular endpoint along with their
paths or queries. For instance, in the previous version, if a user wanted to request a specific
movie's extended record, they would write something like this:

```js
import { TheTVDB } from "@untidy/thetvdb";
import { TheTVDB } from '@untidy/thetvdb';

const client = new TheTVDB("access token");
await client.getMovie({ id: "3646", extended: true });
const client = new TheTVDB('access token');
await client.getMovie({ id: '3646', extended: true });
```

Now, with the new rewrite, there's no need to specify the `extended` argument or even the `id`.

```js
import { TheTVDB } from "@untidy/thetvdb";
import { TheTVDB } from '@untidy/thetvdb';

const client = new TheTVDB("access token");
await client.movieByIdExtended("12586");
const client = new TheTVDB('access token');
await client.movieByIdExtended('12586');
```

These changes streamline the code and provide a more intuitive and concise syntax for accessing
Expand All @@ -39,9 +39,9 @@
- major: Rewrite methods for better handling of requests depending on the specific endpoint.
- major: support to update your token.
- major: bump minimum version of `Node.js` required `18.17.0`.
- major: Only throw `Errors` if the response is not `ok` or the `token` validation fails (previously
strictly throws an error if you miss an specific argument, now this is handle by the consumers of
this package).
- major: Only throw `Errors` if the response is not `ok` or the `token` validation fails
(previously strictly throws an error if you miss an specific argument, now this is handle by the
consumers of this package).
- feat: add `jsdoc` for better documentation and examples of usage with the new
[site](https://untidy-thetvdb.netlify.app).
- feat: support more endpoints
Expand Down

0 comments on commit fc9b76c

Please sign in to comment.