npm - soon-fetch - Versions diffs - 3.1.1 → 4.0.0-beta.0 - Mend

soon-fetch 3.1.1 → 4.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/README.md CHANGED Viewed

@@ -13,7 +13,7 @@
 > - 🚀 request race
 > - 📝 response cache
 > - 🔤 automatic serialization of JSON
-> - 📏 .min size less than **5K**, smaller after zip
+> - 📏 .min size less than **6K**, smaller after zip
 > - 💡 smart type tips with Typescript
 - [Example](#example)
@@ -33,31 +33,28 @@
 > [github: soon-admin-react-nextjs ](https://github.com/leafio/soon-admin-react-nextjs)
 ```typescript
-import { createSoon } from "soon-fetch";
+import { createSoon, soonFetch } from "soon-fetch";
+// 使用 soonFetch 作为基础请求函数
+const request = async <T>(url: string, options?: SoonOptions) => {
+  const isGet = !options?.method || options?.method.toLocaleLowerCase() === "get";
+  const response = await soonFetch<T>({
+    url,
+    options,
+    baseURL: '/api',
+    baseOptions: {
+      timeout: 20 * 1000,
+      headers: new Headers({
+        Authorization: "Bearer " + localStorage.getItem("token"),
+      }),
+      share: isGet ? true : false,
+      staleTime: isGet ? 2 * 1000 : 0,
+    },
+  });
+  return response;
+};
-const soon = createSoon(
-  (url, options) => {
-    const isGet = !options?.method || options?.method.toLocaleLowerCase() === "get"
-    return {
-      baseURL: '/api',
-      baseOptions: {
-        timeout: 20 * 1000,
-        headers: new Headers({
-          Authorization: "Bearer " + localStorage.getItem("token"),
-        }),
-        share: isGet ? true : false,
-        staleTime: isGet ? 2 * 1000 : 0,
-      },
-    }
-  },
-  ({ parsed }) => {
-    return <T>() => {
-      return fetch(parsed.url, parsed.options).then((res) =>
-        res.json()
-      ) as Promise<T>;
-    };
-  }
-);
+const soon = createSoon(request);
 /** GET */
 soon.get("/user?id=123");
@@ -71,7 +68,7 @@ soon.post("/login", { body: { username: "admin", password: "123456" } });
 export const login = soon
   .POST("/user/login")
   .Body<{ username: string; password: string }>()
-  .Send<{ token: string }>();
+  .Ok<{ token: string }>();
 //the develop tools will have type tips for request and response
 login({ username: "admin", password: "123" }).then((res) => {
   localStorage.setItem("token", res.token);
@@ -134,7 +131,7 @@ soon.get(url, { staleTime: 1000 * 60 * 5 });
 import { useEffect, useRef, useState } from "react";
 type User = { name: string; job: string };
-const api = soon.GET("/api/users").Query<{ page: number }>().Send<User[]>();
+const api = soon.GET("/api/users").Query<{ page: number }>().Ok<User[]>();
 export default function App() {
   const refAbort = useRef([]);
   const [list, setList] = useState<User[]>([]);
@@ -161,18 +158,24 @@ export default function App() {
 ```typescript
 //can be GET POST PATCH PUT DELETE
-  soon.GET(url:string).Query<Query>().Send<Response>()
-  soon.POST(url:string).Body<Body>().Send<Response>()
+  soon.GET(url:string).Query<Query>().Ok<Response>()
+  soon.POST(url:string).Body<Body>().Ok<Response>()
+  soon.GET(url:string).Options({ timeout: 5000 }).Ok<Response>()
+  soon.POST(url:string).Body<Body>().Options({ timeout: 5000 }).Ok<Response>()
 //define an api
-export const getUserInfo = soon.GET("/user/:id").Send();
+export const getUserInfo = soon.GET("/user/:id").Ok();
 //then use in any where
 getUserInfo({ id: 2 }).then((res) => console.log(res));
+//define an api with options
+export const getUserInfoWithOptions = soon.GET("/user/:id").Options({ timeout: 5000 }).Ok();
+//then use in any where
+getUserInfoWithOptions({ id: 2 }).then((res) => console.log(res));
 //with typescript,
 export const login = soon
   .POST("/user/login")
   .Body<{ username: string; password: string }>()
-  .Send<{ token: string }>();
+  .Ok<{ token: string }>();
 //the develop tools will have type tips for request and response
 login({ username: "admin", password: "123" }).then((res) => {
   localStorage.setItem("token", res.token);
@@ -213,25 +216,32 @@ Create a soon request instance.
 **Parameters:**
-- `getConfig`: A function to get request configuration, receives url and options, returns an object containing url, options, baseURL, and baseOptions
-- `wrapper`: A wrapper function to handle request logic
+- `request`: A function to handle the actual request, receives url and options, returns a Promise
-**Returns:** An object containing request method and various shortcut methods
+**Returns:** An object containing request method, API methods (GET, POST, PUT, DELETE, PATCH), and shortcut methods (get, post, put, delete, patch, head, options)
 **Example:**
-```javascript
+```typescript
 const soon = createSoon(
-  (url, options) => ({ url, options,baseURL：'/api', baseOptions:{timeout: 5000} }),
-  ({ parsed }) =>
-    async (url, options) => {
-      const response = await fetch(parsed.url, parsed.options);
-      return response.json();
-    }
+  async <T>(url: string, options?: SoonOptions): Promise<T> => {
+    const response = await fetch(url, options);
+    return response.json();
+  }
 );
 // Usage example
-const data = await soon.get("/api/users");
+const data = await soon.get<{ id: number; name: string }[]> ("/api/users");
+// Define API with options
+export const login = soon
+  .POST("/user/login")
+  .Body<{ username: string; password: string }>()
+  .Ok<{ token: string }>();
+login({ username: "admin", password: "123" }).then((res) => {
+  localStorage.setItem("token", res.token);
+});
 ```
 #### createShortApi
@@ -247,18 +257,18 @@ Used to generate type-safe API calling methods, supporting path parameters, quer
 **Example:**
-```javascript
+```typescript
 const API = createShortApi(
-  async (url, method, params, query, body, options) => {
+  async <T>(url: string, method: string, params: Record<string, string | number> | undefined, query: any, body: any, options: any): Promise<T> => {
     // Handle request logic
-    const _url = mergeUrl(url, { params, query });
+    const { url: _url } = parseUrl(url, { params, query });
     const response = await fetch(_url, { ...options, method, body });
     return response.json();
   }
 );
 // Usage example
-const getUser = API.GET("/api/users/:id").Send();
+const getUser = API.GET("/api/users/:id").Ok<{ id: number; name: string }>();
 const userData = await getUser({ id: 1 });
 ```
@@ -275,11 +285,14 @@ Factory function to create shortcut methods.
 **Example:**
-```javascript
-const methods = createShortMethods(["get", "post"], (method) => {
-  return (url, options) => fetch(url, { ...options, method });
+```typescript
+const methods = createShortMethods(["get", "post"] as const, (method) => {
+  return async <T>(url: string, options?: SoonOptions): Promise<T> => {
+    const response = await fetch(url, { ...options, method });
+    return response.json();
+  };
 });
-// Usage: methods.get('/api/users')
+// Usage: methods.get<{ id: number; name: string }[]>('/api/users')
 ```
 #### parseUrlOptions
@@ -294,7 +307,7 @@ Parse URL options.
 **Example:**
-```javascript
+```typescript
 const [url, options] = parseUrlOptions({
   url: "/api/users/:id",
   options: { params: { id: "123" } },
@@ -315,9 +328,9 @@ Merge multiple Headers objects.
 **Example:**
-```javascript
-const headers1 = { "Content-Type": "application/json" };
-const headers2 = { Authorization: "Bearer token" };
+```typescript
+const headers1: HeadersInit = { "Content-Type": "application/json" };
+const headers2: HeadersInit = { Authorization: "Bearer token" };
 const mergedHeaders = mergeHeaders(headers1, headers2);
 ```
@@ -334,7 +347,7 @@ Merge multiple AbortSignal signals.
 **Example:**
-```javascript
+```typescript
 const controller1 = new AbortController();
 const controller2 = new AbortController();
 const mergedSignal = mergeSignals(
@@ -357,8 +370,8 @@ Handle baseURL, path parameters and query parameters to generate complete URL.
 **Example:**
-```javascript
-const url = mergeUrl("/api/users/:id", {
+```typescript
+const { url } = parseUrl("/api/users/:id", {
   params: { id: "123" },
   query: { filter: "active" },
   baseURL: "https://api.example.com",
@@ -379,7 +392,7 @@ Merge request options, including special handling of headers and signals.
 **Example:**
-```javascript
+```typescript
 const defaultOptions = {
   timeout: 5000,
   headers: { "Content-Type": "application/json" },
@@ -404,7 +417,7 @@ Check if body is a plain object, not special types like FormData or Blob.
 **Example:**
-```javascript
+```typescript
 isBodyJson({ name: "John" }); // true
 isBodyJson(new FormData()); // false
 isBodyJson("string"); // false
@@ -423,7 +436,7 @@ Generate a unique key value based on the request's URL, method, headers, body, q
 **Example:**
-```javascript
+```typescript
 const key = genRequestKey({
   url: "/api/users",
   options: { method: "GET", params: { id: 1 } },
@@ -442,26 +455,40 @@ Used to handle request race conditions, terminating previous requests.
 **Example:**
-```javascript
+```typescript
 const controller = new AbortController();
-const controllers = [];
-raceAbort(controller, controllers); // Terminate previous requests and add current controller
+const controllers: AbortController[] = [];
+// 注意：raceAbort 函数已不再直接导出，而是通过 createRequestStore 使用
 ```
-#### createCache
+#### createRequestStore
+Create request store instance.
+Provides request caching, sharing, and race condition handling.
-Create cache instance.
-Provides request result caching function, supports expiration time.
+**Parameters:**
-**Returns:** Cache object containing get, set, remove methods
+- `options`: Configuration options
+  - `maxCacheSize`: Maximum cache size (default: 100000)
+  - `checkInterval`: Cache check interval in milliseconds (default: 60000)
+**Returns:** Request store object with the following methods:
+- `entry(key)`: Get entry for specific request key
+- `dispose()`: Dispose the store and clear intervals
+- `get(key)`: Get request by key
+- `set(key, value)`: Set request by key
+- `remove(key)`: Remove request by key
+- `getAll()`: Get all requests
+- `removeAll()`: Remove all requests
+- `clearCache()`: Clear all cache
+- `clearExpiredCache()`: Clear expired cache
+- `abortAll()`: Abort all requests
 **Example:**
-```javascript
-const cache = createCache();
-cache.set("key", { data: "value" }, Date.now() + 60000); // Cache for 1 minute
-const data = cache.get("key");
-cache.remove("key");
+```typescript
+const store = createRequestStore({ maxCacheSize: 1000, checkInterval: 30000 });
+// Use store in requests
 ```
 #### deepSort
@@ -472,33 +499,18 @@ Recursively sort the keys of an object to generate a stable object serialization
 **Parameters:**
 - `obj`: Object to sort
+- `sortArr`: Whether to sort arrays (default: false)
 **Returns:** Object with sorted keys
 **Example:**
-```javascript
+```typescript
 const obj = { b: 2, a: 1, c: { z: 3, y: 2 } };
 const sorted = deepSort(obj);
 // Returns: { a: 1, b: 2, c: { y: 2, z: 3 } }
 ```
-#### createShare
-Create request sharing instance.
-Used to share the same request to avoid duplicate requests.
-**Returns:** Sharing object containing get and set methods
-**Example:**
-```javascript
-const share = createShare();
-const promise = fetch("/api/data");
-share.set("key", promise);
-const sharedPromise = share.get("key"); // Get the same promise
-```
 #### createSilentRefresh
 Create silent refresh instance.
@@ -512,7 +524,7 @@ Used to handle silent refresh functionality when token expires.
 **Example:**
-```javascript
+```typescript
 const silentRefresh = createSilentRefresh(async () => {
   // Refresh token logic
   await refreshToken();
@@ -525,6 +537,37 @@ silentRefresh(
 );
 ```
+#### soonFetch
+A lightweight fetch wrapper with caching, sharing, and race condition handling.
+**Parameters:**
+- `config`: Configuration object
+  - `url`: Request URL
+  - `options`: Request options (SoonOptions)
+  - `baseURL`: Base URL
+  - `baseOptions`: Base request options
+  - `store`: Custom request store
+  - `sortRequestKey`: Whether to sort request key
+**Returns:** Promise that resolves to the response
+**Example:**
+```typescript
+const data = await soonFetch<User[]>({
+  url: "/api/users",
+  options: {
+    method: "GET",
+    query: { page: 1 },
+    share: true,
+    staleTime: 5000,
+  },
+  baseURL: "https://api.example.com",
+});
+```
 #### parseWithBase
 Parse base URL configuration.
@@ -538,7 +581,7 @@ Process baseURL, headers, body and other configuration items to generate final r
 **Example:**
-```javascript
+```typescript
 const result = parseWithBase({
   url: "/api/users",
   options: { method: "GET" },
@@ -559,7 +602,7 @@ Used to convert plain objects to FormData format, supports files and regular val
 **Example:**
-```javascript
+```typescript
 const formData = toFormData({
   name: "John",
   avatar: fileBlob,
@@ -567,13 +610,103 @@ const formData = toFormData({
 });
 ```
+#### progressDownload
+Download with progress tracking.
+Used to download files with progress updates.
+**Parameters:**
+- `response`: Response object
+- `onProgress`: Progress callback function
+**Returns:** Promise that resolves to ArrayBuffer
+**Example:**
+```typescript
+const response = await fetch("/api/download");
+const buffer = await progressDownload(response, (progress, downloaded, total) => {
+  console.log(`Progress: ${progress}%, Downloaded: ${downloaded}/${total}`);
+});
+```
+#### progressReadBody
+Read response body with progress tracking.
+Used to read response bodies with progress updates.
+**Parameters:**
+- `body`: ReadableStream<Uint8Array>
+- `onProgress`: Progress callback function
+- `total`: Total size in bytes (default: 0)
+**Returns:** Promise that resolves to ArrayBuffer
+**Example:**
+```typescript
+const response = await fetch("/api/download");
+const buffer = await progressReadBody(response.body!, (progress, downloaded, total) => {
+  console.log(`Progress: ${progress}%, Downloaded: ${downloaded}/${total}`);
+});
+```
+#### parseOptions
+Parse and merge request options.
+Used to process request options, including baseURL, headers, and body.
+**Parameters:**
+- `urlOptions`: Object containing url, options, baseURL, and baseOptions
+**Returns:** Object containing parsed url, options, is_body_json, and abortController
+**Example:**
+```typescript
+const parsed = parseOptions({
+  url: "/api/users",
+  options: { method: "GET", query: { page: 1 } },
+  baseURL: "https://api.example.com",
+  baseOptions: { timeout: 5000 },
+});
+```
+#### requestWithStore
+Request wrapper with store support.
+Used to handle requests with caching, sharing, and race condition handling.
+**Parameters:**
+- `store`: Request store instance
+- `requestFn`: Request function
+- `requestKey`: Request key
+- `fetchAbort`: AbortController
+- `options`: Options object
+**Returns:** Promise that resolves to the response
+**Example:**
+```typescript
+const store = createRequestStore();
+const data = await requestWithStore(store, () => fetch(url, options), requestKey, abortController, {
+  share: true,
+  staleTime: 5000,
+});
+```
 [English](#soon-fetch) | [中文](#soon-fetch-1) | [Installation](#安装-installation)
 <!-- omit in toc -->
 #### soon-fetch
-**极轻量的请求库，不到 5K**
+**极轻量的请求库，不到 6K**
 > - 🌐 自动解析 rest Url 的参数
 > - ⭐ 快捷定义请求 api
@@ -582,7 +715,7 @@ const formData = toFormData({
 > - 🚀 请求竞态
 > - 📝 响应缓存
 > - 🔤 自动处理 JSON
-> - 📏 不到 **5K** , zip 后会更小
+> - 📏 不到 **6K** , zip 后会更小
 > - 💡 用 typescript 有智能类型提醒
 - [示例](#示例)
@@ -605,29 +738,28 @@ const formData = toFormData({
 > [github: soon-admin-react-nextjs ](https://github.com/leafio/soon-admin-react-nextjs)
 ```typescript
-const soon = createSoon(
-  (url, options) => {
-    const isGet = !options?.method || options?.method.toLocaleLowerCase() === "get"
-    return {
-      baseURL: '/api',
-      baseOptions: {
-        timeout: 20 * 1000,
-        headers: new Headers({
-          Authorization: "Bearer " + localStorage.getItem("token"),
-        }),
-        share: isGet ? true : false,
-        staleTime: isGet ? 2 * 1000 : 0,
-      },
-    }
-  },
-  ({ parsed }) => {
-    return <T>() => {
-      return fetch(parsed.url, parsed.options).then((res) =>
-        res.json()
-      ) as Promise<T>;
-    };
-  }
-);
+import { createSoon, soonFetch } from "soon-fetch";
+// 使用 soonFetch 作为基础请求函数
+const request = async <T>(url: string, options?: SoonOptions) => {
+  const isGet = !options?.method || options?.method.toLocaleLowerCase() === "get";
+  const response = await soonFetch<T>({
+    url,
+    options,
+    baseURL: '/api',
+    baseOptions: {
+      timeout: 20 * 1000,
+      headers: new Headers({
+        Authorization: "Bearer " + localStorage.getItem("token"),
+      }),
+      share: isGet ? true : false,
+      staleTime: isGet ? 2 * 1000 : 0,
+    },
+  });
+  return response;
+};
+const soon = createSoon(request);
 /** GET */
 soon.get("/user?id=123");
@@ -641,7 +773,7 @@ soon.post("/login", { body: { username: "admin", password: "123456" } });
 export const login = soon
   .POST("/user/login")
   .Body<{ username: string; password: string }>()
-  .Send<{ token: string }>();
+  .Ok<{ token: string }>();
 //开发工具会有请求和响应的智能提醒
 login({ username: "admin", password: "123" }).then((res) => {
@@ -705,7 +837,7 @@ soon.get(url, { staleTime: 1000 * 60 * 5 });
 import { useEffect, useRef, useState } from "react";
 type User = { name: string; job: string };
-const api = soon.GET("/api/users").Query<{ page: number }>().Send<User[]>();
+const api = soon.GET("/api/users").Query<{ page: number }>().Ok<User[]>();
 export default function App() {
   const refAbort = useRef([]);
   const [list, setList] = useState<User[]>([]);
@@ -733,19 +865,25 @@ export default function App() {
 ```ts
   //可以是 GET POST PATCH PUT DELETE
   //GET 请求数据传递至query,其他方法请求数据传递至body
-  soon.GET(url:string).Query<Query>().Send<Response>()
-  soon.POST(url:string).Body<Body>().Send<Response>()
+  soon.GET(url:string).Query<Query>().Ok<Response>()
+  soon.POST(url:string).Body<Body>().Ok<Response>()
+  soon.GET(url:string).Options({ timeout: 5000 }).Ok<Response>()
+  soon.POST(url:string).Body<Body>().Options({ timeout: 5000 }).Ok<Response>()
   //定义一个api
- export const getUserInfo=soon.GET('/user/:id').Send()
+ export const getUserInfo=soon.GET('/user/:id').Ok()
   //使用
   getUserInfo({id:2}).then(res=>console.log(res))
+  //定义一个带选项的api
+ export const getUserInfoWithOptions=soon.GET('/user/:id').Options({ timeout: 5000 }).Ok()
+  //使用
+  getUserInfoWithOptions({id:2}).then(res=>console.log(res))
   //用typescript,
  export const login=soon
   .POST('/user/login')
   .Body<{username:string,password:string}>()
-  .Send<{token:string}>()
+  .Ok<{token:string}>()
  //开发工具会有请求和响应的智能提醒
   login({username:'admin',password:'123'}).then(res=>{
     localStorage.setItem('token', res.token);
@@ -786,24 +924,32 @@ type SoonOptions = Omit<RequestInit, "body"> & {
 **参数:**
-- `getConfig`: 用于获取请求配置的函数，接收 url 和 options，返回包含 url、options、baseURL 和 baseOptions 的对象
-- `wrapper`: 包装器函数，用于处理请求逻辑
+- `request`: 用于处理实际请求的函数，接收 url 和 options，返回一个 Promise
-**返回:** 包含 request 方法和各种快捷方法的对象
+**返回:** 包含 request 方法、API 方法（GET、POST、PUT、DELETE、PATCH）和快捷方法（get、post、put、delete、patch、head、options）的对象
 **示例:**
-```javascript
+```typescript
 const soon = createSoon(
-  (url, options) => ({ url, options,baseURL：'/api', baseOptions:{timeout: 5000} }),
-  ({ parsed }) =>
-    async (url, options) => {
-      const response = await fetch(parsed.url, parsed.options);
-      return response.json();
-    }
+  async (url, options) => {
+    const response = await fetch(url, options);
+    return response.json();
+  }
 );
 // 使用示例
 const data = await soon.get("/api/users");
+// 定义带选项的 API
+export const login = soon
+  .POST("/user/login")
+  .Body<{ username: string; password: string }>()
+  .Ok<{ token: string }>();
+login({ username: "admin", password: "123" }).then((res) => {
+  localStorage.setItem("token", res.token);
+});
 ```
 #### createShortApi
@@ -819,7 +965,7 @@ const data = await soon.get("/api/users");
 **示例:**
-```javascript
+```typescript
 const API = createShortApi(
   async (url, method, params, query, body, options) => {
     // 处理请求逻辑
@@ -830,7 +976,7 @@ const API = createShortApi(
 );
 // 使用示例
-const getUser = API.GET("/api/users/:id").Send();
+const getUser = API.GET("/api/users/:id").Ok();
 const userData = await getUser({ id: 1 });
 ```
@@ -847,8 +993,8 @@ const userData = await getUser({ id: 1 });
 **示例:**
-```javascript
-const methods = createShortMethods(["get", "post"], (method) => {
+```typescript
+const methods = createShortMethods(["get", "post"] as const, (method) => {
   return (url, options) => fetch(url, { ...options, method });
 });
 // 使用: methods.get('/api/users')
@@ -866,7 +1012,7 @@ const methods = createShortMethods(["get", "post"], (method) => {
 **示例:**
-```javascript
+```typescript
 const [url, options] = parseUrlOptions({
   url: "/api/users/:id",
   options: { params: { id: "123" } },
@@ -887,9 +1033,9 @@ const [url, options] = parseUrlOptions({
 **示例:**
-```javascript
-const headers1 = { "Content-Type": "application/json" };
-const headers2 = { Authorization: "Bearer token" };
+```typescript
+const headers1: HeadersInit = { "Content-Type": "application/json" };
+const headers2: HeadersInit = { Authorization: "Bearer token" };
 const mergedHeaders = mergeHeaders(headers1, headers2);
 ```
@@ -906,7 +1052,7 @@ const mergedHeaders = mergeHeaders(headers1, headers2);
 **示例:**
-```javascript
+```typescript
 const controller1 = new AbortController();
 const controller2 = new AbortController();
 const mergedSignal = mergeSignals(
@@ -929,7 +1075,7 @@ const mergedSignal = mergeSignals(
 **示例:**
-```javascript
+```typescript
 const url = mergeUrl("/api/users/:id", {
   params: { id: "123" },
   query: { filter: "active" },
@@ -951,7 +1097,7 @@ const url = mergeUrl("/api/users/:id", {
 **示例:**
-```javascript
+```typescript
 const defaultOptions = {
   timeout: 5000,
   headers: { "Content-Type": "application/json" },
@@ -976,7 +1122,7 @@ const mergedOptions = mergeOptions(defaultOptions, requestOptions);
 **示例:**
-```javascript
+```typescript
 isBodyJson({ name: "John" }); // true
 isBodyJson(new FormData()); // false
 isBodyJson("string"); // false
@@ -995,7 +1141,7 @@ isBodyJson("string"); // false
 **示例:**
-```javascript
+```typescript
 const key = genRequestKey({
   url: "/api/users",
   options: { method: "GET", params: { id: 1 } },
@@ -1014,26 +1160,40 @@ const key = genRequestKey({
 **示例:**
-```javascript
+```typescript
 const controller = new AbortController();
 const controllers = [];
 raceAbort(controller, controllers); // 终止之前的请求并添加当前控制器
 ```
-#### createCache
+#### createRequestStore
-创建缓存实例。
-提供请求结果缓存功能，支持过期时间。
+创建请求存储实例。
+提供请求缓存、共享和竞态条件处理。
-**返回:** 包含 get、set、remove 方法的缓存对象
+**参数:**
+- `options`: 配置选项
+  - `maxCacheSize`: 最大缓存大小（默认: 100000）
+  - `checkInterval`: 缓存检查间隔（毫秒，默认: 60000）
+**返回:** 请求存储对象，包含以下方法：
+- `entry(key)`: 获取特定请求键的条目
+- `dispose()`: 销毁存储并清除定时器
+- `get(key)`: 根据键获取请求
+- `set(key, value)`: 根据键设置请求
+- `remove(key)`: 根据键移除请求
+- `getAll()`: 获取所有请求
+- `removeAll()`: 移除所有请求
+- `clearCache()`: 清除所有缓存
+- `clearExpiredCache()`: 清除过期缓存
+- `abortAll()`: 中止所有请求
 **示例:**
-```javascript
-const cache = createCache();
-cache.set("key", { data: "value" }, Date.now() + 60000); // 缓存1分钟
-const data = cache.get("key");
-cache.remove("key");
+```typescript
+const store = createRequestStore({ maxCacheSize: 1000, checkInterval: 30000 });
+// 在请求中使用 store
 ```
 #### deepSort
@@ -1044,33 +1204,18 @@ cache.remove("key");
 **参数:**
 - `obj`: 要排序的对象
+- `sortArr`: 是否对数组进行排序（默认: false）
 **返回:** 键排序后的对象
 **示例:**
-```javascript
+```typescript
 const obj = { b: 2, a: 1, c: { z: 3, y: 2 } };
 const sorted = deepSort(obj);
 // 返回: { a: 1, b: 2, c: { y: 2, z: 3 } }
 ```
-#### createShare
-创建请求共享实例。
-用于共享相同请求，避免重复请求。
-**返回:** 包含 get 和 set 方法的共享对象
-**示例:**
-```javascript
-const share = createShare();
-const promise = fetch("/api/data");
-share.set("key", promise);
-const sharedPromise = share.get("key"); // 获取相同 promise
-```
 #### createSilentRefresh
 创建静默刷新实例。
@@ -1084,7 +1229,7 @@ const sharedPromise = share.get("key"); // 获取相同 promise
 **示例:**
-```javascript
+```typescript
 const silentRefresh = createSilentRefresh(async () => {
   // 刷新token逻辑
   await refreshToken();
@@ -1097,6 +1242,37 @@ silentRefresh(
 );
 ```
+#### soonFetch
+一个轻量级的 fetch 包装器，支持缓存、共享和竞态条件处理。
+**参数:**
+- `config`: 配置对象
+  - `url`: 请求 URL
+  - `options`: 请求选项 (SoonOptions)
+  - `baseURL`: 基础 URL
+  - `baseOptions`: 基础请求选项
+  - `store`: 自定义请求存储
+  - `sortRequestKey`: 是否对请求键进行排序
+**返回:** 解析为响应的 Promise
+**示例:**
+```typescript
+const data = await soonFetch<User[]>({
+  url: "/api/users",
+  options: {
+    method: "GET",
+    query: { page: 1 },
+    share: true,
+    staleTime: 5000,
+  },
+  baseURL: "https://api.example.com",
+});
+```
 #### parseWithBase
 解析基础 URL 配置。
@@ -1110,7 +1286,7 @@ silentRefresh(
 **示例:**
-```javascript
+```typescript
 const result = parseWithBase({
   url: "/api/users",
   options: { method: "GET" },
@@ -1131,7 +1307,7 @@ const result = parseWithBase({
 **示例:**
-```javascript
+```typescript
 const formData = toFormData({
   name: "John",
   avatar: fileBlob,
@@ -1139,6 +1315,96 @@ const formData = toFormData({
 });
 ```
+#### progressDownload
+带进度的下载。
+用于下载文件并跟踪进度。
+**参数:**
+- `response`: 响应对象
+- `onProgress`: 进度回调函数
+**返回:** 解析为 ArrayBuffer 的 Promise
+**示例:**
+```typescript
+const response = await fetch("/api/download");
+const buffer = await progressDownload(response, (progress, downloaded, total) => {
+  console.log(`进度: ${progress}%, 已下载: ${downloaded}/${total}`);
+});
+```
+#### progressReadBody
+带进度的读取响应体。
+用于读取响应体并跟踪进度。
+**参数:**
+- `body`: ReadableStream<Uint8Array>
+- `onProgress`: 进度回调函数
+- `total`: 总大小（字节，默认: 0）
+**返回:** 解析为 ArrayBuffer 的 Promise
+**示例:**
+```typescript
+const response = await fetch("/api/download");
+const buffer = await progressReadBody(response.body, (progress, downloaded, total) => {
+  console.log(`进度: ${progress}%, 已下载: ${downloaded}/${total}`);
+});
+```
+#### parseOptions
+解析和合并请求选项。
+用于处理请求选项，包括 baseURL、headers 和 body。
+**参数:**
+- `urlOptions`: 包含 url、options、baseURL 和 baseOptions 的对象
+**返回:** 包含解析后的 url、options、is_body_json 和 abortController 的对象
+**示例:**
+```typescript
+const parsed = parseOptions({
+  url: "/api/users",
+  options: { method: "GET", query: { page: 1 } },
+  baseURL: "https://api.example.com",
+  baseOptions: { timeout: 5000 },
+});
+```
+#### requestWithStore
+带存储支持的请求包装器。
+用于处理带有缓存、共享和竞态条件处理的请求。
+**参数:**
+- `store`: 请求存储实例
+- `requestFn`: 请求函数
+- `requestKey`: 请求键
+- `fetchAbort`: AbortController
+- `options`: 选项对象
+**返回:** 解析为响应的 Promise
+**示例:**
+```typescript
+const store = createRequestStore();
+const data = await requestWithStore(store, () => fetch(url, options), requestKey, abortController, {
+  share: true,
+  staleTime: 5000,
+});
+```
 [English](#soon-fetch) | [中文](#soon-fetch-1) | [Installation](#安装-installation)