Fix a couple Vale linter warnings
This commit is contained in:
Jeroen Leenarts
@@ -50,7 +50,7 @@ pubspec.lock
|
||||
# If you don't generate documentation locally you can remove this line.
|
||||
doc/api/
|
||||
|
||||
# Avoid committing generated Javascript files:
|
||||
# Avoid committing generated JavaScript files:
|
||||
*.dart.js
|
||||
*.info.json # Produced by the --dump-info flag.
|
||||
*.js # When generated by dart2js. Don't specify *.js if your
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
🛑️ Breaking Changes from `5.0.0-beta.2`
|
||||
|
||||
- `Channel.addMembers`, `Channel.removeMembers`, `Channel.inviteMembers` and `Channel.update`
|
||||
positional params are now optional params.
|
||||
positional parameters are now optional parameters.
|
||||
|
||||
```dart
|
||||
// previous
|
||||
@@ -390,21 +390,21 @@ the [V4 Migration Guide](https://getstream.io/chat/docs/sdk/flutter/guides/migra
|
||||
🛑️ Breaking Changes from `1.5.3`
|
||||
|
||||
- migrate this package to null safety
|
||||
- `ConnectUserWithProvider` now requires `tokenProvider` as a required param. (Removed from the
|
||||
- `ConnectUserWithProvider` now requires `tokenProvider` as a required parameter. (Removed from the
|
||||
constructor)
|
||||
- `client.disconnect()` is now divided into two different functions
|
||||
- `client.closeConnection()` -> for closing user websocket connection.
|
||||
- `client.closeConnection()` -> for closing user web socket connection.
|
||||
- `client.disconnectUser()` -> for disconnecting user and resetting client state.
|
||||
- `client.devToken()` now returns a `Token` model instead of `String`.
|
||||
- `ApiError` is removed in favor of `StreamChatError`
|
||||
- `StreamChatError` -> parent type for all the stream errors.
|
||||
- `StreamWebSocketError` -> for user websocket related errors.
|
||||
- `StreamWebSocketError` -> for user web socket related errors.
|
||||
- `StreamChatNetworkError` -> for network related errors.
|
||||
- `client.queryChannels()`, `channel.query()` options param is removed in favor of individual params
|
||||
- `client.queryChannels()`, `channel.query()` options parameter is removed in favor of individual parameters
|
||||
- `option.state` -> bool state
|
||||
- `option.watch` -> bool watch
|
||||
- `option.presence` -> bool presence
|
||||
- `client.queryUsers()` options param is removed in favor of individual params
|
||||
- `client.queryUsers()` options parameter is removed in favor of individual parameters
|
||||
- `option.presence` -> bool presence
|
||||
- Migrate this package to null safety
|
||||
- Added typed filters
|
||||
@@ -438,28 +438,28 @@ the [V4 Migration Guide](https://getstream.io/chat/docs/sdk/flutter/guides/migra
|
||||
|
||||
🛑️ Breaking Changes from `2.0.0-nullsafety.6`
|
||||
|
||||
- `ConnectUserWithProvider` now requires `tokenProvider` as a required param. (Removed from the
|
||||
- `ConnectUserWithProvider` now requires `tokenProvider` as a required parameter. (Removed from the
|
||||
constructor)
|
||||
- `client.disconnect()` is now divided into two different functions
|
||||
- `client.closeConnection()` -> for closing user websocket connection.
|
||||
- `client.closeConnection()` -> for closing user web socket connection.
|
||||
- `client.disconnectUser()` -> for disconnecting user and resetting client state.
|
||||
- `client.devToken()` now returns a `Token` model instead of `String`.
|
||||
- `ApiError` is removed in favor of `StreamChatError`
|
||||
- `StreamChatError` -> parent type for all the stream errors.
|
||||
- `StreamWebSocketError` -> for user websocket related errors.
|
||||
- `StreamWebSocketError` -> for user web socket related errors.
|
||||
- `StreamChatNetworkError` -> for network related errors.
|
||||
- `client.queryChannels()`, `channel.query()` options param is removed in favor of individual params
|
||||
- `client.queryChannels()`, `channel.query()` options parameter is removed in favor of individual parameters
|
||||
- `option.state` -> bool state
|
||||
- `option.watch` -> bool watch
|
||||
- `option.presence` -> bool presence
|
||||
- `client.queryUsers()` options param is removed in favor of individual params
|
||||
- `client.queryUsers()` options parameter is removed in favor of individual parameters
|
||||
- `option.presence` -> bool presence
|
||||
|
||||
✅ Added
|
||||
|
||||
- New `Location` enum is introduced for easily changing the client location/baseUrl.
|
||||
- New `client.openConnection()` and `client.closeConnection()` is introduced to connect/disconnect
|
||||
user ws connection.
|
||||
user WS connection.
|
||||
|
||||
🔄 Changed
|
||||
|
||||
@@ -562,7 +562,7 @@ the [V4 Migration Guide](https://getstream.io/chat/docs/sdk/flutter/guides/migra
|
||||
|
||||
- 🛑 **BREAKING** Renamed `Client` to less generic `StreamChatClient`
|
||||
- 🛑 **BREAKING** Segregated the persistence layer into separate
|
||||
package [stream_chat_persistence](https://pub.dev/packages/stream_chat_persistence)
|
||||
package [`stream_chat_persistence`](https://pub.dev/packages/stream_chat_persistence)
|
||||
- 🛑 **BREAKING** Moved `Client.backgroundKeepAlive`
|
||||
to [core package](https://pub.dev/packages/stream_chat_core)
|
||||
- 🛑 **BREAKING** Moved `Client.showLocalNotification`
|
||||
|
||||
@@ -39,7 +39,7 @@ There is a detailed Flutter example project in the `example` folder. You can dir
|
||||
|
||||
## Setup API Client
|
||||
|
||||
First you need to instantiate a chat client. The Chat client will manage API call, event handling and manage the websocket connection to Stream Chat servers. You should only create the client once and re-use it across your application.
|
||||
First you need to instantiate a chat client. The Chat client will manage API call, event handling and manage the web socket connection to Stream Chat servers. You should only create the client once and re-use it across your application.
|
||||
|
||||
```dart
|
||||
final client = StreamChatClient("stream-chat-api-key");
|
||||
@@ -47,7 +47,7 @@ final client = StreamChatClient("stream-chat-api-key");
|
||||
|
||||
### Logging
|
||||
|
||||
By default the Chat Client will write all messages with level Warn or Error to stdout.
|
||||
By default the Chat Client will write all messages with level Warn or Error to `stdout`.
|
||||
|
||||
#### Change Logging Level
|
||||
|
||||
@@ -59,7 +59,7 @@ final client = StreamChatClient("stream-chat-api-key", logLevel: Level.INFO);
|
||||
|
||||
#### Custom Logger
|
||||
|
||||
You can handle the log messages directly instead of have them written to stdout, this is very convenient if you use an error tracking tool or if you want to centralize your logs into one facility.
|
||||
You can handle the log messages directly instead of have them written to `stdout`, this is very convenient if you use an error tracking tool or if you want to centralize your logs into one facility.
|
||||
|
||||
```dart
|
||||
myLogHandlerFunction = (LogRecord record) {
|
||||
@@ -71,7 +71,7 @@ final client = StreamChatClient("stream-chat-api-key", logHandlerFunction: myLog
|
||||
|
||||
### Offline storage
|
||||
|
||||
To add data persistance you can extend the class `ChatPersistenceClient` and pass an instance to the `StreamChatClient`.
|
||||
To add data persistence, you can extend the class `ChatPersistenceClient` and pass an instance to the `StreamChatClient`.
|
||||
|
||||
```dart
|
||||
class CustomChatPersistentClient extends ChatPersistenceClient {
|
||||
@@ -84,7 +84,7 @@ final client = StreamChatClient(
|
||||
)..chatPersistenceClient = CustomChatPersistentClient();
|
||||
```
|
||||
|
||||
We provide an official persistent client in the [stream_chat_persistence](https://pub.dev/packages/stream_chat_persistence) package.
|
||||
We provide an official persistent client in the [`stream_chat_persistence`](https://pub.dev/packages/stream_chat_persistence) package.
|
||||
|
||||
```dart
|
||||
import 'package:stream_chat_persistence/stream_chat_persistence.dart';
|
||||
@@ -104,7 +104,7 @@ final client = StreamChatClient(
|
||||
|
||||
### Code conventions
|
||||
|
||||
- Make sure that you run `dartfmt` before commiting your code
|
||||
- Make sure that you run `dartfmt` before you commit your code
|
||||
- Make sure all public methods and functions are well documented
|
||||
|
||||
### Running tests
|
||||
|
||||
Reference in New Issue
Block a user