Skip to content

Update Timeout Documentation #48

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.

Sign up for GitHub

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

Merged
scottoffen merged 1 commit into from
Nov 29, 2025
Merged

Update Timeout Documentation #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions docs/docs/configure-timeout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,19 @@ var response = await client

Timeouts link with any caller-provided `CancellationToken`; whichever triggers first will cancel the request.

### Clear Timeouts

Any timeouts that have been set can be clearing using `ClearTimeout`. This is most useful when the `HttpRequestBuilder` is being reused.

```csharp
var builder = client
.UsingBase()
.WithRoute("/todos/1")
.WithTimeout(TimeSpan.FromMilliseconds(750));

builder.ClearTimeout();
```

## Behavior Notes

* The timeout applies only to the current request and does not affect any other requests sent using the same `HttpClient` instance.
Expand All @@ -40,5 +53,6 @@ Timeouts link with any caller-provided `CancellationToken`; whichever triggers f

| Method | Purpose |
| ----------------------- | ------------------------------------------------- |
| `ClearTimeout()` | Removes any per-request timeout. |
| `WithTimeout(int)` | Applies a per-request timeout using seconds. |
| `WithTimeout(TimeSpan)` | Applies a per-request timeout using a `TimeSpan`. |