vigor-fetch 2.0.0 → 2.0.2

package/README.md

@@ -15,8 +15,11 @@ Vigor provides a fluent, chainable API for building robust network logic with bu
 - ⚡ **Zero Dependencies** — Built on native Fetch + AbortController
 - 🪝 **Powerful Interceptors** — Lifecycle hooks for full control flow
 - 🧠 **TypeScript First** — Fully typed inference across all modules
+
+
 ---
 
+
 ## Installation
 
 ```bash
@@ -47,10 +50,12 @@ const data = await vigor
   .request()
 ```
 
-# 🛠️ Vigor API Reference (Rewritten)
+# 🛠️ Vigor API Reference
+
 
 ---
 
+
 # 📡 vigor.fetch(origin)
 
 vigor.fetch(origin: string)
@@ -72,8 +77,10 @@ vigor.fetch(origin: string)
 | interceptors | (fn: (i: VigorFetchInterceptors) => VigorFetchInterceptors) => VigorFetch | Lifecycle hooks |
 | request | () => Promise<T> | Execute request |
 
+
 ---
 
+
 ## ⚙️ fetch().setting(s => s)
 
 | Field | Type | Description |
@@ -89,8 +96,10 @@ vigor.fetch(origin: string)
 | options | object | Fetch options |
 | default | T | Fallback value |
 
+
 ---
 
+
 ## 🧩 fetch().interceptors(i => i)
 
 | Hook | Signature | Description |
@@ -100,8 +109,10 @@ vigor.fetch(origin: string)
 | onError | (ctx, { setResult, throwError }) => void | Error handler |
 | result | (ctx, { setResult, throwError }) => void | Final result hook |
 
+
 ---
 
+
 # 🔁 vigor.retry(task)
 
 vigor.retry(task: VigorRetryTask<T>)
@@ -117,8 +128,10 @@ vigor.retry(task: VigorRetryTask<T>)
 | request | () => Promise<T> | Execute retry flow |
 | createController | () => (error: Error) => void | Abort controller |
 
+
 ---
 
+
 ## ⚙️ retry().setting(s => s)
 
 | Field | Type | Description |
@@ -128,8 +141,10 @@ vigor.retry(task: VigorRetryTask<T>)
 | maxDelay | number | Max delay cap |
 | default | T | Fallback value |
 
+
 ---
 
+
 ## 📈 retry().backoff(b => b)
 
 | Field | Type | Description |
@@ -139,8 +154,10 @@ vigor.retry(task: VigorRetryTask<T>)
 | factor | number | Exponential multiplier |
 | jitter | number | Random noise |
 
+
 ---
 
+
 ## 🧩 retry().interceptors(i => i)
 
 | Hook | Signature | Description |
@@ -151,8 +168,10 @@ vigor.retry(task: VigorRetryTask<T>)
 | onRetry | (ctx, { setDelay }) => void | Retry event |
 | retryIf | (ctx, { proceedRetry, cancelRetry }) => void | Retry decision |
 
+
 ---
 
+
 # ⚡ vigor.all(tasks)
 
 vigor.all(tasks: VigorAllTask<T>[])
@@ -166,8 +185,10 @@ vigor.all(tasks: VigorAllTask<T>[])
 | interceptors | (fn: (i: VigorAllInterceptors) => VigorAllInterceptors) => VigorAll | Hooks |
 | request | () => Promise<Array<T | Error>> | Execute all tasks |
 
+
 ---
 
+
 ## ⚙️ all().setting(s => s)
 
 | Field | Type | Description |
@@ -175,8 +196,10 @@ vigor.all(tasks: VigorAllTask<T>[])
 | concurrency | number | Max parallel tasks |
 | jitter | number | Delay randomness |
 
+
 ---
 
+
 ## 🧩 all().interceptors(i => i)
 
 | Hook | Signature | Description |
@@ -186,8 +209,10 @@ vigor.all(tasks: VigorAllTask<T>[])
 | onError | (ctx, { setResult }) => void | Error handling |
 | result | (ctx, { setResult }) => void | Final aggregation |
 
+
 ---
 
+
 # 🧪 vigor.parse(response)
 
 vigor.parse(response: Response)
@@ -199,8 +224,10 @@ vigor.parse(response: Response)
 | type | keyof Response | Force parse type |
 | request | () => Promise<T> | Execute parsing |
 
+
 ---
 
+
 # 🚀 vigor.fetch examples
 
 ## GET request
@@ -274,8 +301,11 @@ vigor.retry(async (ctx, { signal }) => {
 )
 .request()
 ```
+
+
 ---
 
+
 ## retryIf control
 ```ts
 vigor.retry(async () => {
@@ -293,8 +323,11 @@ vigor.retry(async () => {
 )
 .request()
 ```
+
+
 ---
 
+
 ## abort controller
 ```ts
 const retry = vigor.retry(async (ctx, { signal }) => {
@@ -310,8 +343,11 @@ setTimeout(() => {
 
 await retry.request()
 ```
+
+
 ---
 
+
 # ⚡ vigor.all examples
 ```ts
 vigor.all([
@@ -320,7 +356,11 @@ vigor.all([
   async () => fetch("https://api.com/c").then(r => r.json())
 ]).request()
 ```
+
+
 ---
+
+
 ```ts
 vigor.all([
   async () => "A",
@@ -335,7 +375,11 @@ vigor.all([
 )
 .request()
 ```
+
+
 ---
+
+
 ```ts
 vigor.all([
   async () => "ok1",
@@ -343,15 +387,21 @@ vigor.all([
   async () => "ok2"
 ]).request()
 ```
+
 ---
 
+
 # 🧪 vigor.parse examples
 ```ts
 const res = await fetch("https://api.com/data")
 
 vigor.parse(res).request()
 ```
+
+
 ---
+
+
 ```ts
 const img = await fetch("https://api.com/image.png")
 
@@ -359,7 +409,11 @@ vigor.parse(img)
   .type("blob")
   .request()
 ```
+
+
 ---
+
+
 ```ts
 const raw = await fetch("https://api.com")
 
@@ -367,8 +421,11 @@ vigor.parse(raw)
   .original(true)
   .request()
 ```
+
+
 ---
 
+
 # 🔥 full pipeline example
 ```ts
 vigor.fetch("https://api.example.com")
@@ -403,4 +460,6 @@ vigor.fetch("https://api.example.com")
   )
   .request()
 ```
+
+
 ---