@tauri-apps/plugin-http 3.0.0-alpha.1 → 3.0.0-alpha.3

package/README.md

@@ -12,7 +12,7 @@ Access the HTTP client written in Rust.
 
 ## Install
 
-_This plugin requires a Rust version of at least **1.77.2**_
+_This plugin requires a Rust version of at least **1.95**_
 
 There are three general methods of installation that we can recommend.
 

package/dist-js/index.cjs

@@ -33,14 +33,24 @@ const ERROR_REQUEST_CANCELLED = 'Request cancelled';
  * Fetch a resource from the network. It returns a `Promise` that resolves to the
  * `Response` to that `Request`, whether it is successful or not.
  *
+ * The request is performed by the Rust backend instead of the webview, so it is not subject to
+ * CORS, but the URL must be allowed by the plugin scope.
+ *
  * @example
  * ```typescript
+ * import { fetch } from '@tauri-apps/plugin-http';
  * const response = await fetch("http://my.json.host/data.json");
  * console.log(response.status);  // e.g. 200
  * console.log(response.statusText); // e.g. "OK"
  * const jsonData = await response.json();
  * ```
  *
+ * @param input The resource to fetch, as a URL, a string or a `Request` object.
+ * @param init The standard `fetch` request options, extended with the Rust client options from
+ * {@linkcode ClientOptions}: `maxRedirections`, `connectTimeout`, `proxy` and `danger`. The
+ * `signal` option can be used to abort the request.
+ * @returns A promise resolving to the `Response` of the request.
+ *
  * @since 2.0.0
  */
 async function fetch(input, init) {

package/dist-js/index.d.ts

@@ -17,6 +17,11 @@ export interface Proxy {
      */
     https?: string | ProxyConfig;
 }
+/**
+ * Detailed configuration of a single proxy server, used when a plain URL string is not enough.
+ *
+ * @since 2.0.0
+ */
 export interface ProxyConfig {
     /**
      * The URL of the proxy server.
@@ -26,7 +31,13 @@ export interface ProxyConfig {
      * Set the `Proxy-Authorization` header using Basic auth.
      */
     basicAuth?: {
+        /**
+         * The user name sent to the proxy server.
+         */
         username: string;
+        /**
+         * The password sent to the proxy server.
+         */
         password: string;
     };
     /**
@@ -45,9 +56,8 @@ export interface ClientOptions {
      * Defines the maximum number of redirects the client should follow.
      * If set to 0, no redirects will be followed.
      *
-     * When the `scopeRedirects` plugin configuration is enabled, every redirect must
-     * also be allowed by the configured scope, otherwise the request fails
-     * instead of being followed.
+     * Every redirect must also be allowed by the configured scope,
+     * otherwise the request fails instead of being followed.
      */
     maxRedirections?: number;
     /** Timeout in milliseconds */
@@ -80,14 +90,24 @@ export interface DangerousSettings {
  * Fetch a resource from the network. It returns a `Promise` that resolves to the
  * `Response` to that `Request`, whether it is successful or not.
  *
+ * The request is performed by the Rust backend instead of the webview, so it is not subject to
+ * CORS, but the URL must be allowed by the plugin scope.
+ *
  * @example
  * ```typescript
+ * import { fetch } from '@tauri-apps/plugin-http';
  * const response = await fetch("http://my.json.host/data.json");
  * console.log(response.status);  // e.g. 200
  * console.log(response.statusText); // e.g. "OK"
  * const jsonData = await response.json();
  * ```
  *
+ * @param input The resource to fetch, as a URL, a string or a `Request` object.
+ * @param init The standard `fetch` request options, extended with the Rust client options from
+ * {@linkcode ClientOptions}: `maxRedirections`, `connectTimeout`, `proxy` and `danger`. The
+ * `signal` option can be used to abort the request.
+ * @returns A promise resolving to the `Response` of the request.
+ *
  * @since 2.0.0
  */
 export declare function fetch(input: URL | Request | string, init?: RequestInit & ClientOptions): Promise<Response>;

package/dist-js/index.js

@@ -31,14 +31,24 @@ const ERROR_REQUEST_CANCELLED = 'Request cancelled';
  * Fetch a resource from the network. It returns a `Promise` that resolves to the
  * `Response` to that `Request`, whether it is successful or not.
  *
+ * The request is performed by the Rust backend instead of the webview, so it is not subject to
+ * CORS, but the URL must be allowed by the plugin scope.
+ *
  * @example
  * ```typescript
+ * import { fetch } from '@tauri-apps/plugin-http';
  * const response = await fetch("http://my.json.host/data.json");
  * console.log(response.status);  // e.g. 200
  * console.log(response.statusText); // e.g. "OK"
  * const jsonData = await response.json();
  * ```
  *
+ * @param input The resource to fetch, as a URL, a string or a `Request` object.
+ * @param init The standard `fetch` request options, extended with the Rust client options from
+ * {@linkcode ClientOptions}: `maxRedirections`, `connectTimeout`, `proxy` and `danger`. The
+ * `signal` option can be used to abort the request.
+ * @returns A promise resolving to the `Response` of the request.
+ *
  * @since 2.0.0
  */
 async function fetch(input, init) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-http",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.3",
   "license": "MIT OR Apache-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
@@ -24,6 +24,6 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@tauri-apps/api": "^3.0.0-alpha.1"
+    "@tauri-apps/api": "^3.0.0-alpha.2"
   }
 }