ready completes with exceptions and is therefore a breaking change

[hacker1024]

dart-archive/web_socket_channel#240 added the ready property, which completes when the connection is established. It also completes with errors when the connection fails. This results in uncaught exceptions when ready is not being handled.

This breaks semantic versioning, and should be at the very least be explained in the v2.3.0 changelog. I think it should also be mentioned in the documentation, as the stack traces do not always make it easy to work out where these uncaught exceptions can be caught.

[matiasmarcodelpont]

I think I'm having this error. I'm calling IOWebSocketChannel.connect inside a try catch, but when the connection fails, the error isn't being catched. I can't find a way to handle this error

[brianquinlan]

Sorry for not managing this change better. I plan on updating the documentation in dart-archive/web_socket_channel#272

Please feel free to comment if something could be more clear.