Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding documentation for the type guard isAxiosError #3767

Merged
merged 3 commits into from May 4, 2021
Merged

Adding documentation for the type guard isAxiosError #3767

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
274a6af
Adding isAxiosError typeguard documentation
johachi Apr 25, 2021
12e5a06
Merge branch 'master' into add-typeguard-documentation
johachi May 2, 2021
1dbf53b
Merge branch 'master' into add-typeguard-documentation
jasonsaayman May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Expand Up @@ -826,10 +826,21 @@ axios depends on a native ES6 Promise implementation to be [supported](http://ca
If your environment doesn't support ES6 Promises, you can [polyfill](https://github.com/jakearchibald/es6-promise).

## TypeScript
axios includes [TypeScript](http://typescriptlang.org) definitions.

axios includes [TypeScript](http://typescriptlang.org) definitions and a type guard for axios errors.

```typescript
import axios from 'axios';
axios.get('/user?ID=12345');
let user: User = null;
try {
const { data } = await axios.get('/user?ID=12345');
user = data.userDetails;
} catch (error) {
if (axios.isAxiosError(error)) {
handleAxiosError(error);
} else {
handleUnexpectedError(error);
}
}
```

## Online one-click setup
Expand Down