View Source DSL: Reactor.Req
An extension which provides direct support for working with req
requests
within Reactor.
reactor.req_delete
req_delete name
Performs a request using Req.delete/2
.
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_delete.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Delete
reactor.req_get
req_get name
Performs a request using Req.get/2
.
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_get.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Get
reactor.req_head
req_head name
Performs a request using Req.head/2
.
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_head.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Head
reactor.req_merge
req_merge name
Creates a new request using Req.merge/2
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_merge.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Merge
reactor.req_new
req_new name
Creates a new request using Req.new/1
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_new.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.New
reactor.req_patch
req_patch name
Performs a request using Req.patch/2
.
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_patch.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Patch
reactor.req_post
req_post name
Performs a request using Req.post/2
.
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_post.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Post
reactor.req_put
req_put name
Performs a request using Req.put/2
.
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_put.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Put
reactor.req_request
req_request name
Performs a request using Req.request/2
.
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_request.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Request
reactor.req_run
req_run name
Performs a request using Req.run/2
.
Note that Reactor doesn't validate any options - it simply passes them to the underlying Req
function and assumes it will validate them.
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|---|---|---|
name | atom | A unique name for the step. Used when choosing the return value of the Reactor and for arguments into other steps |
Options
Name | Type | Default | Docs |
---|---|---|---|
adapter | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Adapter to use to make the actual HTTP request | |
auth | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Sets request authentication | |
aws_sigv4 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the AWS options to sign request | |
base_url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, the request URL is prepended with this base URL | |
body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request body | |
cache_dir | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The directory to store the cache | |
cache | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If true , performs HTTP caching | |
compress_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , compresses the request body using gzip | |
connect_options | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Dynamically starts (or re-uses already started) Finch pool with the given connection options | |
decode_body | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response body decoding | |
decode_json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Options to pass to Jason.decode!/2 | |
finch_private | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A map or keyword list of private metadata to add to the Finch request | |
finch_request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A function that executes the Finch request, defaults to using Finch.request/3 | |
finch | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The Finch pool to use. Defaults to pool automatically started by Req | |
form_multipart | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as multipart/form-data | |
form | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as application/x-www-form-urlencoded | |
headers | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request headers as a {key, value} enumerable (e.g. map, keyword list) | |
http_errors | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How to manage 4xx and 5xx responses | |
inet6 | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , uses IPv6 | |
into | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Where to send the response body | |
json | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, encodes the request body as JSON | |
max_redirects | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The maximum number of redirects, defaults to 10 | |
max_retries | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Maximum number of retry attempts, defaults to 3 (for a total of 4 requests to the server, including the initial one) | |
method | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request method, defaults to :get | |
params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, appends parameters to the request query string (via put_params step) | |
path_params_style | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | How path params are expressed (via put_path_params step) | |
path_params | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, uses a templated request path (via put_path_params step) | |
plug | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, calls the given plug instead of making an HTTP request over the network (via run_plug step) | |
pool_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Pool checkout timeout in milliseconds, defaults to 5000 | |
raw | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to true , disables automatic body decompression (decompress_body step) and decoding (decode_body step) | |
receive_timeout | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | Socket receive timeout in milliseconds, defaults to 15_000 | |
redirect_trusted | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | By default, authorization credentials are only sent on redirects with the same host, scheme and port. If :redirect_trusted is set to true , credentials will be sent to any host | |
redirect | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set to false , disables automatic response redirects | |
request | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | A previously built request | |
retry_delay | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If not set, which is the default, the retry delay is determined by the value of retry-delay header on HTTP 429/503 responses. If the header is not set, the default delay follows a simple exponential backoff: 1s, 2s, 4s, 8s, ... | |
retry_log_level | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The log level to emit retry logs at. Can also be set to false to disable logging these messages. Defaults to :warning | |
retry | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | One of :safe_transient (default), :transient , fun or false | |
unix_socket | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | If set, connect through the given UNIX domain socket | |
url | nil | Reactor.Template.Element | Reactor.Template.Input | Reactor.Template.Result | Reactor.Template.Value | The request URL |
reactor.req_run.wait_for
wait_for names
Wait for the named step to complete before allowing this one to start.
Desugars to argument :_, result(step_to_wait_for)
Examples
wait_for :create_user
Arguments
Name | Type | Default | Docs |
---|---|---|---|
names | atom | list(atom) | The name of the step to wait for. |
Introspection
Target: Reactor.Dsl.WaitFor
Introspection
Target: Reactor.Req.Dsl.Run