API Reference

Classes

Http

The Http class is used for calling different HTTP methods and requesting and sending information online, as well as testing public accessible resources.

Static Functions

Name	Description
`connect`	Executes a CONNECT request to a specified URL and provides a formatted response.
`delete`	Executes a DELETE request to a specified URL and provides a formatted response.
`fetch`	Executes a HTTP request to a specified URL and provides a formatted response.
`formatUrl`	Serializes an URL Struct to a String.
`get`	Executes a GET request to a specified URL and provides a formatted response.
`parseUrl`	Parses the input URL String using WHATWG URL API and returns an URL Struct.
`patch`	Executes a PATCH request to a specified URL and provides a formatted response.
`post`	Executes a POST request to a specified URL and provides a formatted response.
`put`	Executes a PUT request to a specified URL and provides a formatted response.
`trace`	Executes a TRACE request to a specified URL and provides a formatted response.

`connect`

bring http;

inflight http.connect(url: str, options?: RequestOptions);

Executes a CONNECT request to a specified URL and provides a formatted response.

`url`^Required

Type: str

The target URL for the CONNECT request.

`options`^Optional

Type: RequestOptions

Optional parameters for customizing the CONNECT request.

`delete`

bring http;

inflight http.delete(url: str, options?: RequestOptions);

Executes a DELETE request to a specified URL and provides a formatted response.

`url`^Required

Type: str

The target URL for the DELETE request.

`options`^Optional

Type: RequestOptions

Optional parameters for customizing the DELETE request.

`fetch`

bring http;

inflight http.fetch(url: str, options?: RequestOptions);

Executes a HTTP request to a specified URL and provides a formatted response.

This method allows various HTTP methods based on the provided options.

`url`^Required

Type: str

The target URL for the request.

`options`^Optional

Type: RequestOptions

Optional parameters for customizing the HTTP request.

`formatUrl`

bring http;

inflight http.formatUrl(url: Url, options?: FormatUrlOptions);

Serializes an URL Struct to a String.

`url`^Required

Type: Url

The URL Struct to be formatted.

`options`^Optional

Type: FormatUrlOptions

`get`

bring http;

inflight http.get(url: str, options?: RequestOptions);

Executes a GET request to a specified URL and provides a formatted response.

`url`^Required

Type: str

The target URL for the GET request.

`options`^Optional

Type: RequestOptions

Optional parameters for customizing the GET request.

`parseUrl`

bring http;

inflight http.parseUrl(urlString: str);

Parses the input URL String using WHATWG URL API and returns an URL Struct.

`urlString`^Required

Type: str

The URL String to be parsed.

`patch`

bring http;

inflight http.patch(url: str, options?: RequestOptions);

Executes a PATCH request to a specified URL and provides a formatted response.

`url`^Required

Type: str

The target URL for the PATCH request.

`options`^Optional

Type: RequestOptions

Optional parameters for customizing the PATCH request.

`post`

bring http;

inflight http.post(url: str, options?: RequestOptions);

Executes a POST request to a specified URL and provides a formatted response.

`url`^Required

Type: str

The target URL for the POST request.

`options`^Optional

Type: RequestOptions

Optional parameters for customizing the POST request.

`put`

bring http;

inflight http.put(url: str, options?: RequestOptions);

Executes a PUT request to a specified URL and provides a formatted response.

`url`^Required

Type: str

The target URL for the PUT request.

`options`^Optional

Type: RequestOptions

ptional parameters for customizing the PUT request.

`trace`

bring http;

inflight http.trace(url: str, options?: RequestOptions);

Executes a TRACE request to a specified URL and provides a formatted response.

`url`^Required

Type: str

The target URL for the TRACE request.

`options`^Optional

Type: RequestOptions

Optional parameters for customizing the TRACE request.

Structs

FormatUrlOptions

Options for serializing a WHATWG URL to a String.

Initializer

bring http;

let FormatUrlOptions = http.FormatUrlOptions{ ... };

Properties

Name	Type	Description
`auth`	`bool`	Whether the formatted URL should include the username and password.
`fragment`	`bool`	Whether the formatted URL should include the fragment identifier.
`search`	`bool`	Whether the formatted URL should include the search query.
`unicode`	`bool`	Whether the formatted URL should represent Unicode characters for the host component.

`auth`^Optional

auth: bool;

Type: bool

Whether the formatted URL should include the username and password.

`fragment`^Optional

fragment: bool;

Type: bool

Whether the formatted URL should include the fragment identifier.

`search`^Optional

search: bool;

Type: bool

Whether the formatted URL should include the search query.

`unicode`^Optional

unicode: bool;

Type: bool

Whether the formatted URL should represent Unicode characters for the host component.

RequestOptions

An object containing any custom settings that you want to apply to the request.

Initializer

bring http;

let RequestOptions = http.RequestOptions{ ... };

Properties

