Skip to content
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

Jump to bottom

Add some types to Req.Request #367

Merged
merged 1 commit into from
Jun 2, 2024
Merged

Add some types to Req.Request #367

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
65 changes: 53 additions & 12 deletions lib/req/request.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ defmodule Req.Request do

### Request Steps

A **request step** is a function that accepts a `request` and returns one of the following:
A **request step** (`t:request_step/0`) is a function that accepts a `request` and returns one
of the following:

* A `request`.

Expand Down Expand Up @@ -152,8 +153,8 @@ defmodule Req.Request do

### Response and Error Steps

A response step is a function that accepts a `{request, response}` tuple and returns one of the
following:
A response step (`t:response_step/0`) is a function that accepts a `{request, response}` tuple
and returns one of the following:

* A `{request, response}` tuple.

Expand Down Expand Up @@ -368,9 +369,49 @@ defmodule Req.Request do
private: map()
}

@typep request_step() :: fun() | {module(), atom(), [term()]}
@typep response_step() :: fun() | {module(), atom(), [term()]}
@typep error_step() :: fun() | {module(), atom(), [term()]}
@typedoc """
A request step is a function that takes a request and returns a request or a tuple of request
and response/exception.

The function can be an anonymous function, or a `{module, function, args}` tuple. In the latter
case, the step is invoked as `apply(module, function, [request | args])`.

See also the ["Request Steps"](#module-request-steps) section in the module documentation.
"""
@typedoc since: "0.6.0"
@type request_step() ::
(t() -> t() | {t(), Req.Response.t() | Exception.t()}) | {module(), atom(), [term()]}

@typedoc """
A response step is a function that takes a request/response tuple and returns a request/response
or a request/exception tuple.

The function can be an anonymous function, or a `{module, function, args}` tuple. In the latter
case, the step is invoked as `apply(module, function, [request | args])`.

See also the ["Response and Error Steps"](#module-response-and-error-steps) section in the
module documentation.
"""
@typedoc since: "0.6.0"
@type response_step() ::
({t(), Req.Response.t()} -> {t(), Req.Response.t() | Exception.t()})
| {module(), atom(), [term()]}

@typedoc """
An error step is a function that takes a request/exception tuple and returns a request/response
or a request/exception tuple.

The function can be an anonymous function, or a `{module, function, args}` tuple. In the latter
case, the step is invoked as `apply(module, function, [request | args])`.

See also the ["Response and Error Steps"](#module-response-and-error-steps) section in the
module documentation.
"""
@typedoc since: "0.6.0"
@type error_step() ::
({t(), Exception.t()} -> {t(), Req.Response.t() | Exception.t()})
| {module(), atom(), [term()]}

@typep options() :: term()

defstruct method: :get,
Expand Down Expand Up @@ -653,7 +694,7 @@ defmodule Req.Request do
inspect: &IO.inspect/1
)
"""
@spec append_request_steps(t(), keyword(fun())) :: t()
@spec append_request_steps(t(), keyword(request_step())) :: t()
def append_request_steps(request, steps) do
%{
request
Expand All @@ -675,7 +716,7 @@ defmodule Req.Request do
inspect: &IO.inspect/1
)
"""
@spec prepend_request_steps(t(), keyword(fun())) :: t()
@spec prepend_request_steps(t(), keyword(request_step())) :: t()
def prepend_request_steps(request, steps) do
%{
request
Expand All @@ -697,7 +738,7 @@ defmodule Req.Request do
inspect: &IO.inspect/1
)
"""
@spec append_response_steps(t(), keyword(fun())) :: t()
@spec append_response_steps(t(), keyword(response_step())) :: t()
def append_response_steps(request, steps) do
%{
request
Expand All @@ -718,7 +759,7 @@ defmodule Req.Request do
inspect: &IO.inspect/1
)
"""
@spec prepend_response_steps(t(), keyword(fun())) :: t()
@spec prepend_response_steps(t(), keyword(response_step())) :: t()
def prepend_response_steps(request, steps) do
%{
request
Expand All @@ -739,7 +780,7 @@ defmodule Req.Request do
inspect: &IO.inspect/1
)
"""
@spec append_error_steps(t(), keyword(fun())) :: t()
@spec append_error_steps(t(), keyword(error_step())) :: t()
def append_error_steps(request, steps) do
%{
request
Expand All @@ -760,7 +801,7 @@ defmodule Req.Request do
inspect: &IO.inspect/1
)
"""
@spec prepend_error_steps(t(), keyword(fun())) :: t()
@spec prepend_error_steps(t(), keyword(error_step())) :: t()
def prepend_error_steps(request, steps) do
%{
request
Expand Down
Loading