Http :: # (opaque)
Send requests using the shared
roc-lang/http Request and Response
types. This module supplies effects and small JSON/UTF-8 conveniences while
leaving pure request and response construction to that package.
Validate and send an HTTP request.
The request URI must be an absolute HTTP or HTTPS URL accepted by Url. Invalid URLs return InvalidUrl before any host effect occurs. Fragments are removed because they are client-side identifiers and are not sent.
request = Request.from_method(GET).with_uri("https://www.roc-lang.org")
response = Http.send!(request)?with_json_body : Request, _ => Try(Request, [JsonErr(_), ..])
Encode a value as JSON and set it as the request body.
This uses Roc's builtin JSON encoder, so the value's type determines the encoder through static dispatch.
send_json! : Request, _ => Try(Response, [JsonErr(_), InvalidUrl(ParseErr), HttpErr(TransportErr), ..])
Encode a value as JSON, attach it to the request body, and send it.
Perform an HTTP GET and decode the response body as a UTF-8 Str.
The argument is a validated Url. Quoted literals work through Url.from_quote; dynamic strings should be passed through Url.parse.
hello_str = Http.get_utf8!("http://localhost:8000")?decode_json_response : Response => Try(_, [BadBody(Str), JsonErr(_), ..])
Decode a response body as JSON.
This uses Roc's builtin JSON parser, so the expected result type determines the parser through static dispatch.
Perform an HTTP GET and decode the response body as JSON.
The argument is a validated Url. JSON parser failures are returned as JsonErr(_).
payload : Try({ foo : Str }, _)
payload = Http.get!("http://localhost:8000")TransportErr : TransportErr
Errors raised by the host while sending a request, before a real HTTP response is available.