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

Provide an example of configuring IOClient with an HttpClient. #1074

Merged
merged 1 commit into from
Dec 7, 2023
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
12 changes: 12 additions & 0 deletions pkgs/http/lib/src/io_client.dart
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,18 @@ class IOClient extends BaseClient {
/// The underlying `dart:io` HTTP client.
HttpClient? _inner;

/// Create a new `dart:io`-based HTTP [Client].
///
/// If [inner] is provided then it can be used to provide configuration
/// options for the client.
///
/// For example:
/// ```dart
/// final httpClient = HttpClient()
/// ..userAgent = 'Book Agent'
/// ..idleTimeout = const Duration(seconds: 5);
/// final client = IOClient(httpClient);
/// ```
IOClient([HttpClient? inner]) : _inner = inner ?? HttpClient();

/// Sends an HTTP request and asynchronously returns the response.
Expand Down