# typed: true # DO NOT EDIT MANUALLY # This is an autogenerated file for types exported from the `faraday-em_http` gem. # Please instead update this file by running `bin/tapioca gem faraday-em_http`. # This is the main namespace for Faraday. # # It provides methods to create {Connection} objects, and HTTP-related # methods to use directly. # # @example Helpful class methods for easy usage # Faraday.get "http://faraday.com" # @example Helpful class method `.new` to create {Connection} objects. # conn = Faraday.new "http://faraday.com" # conn.get '/' module Faraday class << self # @overload default_adapter # @overload default_adapter= def default_adapter; end # Documented elsewhere, see default_adapter reader def default_adapter=(adapter); end # @overload default_connection # @overload default_connection= def default_connection; end # Documented below, see default_connection def default_connection=(_arg0); end # Gets the default connection options used when calling {Faraday#new}. # # @return [Faraday::ConnectionOptions] def default_connection_options; end # Sets the default options used when calling {Faraday#new}. # # @param options [Hash, Faraday::ConnectionOptions] def default_connection_options=(options); end # Tells Faraday to ignore the environment proxy (http_proxy). # Defaults to `false`. # # @return [Boolean] def ignore_env_proxy; end # Tells Faraday to ignore the environment proxy (http_proxy). # Defaults to `false`. # # @return [Boolean] def ignore_env_proxy=(_arg0); end # Gets or sets the path that the Faraday libs are loaded from. # # @return [String] def lib_path; end # Gets or sets the path that the Faraday libs are loaded from. # # @return [String] def lib_path=(_arg0); end # Initializes a new {Connection}. # # @example With an URL argument # Faraday.new 'http://faraday.com' # # => Faraday::Connection to http://faraday.com # @example With everything in an options hash # Faraday.new url: 'http://faraday.com', # params: { page: 1 } # # => Faraday::Connection to http://faraday.com?page=1 # @example With an URL argument and an options hash # Faraday.new 'http://faraday.com', params: { page: 1 } # # => Faraday::Connection to http://faraday.com?page=1 # @option options # @option options # @option options # @option options # @option options # @option options # @param url [String, Hash] The optional String base URL to use as a prefix # for all requests. Can also be the options Hash. Any of these # values will be set on every request made, unless overridden # for a specific request. # @param options [Hash] # @return [Faraday::Connection] def new(url = T.unsafe(nil), options = T.unsafe(nil), &block); end # Internal: Requires internal Faraday libraries. # # @param libs [Array] one or more relative String names to Faraday classes. # @private # @return [void] def require_lib(*libs); end # Internal: Requires internal Faraday libraries. # # @param libs [Array] one or more relative String names to Faraday classes. # @private # @return [void] def require_libs(*libs); end # @return [Boolean] def respond_to_missing?(symbol, include_private = T.unsafe(nil)); end # The root path that Faraday is being loaded from. # # This is the root from where the libraries are auto-loaded. # # @return [String] def root_path; end # The root path that Faraday is being loaded from. # # This is the root from where the libraries are auto-loaded. # # @return [String] def root_path=(_arg0); end private # Internal: Proxies method calls on the Faraday constant to # .default_connection. def method_missing(name, *args, &block); end end end # Base class for all Faraday adapters. Adapters are # responsible for fulfilling a Faraday request. class Faraday::Adapter extend ::Faraday::MiddlewareRegistry extend ::Faraday::DependencyLoader extend ::Faraday::Adapter::Parallelism extend ::Faraday::AutoloadHelper # @return [Adapter] a new instance of Adapter def initialize(_app = T.unsafe(nil), opts = T.unsafe(nil), &block); end def call(env); end # Close any persistent connections. The adapter should still be usable # after calling close. def close; end # Yields or returns an adapter's configured connection. Depends on # #build_connection being defined on this adapter. # # @param env [Faraday::Env, Hash] The env object for a faraday request. # @return The return value of the given block, or the HTTP connection object # if no block is given. # @yield [conn] def connection(env); end private # Fetches either a read, write, or open timeout setting. Defaults to the # :timeout value if a more specific one is not given. # # @param type [Symbol] Describes which timeout setting to get: :read, # :write, or :open. # @param options [Hash] Hash containing Symbol keys like :timeout, # :read_timeout, :write_timeout, :open_timeout, or # :timeout # @return [Integer, nil] Timeout duration in seconds, or nil if no timeout # has been set. def request_timeout(type, options); end def save_response(env, status, body, headers = T.unsafe(nil), reason_phrase = T.unsafe(nil)); end end Faraday::Adapter::CONTENT_LENGTH = T.let(T.unsafe(nil), String) # EventMachine adapter. This adapter is useful for either asynchronous # requests when in an EM reactor loop, or for making parallel requests in # synchronous code. class Faraday::Adapter::EMHttp < ::Faraday::Adapter include ::Faraday::Adapter::EMHttp::Options def call(env); end def create_request(env); end def error_message(client); end # @return [Boolean] def parallel?(env); end def perform_request(env); end # TODO: reuse the connection to support pipelining def perform_single_request(env); end # @raise [error_class] def raise_error(msg); end # @return [Boolean] def timeout_message?(msg); end class << self # @return [Manager] def setup_parallel_manager(_options = T.unsafe(nil)); end end end # This parallel manager is designed to start an EventMachine loop # and block until all registered requests have been completed. class Faraday::Adapter::EMHttp::Manager # @return [Manager] a new instance of Manager # @see reset def initialize; end def add(&block); end def check_finished; end def perform_request; end # Re-initializes instance variables def reset; end def run; end # @return [Boolean] def running?; end end # Options is a module containing helpers to convert the Faraday env object # into options hashes for EMHTTP method calls. module Faraday::Adapter::EMHttp::Options # Reads out compression header settings from env into options def configure_compression(options, env); end # Reads out proxy settings from env into options def configure_proxy(options, env); end # Reads out host and port settings from env into options def configure_socket(options, env); end # Reads out SSL certificate settings from env into options def configure_ssl(options, env); end # Reads out timeout settings from env into options def configure_timeout(options, env); end # @return [Hash] def connection_config(env); end def read_body(env); end def request_config(env); end def request_options(env); end end Faraday::Adapter::TIMEOUT_KEYS = T.let(T.unsafe(nil), Hash) Faraday::CONTENT_TYPE = T.let(T.unsafe(nil), String) Faraday::CompositeReadIO = Faraday::Multipart::CompositeReadIO # Main Faraday::EmHttp module module Faraday::EmHttp; end Faraday::EmHttp::VERSION = T.let(T.unsafe(nil), String) Faraday::FilePart = Multipart::Post::UploadIO Faraday::METHODS_WITH_BODY = T.let(T.unsafe(nil), Array) Faraday::METHODS_WITH_QUERY = T.let(T.unsafe(nil), Array) Faraday::ParamPart = Faraday::Multipart::ParamPart Faraday::Parts = Multipart::Post::Parts Faraday::Timer = Timeout Faraday::UploadIO = Multipart::Post::UploadIO Faraday::VERSION = T.let(T.unsafe(nil), String)