Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about compression for Dart #257

Merged
merged 1 commit into from
Feb 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/dart/using-clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ final transport = protocol.Transport(
different protocols with different APIs, create one `Transport` for each
protocol.**

### Compression

Request compression and response decompression can be enabled for io platforms by providing the
`compression` transport option. Gzip compression is provided in `package:connectrpc/io.dart`, and
support for other compression algorithms can be added by implementing the `Compression` interface.

### HTTP stack

Connect-Dart provides three different HTTP client implementations out of
Expand Down Expand Up @@ -96,7 +102,7 @@ print(response.message.sentence);
```

For server-streaming RPCs, the corresponding method on the client returns
a `Stream` object which allows the caller to iterate over updates from
a `Stream` object which allows the caller to iterate over updates from
the server using the `await for`:

```dart
Expand Down