httpx/sig/plugins/proxy.rbs
HoneyryderChuck 43016795f3 introducing the :no_proxy option
can be passed in the `:proxy` option hash, and receives domains, as
strings, which requests should not go through the proxy.
2022-08-05 22:37:52 +01:00

49 lines
1.3 KiB
Plaintext

module HTTPX
class HTTPProxyError < Error
end
module Plugins
module Proxy
Error: singleton(HTTPProxyError)
PROXY_ERRORS: Array[singleton(StandardError)]
class Parameters
attr_reader uri: URI::Generic
attr_reader username: String?
attr_reader password: String?
attr_reader scheme: String?
def can_authenticate?: (*untyped) -> boolish
def authenticate: (*untyped) -> String?
def ==: (untyped) -> bool
private
def initialize: (uri: generic_uri, ?scheme: String, ?username: String, ?password: String, **untyped) -> untyped
end
def self.configure: (singleton(Session)) -> void
type proxyParam = Parameters | Hash[Symbol, untyped]
interface _ProxyOptions
def proxy: () -> proxyParam?
end
def self.extra_options: (Options) -> (Options & _ProxyOptions)
module InstanceMethods
private
def proxy_uris: (generic_uri, Options & _ProxyOptions) -> { uri: generic_uri, username: String, password: String }
| (generic_uri, Options & _ProxyOptions) -> { uri: generic_uri }
| (generic_uri, Options & _ProxyOptions) -> nil
end
end
type sessionProxy = Session & Proxy::InstanceMethods
end
end