Skip to content

Latest commit

 

History

History
13 lines (8 loc) · 1.74 KB

migrating-from-version-6-to-7.md

File metadata and controls

13 lines (8 loc) · 1.74 KB
Raw

This guide relates to changes implemented in PR 1058.

The request HTTP client was deprecated as of Feb 11th 2020. We have updated this helper library with the axios HTTP client.

In version 6.X.X, our ClientRequest and ClientResponse types exposed the raw interfaces from the request module directly. In version 7.X.X, the ClientRequest and ClientResponse objects untethers from a specific HTTP client implementation. We have maintained the core request and response interfaces exposed in test cases and usage examples, but mask everything else.

If you are passing in request options, outside of what’s documented, to the HTTP request client, this may be a breaking change for you. Please check the RequestOptions interface to inspect the updated options. If you rely on HTTP response data previously available, this may also be a breaking change for you. Please see the ClientResponse object for details about what data is now exposed.

Action steps:

  1. Locate any areas in your code that utilizes request and response properties that are no longer exposed in the new interfaces.
  2. Update the response values to use the new Response object.
  3. Update the request values to use the new options exposed in the RequestOptions object.