ResponseModule
PackageAxial.HttpClient
Summary
| Name | Signature | Synopsis |
|---|---|---|
| text | Response.text response | Returns the response body text. |
| bytes | Response.bytes response | Returns the exact response body bytes. |
| statusCode | Response.statusCode response | Returns the response status code. |
| tryHeader | Response.tryHeader name response | Finds the first header with the given case-insensitive name. |
| json | Response.json decode response | Decodes the response body with the supplied decoder, mapping failure to <c>HttpError.DecodeFailed</c>. |
| create | Response.create startedAt status bodyText | Creates a synthetic response transcript at an explicit start time, primarily for test fakes. |
Returns the response body text. <example><code>response |> Response.text</code></example>
Parameters
| Name | Type | Description |
|---|---|---|
| response | HttpResponse |
Returns
string
Returns the exact response body bytes. <example><code>response |> Response.bytes</code></example>
Parameters
| Name | Type | Description |
|---|---|---|
| response | HttpResponse |
Returns
byte array
Returns the response status code. <example><code>response |> Response.statusCode</code></example>
Parameters
| Name | Type | Description |
|---|---|---|
| response | HttpResponse |
Returns
int
Finds the first header with the given case-insensitive name.
<example><code>response |> Response.tryHeader "ETag"</code></example>
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | |
| response | HttpResponse |
Returns
string option
Decodes the response body with the supplied decoder, mapping failure to <c>HttpError.DecodeFailed</c>.
<example><code>response |> Response.json (Json.deserializeResult codec)</code></example>
Parameters
| Name | Type | Description |
|---|---|---|
| decode | string -> Result<'value, string> | |
| response | HttpResponse |
Returns
Result<'value, HttpError>
Creates a synthetic response transcript at an explicit start time, primarily for test fakes.
<example><code>Response.create startedAt 200 """{"ok":true}"""</code></example>
Parameters
| Name | Type | Description |
|---|---|---|
| startedAt | DateTimeOffset | |
| status | int | |
| bodyText | string |
Returns
HttpResponse