@superutils/fetch 1.1.3 → 1.1.5

package/dist/index.d.ts

@@ -84,7 +84,7 @@ declare class FetchError extends Error {
  * // Interceptors can be async functions or just return a promise that resolves to the error.
  * // If the execution of the interceptor fails or promise rejects, it will be ignored.
  * // To transform the error it must directly return an error or a Promise that `resolves` with an error.
- * const transformError = async fetchErr => {
+ * const transformError = async (fetchErr, url, options) => {
  *     fetchErr.message = 'Custom errormessage'
  * 	   return Promise.resolve(fetchErr)
  * }
@@ -95,7 +95,7 @@ declare class FetchError extends Error {
  * })
  * ```
  */
-type FetchInterceptorError = Interceptor<FetchError, []>;
+type FetchInterceptorError = Interceptor<FetchError, FetchArgsInterceptor>;
 /**
  *
  * Fetch request interceptor to be invoked before making a fetch request.
@@ -417,10 +417,10 @@ declare function fetchDeferred<ThisArg = unknown, Delay extends number = number,
  * If the same property is provided in both cases, defaults will be overriden by the callback.
  *
  *
+ * #### Example 1: Auto-saving form data with throttling
  *
- * @example Auto-saving form data with throttling
- * ```javascript
- * import { postDeferred } from '@superutils/fetch'
+ * ```typescript
+ * import fetch from '@superutils/fetch'
  * import PromisE from '@superutils/promise'
  *
  * // Create a throttled function to auto-save product updates.
@@ -431,23 +431,29 @@ declare function fetchDeferred<ThisArg = unknown, Delay extends number = number,
  * 		trailing: true, // Ensures the very last update is always saved
  * 		onResult: product => console.log(`[Saved] Product: ${product.title}`),
  * 	},
- * 	'https://dummyjson.com/products/1', // Default URL
- * 	undefined, // No default data
- * 	{ method: 'put' }, // Default method
+ * 	'https://dummyjson.com/products/add', // Default URL
  * )
  * // Simulate a user typing quickly, triggering multiple saves.
  * console.log('User starts typing...')
- * // First call
- * saveProductThrottled({ title: 'iPhone' }) // Executed immediately (leading edge)
- * // Second call after 200ms => Ignored (within 1000ms throttle window)
+ *
+ * // Executed immediately (leading edge)
+ * saveProductThrottled({ title: 'iPhone' })
+ * // Ignored (within 1000ms throttle window)
  * PromisE.delay(200, () => saveProductThrottled({ title: 'iPhone 15' }))
- * // Third call 300ms after second call => Ignored
- * PromisE.delay(500, () => saveProductThrottled({ title: 'iPhone 15 Pro' }))
- * // Fourth call 400ms after third call => Queued to execute on the trailing edge
- * PromisE.delay(900, () => saveProductThrottled({ title: 'iPhone 15 Pro Max' }))
+ * // Ignored
+ * PromisE.delay(300, () => saveProductThrottled({ title: 'iPhone 15 Pro' }))
+ * // Queued to execute on the trailing edge
+ * PromisE.delay(400, () => saveProductThrottled({ title: 'iPhone 15 Pro Max' }))
+ * // Outcome:
+ * // The first call ('iPhone') is executed immediately.
+ * // The next two calls are ignored by the throttle.
+ * // The final call ('iPhone 15 Pro Max') is executed after the 1000ms throttle window closes,
+ * // thanks to `trailing: true`.
+ * // This results in only two network requests instead of four.
  * ```
  *
- * @example Advanced example: debouncing an authentication token refresh
+ * #### Example 2: debouncing an authentication token refresh
+ *
  * ```typescript
  * import fetch from '@superutils/fetch'
  * import PromisE from '@superutils/promise'
@@ -459,11 +465,11 @@ declare function fetchDeferred<ThisArg = unknown, Delay extends number = number,
  * const requestNewToken = fetch.post.deferred(
  * 	{
  * 		delayMs: 300, // debounce delay
- * 		onResult: ({ token = '' }) => {
+ * 		onResult: ({ refreshToken = '' }) => {
  * 			console.log(
  * 				`Auth token successfully refreshed at ${new Date().toISOString()}`,
  * 			)
- * 			currentRefreshToken = token
+ * 			currentRefreshToken = refreshToken
  * 		},
  * 	},
  * 	'https://dummyjson.com/auth/refresh', // Default URL
@@ -497,7 +503,7 @@ declare function fetchDeferred<ThisArg = unknown, Delay extends number = number,
  * // The token is refreshed only once, preventing redundant network requests.
  * ```
  */
-declare function postDeferred<ThisArg, Delay extends number = number, DefaultUrl extends PostArgs[0] | undefined = undefined, DefaultData extends PostArgs[1] | undefined = undefined, CbArgs extends unknown[] = PostDeferredCbArgs<DefaultUrl, DefaultData, false>>(deferOptions?: DeferredAsyncOptions<ThisArg, Delay>, defaultUrl?: DefaultUrl, defaultData?: DefaultData, defaultOptions?: PostArgs[2]): <TResult = unknown>(...args: CbArgs) => _superutils_promise.IPromisE<TResult>;
+declare function postDeferred<ThisArg, Delay = unknown, DefaultUrl extends PostArgs[0] | undefined = undefined, DefaultData extends PostArgs[1] | undefined = undefined, CbArgs extends unknown[] = PostDeferredCbArgs<DefaultUrl, DefaultData, false>>(deferOptions?: DeferredAsyncOptions<ThisArg, Delay>, defaultUrl?: DefaultUrl, defaultData?: DefaultData, defaultOptions?: PostArgs[2]): <TResult = unknown>(...args: CbArgs) => _superutils_promise.IPromisE<TResult>;
 
 /**
  * Merge one or more {@link FetchOptions}

package/package.json

@@ -5,8 +5,8 @@
 	},
 	"description": "A lightweight `fetch` wrapper for browsers and Node.js, designed to simplify data fetching and reduce boilerplate.",
 	"dependencies": {
-		"@superutils/core": "^1.1.1",
-		"@superutils/promise": "^1.1.3"
+		"@superutils/core": "^1.1.4",
+		"@superutils/promise": "^1.1.4"
 	},
 	"files": [
 		"dist",
@@ -24,8 +24,8 @@
 	"main": "dist/index.js",
 	"name": "@superutils/fetch",
 	"peerDependencies": {
-		"@superutils/core": "^1.1.1",
-		"@superutils/promise": "^1.1.3"
+		"@superutils/core": "^1.1.4",
+		"@superutils/promise": "^1.1.4"
 	},
 	"publishConfig": {
 		"access": "public"
@@ -45,5 +45,5 @@
 	"sideEffects": false,
 	"type": "module",
 	"types": "dist/index.d.ts",
-	"version": "1.1.3"
+	"version": "1.1.5"
 }