soon-fetch 4.0.0-beta.4 → 4.0.0

package/README.md

@@ -180,6 +180,10 @@ export const login = soon
 login({ username: "admin", password: "123" }).then((res) => {
   localStorage.setItem("token", res.token);
 });
+
+//with Params for type safety
+export const getUserById = soon.GET("/user/:id").Params<{ id: number }>().Ok<{ id: number; name: string }>();
+getUserById({ id: 1 }).then((res) => console.log(res));
 ```
 
 ### API
@@ -270,6 +274,10 @@ const API = createShortApi(
 // Usage example
 const getUser = API.GET("/api/users/:id").Ok<{ id: number; name: string }>();
 const userData = await getUser({ id: 1 });
+
+// With Params for type safety
+const getUserById = API.GET("/api/users/:id").Params<{ id: number }>().Ok<{ id: number; name: string }>();
+const userData = await getUserById({ id: 1 });
 ```
 
 #### createShortMethods
@@ -295,7 +303,7 @@ const methods = createShortMethods(["get", "post"] as const, (method) => {
 // Usage: methods.get<{ id: number; name: string }[]>('/api/users')
 ```
 
-#### parseUrlOptions
+#### parseOptions
 
 Parse URL options.
 
@@ -303,17 +311,17 @@ Parse URL options.
 
 - `urlOptions`: Object containing url, options, baseURL and baseOptions
 
-**Returns:** Tuple of processed url and options
+**Returns:** Object containing parsed url, options, is_body_json, and abortController
 
 **Example:**
 
 ```typescript
-const [url, options] = parseUrlOptions({
+const parsed = parseOptions({
   url: "/api/users/:id",
   options: { params: { id: "123" } },
   baseURL: "https://api.example.com",
 });
-// Returns: ['https://api.example.com/api/users/123', options]
+// Returns: { url: 'https://api.example.com/api/users/123', options: {...}, is_body_json: false, abortController: AbortController }
 ```
 
 #### mergeHeaders
@@ -356,7 +364,7 @@ const mergedSignal = mergeSignals(
 );
 ```
 
-#### mergeUrl
+#### parseUrl
 
 Merge URL and its related parameters.
 Handle baseURL, path parameters and query parameters to generate complete URL.
@@ -443,24 +451,6 @@ const key = genRequestKey({
 });
 ```
 
-#### raceAbort
-
-Race condition handling function.
-Used to handle request race conditions, terminating previous requests.
-
-**Parameters:**
-
-- `abortController`: Controller of the current request
-- `controllers`: Array of existing controllers
-
-**Example:**
-
-```typescript
-const controller = new AbortController();
-const controllers: AbortController[] = [];
-// 注意：raceAbort 函数已不再直接导出，而是通过 createRequestStore 使用
-```
-
 #### createRequestStore
 
 Create request store instance.
@@ -568,27 +558,6 @@ const data = await soonFetch<User[]>({
 });
 ```
 
-#### parseWithBase
-
-Parse base URL configuration.
-Process baseURL, headers, body and other configuration items to generate final request configuration.
-
-**Parameters:**
-
-- `urlOptions`: Object containing url, options, baseURL and baseOptions
-
-**Returns:** Processed url, options, is_body_json and abortController
-
-**Example:**
-
-```typescript
-const result = parseWithBase({
-  url: "/api/users",
-  options: { method: "GET" },
-  baseURL: "https://api.example.com",
-});
-```
-
 #### toFormData
 
 Convert object to FormData.
@@ -653,28 +622,6 @@ const buffer = await progressReadBody(response.body!, (progress, downloaded, tot
 });
 ```
 
-#### 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.
@@ -779,6 +726,10 @@ export const login = soon
 login({ username: "admin", password: "123" }).then((res) => {
   localStorage.setItem("token", res.token);
 });
+
+//使用 Params 进行类型安全定义
+export const getUserById = soon.GET("/user/:id").Params<{ id: number }>().Ok<{ id: number; name: string }>();
+getUserById({ id: 1 }).then((res) => console.log(res));
 ```
 
 ### 特别功能
@@ -888,6 +839,10 @@ export default function App() {
   login({username:'admin',password:'123'}).then(res=>{
     localStorage.setItem('token', res.token);
   })
+
+  //使用 Params 进行类型安全定义
+  export const getUserById = soon.GET('/user/:id').Params<{ id: number }>().Ok<{ id: number; name: string }>();
+  getUserById({ id: 1 }).then(res => console.log(res));
 ```
 
 ### API
@@ -969,7 +924,7 @@ login({ username: "admin", password: "123" }).then((res) => {
 const API = createShortApi(
   async (url, method, params, query, body, options) => {
     // 处理请求逻辑
-    const _url = mergeUrl(url, { params, query });
+    const { url: _url } = parseUrl(url, { params, query });
     const response = await fetch(_url, { ...options, method, body });
     return response.json();
   }
@@ -978,6 +933,10 @@ const API = createShortApi(
 // 使用示例
 const getUser = API.GET("/api/users/:id").Ok();
 const userData = await getUser({ id: 1 });
+
+// 使用 Params 进行类型安全定义
+const getUserById = API.GET("/api/users/:id").Params<{ id: number }>().Ok<{ id: number; name: string }>();
+const userData = await getUserById({ id: 1 });
 ```
 
 #### createShortMethods
@@ -1000,7 +959,7 @@ const methods = createShortMethods(["get", "post"] as const, (method) => {
 // 使用: methods.get('/api/users')
 ```
 
-#### parseUrlOptions
+#### parseOptions
 
 解析 URL 选项。
 
@@ -1008,17 +967,17 @@ const methods = createShortMethods(["get", "post"] as const, (method) => {
 
 - `urlOptions`: 包含 url、options、baseURL 和 baseOptions 的对象
 
-**返回:** 处理后的 url 和 options 元组
+**返回:** 包含解析后的 url、options、is_body_json 和 abortController 的对象
 
 **示例:**
 
 ```typescript
-const [url, options] = parseUrlOptions({
+const parsed = parseOptions({
   url: "/api/users/:id",
   options: { params: { id: "123" } },
   baseURL: "https://api.example.com",
 });
-// 返回: ['https://api.example.com/api/users/123', options]
+// 返回: { url: 'https://api.example.com/api/users/123', options: {...}, is_body_json: false, abortController: AbortController }
 ```
 
 #### mergeHeaders
@@ -1061,7 +1020,7 @@ const mergedSignal = mergeSignals(
 );
 ```
 
-#### mergeUrl
+#### parseUrl
 
 合并 URL 及其相关参数。
 处理 baseURL、路径参数和查询参数，生成完整 URL。
@@ -1076,7 +1035,7 @@ const mergedSignal = mergeSignals(
 **示例:**
 
 ```typescript
-const url = mergeUrl("/api/users/:id", {
+const url = parseUrl("/api/users/:id", {
   params: { id: "123" },
   query: { filter: "active" },
   baseURL: "https://api.example.com",
@@ -1148,24 +1107,6 @@ const key = genRequestKey({
 });
 ```
 
-#### raceAbort
-
-竞态处理函数。
-用于处理请求竞态，终止之前的请求。
-
-**参数:**
-
-- `abortController`: 当前请求的控制器
-- `controllers`: 已存在的控制器数组
-
-**示例:**
-
-```typescript
-const controller = new AbortController();
-const controllers = [];
-raceAbort(controller, controllers); // 终止之前的请求并添加当前控制器
-```
-
 #### createRequestStore
 
 创建请求存储实例。
@@ -1273,27 +1214,6 @@ const data = await soonFetch<User[]>({
 });
 ```
 
-#### parseWithBase
-
-解析基础 URL 配置。
-处理 baseURL、headers、body 等配置项，生成最终的请求配置。
-
-**参数:**
-
-- `urlOptions`: 包含 url、options、baseURL 和 baseOptions 的对象
-
-**返回:** 处理后的 url、options、is_body_json 和 abortController
-
-**示例:**
-
-```typescript
-const result = parseWithBase({
-  url: "/api/users",
-  options: { method: "GET" },
-  baseURL: "https://api.example.com",
-});
-```
-
 #### toFormData
 
 将对象转换为 FormData。
@@ -1358,28 +1278,6 @@ const buffer = await progressReadBody(response.body, (progress, downloaded, tota
 });
 ```
 
-#### 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
 
 带存储支持的请求包装器。

package/dist/index.d.cts

@@ -194,14 +194,14 @@ declare function requestWithStore<T>(store: ReturnType<typeof createRequestStore
   aborts?: [AbortController] | [];
   staleTime?: number;
 }): Promise<T>;
-declare const soonFetch: <T>(config: {
+declare const soonFetch: (config: {
   url: string;
   options?: SoonOptions;
   baseURL?: string;
   baseOptions?: SoonOptions;
   store?: ReturnType<typeof createRequestStore>;
   sortRequestKey?: boolean;
-}) => Promise<T>;
+}) => Promise<Response>;
 declare function createSoon<Options extends SoonOptions>(request: <T>(url: string, options?: Options) => Promise<T>): {
   options: <T>(url: string, options?: Options) => Promise<T>;
   get: <T>(url: string, options?: Options) => Promise<T>;

package/dist/index.d.mts

@@ -194,14 +194,14 @@ declare function requestWithStore<T>(store: ReturnType<typeof createRequestStore
   aborts?: [AbortController] | [];
   staleTime?: number;
 }): Promise<T>;
-declare const soonFetch: <T>(config: {
+declare const soonFetch: (config: {
   url: string;
   options?: SoonOptions;
   baseURL?: string;
   baseOptions?: SoonOptions;
   store?: ReturnType<typeof createRequestStore>;
   sortRequestKey?: boolean;
-}) => Promise<T>;
+}) => Promise<Response>;
 declare function createSoon<Options extends SoonOptions>(request: <T>(url: string, options?: Options) => Promise<T>): {
   options: <T>(url: string, options?: Options) => Promise<T>;
   get: <T>(url: string, options?: Options) => Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "soon-fetch",
-  "version": "4.0.0-beta.4",
+  "version": "4.0.0",
   "description": "a request lib alternative to axios with timeout, request reusing, race, response cache ...",
   "homepage": "https://github.com/leafio/soon-fetch",
   "type": "module",
@@ -21,16 +21,19 @@
     "request",
     "fetch",
     "lightweight",
+    "axios",
     "timeout",
-    "http",
-    "axios"
+    "request reusing",
+    "race",
+    "response cache",
+    "abort controller"
   ],
-  "author": "",
+  "author": "leaf",
   "license": "MIT",
   "devDependencies": {
+    "@types/node": "^20.11.30",
     "tsdown": "^0.21.7",
-    "tsup": "^8.5.1",
-    "typescript": "^5.6.2",
-    "vitest": "^2.1.1"
+    "typescript": "^5.4.3",
+    "vitest": "^1.3.1"
   }
-}
+}