Skip to content

Commit

Permalink
Add sigs for HTTP verbs
Browse files Browse the repository at this point in the history
  • Loading branch information
dduugg committed Jul 14, 2020
1 parent 0060240 commit 83132c1
Showing 1 changed file with 70 additions and 9 deletions.
79 changes: 70 additions & 9 deletions lib/faraday/all/faraday.rbi
@@ -1,13 +1,4 @@
# This file is autogenerated. Do not edit it by hand. Regenerate it with:
# srb rbi gems

# typed: true
#
# If you would like to make changes to this file, great! Please create the gem's shim here:
#
# https://github.com/sorbet/sorbet-typed/new/master?filename=lib/faraday/all/faraday.rbi
#
# faraday-1.0.1

module Faraday
def self.default_adapter; end
Expand All @@ -27,6 +18,76 @@ module Faraday
def self.respond_to_missing?(symbol, include_private = nil); end
def self.root_path; end
def self.root_path=(arg0); end

# HTTP verb methods. These are proxied to Faraday::Connecation,
# which should have corresponding sigs

# Query methods
sig do
params(
url: String,
params: T.nilable(T::Hash[Object, Object]),
headers: T.nilable(T::Hash[Object, String]),
block: T.nilable(T.proc.params(req: Faraday::Request).void),
).returns(Faraday::Response)
end
def self.get(url, params = nil, headers = nil, &block); end
sig do
params(
url: String,
params: T.nilable(T::Hash[Object, Object]),
headers: T.nilable(T::Hash[Object, String]),
block: T.nilable(T.proc.params(req: Faraday::Request).void),
).returns(Faraday::Response)
end
def self.head(url, params = nil, headers = nil, &block); end
sig do
params(
url: String,
params: T.nilable(T::Hash[Object, Object]),
headers: T.nilable(T::Hash[Object, String]),
block: T.nilable(T.proc.params(req: Faraday::Request).void),
).returns(Faraday::Response)
end
def self.delete(url, params = nil, headers = nil, &block); end
sig do
params(
url: String,
params: T.nilable(T::Hash[Object, Object]),
headers: T.nilable(T::Hash[Object, String]),
block: T.nilable(T.proc.params(req: Faraday::Request).void),
).returns(Faraday::Response)
end
def self.trace(url, params = nil, headers = nil, &block); end

# Body methods
sig do
params(
url: String,
body: T.any(String, T.nilable(T::Hash[Object, Object])),
headers: T.nilable(T::Hash[Object, String]),
block: T.nilable(T.proc.params(req: Faraday::Request).void),
).returns(Faraday::Response)
end
def self.post(url, body = nil, headers = nil, &block); end
sig do
params(
url: String,
body: T.any(String, T.nilable(T::Hash[Object, Object])),
headers: T.nilable(T::Hash[Object, String]),
block: T.nilable(T.proc.params(req: Faraday::Request).void),
).returns(Faraday::Response)
end
def self.put(url, body = nil, headers = nil, &block); end
sig do
params(
url: String,
body: T.any(String, T.nilable(T::Hash[Object, Object])),
headers: T.nilable(T::Hash[Object, String]),
block: T.nilable(T.proc.params(req: Faraday::Request).void),
).returns(Faraday::Response)
end
def self.patch(url, body = nil, headers = nil, &block); end
end
module Faraday::MiddlewareRegistry
def fetch_middleware(key); end
Expand Down

0 comments on commit 83132c1

Please sign in to comment.