Name	Type	Description
`body`	`str`	Any body that you want to add to your request.
`cache`	`RequestCache`	The cache mode you want to use for the request.
`headers`	`MutMap<str>`	Any headers you want to add to your request.
`method`	`HttpMethod`	The request method, e.g., GET, POST. The default is GET.
`redirect`	`RequestRedirect`	An enum specifying the redirect mode to use: follow, error or manual.
`referrer`	`str`	A string specifying "no-referrer", client, or a URL.
`timeout`	`duration`	Timeout for terminating a pending request.

`body`^Optional

body: str;

Type: str

Any body that you want to add to your request.

Note that a request using the GET or HEAD method cannot have a body.

`cache`^Optional

cache: RequestCache;

Type: RequestCache
Default: RequestCache.DEFAULT

The cache mode you want to use for the request.

`headers`^Optional

headers: MutMap<str>;

Type: MutMap<str>

Any headers you want to add to your request.

`method`^Optional

method: HttpMethod;

Type: HttpMethod
Default: GET

The request method, e.g., GET, POST. The default is GET.

`redirect`^Optional

redirect: RequestRedirect;

Type: RequestRedirect
Default: RequestRedirect.FOLLOW

An enum specifying the redirect mode to use: follow, error or manual.

The default is follow.

`referrer`^Optional

referrer: str;

Type: str
Default: about:client

A string specifying "no-referrer", client, or a URL.

The default is "about:client".

`timeout`^Optional

timeout: duration;

Type: duration
Default: no timeout

Timeout for terminating a pending request.

None if undefined.

Response

The response to a HTTP request.

Initializer

bring http;

let Response = http.Response{ ... };

Properties

Name	Type	Description
`body`	`str`	A string representation of the body contents.
`headers`	`MutMap<str>`	The map of header information associated with the response.
`ok`	`bool`	A boolean indicating whether the response was successful (status in the range 200 – 299) or not.
`status`	`num`	The status code of the response.
`url`	`str`	The URL of the response.

`body`^Required

body: str;

Type: str

A string representation of the body contents.

`headers`^Required

headers: MutMap<str>;

Type: MutMap<str>

The map of header information associated with the response.

`ok`^Required

ok: bool;

Type: bool

A boolean indicating whether the response was successful (status in the range 200 – 299) or not.

`status`^Required

status: num;

Type: num

The status code of the response.

(This will be 200 for a success).

`url`^Required

url: str;

Type: str

The URL of the response.

Url

An URL following WHATWG URL Standard.

Initializer

bring http;

let Url = http.Url{ ... };

Properties

Name	Type	Description
`hash`	`str`	The URL's fragment.
`host`	`str`	The URL's host.
`hostname`	`str`	The URL's hostname.
`href`	`str`	The entire URL.
`origin`	`str`	The URL's origin.
`password`	`str`	The URL’s password.
`pathname`	`str`	The URL's pathname.
`port`	`str`	The URL's port.
`protocol`	`str`	The URL's protocol.
`search`	`str`	The URL's search.
`username`	`str`	The URL's username.

`hash`^Required

hash: str;

Type: str

The URL's fragment.

`host`^Required

host: str;

Type: str

The URL's host.

`hostname`^Required

hostname: str;

Type: str

The URL's hostname.

`href`^Required

href: str;

Type: str

The entire URL.

`origin`^Required

origin: str;

Type: str

The URL's origin.

`password`^Required

password: str;

Type: str

The URL’s password.

`pathname`^Required

pathname: str;

Type: str

The URL's pathname.

`port`^Required

port: str;

Type: str

The URL's port.

`protocol`^Required

protocol: str;

Type: str

The URL's protocol.

`search`^Required

search: str;

Type: str

The URL's search.

`username`^Required

username: str;

Type: str

The URL's username.

Enums

HttpMethod

The request's method.

Members

Name	Description
`GET`	GET.
`PUT`	PUT.
`DELETE`	DELETE.
`PATCH`	PATCH.
`POST`	POST.
`OPTIONS`	OPTIONS.
`HEAD`	HEAD.
`CONNECT`	CONNECT.
`TRACE`	TRACE.

`GET`

GET.

`PUT`

PUT.

`DELETE`

DELETE.

`PATCH`

PATCH.

`POST`

POST.

`OPTIONS`

OPTIONS.

`HEAD`

HEAD.

`CONNECT`

CONNECT.

`TRACE`

TRACE.

RequestCache

The cache mode of the request.

It controls how a request will interact with the system's HTTP cache.

Members

Name	Description
`DEFAULT`	The runtime environment looks for a matching request in its HTTP cache.
`NO_STORE`	The runtime environment fetches the resource from the remote server without first looking in the cache, and will not update the cache with the downloaded resource.
`RELOAD`	The runtime environment fetches the resource from the remote server without first looking in the cache, but then will update the cache with the downloaded resource.
`NO_CACHE`	The runtime environment looks for a matching request in its HTTP cache.
`FORCE_CACHE`	The runtime environment looks for a matching request in its HTTP cache.

