AxiosError type for javascript

[vladkolotvin]

Summary

Axios rejects error with Error type. Adding custom error type will help with distinguishing between axios and other errors. The only way now is to check 'request' field existence which is not always possible. Our internal custom error type has this field too.

Example:

const { axios, AxiosError } = require('axios');
...
try {
  ...
  const response = await axios.get(url);
  ...
} catch (error) {
  if(error instanceof AxiosError) {
    return processAxiosError(error);
  }
  throw error;
}

Context

• axios version: 0.18.0

Relates to: #24

[AyushG3112]

This would be simple enough to do, but would be a breaking change.

[vladkolotvin]

AxiosError has to inherit from Error. This wouldn't breaking change.

[AyushG3112]

It would be if someone is checking error.constructor.name === 'Error'

[vladkolotvin]

I agree but this is a minor breaking change. Can we sacrifice this for better API?

[AyushG3112]

I'm in favor of this, but personally I would prefer, if the maintainers agree ofcourse, that we bump axios to a semver, v1.0.0

Axios certainly seems stable enough for that, and following semver-major prevents breakage.

On another note, given the widespread use of axios and the preferred HTTP library of React and Vue.js, a breaking change can have major impacts which need to be considered.

[AyushG3112]

Actually, now that I checked, axios is working on a v1.0.0 branch, I might open a PR for this today.

[vladkolotvin]

@mzabriskie, @nickuraltsev

[vladkolotvin]

@JustinBeckwith

[AyushG3112]

/cc @Khaledgarbaya @axe312ger @zcei

[axe312ger]

Ohh yes, this would help a lot. Having kinda the same issue in our SDK.

Can we add this to #1333 @Khaledgarbaya?

[AyushG3112]

The PR is already there, I added a soft fix for the 0.x versions as a flag in #1419, and the Error type change for the 1.x in #1420, refer the linked PRs

[AyushG3112]

@axe312ger @Khaledgarbaya any updates on this?

[AyushG3112]

@axe312ger any update please?

[axe312ger]

Have to pass on to @Khaledgarbaya 😅

[seanlindo]

This would be wonderful. Running into this issue now!

[nilptr]

Is there any progress on this issue? It's useful to distinguish axios errors from other errors. And adding isAxiosError flag to errors thrown by axios #1419 is a good solution without breaking changes. Consider adding this flag in a patch version please?

[fractalzombie]

+1

[vladkolotvin]

@Khaledgarbaya any updates on this?

[axe312ger]

I still like this, as we all have jobs, feel free to contribute that as PR

[vladkolotvin]

@axe312ger We already have 2 PRs for 5 months!
#1420 and #1419

[axe312ger]

Oops. Hard to keep track on this repo.

I'd prefer #1419 to end up in master since the v1 rewrite currently is kinda frozen due to lack of time on our side.

Can you resolve conflicts and mention some people in there?

[Khaledgarbaya]

This is now fixed in #1419

[axe312ger]

That was fast :)

[vladkolotvin]

That was open source:)

[axe312ger]

The power of GitHub mentions

[AyushG3112]

@axe312ger @Khaledgarbaya is it too soon to request a release please?

[Khaledgarbaya]

@AyushG3112 Unfortunately I don't have npm release rights

[skaldo]

@nickuraltsev @emilyemorehouse is there a plan releasing this anytime soon?

[fractalzombie]

I think if it is implemented, it will be more practical and clearer than using <Error.isAxiosError>.

[AyushG3112]

@axe312ger @Khaledgarbaya @nickuraltsev @emilyemorehouse can any of you please @-mention someone with npm publish rights?

[rhyek]

AxiosError would've been nicer... Can someone publish the isAxiosError change, please?

[ypresto]

Because at least we need some type-guard-aware function like function isAxiosError(error: Error): error is AxiosError { return !!error.isAxiosError }, it might be better to have it in library side.

[AyushG3112]

@Khaledgarbaya @axe312ger It's been months, can we have a release please?

[axe312ger]

We have no rights to publish axios to npm

[AyushG3112]

Could you tag someone who does please?

[zcei]

You did yourself last December #1415 (comment) - Nick and Emily have publish rights.

[emilyemorehouse]

👋 I've been handling all releases for consistency. As soon as CI is green again, I'll release!