Skip to content

Commit

Permalink
feat(repeater): update README
Browse files Browse the repository at this point in the history
closes #196
  • Loading branch information
ostridm committed Jun 18, 2024
1 parent ed80f20 commit f14760c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/repeater/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ describe('Scan', () => {

### Implementation details

Under the hood `Repeater` register `ExecuteRequestEventHandler` in bus,
which in turn uses the `RequestRunner` to proceed with request:
Under the hood `Repeater` connects to the Bright engine using web socket protocol, then listens for incoming commands from the engine.
Which in turn get executed with the `RequestRunner` to proceed with the request coming from the engine:

```ts
export interface RequestRunner {
Expand All @@ -152,7 +152,7 @@ export interface RequestRunner {
}
```

Package contains `RequestRunner` implementations for both HTTP and WS protocols.
Package contains `RequestRunner` implementations for HTTP protocol only.
To support other protocol new class implementation of `RequestRunner` should be registered in global IoC container:

```ts
Expand Down

0 comments on commit f14760c

Please sign in to comment.