Skip to content

Commit 0198b08

Browse files
committed
Document wsDisconnect with reason parameter
1 parent 817d32b commit 0198b08

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
99

1010
### Fixed
1111

12-
- tbd
12+
- Document `wsDisconnect` with reason parameter
1313

1414
## Version 1.6.0 - 2025-02-03
1515

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1337,8 +1337,10 @@ and headers from subsections `websocket.generic.<header>` or `ws.generic.<header
13371337
Every time a server socket is connected via websocket client, the CDS service is notified by calling the corresponding
13381338
service operation:
13391339
1340-
- `Connect`: Invoke service operation `wsConnect`, if available
1341-
- `Disconnect`: Invoke service operation `wsDisconnect`, if available
1340+
- `Connect`: Invoke service operation `wsConnect()`, if available
1341+
- `Disconnect`: Invoke service operation `wsDisconnect()`, if available
1342+
- `wsDisconnect()`: No parameters are passed
1343+
- `wsDisconnect(reason: String)`: Disconnect reason is passed as parameter
13421344
13431345
### Approuter
13441346

0 commit comments

Comments
 (0)