@tauri-apps/plugin-http
Make HTTP requests with the Rust backend.
Security
This API has a scope configuration that forces you to restrict the URLs that can be accessed using glob patterns.
For instance, this scope configuration only allows making HTTP requests to all subdomains for tauri.app
except for https://private.tauri.app
:
Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.
Interfaces
ClientOptions
Options to configure the Rust client used to make fetch requests
Since
2.0.0
Properties
Property | Type | Description | Defined in |
---|---|---|---|
connectTimeout? | number | Timeout in milliseconds | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L82 |
maxRedirections? | number | Defines the maximum number of redirects the client should follow. If set to 0, no redirects will be followed. | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L80 |
proxy? | Proxy | Configuration of a proxy that a Client should pass requests to. | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L86 |
Proxy
Configuration of a proxy that a Client should pass requests to.
Since
2.0.0
Properties
Property | Type | Description | Defined in |
---|---|---|---|
all? | string | ProxyConfig | Proxy all traffic to the passed URL. | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L40 |
http? | string | ProxyConfig | Proxy all HTTP traffic to the passed URL. | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L44 |
https? | string | ProxyConfig | Proxy all HTTPS traffic to the passed URL. | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L48 |
ProxyConfig
Properties
Property | Type | Description | Defined in |
---|---|---|---|
basicAuth? | object | Set the Proxy-Authorization header using Basic auth. | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L59 |
basicAuth.password | string | - | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L61 |
basicAuth.username | string | - | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L60 |
noProxy? | string | A configuration for filtering out requests that shouldn’t be proxied. Entries are expected to be comma-separated (whitespace between entries is ignored) | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L67 |
url | string | The URL of the proxy server. | Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L55 |
Functions
fetch()
Fetch a resource from the network. It returns a Promise
that resolves to the
Response
to that Request
, whether it is successful or not.
Parameters
Parameter | Type |
---|---|
input | string | URL | Request |
init ? | RequestInit & ClientOptions |
Returns
Example
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/http/guest-js/index.ts#L105
© 2024 Tauri Contributors. CC-BY / MIT