create-request 0.0.1-beta.9 → 1.1.0

package/README.md

@@ -3,36 +3,58 @@
 [![npm version](https://img.shields.io/npm/v/create-request.svg)](https://www.npmjs.com/package/create-request)
 [![License](https://img.shields.io/npm/l/create-request.svg)](https://github.com/DanielAmenou/create-request/blob/main/LICENSE)
 [![Bundle Size](https://img.shields.io/bundlephobia/minzip/create-request)](https://bundlephobia.com/package/create-request)
+[![TypeScript](https://img.shields.io/badge/TypeScript-4.7%2B-blue)](https://www.typescriptlang.org/)
 
 `create-request` is a modern TypeScript library that transforms how you make API calls. Built as an elegant wrapper around the native Fetch API, it provides a chainable, fluent interface that dramatically reduces boilerplate while adding powerful features like automatic retries, timeout handling, and comprehensive error management.
 
+## Table of Contents
+
+- [Core Features](#core-features)
+- [Why create-request](#why-create-request)
+- [Installation](#installation)
+- [Basic Usage](#basic-usage)
+- [Advanced Usage](#advanced-usage)
+- [GraphQL Support](#graphql-support)
+- [Interceptors](#interceptors)
+- [TypeScript Support](#typescript-support)
+- [CSRF Protection](#csrf-protection)
+- [Performance Considerations](#performance-considerations)
+- [Browser Support](#browser-support)
+- [Comparison of JavaScript HTTP Client Libraries](#comparison-of-javascript-http-client-libraries)
+- [License](#license)
+
 ## Core Features
 
-- ⏱️ **Timeout Support** - Set timeouts for any request
 - 🚀 **Performance** - Tiny bundle size with zero dependencies
 - 🚧 **Error Handling** - Detailed error info with custom error class
-- 🔐 **Auth Helpers** - Simple methods for common authentication patterns
 - ⛓️ **Chainable API** - Build and execute requests with a fluent interface
-- 📉 **Reduced Boilerplate** - Write 60% less code for common API operations
-- 🔁 **Automatic Retries** - Retry failed requests with customizable settings
+- ⏱️ **Timeout Support** - Set timeouts for requests with automatic aborts
 - 🛡️ **Type Safety** - Full TypeScript support with intelligent type inference
-- 📝 **Response Caching** - Flexible caching system with multiple storage options
+- 🔐 **Auth Helpers** - Simple methods for common authentication patterns
+- 🔍 **Data Selection** - Extract and transform specific data from responses
+- 🔁 **Automatic Retries** - Retry failed requests with customizable settings
+- 📉 **Reduced Boilerplate** - Write 60% less code for common API operations
+- 🔒 **CSRF Protection** - Built-in safeguards against cross-site request forgery
+- 🛑 **Request Cancellation** - Abort requests on demand with AbortController integration
+- 🔌 **Interceptors** - Global and per-request interceptors for requests, responses, and errors
+- 🔷 **GraphQL Support** - Built-in GraphQL query and mutation helpers
 
 ## Why create-request?
 
 **API interactions often require repetitive code patterns** - handling HTTP status checks, parsing responses, managing errors, and dealing with TypeScript types. `create-request` provides a clean, efficient solution with an elegant API that separates request building from execution:
 
+### With Regular Fetch
+
 ```typescript
-// Before: Regular fetch
 async function createUser(userData) {
   try {
-    const response = await fetch('https://api.example.com/users', {
-      method: 'POST',
+    const response = await fetch("https://api.example.com/users", {
+      method: "POST",
       headers: {
-        'Content-Type': 'application/json',
-        'Authorization': 'Basic ' + btoa('username:password')
+        "Content-Type": "application/json",
+        Authorization: "Basic " + btoa("username:password"),
       },
-      body: JSON.stringify(userData)
+      body: JSON.stringify(userData),
     });
 
     if (!response.ok) {
@@ -41,22 +63,25 @@ async function createUser(userData) {
     const data = await response.json();
     return data;
   } catch (error) {
-    console.error('Fetch error:', error);
+    console.error("Fetch error:", error);
     throw error;
   }
 }
+```
 
-// After: With create-request
-import create from 'create-request';
+### With create-request
+
+```typescript
+import create from "create-request";
 
 function createUser(userData) {
-  return create.post()
-    .withBasicAuth('username', 'password')
-    .withBody(userData)
-    .sendTo('https://api.example.com/users')
-    .getData<User>()
+  return create
+    .post("https://api.example.com/users")
+    .withBasicAuth("username", "password")
+    .withBody(userData) // Content-Type automatically set to application/json
+    .getData<User>() // Type-safe response handling
     .catch(error => {
-      console.error('Fetch error:', error);
+      console.error("Fetch error:", error);
       throw error;
     });
 }
@@ -65,13 +90,14 @@ function createUser(userData) {
 ## Installation
 
 ```bash
+# npm
 npm install create-request
-```
 
-Or with yarn:
-
-```bash
+# yarn
 yarn add create-request
+
+# pnpm
+pnpm add create-request
 ```
 
 ## Basic Usage
@@ -79,16 +105,16 @@ yarn add create-request
 ### Creating Requests
 
 ```typescript
-import create from 'create-request';
-
-// Create different request types
-const getRequest = create.get();
-const postRequest = create.post();
-const putRequest = create.put();
-const headRequest = create.head();
-const deleteRequest = create.del();
-const patchRequest = create.patch();
-const optionsRequest = create.options();
+import create from "create-request";
+
+// Create different request types with URL
+const getRequest = create.get("https://api.example.com/users"); // GET
+const putRequest = create.put("https://api.example.com/users/1"); // PUT
+const postRequest = create.post("https://api.example.com/users"); // POST
+const headRequest = create.head("https://api.example.com/users/1"); // HEAD
+const patchRequest = create.patch("https://api.example.com/users/1"); // PATCH
+const deleteRequest = create.del("https://api.example.com/users/1"); // DELETE
+const optionsRequest = create.options("https://api.example.com/users"); // OPTIONS
 ```
 
 ### Request Configuration
@@ -96,13 +122,20 @@ const optionsRequest = create.options();
 The library provides a comprehensive set of configuration methods that can be chained together to customize your requests:
 
 ```typescript
-import create, { RequestPriority, CredentialsPolicy, RequestMode, CacheMode, RedirectMode, ReferrerPolicy } from 'create-request';
+import create, {
+  RequestPriority,
+  CredentialsPolicy,
+  RedirectMode,
+  ReferrerPolicy,
+  SameSitePolicy,
+} from "create-request";
 
 // Configure request options
-const request = create.get()
+const request = create
+  .get("https://api.example.com/users")
   // Basic headers
-  .withHeaders({ 'X-API-Key': 'abc123', 'Accept-Language': 'en-US' })
-  .withHeader('Custom-Header', 'value') // Add a single header
+  .withHeaders({ "X-API-Key": "abc123", "Accept-Language": "en-US" })
+  .withHeader("Custom-Header", "value") // Add a single header
 
   // Timeout settings
   .withTimeout(5000) // Request will abort after 5 seconds
@@ -114,138 +147,209 @@ const request = create.get()
   })
 
   // Authentication methods
-  .withBearerToken('your-token') // Adds Authorization: Bearer your-token
-  .withBasicAuth('username', 'password') // HTTP Basic Authentication
+  .withBearerToken("your-token") // Adds Authorization: Bearer your-token
+  .withBasicAuth("username", "password") // HTTP Basic Authentication
+  .withAuthorization("auth-scheme value") // Custom authorization header
+
+  // Add a single cookie
+  .withCookie("language", "en-US")
+
+  // Add multiple cookies
+  .withCookies({
+    sessionId: "abc123",
+    preferences: { value: "dark-mode", secure: true },
+    tracking: { value: "enabled", sameSite: SameSitePolicy.STRICT },
+  })
 
-  // URL parameters
-  .withQueryParams({ search: 'term', page: 1, limit: 20 })
-  .withQueryParam('filter', 'active') // Add a single query parameter
+  // URL parameters (supports arrays, null/undefined filtering, and all types)
+  .withQueryParams({ search: "term", page: 1, limit: 20, tags: ["js", "ts"] })
+  .withQueryParam("filter", "active") // Add a single query parameter
+  .withQueryParam("ids", [1, 2, 3]) // Array values create multiple query params
 
   // Request body configuration (for POST/PUT/PATCH)
-  .withContentType('application/json') // Set specific content type
+  .withContentType("application/json") // Set specific content type
 
   // Fetch API options
-  .withCredentials(CredentialsPolicy.INCLUDE) // Includes cookies with cross-origin requests
-  .withMode(RequestMode.CORS) // Controls CORS behavior
-  .withRedirect(RedirectMode.FOLLOW) // Controls redirect behavior (follow, error, manual)
-  .withReferrer('https://example.com') // Sets request referrer
-  .withReferrerPolicy(ReferrerPolicy.NO_REFERRER_WHEN_DOWNGRADE) // Controls referrer policy
-  .withPriority(RequestPriority.HIGH) // Sets request priority
+  // Note: These methods support three styles - Fluent API (shown below), Enum-based (e.g., .withMode(RequestMode.CORS)), or String-based (e.g., .withMode("cors"))
+  .withCredentials.INCLUDE() // Includes cookies with cross-origin requests
+  .withMode.CORS() // Controls CORS behavior
+  .withRedirect.FOLLOW() // Controls redirect behavior (follow, error, manual)
+  .withReferrer("https://example.com") // Sets request referrer
+  .withReferrerPolicy.NO_REFERRER_WHEN_DOWNGRADE() // Controls referrer policy
+  .withPriority.HIGH() // Sets request priority
+  .withKeepAlive(true); // Keeps connection alive after the page is unloaded
 ```
 
 Each configuration method returns the request object, allowing for a fluent interface where methods can be chained together. You can configure only what you need for a specific request:
 
 ```typescript
 // Simple example with just what's needed
-const searchUsers = create.get()
+const users = await create
+  .get("https://api.example.com/users")
   .withBearerToken(userToken)
   .withQueryParams({ q: searchTerm, limit: 20 })
-  .withTimeout(3000);
-
-// Now execute the request
-const users = await searchUsers.sendTo('https://api.example.com/users').getData();
-```
-
-You can also create reusable base requests with common settings:
-
-```typescript
-// Create base authenticated request
-const apiBase = create.get()
-  .withHeaders({
-    'X-API-Version': '1.2',
-    'Accept-Language': 'en-US'
-  })
-  .withBearerToken(authToken)
-  .withTimeout(5000)
-  .withRetries(2);
-
-// Use the base request for different endpoints
-const users = await apiBase.sendTo('https://api.example.com/users').getData();
-const products = await apiBase.sendTo('https://api.example.com/products').getData();
+  .withTimeout(3000)
+  .getData();
 ```
 
 ### Request Bodies (POST/PUT/PATCH)
 
 ```typescript
-// JSON body
-const jsonRequest = create.post()
-  .withBody({ name: 'John', age: 30 });
+// JSON body (Content-Type automatically set to application/json)
+const jsonRequest = create
+  .post("https://api.example.com/users")
+  .withBody({ name: "John", age: 30 });
 
-// String body
-const textRequest = create.post()
-  .withBody('Plain text content');
+// String body (Content-Type automatically set to text/plain)
+const textRequest = create
+  .post("https://api.example.com/users")
+  .withBody("Plain text content");
 
 // Form data
 const formData = new FormData();
-formData.append('name', 'John');
-formData.append('file', fileBlob);
+formData.append("name", "John");
+formData.append("file", fileBlob);
 
-const formRequest = create.post()
-  .withBody(formData);
+const formRequest = create.post("https://api.example.com/users").withBody(formData);
+
+// URLSearchParams (typically used for application/x-www-form-urlencoded)
+const params = new URLSearchParams();
+params.append("username", "john");
+params.append("password", "secret");
+
+const formUrlEncodedRequest = create.post("https://api.example.com/login").withBody(params);
 ```
 
-### Executing Requests
+### GraphQL Requests
+
+The library provides built-in support for GraphQL queries and mutations:
 
 ```typescript
-// Simple execution
-const response = await request.sendTo('https://api.example.com/endpoint');
+// GraphQL query without variables
+const users = await create
+  .post("https://api.example.com/graphql")
+  .withGraphQL("query { users { id name email } }")
+  .getJson();
+
+// GraphQL query with variables
+const user = await create
+  .post("https://api.example.com/graphql")
+  .withGraphQL("query GetUser($id: ID!) { user(id: $id) { name email } }", { id: "123" })
+  .getJson();
+
+// GraphQL mutation
+const result = await create
+  .post("https://api.example.com/graphql")
+  .withGraphQL(
+    "mutation CreateUser($name: String!) { createUser(name: $name) { id name } }",
+    { name: "John Doe" }
+  )
+  .getJson();
+```
 
-// With direct data extraction
-const jsonData = await request.sendTo('https://api.example.com/endpoint').getJson();
-const textData = await request.sendTo('https://api.example.com/endpoint').getText();
-const blobData = await request.sendTo('https://api.example.com/endpoint').getBlob();
-const bodyStream = await request.sendTo('https://api.example.com/endpoint').getBody();
-const arrayBuffer = await request.sendTo('https://api.example.com/endpoint').getArrayBuffer();
+#### GraphQL Error Handling
 
-// Using the data selector API to extract specific data
-const userData = await request.sendTo('https://api.example.com/users')
-  .getData(data => data.results.users);
+GraphQL errors do not cause exceptions by default. Use the `throwOnError` option to make them throw exceptions:
 
-// Using the data selector without a selector function just returns the full JSON response
-const fullData = await request.sendTo('https://api.example.com/data').getData();
+```typescript
+// Throw an error if the GraphQL response contains errors
+try {
+  const user = await create
+    .post("https://api.example.com/graphql")
+    .withGraphQL(
+      "query GetUser($id: ID!) { user(id: $id) { name email } }",
+      { id: "123" },
+      { throwOnError: true }
+    )
+    .getJson();
+} catch (error) {
+  console.error(error.message);
+}
 ```
 
-### Data Selection
+The `withGraphQL` method automatically:
 
-The `getData` method provides a powerful way to extract and transform specific data from API responses:
+- Formats the body as JSON with `query` and optional `variables` properties
+- Sets `Content-Type` to `application/json`
+- Validates the query is non-empty
+- Validates variables are a plain object (not arrays or null)
+- Optionally throws errors when GraphQL response contains errors (with `throwOnError: true`)
+
+### Query Parameters Advanced Features
+
+The library supports advanced query parameter handling:
 
 ```typescript
-// Extract specific properties from nested structures
-const posts = await request
-  .sendTo('https://api.example.com/feed')
-  .getData(data => data.feed.posts);
+// Array values create multiple query params with the same key
+const request = create.get("https://api.example.com/search").withQueryParams({
+  tags: ["javascript", "typescript", "node"], // ?tags=javascript&tags=typescript&tags=node
+  page: 1,
+  active: true,
+});
+
+// Null and undefined values are automatically filtered out
+const filtered = create.get("https://api.example.com/users").withQueryParams({
+  name: "John",
+  age: null, // Ignored
+  email: undefined, // Ignored
+});
+
+// Supports all JavaScript types (strings, numbers, booleans, arrays)
+const typed = create.get("https://api.example.com/data").withQueryParams({
+  page: 1, // Number
+  active: true, // Boolean
+  tags: ["js", "ts"], // Array
+  name: "John", // String
+});
+
+// Merge with existing query params in URL
+const merged = create
+  .get("https://api.example.com/users?existing=value")
+  .withQueryParams({ new: "param" }); // Both existing and new params included
+```
 
-// Transform data in the selector function
-const usernames = await request
-  .sendTo('https://api.example.com/users')
-  .getData(data => data.users.map(user => user.username));
+### Executing Requests
 
-// Apply filtering in the selector
-const activeUsers = await request
-  .sendTo('https://api.example.com/users')
-  .getData(data => data.users.filter(user => user.isActive));
+```typescript
+// Get the full response
+const response = await create.get("https://api.example.com/endpoint").getResponse();
 
-// Combine data from complex nested structures
-const combinedData = await request
-  .sendTo('https://api.example.com/dashboard')
-  .getData(data => ({
-    userCount: data.stats.users.total,
-    recentPosts: data.content.recent.slice(0, 5),
-    notifications: data.user.notifications.unread
-  }));
+// With direct data extraction
+const jsonData = await create.get("https://api.example.com/endpoint").getJson();
+const textData = await create.get("https://api.example.com/endpoint").getText();
+const blobData = await create.get("https://api.example.com/endpoint").getBlob();
+const bodyStream = await create.get("https://api.example.com/endpoint").getBody();
+
+// Using the data selector API to extract specific data
+const userData = await create
+  .get("https://api.example.com/users")
+  .getData(data => data.results.users);
+
+// Using the data selector without a selector function just returns the full JSON response
+const fullData = await create.get("https://api.example.com/data").getData();
 ```
 
-When a selector fails, the error message will contain the original response data to help diagnose the issue:
+### ResponseWrapper Properties
+
+When you use `getResponse()`, you get a `ResponseWrapper` object that provides convenient access to response properties and methods:
 
 ```typescript
-try {
-  const result = await request
-    .sendTo('https://api.example.com/data')
-    .getData(data => data.results.items); // Will fail if structure is different
-} catch (error) {
-  console.error(error);
-  // Error message includes the original response data
-}
+const response = await create.get("https://api.example.com/users").getResponse();
+
+// Access response properties directly
+console.log(response.status); // HTTP status code (e.g., 200)
+console.log(response.statusText); // Status text (e.g., "OK")
+console.log(response.ok); // Boolean: true if status is 200-299
+console.log(response.headers); // Headers object
+console.log(response.url); // Request URL
+console.log(response.method); // HTTP method
+console.log(response.raw); // Raw Response object from fetch
+
+// Use wrapper methods for body parsing
+const json = await response.getJson();
+const text = await response.getText();
+const blob = await response.getBlob();
+const stream = response.getBody(); // ReadableStream or null
 ```
 
 ### Error Handling
@@ -254,14 +358,15 @@ All errors from requests are instances of `RequestError` with detailed informati
 
 ```typescript
 try {
-  const data = await request.sendTo('https://api.example.com/data').getJson();
+  const data = await create.get("https://api.example.com/data").getJson();
 } catch (error) {
   // error will always be a RequestError
-  console.log(error.message);     // Error message
-  console.log(error.status);      // HTTP status code (if available)
-  console.log(error.url);         // Request URL
-  console.log(error.method);      // HTTP method
-  console.log(error.timeoutError); // Whether it was a timeout
+  console.log(error.message); // Error message
+  console.log(error.status); // HTTP status code (if available)
+  console.log(error.url); // Request URL
+  console.log(error.method); // HTTP method
+  console.log(error.isTimeout); // Whether it was a timeout
+  console.log(error.isAborted); // Whether it was aborted/cancelled
 
   // Access the original response if available
   if (error.response) {
@@ -271,53 +376,140 @@ try {
 }
 ```
 
-### Caching Requests
+## Advanced Usage
+
+### Interceptors
+
+Interceptors allow you to modify requests, transform responses, or handle errors globally or per-request. This is perfect for adding authentication tokens, logging, error recovery, and more.
+
+#### Global Interceptors
+
+Global interceptors apply to all requests:
 
 ```typescript
-import create, { createMemoryStorage, createLocalStorageStorage, createSessionStorageStorage } from 'create-request';
+// Add a global request interceptor (modify all requests)
+const requestInterceptorId = create.config.addRequestInterceptor(config => {
+  // Add auth token to all requests
+  config.headers["Authorization"] = `Bearer ${getToken()}`;
+  // Modify URL, headers, body, etc.
+  return config;
+});
+
+// Add a global response interceptor (transform all responses)
+const responseInterceptorId = create.config.addResponseInterceptor(response => {
+  console.log(`Response received: ${response.status}`);
+  // Transform or modify the response
+  return response;
+});
+
+// Add a global error interceptor (handle all errors)
+const errorInterceptorId = create.config.addErrorInterceptor(error => {
+  console.error("Request failed:", error.message);
+  // Can throw to propagate error, or return ResponseWrapper to recover
+  throw error;
+});
+
+// Remove interceptors when no longer needed
+create.config.removeRequestInterceptor(requestInterceptorId);
+create.config.removeResponseInterceptor(responseInterceptorId);
+create.config.removeErrorInterceptor(errorInterceptorId);
+
+// Clear all interceptors at once
+create.config.clearInterceptors();
+```
 
-// Simple in-memory caching
-const request = create.get()
-  .withCache({
-    storage: createMemoryStorage(),
-    ttl: 60000 // 1 minute in milliseconds
+#### Per-Request Interceptors
+
+Per-request interceptors apply only to a specific request:
+
+```typescript
+// Request interceptor - modify request configuration
+const data = await create
+  .get("https://api.example.com/users")
+  .withRequestInterceptor(config => {
+    config.headers["X-Custom-Header"] = "value";
+    config.url = "https://api.example.com/modified-url"; // Can modify URL
+    return config;
   })
-  .sendTo('https://api.example.com/data');
-
-// Using localStorage storage
-const request = create.get()
-  .withCache({
-    storage: createLocalStorageStorage(),
-    ttl: 5 * 60 * 1000, // 5 minutes
-    maxSize: '1MB',
-    keyPrefix: 'user-data'
+  .getJson();
+
+// Response interceptor - transform response
+const transformed = await create
+  .get("https://api.example.com/users")
+  .withResponseInterceptor(response => {
+    console.log(`Got response with status ${response.status}`);
+    return response;
   })
-  .sendTo('https://api.example.com/users');
-
-// Using sessionStorage for per-session caching
-const request = create.get()
-  .withCache({
-    storage: createSessionStorageStorage(),
-    maxEntries: 50,
-    varyByHeaders: ['x-api-version']
+  .getJson();
+
+// Error interceptor - handle or recover from errors
+const recovered = await create
+  .get("https://api.example.com/users")
+  .withErrorInterceptor(error => {
+    // Option 1: Throw to propagate error
+    throw error;
+
+    // Option 2: Return a ResponseWrapper to recover from error
+    // return new ResponseWrapper(fallbackResponse, error.url, error.method);
   })
-  .sendTo('https://api.example.com/data');
+  .getJson();
 ```
 
-## Advanced Usage
+#### Interceptor Execution Order
 
-### Request Reuse
+Interceptors execute in a specific order:
+
+1. **Request interceptors**: Global interceptors run first (in registration order), then per-request interceptors (in registration order)
+2. **Response interceptors**: Per-request interceptors run first (in registration order), then global interceptors (in reverse registration order)
+3. **Error interceptors**: Per-request interceptors run first (in registration order), then global interceptors (in reverse registration order)
 
 ```typescript
-// Create a base authenticated request
-const authRequest = create.get()
-  .withBearerToken('token123')
-  .withTimeout(5000)
-  .withRetries(2);
-
-// Reuse for different endpoints
-const users = await authRequest.sendTo('https://api.example.com/users').getJson();
-const products = await authRequest.sendTo('https://api.example.com/products').getJson();
+// Request: Global 1 → Global 2 → Per-request 1 → Per-request 2
+// Response: Per-request 1 → Per-request 2 → Global 2 → Global 1
+const data = await create
+  .get("https://api.example.com/users")
+  .withRequestInterceptor(() => console.log("Per-request 1"))
+  .withRequestInterceptor(() => console.log("Per-request 2"))
+  .getJson();
+```
+
+#### Advanced Interceptor Patterns
+
+```typescript
+// Short-circuit request with early response
+const cached = await create
+  .get("https://api.example.com/users")
+  .withRequestInterceptor(() => {
+    // Return early response from cache
+    return new Response(JSON.stringify(cachedData), {
+      status: 200,
+      headers: { "Content-Type": "application/json" },
+    });
+  })
+  .getJson();
+
+// Recover from error with fallback
+const fallback = await create
+  .get("https://api.example.com/users")
+  .withErrorInterceptor(error => {
+    // Return fallback response instead of throwing
+    const fallbackResponse = new Response(JSON.stringify({ users: [] }), {
+      status: 200,
+      headers: { "Content-Type": "application/json" },
+    });
+    return new ResponseWrapper(fallbackResponse, error.url, error.method);
+  })
+  .getJson();
+
+// Async interceptors
+const asyncData = await create
+  .get("https://api.example.com/users")
+  .withRequestInterceptor(async config => {
+    const token = await getTokenAsync();
+    config.headers["Authorization"] = `Bearer ${token}`;
+    return config;
+  })
+  .getJson();
 ```
 
 ### Request Cancellation
@@ -325,7 +517,8 @@ const products = await authRequest.sendTo('https://api.example.com/products').ge
 ```typescript
 const controller = new AbortController();
 
-const request = create.get()
+const request = create
+  .get("https://api.example.com/slow-endpoint")
   .withTimeout(10000)
   .withAbortController(controller);
 
@@ -333,151 +526,130 @@ const request = create.get()
 setTimeout(() => controller.abort(), 2000);
 
 try {
-  const data = await request.sendTo('https://api.example.com/slow-endpoint').getJson();
+  const data = await request.getJson();
 } catch (error) {
-  // Check if request was cancelled
-  console.log('Request was cancelled:', error.name === 'AbortError');
+  if (error.name === "AbortError") {
+    console.log("Request was cancelled by user");
+  } else if (error.isTimeout) {
+    console.log("Request timed out");
+  } else {
+    console.log("Other error:", error.message);
+  }
 }
 ```
 
-### Working with Typed Responses
+### URL Handling
+
+The library handles both absolute and relative URLs, and automatically merges query parameters:
 
 ```typescript
-interface User {
-  id: number;
-  name: string;
-  email: string;
-}
+// Relative URLs (preserved as-is)
+const relative = await create.get("/api/users").getJson();
+
+// Absolute URLs
+const absolute = await create.get("https://api.example.com/users").getJson();
+
+// Merging query params with existing URL params
+const merged = await create
+  .get("https://api.example.com/users?page=1")
+  .withQueryParams({ limit: 20, sort: "name" })
+  .getJson();
+// Result: https://api.example.com/users?page=1&limit=20&sort=name
+
+// Special characters and unicode are properly encoded
+const encoded = await create
+  .get("https://api.example.com/search")
+  .withQueryParams({ name: "用户名", filter: "status:active" })
+  .getJson();
+```
 
-interface ApiResponse {
-  users: User[];
-  pagination: {
-    total: number;
-    page: number;
-  }
-}
+### Data Selection
 
-const userRequest = create.get();
+The `getData` method provides a powerful way to extract and transform specific data from API responses:
 
-// Type the full response
-const response = await userRequest
-  .sendTo('https://api.example.com/users')
-  .getJson<ApiResponse>();
+```typescript
+// Extract specific properties from nested structures
+const posts = await create
+  .get("https://api.example.com/feed")
+  .getData(data => data.feed.posts);
 
-// Or use getData with type parameters
-const users = await userRequest
-  .sendTo('https://api.example.com/users')
-  .getData<ApiResponse, User[]>(data => data.users);
+// Transform data in the selector function
+const usernames = await create
+  .get("https://api.example.com/users")
+  .getData(data => data.users.map(user => user.username));
 
-// Or just get the full typed response
-const fullData = await userRequest
-  .sendTo('https://api.example.com/users')
-  .getData<ApiResponse>();
+// Apply filtering in the selector
+const activeUsers = await create
+  .get("https://api.example.com/users")
+  .getData(data => data.users.filter(user => user.isActive));
 
-// TypeScript knows the types
-console.log(users[0].name);
+// Combine data from complex nested structures
+const combinedData = await create.get("https://api.example.com/dashboard").getData(data => ({
+  userCount: data.stats.users.total,
+  recentPosts: data.content.recent.slice(0, 5),
+  notifications: data.user.notifications.unread,
+}));
 ```
 
-### Promise Chaining
+When a selector fails, the error message will contain helpful context to diagnose the issue:
 
 ```typescript
-const request = create.get();
-
-request.sendTo('https://api.example.com/data')
-  .then(response => {
-    console.log('Status:', response.status);
-    return response.getJson();
-  })
-  .then(data => {
-    console.log('Data:', data);
-  })
-  .catch(error => {
-    console.error('Error:', error.message);
-  });
+try {
+  // This will fail if the response structure doesn't match expectations
+  const result = await create
+    .get("https://api.example.com/data")
+    .getData(data => data.results.items);
+} catch (error) {
+  console.error(error);
+  // Error message includes context for debugging
+}
 ```
 
-### Advanced Caching
+## TypeScript Support
 
 ```typescript
-import create, { createMemoryStorage, StorageProvider } from 'create-request';
-
-// Custom key generation
-const request = create.get()
-  .withCache({
-    storage: createMemoryStorage(),
-    keyGenerator: (url, method, headers) => {
-      // Include user ID from authorization header in the cache key
-      const authHeader = headers?.['Authorization'] || '';
-      const userMatch = authHeader.match(/User-(\d+)/);
-      const userId = userMatch ? userMatch[1] : 'anonymous';
-      return `${method}:${userId}:${url}`;
-    }
-  })
-  .sendTo('https://api.example.com/data');
-```
-
-### Implementing Custom Storage Providers
-
-You can create your own storage provider by implementing the `StorageProvider` interface:
+interface User {
+  id: number;
+  name: string;
+  email: string;
+  isActive: boolean;
+}
 
-```typescript
-import { StorageProvider } from 'create-request';
-
-// Create a simple custom storage provider
-export function createNamespacedStorage(namespace: string): StorageProvider {
-  return {
-    get(key: string): string | null {
-      return localStorage.getItem(`${namespace}:${key}`);
-    },
-
-    set(key: string, value: string): void {
-      try {
-        localStorage.setItem(`${namespace}:${key}`, value);
-      } catch (e) {
-        // Handle quota exceeded errors
-        console.warn("Storage quota exceeded, clearing cache");
-        this.clear();
-        try {
-          localStorage.setItem(`${namespace}:${key}`, value);
-        } catch (e) {
-          console.error("Failed to set cache item even after clearing cache");
-        }
-      }
-    },
-
-    has(key: string): boolean {
-      return localStorage.getItem(`${namespace}:${key}`) !== null;
-    },
-
-    delete(key: string): void {
-      localStorage.removeItem(`${namespace}:${key}`);
-    },
-
-    clear(): void {
-      // Only clear items in our namespace
-      Object.keys(localStorage)
-        .filter(key => key.startsWith(`${namespace}:`))
-        .forEach(key => localStorage.removeItem(key));
-    }
+interface ApiResponse<T> {
+  data: T;
+  meta: {
+    total: number;
+    page: number;
   };
 }
 
-// Usage:
-const request = create.get()
-  .withCache({
-    storage: createNamespacedStorage('api-cache'),
-    ttl: 24 * 60 * 60 * 1000 // 24 hours
-  })
-  .sendTo('https://api.example.com/data');
-```
+// Type the full response
+const response = await create
+  .get("https://api.example.com/users")
+  .getJson<ApiResponse<User[]>>();
 
-With custom storage providers, you can integrate with any storage system, such as:
+// Or use getData with type parameters
+const users = await create
+  .get("https://api.example.com/users")
+  .getData<ApiResponse<User[]>, User[]>(data => data.data);
 
-- Custom browser storage solutions
-- Memory caches with expiration policies
-- Session-based storage mechanisms
-- Encrypted storage providers
-- Third-party storage libraries
+// TypeScript knows the types
+users.forEach(user => {
+  console.log(`${user.name} (${user.email}): ${user.isActive ? "Active" : "Inactive"}`);
+});
+
+// Function with proper types
+async function getUserById(id: number): Promise<User> {
+  return create
+    .get("https://api.example.com/users")
+    .withQueryParam("id", id)
+    .getData<ApiResponse<User[]>, User>(data => {
+      const user = data.data[0];
+      if (!user) throw new Error(`User with ID ${id} not found`);
+      return user;
+    });
+}
+```
 
 ## CSRF Protection
 
@@ -499,11 +671,15 @@ You can configure CSRF settings globally for all requests:
 
 ```typescript
 // Configure CSRF settings for all requests
-create.config.setCsrfToken('your-csrf-token');
-create.config.setCsrfHeaderName('X-CSRF-Token'); // Default header name
-create.config.setXsrfCookieName('XSRF-TOKEN'); // Default cookie name
+create.config.setCsrfToken("your-csrf-token");
+create.config.setCsrfHeaderName("X-CSRF-Token"); // Default header name for CSRF token
+create.config.setXsrfCookieName("XSRF-TOKEN"); // Default cookie name to read from
+create.config.setXsrfHeaderName("X-XSRF-TOKEN"); // Default header name for XSRF token from cookie
 create.config.setEnableAntiCsrf(true); // Enable/disable X-Requested-With header
 create.config.setEnableAutoXsrf(true); // Enable/disable automatic cookie-to-header token
+
+// Reset all configuration to defaults
+create.config.reset();
 ```
 
 ### Per-Request CSRF Settings
@@ -512,22 +688,22 @@ You can also configure CSRF protection on individual requests:
 
 ```typescript
 // Configure CSRF for a specific request
-const request = create.post()
-  .withCsrfToken('request-specific-token') // Set a specific token
+const request = create
+  .post("https://api.example.com/users")
+  .withCsrfToken("request-specific-token") // Set a specific token
   .withAntiCsrfHeaders() // Explicitly add X-Requested-With header
   .withoutCsrfProtection(); // Or disable all automatic CSRF protection
 ```
 
-### Integrating with Backend Frameworks
+## Performance Considerations
 
-Most modern frameworks support CSRF protection out of the box. The library works seamlessly with:
+create-request is designed to be lightweight and efficient:
 
-- **Laravel**: Automatically reads XSRF-TOKEN cookie and sends X-XSRF-TOKEN header
-- **Rails**: Works with the Rails CSRF token system
-- **Django**: Compatible with Django's CSRF middleware
-- **Express.js + csurf**: Works with the csurf middleware token pattern
-
-When your server sends a CSRF token in a cookie or response header, `create-request` can automatically extract and include it in subsequent requests.
+- **Zero Dependencies**: No extra libraries to load
+- **Tree-Shakable**: Only import what you need
+- **Minimal Overhead**: Thin wrapper around the native Fetch API
+- **Memory Efficient**: Doesn't create unnecessary objects
+- **Clean API**: Simple and intuitive interface
 
 ## Browser Support
 
@@ -539,6 +715,35 @@ This library works with all browsers that support the Fetch API:
 - Edge 14+
 - Opera 29+
 
+## Comparison of JavaScript HTTP Client Libraries
+
+| Feature             | create-request | Fetch  | Axios   | SuperAgent | Got     | Ky     | node-fetch | Redaxios |
+| ------------------- | -------------- | ------ | ------- | ---------- | ------- | ------ | ---------- | -------- |
+| **Size (min+gzip)** | ~5.8KB         | Native | ~13.6KB | ~17.8KB    | ~17.8KB | ~3.4KB | ~7.7KB     | ~1KB     |
+| **Browser**         | Modern         | Modern | IE11+   | IE9+       | ❌ No   | Modern | ❌ No      | Modern   |
+| **Node.js**         | ✅             | ✅     | ✅      | ✅         | ✅      | ✅     | ✅         | ✅       |
+| **HTTP/2**          | ✅             | ✅     | ✅      | ✅         | ✅      | ✅     | ❌         | ❌       |
+| **Auto Retries**    | ✅             | ❌     | 🛠️      | ✅         | ✅      | ✅     | ❌         | ❌       |
+| **Cancellation**    | ✅             | ✅     | ✅      | ✅         | ✅      | ✅     | ✅         | ✅       |
+| **Auto JSON**       | ✅             | ❌     | ✅      | ✅         | ✅      | ✅     | ❌         | ✅       |
+| **Timeout**         | ✅             | ❌     | ✅      | ✅         | ✅      | ✅     | ✅         | ✅       |
+| **TypeScript**      | ✅             | ✅     | ✅      | ✅         | ✅      | ✅     | ✅         | ✅       |
+| **Streaming**       | ✅             | ✅     | ✅      | ✅         | ✅      | ✅     | ✅         | ❌       |
+| **Progress**        | ❌             | ❌     | ✅      | ✅         | ✅      | ✅     | ❌         | ❌       |
+| **Middleware**      | ❌             | ❌     | ✅      | ✅         | ✅      | ✅     | ❌         | ❌       |
+| **Cookies**         | ✅             | ✅     | 🛠️      | ✅         | ✅      | ❌     | ❌         | ❌       |
+| **Pagination API**  | ❌             | ❌     | ❌      | ❌         | ✅      | ❌     | ❌         | ❌       |
+| **Zero Deps**       | ✅             | ✅     | ❌      | ❌         | ❌      | ✅     | ✅         | ✅       |
+| **Chainable API**   | ✅             | ❌     | ❌      | ✅         | ✅      | ✅     | ❌         | ❌       |
+| **CSRF Protection** | ✅             | ❌     | ✅      | ❌         | ❌      | ❌     | ❌         | ❌       |
+| **GraphQL Support** | ✅             | ❌     | ❌      | ❌         | ❌      | ❌     | ❌         | ❌       |
+| **Interceptors**    | ✅             | ❌     | ✅      | ✅         | ✅      | ✅     | ❌         | ❌       |
+
+**Notes:**
+
+- "Modern" browser support: Chrome 42+, Firefox 39+, Safari 10.1+, Edge 14+, Opera 29+
+- 🛠️ Feature requires additional plugins or adapters (not available out-of-the-box)
+
 ## License
 
 MIT