RequestModule

Creates a request with the supplied method and already-formed URL. <example><code>Request.create Method.Get "https://api.example.com/users"</code></example>

Returns the request method. <example><code>Request.method request</code></example>

Returns the real request URL without appended query parameters. <example><code>Request.url request</code></example>

Returns query parameters as name-value pairs. <example><code>Request.queryParameters request</code></example>

Returns headers as name-value pairs. <example><code>Request.headerValues request</code></example>

Returns the request body. <example><code>Request.body request</code></example>

Returns the per-request timeout. <example><code>Request.tryTimeout request</code></example>

Returns the success expectation. <example><code>Request.expectation request</code></example>

Appends one URL-encoded query parameter. <example><code>request |&gt; Request.query "page" 2</code></example>

Appends a query parameter whose value is replaced with <c>***</c> in plans and error transcripts. <example><code>request |&gt; Request.secretQuery "api_key" key</code></example>

Appends one request header. <example><code>request |&gt; Request.header "Accept" "application/json"</code></example>

Appends a header whose value is replaced with <c>***</c> in plans and error transcripts. <example><code>request |&gt; Request.secretHeader "X-Api-Key" key</code></example>

Adds a bearer-token Authorization header. The token is always redacted in diagnostics. <example><code>request |&gt; Request.bearer token</code></example>

Adds a basic-auth Authorization header. The credentials are always redacted in diagnostics. <example><code>request |&gt; Request.basicAuth user password</code></example>

Sets the Accept header. <example><code>request |&gt; Request.accept "application/json"</code></example>

Sets the Accept header to <c>application/json</c>. <example><code>request |&gt; Request.acceptJson</code></example>

Sets the User-Agent header. <example><code>request |&gt; Request.userAgent "axial-app/1.0"</code></example>

Sets a per-request timeout enforced by the live service. <example><code>request |&gt; Request.timeout (TimeSpan.FromSeconds 5.0)</code></example>

Sends a plain-text body. <example><code>request |&gt; Request.textBody "hello"</code></example>

Sends an already-serialized JSON body with the <c>application/json</c> content type. <example><code>request |&gt; Request.jsonBody """{"name":"Ada"}"""</code></example>

Encodes a value with the supplied serializer and sends it as JSON. <example><code>request |&gt; Request.jsonBodyWith (Json.serialize codec) user</code></example>

Sends raw bytes with an explicit content type. <example><code>request |&gt; Request.bytesBody "application/octet-stream" payload</code></example>

Sends URL-encoded form fields. <example><code>request |&gt; Request.formBody [ "q", "axial" ]</code></example>

Replaces the statuses treated as success. <example><code>request |&gt; Request.expect [ 200; 404 ]</code></example>

Treats every status as success so the caller can branch on the code explicitly. <example><code>request |&gt; Request.expectAny</code></example>

Renders the redacted request line used in error transcripts. <example><code>Request.render request</code></example>

Returns a redacted request plan without sending anything. <example><code>Request.plan request</code></example>