@kevisual/query 0.0.1 → 0.0.2-alpha.0

package/dist/adapter.d.ts

@@ -2,6 +2,7 @@ type AdapterOpts = {
     url: string;
     headers?: Record<string, string>;
     body?: Record<string, any>;
+    timeout?: number;
 };
 export declare const adapter: (opts: AdapterOpts) => Promise<any>;
 export {};

package/dist/index.d.ts

@@ -4,20 +4,48 @@ type Fn = (opts: {
     headers?: Record<string, string>;
     body?: Record<string, any>;
     [key: string]: any;
+    timeout?: number;
 }) => Promise<Record<string, any>>;
 type QueryOpts = {
     url?: string;
     adapter?: typeof adapter;
     headers?: Record<string, string>;
+    timeout?: number;
 };
+type Data = {
+    path?: string;
+    key?: string;
+    payload?: Record<string, any>;
+    [key: string]: any;
+};
+type Result<S = any> = {
+    code: number;
+    data?: S;
+    message?: string;
+    success: boolean;
+};
+type DataOpts = Partial<QueryOpts> & {
+    beforeRequest?: Fn;
+    afterResponse?: (result: Result) => Promise<any>;
+};
+/**
+ * const query = new Query();
+ * const res = await query.post({
+ *   path: 'demo',
+ *   key: '1',
+ *  });
+ */
 export declare class Query {
     adapter: typeof adapter;
     url: string;
     beforeRequest?: Fn;
+    afterResponse?: (result: Result) => Promise<any>;
     headers?: Record<string, string>;
+    timeout?: number;
     constructor(opts: QueryOpts);
-    get(params: Record<string, any>): Promise<any>;
-    post(body: Record<string, any>): Promise<any>;
+    get<T, S>(params: Record<string, any> & Data & T, options?: DataOpts): Promise<Result<S>>;
+    post<T, S>(body: Record<string, any> & Data & T, options?: DataOpts): Promise<Result<S>>;
     before(fn: Fn): void;
+    after(fn: (result: Result) => Promise<any>): void;
 }
 export { adapter };

package/dist/index.js

@@ -1,4 +1,10 @@
 const adapter = async (opts) => {
+    const controller = new AbortController();
+    const signal = controller.signal;
+    const timeout = opts.timeout || 60000; // 默认超时时间为 60s
+    const timer = setTimeout(() => {
+        controller.abort();
+    }, timeout);
     return fetch(opts.url, {
         method: 'POST',
         headers: {
@@ -6,6 +12,7 @@ const adapter = async (opts) => {
             ...opts.headers,
         },
         body: JSON.stringify(opts.body),
+        signal,
     })
         .then((response) => {
         // 获取 Content-Type 头部信息
@@ -26,38 +33,66 @@ const adapter = async (opts) => {
         return {
             code: 500,
         };
+    })
+        .finally(() => {
+        clearTimeout(timer);
     });
 };
 
+/**
+ * const query = new Query();
+ * const res = await query.post({
+ *   path: 'demo',
+ *   key: '1',
+ *  });
+ */
 class Query {
     adapter;
     url;
     beforeRequest;
+    afterResponse;
     headers;
+    timeout;
     constructor(opts) {
         this.adapter = opts.adapter || adapter;
         this.url = opts.url || '/api/router';
         this.headers = opts.headers || {
             'Content-Type': 'application/json',
         };
+        this.timeout = opts.timeout || 60000; // 默认超时时间为 60s
     }
-    async get(params) {
-        return this.post(params);
+    async get(params, options) {
+        return this.post(params, options);
     }
-    async post(body) {
+    async post(body, options) {
+        const url = options?.url || this.url;
+        const headers = { ...this.headers, ...options?.headers };
+        const adapter = options?.adapter || this.adapter;
+        const beforeRequest = options?.beforeRequest || this.beforeRequest;
+        const timeout = options?.timeout || this.timeout;
         const req = {
-            url: this.url,
-            headers: this.headers,
+            url: url,
+            headers: headers,
             body,
+            timeout,
         };
-        if (this.beforeRequest) {
-            await this.beforeRequest(req);
+        if (beforeRequest) {
+            await beforeRequest(req);
         }
-        return this.adapter(req);
+        return adapter(req).then(async (res) => {
+            res.success = res.code === 200;
+            if (options?.afterResponse) {
+                return await options.afterResponse(res);
+            }
+            return res;
+        });
     }
     before(fn) {
         this.beforeRequest = fn;
     }
+    after(fn) {
+        this.afterResponse = fn;
+    }
 }
 
 export { Query, adapter };

package/dist/node-adapter.js

@@ -5,7 +5,6 @@ const nodeAdapter = async (opts) => {
         const postData = JSON.stringify(opts.body || '');
         const _url = new URL(opts.url);
         const { hostname, port, pathname } = _url;
-        console.log('hostname:', hostname, port, pathname);
         const options = {
             hostname: hostname,
             port: port,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kevisual/query",
-  "version": "0.0.1",
+  "version": "0.0.2-alpha.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -1,2 +1,36 @@
 # query
 
+对应的 fetch 内容的一部分功能的封装。
+
+主要目的：请求路径默认`/api/router`，使用`post`,`post`的数据分流使用`path`和`key`.
+
+## query
+
+
+```ts
+const query = new Query();
+const res = await query.post({
+  path: 'demo',
+  key: '1',
+});
+```
+
+### 参数
+
+```ts
+type QueryOpts = {
+  url?: string;
+  adapter?: typeof adapter;
+  headers?: Record<string, string>;
+  timeout?: number;
+};
+type Data = {
+  path?: string;
+  key?: string;
+  [key: string]: any;
+};
+// 额外功能
+type DataOpts = Partial<QueryOpts> & {
+  beforeRequest?: Fn;
+};
+```