axios.md

> Back to homepage

Migration guides

You may think it's too hard to switch, but it's really not. 🦄

Axios

Axios is very similar to Got. The difference is that Axios targets browsers first, while Got fully makes use of Node.js features.

Common options

These options remain the same as well:

• url
• method
• headers
• maxRedirects
• decompress

Renamed options

We deeply care about readability, so we renamed these options:

• httpAgent → agent.http
• httpsAgent → agent.https
• socketPath → url
• responseEncoding → encoding
• auth.username → username
• auth.password → password
• data → body / json / form
• params → searchParams

Changes in behavior

• transformRequest → hooks.beforeRequest
  • The API is different.
• transformResponse → hooks.afterResponse
  • The API is different.
• baseUrl → prefixUrl
  • The prefixUrl is always prepended to the url.
• timeout
  • This option is now an object. You can now set timeouts on particular events!
• responseType
  • Accepts 'text', 'json' or 'buffer'.

Breaking changes

• onUploadProgress
  • This option does not exist. Instead, use got(…).on('uploadProgress', …).
• onDownloadProgress
  • This option does not exist. Instead, use got(…).on('downloadProgress', …).
• maxContentLength
  • This option does not exist. Instead, use a handler.
• validateStatus
  • This option does not exist. Got automatically validates the status according to the specification.
• proxy
  • This option does not exist. You need to pass an agent instead.
• cancelToken
  • Use the signal option with AbortController.
• paramsSerializer
  • This option does not exist.
• maxBodyLength
  • This option does not exist.

Response

The response object is different as well:

• response.data → response.body
• response.status → response.statusCode
• response.statusText → response.statusMessage
• response.config → response.request.options
• response.request
  • Returns a Got stream.

The response.headers object remains the same.

Interceptors

Got offers hooks instead, which are more flexible.

Errors

Errors look the same, with the difference error.request returns a Got stream. Furthermore, Got provides more details to make debugging easier.

Abort

Got supports AbortController via the signal option.

Convenience methods

Convenience methods, such as axios.get(…) etc. remain the same: got.get(…). Instead of axios.create(…) use got.extend(…).

You're good to go!

Well, you have already come this far 🎉
Take a look at the documentation. It's worth the time to read it.
There are some great tips.

If something is unclear or doesn't work as it should, don't hesitate to open an issue.