Skip to content

Commit 9ea21fb

Browse files
docs(connectivity_plus): Improve documentation onConnectivityChanged method (#2746)
1 parent 4d5b950 commit 9ea21fb

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

packages/connectivity_plus/connectivity_plus/lib/connectivity_plus.dart

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,16 @@ class Connectivity {
3434
return ConnectivityPlatform.instance;
3535
}
3636

37-
/// Fires whenever the connectivity state changes.
37+
/// Exposes connectivity update events from the platform.
3838
///
3939
/// On iOS, the connectivity status might not update when WiFi
4040
/// status changes, this is a known issue that only affects simulators.
4141
/// For details see https://github.com/fluttercommunity/plus_plugins/issues/479.
42+
///
43+
/// On Android, the Stream may emit new values even when
44+
/// the [ConnectivityResult] list remains the same.
45+
///
46+
/// This method doesn't filter events, nor it ensures distinct values.
4247
Stream<List<ConnectivityResult>> get onConnectivityChanged {
4348
return _platform.onConnectivityChanged;
4449
}

0 commit comments

Comments
 (0)