Mention `ready` in the docs for `connect`

dart-lang / web_socket_channel

StreamChannel wrappers for WebSockets.

https://pub.dev/packages/web_socket_channel

BSD 3-Clause "New" or "Revised" License

419 stars 109 forks source link

Mention `ready` in the docs for `connect` #287

Closed natebosch closed 1 year ago

natebosch commented 1 year ago

Closes #280

Errors during connection can cause confusion because they escape a try block unless there is an await channel.ready. Mention that ready can complete as an error in the case of connection failure.