1.0.0-pre.3

PlugFox · Jul 16, 2023 · 803bcbd · 803bcbd
1 parent 11d3f64
commit 803bcbd
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-## 1.0.0-pre.2
+## 1.0.0-pre.3
 
 - **BREAKING CHANGE**: Change options to separate, platform-specific object
 - You can now pass a headers and other options to the IO websocket client

diff --git a/lib/src/client/ws_options.dart b/lib/src/client/ws_options.dart
@@ -25,6 +25,9 @@ typedef ConnectionRetryInterval = ({Duration min, Duration max});
 /// The [protocols] argument is specifying the subprotocols the
 /// client is willing to speak.
 ///
+/// The [timeout] argument is specifying the maximum time to wait for the
+/// connection to be established.
+///
 /// Other arguments are platform dependent.
 ///
 /// {@endtemplate}
@@ -85,6 +88,9 @@ abstract base class WebSocketOptions {
   /// If [customClient] is provided, the `WebSocket` created will be configured.
   ///
   /// If [userAgent] is provided, the `WebSocket` created will be configured.
+  ///
+  /// The [timeout] argument is specifying the maximum time to wait for the
+  /// connection to be established.
   /// {@endtemplate}
   factory WebSocketOptions.vm({
     ConnectionRetryInterval? connectionRetryInterval,
@@ -120,8 +126,9 @@ abstract base class WebSocketOptions {
   /// The [timeout] argument is specifying the maximum time to wait for the
   /// connection to be established.
   ///
-  /// The [useBlobForBinary] argument is specifying the Uint8List should be send as
-  /// Blob or as Typed data. By default, the data send as Typed data.
+  /// The [useBlobForBinary] argument is specifying the Uint8List
+  /// should be send as Blob or as Typed data.
+  /// By default, the data send as Typed data.
   /// {@endtemplate}
   factory WebSocketOptions.js({
     ConnectionRetryInterval? connectionRetryInterval,

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -3,7 +3,7 @@ name: ws
 description: >
   WS: A compact, highly efficient WebSocket library. Easily establish, manage, and reconnect WebSocket connections in real-time apps.
 
-version: 1.0.0-pre.2
+version: 1.0.0-pre.3
 
 homepage: https://github.com/plugfox/ws