Skip to content

Commit 8e424e9

Browse files
committed
docs: add description of circuit breaker support
1 parent 9525e80 commit 8e424e9

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This library is inspired by the HTTP interface in Spring 6 and provides a simila
1818
- Offers integration with [class-transformer](https://github.com/typestack/class-transformer) to facilitate data
1919
transformation.
2020
- Uses promises instead of observables
21+
- Circuit breaker support
2122

2223
## Requirements
2324

@@ -113,6 +114,9 @@ class UserService {
113114
- `@RequestForm(key?: string, defaultValue?: string)`: Specifies the request form
114115
using `application/x-www-form-urlencoded` as the content type, requiring the key of the body optionally.
115116

117+
- `@CircuitBreaker(options?: CircuitBreaker.Options)`: Marks the method as a circuit breaker, with `options` being the
118+
options of the circuit breaker. You can use global options by setting the `circuitBreakerOption` property in the module.
119+
116120
## Auto generate `@ResponseBody()` from return type of exchange method
117121

118122
Because of limitation of `reflect-metadata`, `@ResponseBody()` is required to specify the response DTO.

0 commit comments

Comments
 (0)