Access the HTTP client written in Rust.

This package is also accessible with window.__TAURI__.http when tauri.conf.json > build > withGlobalTauri is set to true.

The APIs must be allowlisted on tauri.conf.json:

{
  "tauri": {
    "allowlist": {
      "http": {
        "all": true, // enable all http APIs
        "request": true // enable HTTP request API
      }
    }
  }
}

It is recommended to allowlist only the APIs you use for optimal bundle size and security.

Enumerations

• ResponseType

Classes

• Body
• Client
• Response

Interfaces

• ClientOptions
• HttpOptions

Type aliases

FetchOptions

Ƭ FetchOptions: Omit<HttpOptions, "url">

Options for the fetch API.

Defined in

http.ts:124

---

HttpVerb

Ƭ HttpVerb: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "CONNECT" | "TRACE"

The request HTTP verb.

Defined in

http.ts:99

---

Part

Ƭ Part: "string" | number[]

Defined in

http.ts:40

---

RequestOptions

Ƭ RequestOptions: Omit<HttpOptions, "method" | "url">

Request options.

Defined in

http.ts:122

Functions

fetch

▸ fetch<T>(url, options?): Promise<Response<T>>

Perform an HTTP request using the default client.

Type parameters

Name
T

Parameters

Name	Type	Description
url	string	The request URL.
options?	FetchOptions	The fetch options.

Returns

Promise<Response<T>>

The response object.

Defined in

http.ts:335

---

getClient

▸ getClient(options?): Promise<Client>

Creates a new client using the specified options.

Parameters

Name	Type	Description
options?	ClientOptions	Client configuration.

Returns

Promise<Client>

A promise resolving to the client instance.

Defined in

http.ts:315