@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 and paths that can be accessed using glob patterns.
For instance, this scope configuration only allows making HTTP requests to the GitHub API for the tauri-apps
organization:
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 |
---|---|---|
connectTimeout? | number | Timeout in milliseconds |
maxRedirections? | number | Defines the maximum number of redirects the client should follow. If set to 0, no redirects will be followed. |
proxy? | Proxy | Configuration of a proxy that a Client should pass requests to. |
ProxyConfig
Properties
Type Aliases
Proxy
Configuration of a proxy that a Client should pass requests to.
Since
2.0.0
Type declaration
Member | Type | Description |
---|---|---|
all | string | ProxyConfig | Proxy all traffic to the passed URL. |
http | string | ProxyConfig | Proxy all HTTP traffic to the passed URL. |
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#L34
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#L101
© 2024 Tauri Contributors. CC-BY / MIT