Skip to content

Commit 9002740

Browse files
committed
refactor: move RealtimeClientOptions to general options file
1 parent 2d12a6c commit 9002740

File tree

3 files changed

+44
-46
lines changed

3 files changed

+44
-46
lines changed

packages/supabase/lib/src/realtime_client_options.dart

Lines changed: 0 additions & 45 deletions
This file was deleted.

packages/supabase/lib/src/supabase_client_options.dart

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,47 @@ class StorageClientOptions {
2323

2424
const StorageClientOptions({this.retryAttempts = 0});
2525
}
26+
27+
/// {@template realtime_client_options}
28+
/// Options to pass to the RealtimeClient.
29+
/// {@endtemplate}
30+
class RealtimeClientOptions {
31+
/// How many events the RealtimeClient can push in a second
32+
///
33+
/// Defaults to 10 events per second
34+
@Deprecated(
35+
'Client side rate limit has been removed. This option will be ignored.')
36+
final int? eventsPerSecond;
37+
38+
/// Level of realtime server logs to be logged
39+
final RealtimeLogLevel? logLevel;
40+
41+
/// the timeout to trigger push timeouts
42+
final Duration? timeout;
43+
44+
/// The WebSocket implementation to use
45+
final WebSocketTransport? webSocketTransport;
46+
47+
/// {@macro realtime_client_options}
48+
const RealtimeClientOptions({
49+
this.eventsPerSecond,
50+
this.logLevel,
51+
this.timeout,
52+
this.webSocketTransport,
53+
});
54+
55+
RealtimeClientOptions copyWith({
56+
int? eventsPerSecond,
57+
RealtimeLogLevel? logLevel,
58+
Duration? timeout,
59+
WebSocketTransport? webSocketTransport,
60+
}) {
61+
return RealtimeClientOptions(
62+
// ignore: deprecated_member_use_from_same_package
63+
eventsPerSecond: eventsPerSecond ?? this.eventsPerSecond,
64+
logLevel: logLevel ?? this.logLevel,
65+
timeout: timeout ?? this.timeout,
66+
webSocketTransport: webSocketTransport ?? this.webSocketTransport,
67+
);
68+
}
69+
}

packages/supabase/lib/supabase.dart

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ export 'package:realtime_client/realtime_client.dart';
1111
export 'package:storage_client/storage_client.dart';
1212

1313
export 'src/auth_user.dart';
14-
export 'src/realtime_client_options.dart';
1514
export 'src/remove_subscription_result.dart';
1615
export 'src/supabase_client.dart';
1716
export 'src/supabase_client_options.dart';

0 commit comments

Comments
 (0)