@ureq/lib-hash 0.0.3 → 0.0.4

package/README.md

@@ -15,37 +15,41 @@ pnpm add @ureq/lib-hash
 ## 使用
 
 ```typescript
-import { DefaultHashService } from '@ureq/lib-hash';
+import { generateHash, generateRequestHash } from '@ureq/lib-hash';
 
-const hashService = new DefaultHashService();
+// 生成字符串哈希
+const hash = generateHash('some-string');
 
 // 生成请求哈希
-const requestHash = hashService.generateRequestHash(
+const requestHash = generateRequestHash(
   'GET',
   '/api/users',
   null,
   { params: { page: 1 } }
 );
-
-// 生成字符串哈希
-const strHash = hashService.hashString('some-string');
 ```
 
 ## API
 
-### DefaultHashService
+### generateHash
+
+生成字符串的哈希值。
+
+```typescript
+function generateHash(input: string): string
+```
+
+### generateRequestHash
+
+生成请求的唯一哈希值。
 
 ```typescript
-class DefaultHashService implements HashService {
-  generateRequestHash(
-    method: string,
-    url: string,
-    data?: any,
-    options?: RequestOptions
-  ): string;
-  
-  hashString(str: string): string;
-}
+function generateRequestHash(
+  method: string,
+  url: string,
+  data?: any,
+  options?: Record<string, any>
+): string
 ```
 
 ## 功能
@@ -59,40 +63,28 @@ class DefaultHashService implements HashService {
 - 请求标识
 
 ```typescript
-const hash1 = hashService.generateRequestHash('GET', '/users', null, { params: { page: 1 } });
-const hash2 = hashService.generateRequestHash('GET', '/users', null, { params: { page: 1 } });
+import { generateRequestHash } from '@ureq/lib-hash';
+
+const hash1 = generateRequestHash('GET', '/users', null, { params: { page: 1 } });
+const hash2 = generateRequestHash('GET', '/users', null, { params: { page: 1 } });
 
 console.log(hash1 === hash2);  // true - 相同的请求生成相同的哈希
 ```
 
-### hashString
+### generateHash
 
 生成字符串的哈希值。
 
 ```typescript
-const hash = hashService.hashString('hello world');
+import { generateHash } from '@ureq/lib-hash';
+
+const hash = generateHash('hello world');
 console.log(hash);  // 生成的哈希值
 ```
 
 ## 哈希算法
 
-默认使用简单的字符串哈希算法，适用于大多数场景。如需更强的哈希算法，可以自定义实现：
-
-```typescript
-import { HashService } from '@ureq/business';
-import crypto from 'crypto';
-
-class CryptoHashService implements HashService {
-  generateRequestHash(method: string, url: string, data?: any, options?: any): string {
-    const str = JSON.stringify({ method, url, data, options });
-    return this.hashString(str);
-  }
-  
-  hashString(str: string): string {
-    return crypto.createHash('sha256').update(str).digest('hex');
-  }
-}
-```
+使用简单高效的字符串哈希算法，将输入转换为 32 位整数，然后转换为 36 进制字符串。适用于大多数场景。
 
 ## 使用场景
 
@@ -101,15 +93,15 @@ class CryptoHashService implements HashService {
 ```typescript
 import { Request } from '@ureq/core';
 import { FetchRequestor } from '@ureq/impl-fetch';
-import { DefaultHashService } from '@ureq/lib-hash';
-
-const hashService = new DefaultHashService();
+import { generateRequestHash } from '@ureq/lib-hash';
 
 const request = new Request(
   new FetchRequestor(),
   {
     idempotent: {
-      hashService,
+      getRequestId: (method, url, data, options) => {
+        return generateRequestHash(method, url, data, options);
+      },
       dedupeTime: 1000
     }
   }
@@ -119,12 +111,14 @@ const request = new Request(
 ### 缓存键生成
 
 ```typescript
+import { generateRequestHash } from '@ureq/lib-hash';
+
 const request = new Request(
   new FetchRequestor(),
   {
     cache: {
       getCacheKey: (url, options) => {
-        return hashService.generateRequestHash('GET', url, null, options);
+        return generateRequestHash('GET', url, null, options);
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ureq/lib-hash",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Hash utilities for universal request library",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -18,6 +18,6 @@
   "scripts": {
     "build": "tsup --config tsup.config.ts",
     "dev": "tsup --config tsup.config.ts --watch",
-    "test": "vitest"
+    "test": "vitest --run"
   }
 }