Skip to content

feat(client): accept sub-second timeouts #138

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

Open
0x676e67 wants to merge 2 commits into
base: demo/stable-error-hierarchy-111
Choose a base branch
from
Open

feat(client): accept sub-second timeouts #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5488d02
feat(client): accept sub-second timeouts
0x676e67 Jul 16, 2026
fca217f
Clarify timeout and TCP option documentation
0x676e67 Jul 16, 2026
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
72 changes: 54 additions & 18 deletions lib/wreq.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,12 @@ module Wreq
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down Expand Up @@ -83,8 +87,12 @@ def self.request(method, url, **options)
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down Expand Up @@ -116,8 +124,12 @@ def self.get(url, **options)
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down Expand Up @@ -149,8 +161,12 @@ def self.head(url, **options)
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down Expand Up @@ -182,8 +198,12 @@ def self.post(url, **options)
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down Expand Up @@ -215,8 +235,12 @@ def self.put(url, **options)
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down Expand Up @@ -248,8 +272,12 @@ def self.delete(url, **options)
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down Expand Up @@ -281,8 +309,12 @@ def self.options(url, **options)
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down Expand Up @@ -314,8 +346,12 @@ def self.trace(url, **options)
# @param brotli [Boolean, nil] Enable Brotli compression
# @param deflate [Boolean, nil] Enable deflate compression
# @param zstd [Boolean, nil] Enable Zstandard compression
# @param timeout [Integer, nil] Total request timeout (seconds)
# @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
# @param timeout [Numeric, nil] Total request timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param read_timeout [Numeric, nil] Per-chunk read timeout in seconds.
# Must be finite and non-negative; fractions are accepted, 0 expires
# immediately, and nil leaves it unset.
# @param proxy [String, nil] Proxy server URI
# @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
# @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
Expand Down
Loading