Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jbl428 committed Jun 25, 2023
1 parent 308f6c6 commit 16024b8
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This library is inspired by the HTTP interface in Spring 6 and provides a simila
- Provides a concise syntax for handling query parameters, path variables, request headers, request bodies, and forms.
- Offers integration with [class-transformer](https://github.com/typestack/class-transformer) to facilitate data
transformation.
- Uses promises instead of observables
- Support both promise and observable.
- Circuit breaker support

## Requirements
Expand Down Expand Up @@ -118,6 +118,9 @@ class UserService {
options of the circuit breaker. You can use global options by setting the `circuitBreakerOption` property in the module.
`options` is from [opossum](https://www.npmjs.com/package/opossum) library.

- `@Observable()`: Marks the method as an observable method. If this decorator is not specified, the method will return
a promise.

## Auto generate `@ResponseBody()` from return type of exchange method

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

0 comments on commit 16024b8

Please sign in to comment.