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.

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

Update axios + other housekeeping #54

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update axios + other housekeeping #54

wants to merge 1 commit into from

Conversation

dabrowne
Copy link
Contributor

@dabrowne dabrowne commented May 10, 2024

Primary change is upgrading to Axios 1.x.
Also includes some housekeeping on dev-dependencies & docs.

Primary chance is upgrading to Axios 1.x.
Also includes some housekeeping on dev-dependencies & docs.
},
"dependencies": {
"axios": "^0.21.1",
"tslib": "^2.3.0",
"axios": "^1.6.8",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a major version bump for our Package?

Does it have potential to break things such as args passed in, or middlewares?

Copy link
Contributor Author

@dabrowne dabrowne May 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We only expose a fairly limited subset of native axios options, the most significant of which is adapter, which doesn't appear to have any breaking API changes as far as I can tell. That would indicate that we're maintaining API compatibility, so a minor version bump should be sufficient.

However, we specifically added the adapter param to support axios-fetch-adaptor for use in environments like the CloudFlare worker runtime which doesn't implement the necessary APIs for axios to run natively. It looks like this isn't compatible with axios 1.x, not due to API compatibility, but changes in import paths in the axios peer-dependency. That would mean that the new version of our package does break this use-case, and because we're specifying axios as a dependency rather than peer-dependency, I'm not sure whether npm would be smart enough to find the right combination of package versions to maintain compatibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants