@fuman/fetch 0.1.0 → 0.1.1

package/addons/rate-limit.d.cts

@@ -1,5 +1,5 @@
-import { FfetchAddon } from './types.js';
 import { MaybePromise } from '@fuman/utils';
+import { FfetchAddon } from './types.js';
 export interface RateLimitAddon {
     rateLimit?: {
         /**

package/addons/rate-limit.d.ts

@@ -1,5 +1,5 @@
-import { FfetchAddon } from './types.js';
 import { MaybePromise } from '@fuman/utils';
+import { FfetchAddon } from './types.js';
 export interface RateLimitAddon {
     rateLimit?: {
         /**

package/ffetch.cjs

@@ -66,6 +66,9 @@ class FfetchResultImpl {
         } catch {
         }
       }
+      if (this._options.mapError != null) {
+        throw this._options.mapError(err);
+      }
       throw err;
     }
     return res;
@@ -195,6 +198,8 @@ function createFfetch(baseOptions = {}) {
     }
     init.headers = headers;
     options.validateResponse ??= baseOptions.validateResponse;
+    options.readBodyOnError ??= baseOptions.readBodyOnError;
+    options.mapError ??= baseOptions.mapError;
     return new FfetchResultInner(fetcher, url, init, headers, options, stack);
   };
   const fn = fn_;

package/ffetch.d.cts

@@ -23,6 +23,30 @@ export interface FfetchOptions {
      * @default true
      */
     readBodyOnError?: boolean;
+    /**
+     * optional function to map the error
+     *
+     * useful when your API has an app-level error format, and you want to throw a custom error
+     *
+     * @param err  original {@link HttpError} that would have been thrown
+     * @returns  the error to be thrown instead
+     * @example
+     * ```ts
+     * const api = createFfetch({
+     *   ...,
+     *   mapError: (err) => {
+     *     if (err.response.headers.get('Content-Type') !== 'application/json') return err
+     *     try {
+     *       // note: .bodyText is only available if `readBodyOnError` is true
+     *       const json = JSON.parse(err.bodyText)
+     *       throw new ApiError(json.errorCode, json.message)
+     *     } catch {
+     *       return err
+     *     }
+     *   }
+     * })
+     */
+    mapError?: (err: HttpError) => Error;
     /**
      * base url to be prepended to the url
      *

package/ffetch.d.ts

@@ -23,6 +23,30 @@ export interface FfetchOptions {
      * @default true
      */
     readBodyOnError?: boolean;
+    /**
+     * optional function to map the error
+     *
+     * useful when your API has an app-level error format, and you want to throw a custom error
+     *
+     * @param err  original {@link HttpError} that would have been thrown
+     * @returns  the error to be thrown instead
+     * @example
+     * ```ts
+     * const api = createFfetch({
+     *   ...,
+     *   mapError: (err) => {
+     *     if (err.response.headers.get('Content-Type') !== 'application/json') return err
+     *     try {
+     *       // note: .bodyText is only available if `readBodyOnError` is true
+     *       const json = JSON.parse(err.bodyText)
+     *       throw new ApiError(json.errorCode, json.message)
+     *     } catch {
+     *       return err
+     *     }
+     *   }
+     * })
+     */
+    mapError?: (err: HttpError) => Error;
     /**
      * base url to be prepended to the url
      *

package/ffetch.js

@@ -64,6 +64,9 @@ class FfetchResultImpl {
         } catch {
         }
       }
+      if (this._options.mapError != null) {
+        throw this._options.mapError(err);
+      }
       throw err;
     }
     return res;
@@ -193,6 +196,8 @@ function createFfetch(baseOptions = {}) {
     }
     init.headers = headers;
     options.validateResponse ??= baseOptions.validateResponse;
+    options.readBodyOnError ??= baseOptions.readBodyOnError;
+    options.mapError ??= baseOptions.mapError;
     return new FfetchResultInner(fetcher, url, init, headers, options, stack);
   };
   const fn = fn_;

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "@fuman/fetch",
     "type": "module",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "tiny wrapper over fetch",
     "license": "MIT",
     "dependencies": {
-        "@fuman/utils": "^0.0.14"
+        "@fuman/utils": "^0.0.15"
     },
     "peerDependencies": {
         "@badrap/valita": ">=0.4.0",