From ac77bb2f5f1a92532487b427ebf5fc70c569bf2c Mon Sep 17 00:00:00 2001 From: mytja Date: Fri, 22 Dec 2023 19:32:36 +0100 Subject: [PATCH] [fix] fix analysis --- .../_web_socket_connect_html.dart | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/lib/src/_web_socket_connect/_web_socket_connect_html.dart b/lib/src/_web_socket_connect/_web_socket_connect_html.dart index 1875384..ae06e83 100644 --- a/lib/src/_web_socket_connect/_web_socket_connect_html.dart +++ b/lib/src/_web_socket_connect/_web_socket_connect_html.dart @@ -3,14 +3,27 @@ import 'dart:js_interop'; import 'package:web/helpers.dart'; -// TODO: remove when https://github.com/dart-lang/web/commit/4cb5811ed06 +// TODO(mytja): remove when https://github.com/dart-lang/web/commit/4cb5811ed06 // is in a published release and the min constraint on pkg:web is updated +/// [WebSocketEvents] is an extension to the main [WebSocket] class from +/// package:web. It adds appropriate streams while https://github.com/dart-lang/web/commit/4cb5811ed06 +/// is not yet published. extension WebSocketEvents on WebSocket { + /// [onOpen] is a [Stream], which returns [Event]s upon + /// establishing new WebSocket connection. Stream get onOpen => EventStreamProviders.openEvent.forTarget(this); + + /// [onMessage] is a [Stream], which returns [MessageEvent]s upon + /// receiving messages through the WebSocket connection. Stream get onMessage => EventStreamProviders.messageEvent.forTarget(this); + + /// [onClose] is a [Stream], which returns [CloseEvent]s upon + /// WebSocket closure. Stream get onClose => EventStreamProviders.closeEvent.forTarget(this); + + /// [onError] is a [Stream], which returns [Event]s upon error. Stream get onError => EventStreamProviders.errorEventSourceEvent.forTarget(this); }