@ahoo-wang/fetcher 0.0.2 → 0.0.4

package/README.md

@@ -1,50 +1,57 @@
-# @fetcher/core
+# @ahoo-wang/fetcher
 
-Fetcher-core 是一个基于现代 Fetch API 的 HTTP 客户端库，旨在简化和优化与后端 RESTful API 的交互。它提供了类似于 Axios 的 API，支持路径参数、查询参数、超时设置以及请求和响应拦截器。
+[![npm version](https://img.shields.io/npm/v/@ahoo-wang/fetcher.svg)](https://www.npmjs.com/package/@ahoo-wang/fetcher)
+[![Build Status](https://github.com/Ahoo-Wang/fetcher/actions/workflows/ci.yml/badge.svg)](https://github.com/Ahoo-Wang/fetcher/actions)
+[![codecov](https://codecov.io/gh/Ahoo-Wang/Fetcher/graph/badge.svg?token=CUPgk8DmH5)](https://codecov.io/gh/Ahoo-Wang/Fetcher)
+[![License](https://img.shields.io/npm/l/@ahoo-wang/fetcher.svg)](https://github.com/Ahoo-Wang/fetcher/blob/main/LICENSE)
+[![npm downloads](https://img.shields.io/npm/dm/@ahoo-wang/fetcher.svg)](https://www.npmjs.com/package/@ahoo-wang/fetcher)
+[![Bundle Size](https://img.shields.io/bundlephobia/minzip/@ahoo-wang/fetcher.svg)](https://bundlephobia.com/package/@ahoo-wang/fetcher)
 
-## 特性
+A modern HTTP client library based on the Fetch API, designed to simplify and optimize interactions with backend RESTful APIs. It provides an Axios-like API with support for path parameters, query parameters, timeout settings, and request/response interceptors.
 
-- **兼容 Fetch API**: fetcher 的 API 完全兼容原生 Fetch API，易于上手。
-- **路径和查询参数**: 支持在请求中使用路径参数和查询参数，路径参数使用 `{}` 包裹。
-- **超时设置**: 可以为请求设置超时时间。
-- **请求拦截器**: 支持在请求发送前对请求进行修改。
-- **响应拦截器**: 支持在响应返回后对响应进行处理。
-- **模块化设计**: 代码结构清晰，易于维护和扩展。
-- **TypeScript 支持**: 完整的 TypeScript 类型定义。
+## Features
 
-## 安装
+- **Fetch API Compatible**: Fetcher's API is fully compatible with the native Fetch API, making it easy to get started.
+- **Path and Query Parameters**: Supports path parameters and query parameters in requests, with path parameters wrapped in `{}`.
+- **Timeout Settings**: Request timeout can be configured.
+- **Request Interceptors**: Supports modifying requests before they are sent.
+- **Response Interceptors**: Supports processing responses after they are returned.
+- **Modular Design**: Clear code structure for easy maintenance and extension.
+- **TypeScript Support**: Complete TypeScript type definitions.
 
-使用 pnpm 安装：
+## Installation
+
+Using pnpm:
 
 ```bash
-pnpm add @fetcher/core
+pnpm add @ahoo-wang/fetcher
 ```
 
-使用 npm 安装：
+Using npm:
 
 ```bash
-npm install @fetcher/core
+npm install @ahoo-wang/fetcher
 ```
 
-使用 yarn 安装：
+Using yarn:
 
 ```bash
-yarn add @fetcher/core
+yarn add @ahoo-wang/fetcher
 ```
 
-## 使用示例
+## Usage
 
-### 基本用法
+### Basic Usage
 
 ```typescript
-import { Fetcher } from '@fetcher/core';
+import { Fetcher } from '@ahoo-wang/fetcher';
 
 const fetcher = new Fetcher({
   baseURL: 'https://api.example.com',
   timeout: 5000,
 });
 
-// GET 请求带路径参数和查询参数
+// GET request with path parameters and query parameters
 fetcher
   .get('/users/{id}', {
     pathParams: { id: 123 },
@@ -57,7 +64,7 @@ fetcher
     console.error(error);
   });
 
-// POST 请求带 JSON 数据
+// POST request with JSON body
 fetcher
   .post('/users', {
     body: JSON.stringify({ name: 'John Doe', email: 'john@example.com' }),
@@ -71,17 +78,17 @@ fetcher
   });
 ```
 
-### 拦截器用法
+### Interceptor Usage
 
 ```typescript
-import { Fetcher } from '@fetcher/core';
+import { Fetcher } from '@ahoo-wang/fetcher';
 
 const fetcher = new Fetcher({ baseURL: 'https://api.example.com' });
 
-// 添加请求拦截器
+// Add request interceptor
 const requestInterceptorId = fetcher.interceptors.request.use({
   intercept(request) {
-    // 修改请求配置，例如添加认证头
+    // Modify request configuration, e.g., add auth header
     return {
       ...request,
       headers: {
@@ -92,88 +99,88 @@ const requestInterceptorId = fetcher.interceptors.request.use({
   },
 });
 
-// 添加响应拦截器
+// Add response interceptor
 const responseInterceptorId = fetcher.interceptors.response.use({
   intercept(response) {
-    // 处理响应数据，例如解析 JSON
+    // Process response data, e.g., parse JSON
     return response;
   },
 });
 
-// 添加错误拦截器
+// Add error interceptor
 const errorInterceptorId = fetcher.interceptors.error.use({
   intercept(error) {
-    // 处理错误，例如记录日志
+    // Handle errors, e.g., log them
     console.error('Request failed:', error);
     return error;
   },
 });
 ```
 
-## API 参考
+## API Reference
 
-### Fetcher 类
+### Fetcher Class
 
-核心 HTTP 客户端类，提供各种 HTTP 方法。
+Core HTTP client class that provides various HTTP methods.
 
-#### 构造函数
+#### Constructor
 
 ```typescript
 new Fetcher(options?: FetcherOptions)
 ```
 
-**参数:**
+**Parameters:**
 
-- `options.baseURL`: 基础 URL
-- `options.timeout`: 请求超时时间（毫秒）
-- `options.headers`: 默认请求头
+- `options.baseURL`: Base URL
+- `options.timeout`: Request timeout in milliseconds
+- `options.headers`: Default request headers
 
-#### 方法
+#### Methods
 
-- `fetch(url: string, request?: FetcherRequest): Promise<Response>` - 通用 HTTP 请求方法
-- `get(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - GET 请求
-- `post(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - POST 请求
-- `put(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - PUT 请求
-- `delete(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - DELETE 请求
-- `patch(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - PATCH 请求
-- `head(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - HEAD 请求
-- `options(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - OPTIONS 请求
+- `fetch(url: string, request?: FetcherRequest): Promise<Response>` - Generic HTTP request method
+- `get(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - GET request
+- `post(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - POST request
+- `put(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - PUT request
+- `delete(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - DELETE request
+- `patch(url: string, request?: Omit<FetcherRequest, 'method'>): Promise<Response>` - PATCH request
+- `head(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - HEAD request
+- `options(url: string, request?: Omit<FetcherRequest, 'method' | 'body'>): Promise<Response>` - OPTIONS request
 
-### UrlBuilder 类
+### UrlBuilder Class
 
-URL 构建器，用于构建带参数的完整 URL。
+URL builder for constructing complete URLs with parameters.
 
-#### 方法
+#### Methods
 
-- `build(path: string, pathParams?: Record<string, any>, queryParams?: Record<string, any>): string` - 构建完整 URL
+- `build(path: string, pathParams?: Record<string, any>, queryParams?: Record<string, any>): string` - Build complete URL
 
-### InterceptorManager 类
+### InterceptorManager Class
 
-拦截器管理器，用于管理同一类型的多个拦截器。
+Interceptor manager for managing multiple interceptors of the same type.
 
-#### 方法
+#### Methods
 
-- `use(interceptor: T): number` - 添加拦截器，返回拦截器 ID
-- `eject(index: number): void` - 根据 ID 移除拦截器
-- `clear(): void` - 清空所有拦截器
-- `intercept(data: R): Promise<R>` - 依次执行所有拦截器
+- `use(interceptor: T): number` - Add interceptor, returns interceptor ID
+- `eject(index: number): void` - Remove interceptor by ID
+- `clear(): void` - Clear all interceptors
+- `intercept(data: R): Promise<R>` - Execute all interceptors sequentially
 
-### FetcherInterceptors 类
+### FetcherInterceptors Class
 
-Fetcher 拦截器集合，包含请求、响应和错误拦截器管理器。
+Fetcher interceptor collection, including request, response, and error interceptor managers.
 
-#### 属性
+#### Properties
 
-- `request: RequestInterceptorManager` - 请求拦截器管理器
-- `response: ResponseInterceptorManager` - 响应拦截器管理器
-- `error: ErrorInterceptorManager` - 错误拦截器管理器
+- `request: RequestInterceptorManager` - Request interceptor manager
+- `response: ResponseInterceptorManager` - Response interceptor manager
+- `error: ErrorInterceptorManager` - Error interceptor manager
 
-## 完整示例
+## Complete Example
 
 ```typescript
-import { Fetcher } from '@fetcher/core';
+import { Fetcher } from '@ahoo-wang/fetcher';
 
-// 创建 fetcher 实例
+// Create fetcher instance
 const fetcher = new Fetcher({
   baseURL: 'https://api.example.com',
   timeout: 10000,
@@ -182,7 +189,7 @@ const fetcher = new Fetcher({
   },
 });
 
-// 添加请求拦截器 - 添加认证头
+// Add request interceptor - Add auth header
 fetcher.interceptors.request.use({
   intercept(request) {
     return {
@@ -195,7 +202,7 @@ fetcher.interceptors.request.use({
   },
 });
 
-// 添加响应拦截器 - 自动解析 JSON
+// Add response interceptor - Auto-parse JSON
 fetcher.interceptors.response.use({
   intercept(response) {
     if (response.headers.get('content-type')?.includes('application/json')) {
@@ -207,7 +214,7 @@ fetcher.interceptors.response.use({
   },
 });
 
-// 添加错误拦截器 - 统一错误处理
+// Add error interceptor - Unified error handling
 fetcher.interceptors.error.use({
   intercept(error) {
     if (error.name === 'FetchTimeoutError') {
@@ -219,7 +226,7 @@ fetcher.interceptors.error.use({
   },
 });
 
-// 使用 fetcher 发起请求
+// Use fetcher to make requests
 fetcher
   .get('/users/{id}', {
     pathParams: { id: 123 },
@@ -234,18 +241,18 @@ fetcher
   });
 ```
 
-## 测试
+## Testing
 
-运行测试：
+Run tests:
 
 ```bash
 pnpm test
 ```
 
-## 贡献
+## Contributing
 
-欢迎任何形式的贡献！请查看 [贡献指南](https://github.com/Ahoo-Wang/fetcher/blob/main/CONTRIBUTING.md) 了解更多信息。
+Contributions of any kind are welcome! Please see the [contributing guide](https://github.com/Ahoo-Wang/fetcher/blob/main/CONTRIBUTING.md) for more details.
 
-## 许可证
+## License
 
-本项目采用 [Apache-2.0](https://opensource.org/licenses/Apache-2.0) 许可证。
+This project is licensed under the [Apache-2.0 License](https://opensource.org/licenses/Apache-2.0).

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,IAAI,SAAS;CACd"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,IAAI,SAAS;CACd"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Core library providing basic HTTP client functionality for Fetcher",
   "keywords": [
     "fetch",