Skip to content

Commit e92ea5e

Browse files
committed
docs: update readme to list breaking changes from 1.X to 2.0
1 parent 042e695 commit e92ea5e

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1085,10 +1085,13 @@ server.auth((accept, reject, handshake) => {
10851085
* RPC calls while in this state are rejected.
10861086
* RPC responses will be silently dropped.
10871087

1088-
## Upgrading from 1.6 -> 2.0
1088+
## Upgrading from 1.X -> 2.0
10891089

1090-
* The RPCClient event `'strictValidationFailure'` now fires for both inbound & outbound requests & responses.
1091-
* The RPCClient event `'strictValidationFailure'` emits an object containing more information than was previously available. The Error which was previously emitted is now a member of this object.
1090+
Breaking changes:
1091+
* The `RPCClient` event [`'strictValidationFailure'`](#event-strictvalidationfailure) now fires for both inbound & outbound requests & responses.
1092+
* The `RPCClient` event [`'strictValidationFailure'`](#event-strictvalidationfailure) emits an object containing more information than was previously available. The Error which was previously emitted is now a member of this object.
1093+
* The `password` option in the `RPCClient` [constructor](#new-rpcclientoptions) can now be supplied as a `Buffer`. If a string is provided, it will be encoded as utf8.
1094+
* The `password` field of `RPCServerClient`'s [`handshake`](#clienthandshake) object is now always provided as a Buffer instead of a string. Use `password.toString('utf8')` to convert back to a string as per previous versions.
10921095

10931096
## License
10941097

0 commit comments

Comments
 (0)