`DEFAULT`

The runtime environment looks for a matching request in its HTTP cache.

If there is a match and it is fresh, it will be returned from the cache.
If there is a match but it is stale, the runtime environment will make a conditional request to the remote server.
If the server indicates that the resource has not changed, it will be returned from the cache.
Otherwise the resource will be downloaded from the server and the cache will be updated.
If there is no match, the runtime environment will make a normal request, and will update the cache with the downloaded resource.

`NO_STORE`

The runtime environment fetches the resource from the remote server without first looking in the cache, and will not update the cache with the downloaded resource.

`RELOAD`

The runtime environment fetches the resource from the remote server without first looking in the cache, but then will update the cache with the downloaded resource.

`NO_CACHE`

The runtime environment looks for a matching request in its HTTP cache.

If there is a match, fresh or stale, the runtime environment will make a conditional request to the remote server.
If the server indicates that the resource has not changed, it will be returned from the cache. Otherwise the resource will be downloaded from the server and the cache will be updated.
If there is no match, the runtime environment will make a normal request, and will update the cache with the downloaded resource.

`FORCE_CACHE`

The runtime environment looks for a matching request in its HTTP cache.

If there is a match, fresh or stale, it will be returned from the cache.
If there is no match, the runtime environment will make a normal request, and will update the cache with the downloaded resource.

RequestRedirect

The redirect read-only property that contains the mode for how redirects are handled.

Members

Name	Description
`MANUAL`	Do not follow redirects automatically.
`FOLLOW`	Follow all redirects incurred when fetching a resource.
`ERROR`	Return a network error when a request is met with a redirect.

`MANUAL`

Do not follow redirects automatically.

The Location response header includes the redirect target.

`FOLLOW`

Follow all redirects incurred when fetching a resource.

`ERROR`

Return a network error when a request is met with a redirect.

API Reference

Classes ​

Http ​

Static Functions ​

connect ​

urlRequired ​

optionsOptional ​

delete ​

urlRequired ​

optionsOptional ​

fetch ​

urlRequired ​

optionsOptional ​

formatUrl ​

urlRequired ​

optionsOptional ​

get ​

urlRequired ​

optionsOptional ​

parseUrl ​

urlStringRequired ​

patch ​

urlRequired ​

optionsOptional ​

post ​

urlRequired ​

optionsOptional ​

put ​

urlRequired ​

optionsOptional ​

trace ​

urlRequired ​

optionsOptional ​

Structs ​

FormatUrlOptions ​

Initializer ​

Properties ​

authOptional ​

fragmentOptional ​

searchOptional ​

unicodeOptional ​

RequestOptions ​

Initializer ​

Properties ​

bodyOptional ​

cacheOptional ​

headersOptional ​

methodOptional ​

redirectOptional ​

referrerOptional ​

timeoutOptional ​

Response ​

Initializer ​

Properties ​

bodyRequired ​

headersRequired ​

okRequired ​

statusRequired ​

urlRequired ​

Url ​

Initializer ​

Properties ​

hashRequired ​

hostRequired ​

hostnameRequired ​

hrefRequired ​

originRequired ​

passwordRequired ​

pathnameRequired ​

portRequired ​

protocolRequired ​

searchRequired ​

usernameRequired ​

Enums ​

HttpMethod ​

Members ​

GET ​

PUT ​

DELETE ​

PATCH ​

Classes

Http

Static Functions

`connect`

`url`^Required

`options`^Optional

`delete`

`url`^Required

`options`^Optional

`fetch`

`url`^Required

`options`^Optional

`formatUrl`

`url`^Required

`options`^Optional

`get`

`url`^Required

`options`^Optional

`parseUrl`

`urlString`^Required

`patch`

`url`^Required

`options`^Optional

`post`

`url`^Required

`options`^Optional

`put`

`url`^Required

`options`^Optional

`trace`

`url`^Required

`options`^Optional

Structs

FormatUrlOptions

Initializer

Properties

`auth`^Optional

`fragment`^Optional

`search`^Optional

`unicode`^Optional

RequestOptions

Initializer

Properties

`body`^Optional

`cache`^Optional

`headers`^Optional

`method`^Optional

`redirect`^Optional

`referrer`^Optional

`timeout`^Optional

Response

Initializer

Properties

`body`^Required

`headers`^Required

`ok`^Required

`status`^Required

`url`^Required

Url

Initializer

Properties

`hash`^Required

`host`^Required

`hostname`^Required

`href`^Required

`origin`^Required

`password`^Required

`pathname`^Required

`port`^Required

`protocol`^Required

`search`^Required

`username`^Required

Enums

HttpMethod

Members

`GET`

`PUT`

`DELETE`

`PATCH`

`POST`