# Change log

# 2.2.0

Adds support for call-specific custom timeout

# 2.1.0
Allow client to be proxy-aware
 - keepalive agent options can be passed through to the underlying `agentkeepalive` agent configuration.
-  alternatively the `NODE_USE_ENV_PROXY` environment variable will be detected to automatically read proxy variables (`HTTPS_PROXY`, `HTTP_PROXY` and `NO_PROXY`) from the environment. 

# 2.0.0

Drops support for node engine 20 (no longer maintained) and adds 26 (will be LTS later this year).

# 1.2.1

Handle network timeouts when sanitising errors.

# 1.2.0

Change rest-client logging levels to better reflect issues and be less verbose.

# 1.1.0
- Add support for multipart form data requests [PR-143](https://github.com/ministryofjustice/hmpps-typescript-lib/pull/143)

# 1.0.0

Move to node 24

 @types/express  ^5.0.3 →  ^5.0.5

# 0.0.3

 superagent     ^10.2.1 →  ^10.2.3

# 0.0.2
- Add support for providing a custom retryHandler function which overrides built-in retry handler [PR-89](https://github.com/ministryofjustice/hmpps-typescript-lib/pull/89)
- Updated built-in retry handler to match SuperAgent's default retry behaviours [PR-90](https://github.com/ministryofjustice/hmpps-typescript-lib/pull/90)

# 0.0.1

Initial release

 @types/express  ^4.17.21 →  ^5.0.3
 nock            ^13.5.6" →  ^14.0.5

## 0.0.1-alpha.11

Revert prefixing node standard library imports with “node:” because cypress is unhappy with them.

## 0.0.1-alpha.10

Make `RestClient` non-abstract so that it can be instantiated directly in applications.
Instantiate `SanitisedError` class directly instead of using it purely as a type interface.

## 0.0.1-alpha.9

Improve JSDoc for `RestClient` to document the throwing of `SanitisedError` by default.

## 0.0.1-alpha.8

Rename `SanitisedError` status property to `responseStatus` and provide examples for use and document.
Also export `AuthOptions`.

## 0.0.1-alpha.7

Add in `errorLogger` parameter to streaming to override default logger behaviour.

## 0.0.1-alpha.6

Switch stream method to read the `response.body` instead of `response.text`. This is to allow clients to stream
compressed responses as `response.text` is `null` in those circumstances.

## 0.0.1-alpha.5

Fix to export AgentConfig class

## 0.0.1-alpha.4

Initial pre-release for testing with HMPPS projects.

## 0.0.1-alpha.1 to 0.0.1-alpha.3

Pre-releases which should not be used in projects.