8000 Update documentation · sockjs/sockjs-node@a15705b · GitHub
[go: up one dir, main page]

Skip to content

Commit a15705b

Browse files
committed
Update documentation
1 parent b74358b commit a15705b

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

CHANGELOG.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
1-
Unreleased
2-
======
1+
# Unreleased
2+
3+
## **BREAKING CHANGES**
4+
* `installHandlers(server, options)` renamed to `attach(server)` and only takes a single argument.
5+
This means you cannot use the same SockJS server installed at multiple prefixes.
6+
In practice this was confusing and not common.
7+
* `websocket` option is deprecated, but still respected. Please use the new `transports` option.
8+
* Node.js `>= 6.5.0` is required.
39

10+
## Other Fixes/Changes
411
* Convert from coffeescript to ES6.
512
* Update minimum Node.js version to 6.X.
613
* Update SockJSConnection implementation to be compatible with latest Node.js streams.
714
* SockJSConnection properties `readable` and `writable` have been removed. These are used internally by Node.js streams.
815
* Remove `console.log` logging by default.
916
* Remove usage of exceptions for flow control.
1017
* Add `debug` logs for easier troubleshooting.
18+
* Added `transports` option to allow selection of specific transports.
19+
* Added `detach(server)` function to remove SockJS from a HTTP server instance.
20+
* Update dependencies.
21+
* Examples have been updated to use latest versions of libraries.
1122

1223

1324
0.3.19

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ and emits following event:
191191
All http requests that don't go under the path selected by `prefix`
192192
will remain unanswered and will be passed to previously registered
193193
handlers. You must install your custom http handlers before calling
194-
`attach`.
194+
`attach`. You can remove the SockJS handler later with `detach`.
195195

196196
### Connection instance
197197

0 commit comments

Comments
 (0)
0