@ribbon-studios/js-utils 1.5.1 → 1.6.0

package/README.md

@@ -249,6 +249,24 @@ await rfetch.get('https://ribbonstudios.com', {
 });
 ```
 
+### `rfetch.is.error`
+
+A type guard that helps determine if the error is from a `rfetch` response.
+
+```ts
+import { rfetch } from '@ribbon-studios/js-utils';
+
+try {
+  await rfetch.get('https://ribbonstudios.com');
+} catch (error: any) {
+  if (rfetch.is.error(error) && error.status === 404) {
+    // Do something!
+  }
+
+  throw error;
+}
+```
+
 [_**Want to Contribute?**_](/CONTRIBUTING.md)
 
 [npm-version-image]: https://img.shields.io/npm/v/@ribbon-studios/js-utils.svg

package/dist/index.cjs

@@ -41,6 +41,13 @@ async function retry(fn, n) {
     }
   }
 }
+class RibbonFetchError extends Error {
+  constructor({ status, content }) {
+    super();
+    this.status = status;
+    this.content = content;
+  }
+}
 var DelimiterType = /* @__PURE__ */ ((DelimiterType2) => {
   DelimiterType2[DelimiterType2["COMMA"] = 0] = "COMMA";
   DelimiterType2[DelimiterType2["DUPLICATE"] = 1] = "DUPLICATE";
@@ -100,10 +107,12 @@ async function rfetch(url, { params, body, ...options } = {}) {
   if (response.ok) {
     return content;
   }
-  return Promise.reject({
-    status: response.status,
-    content
-  });
+  return Promise.reject(
+    new RibbonFetchError({
+      status: response.status,
+      content
+    })
+  );
 }
 ((rfetch2) => {
   async function get(url, options) {
@@ -158,8 +167,15 @@ async function rfetch(url, { params, body, ...options } = {}) {
       fetchInterceptors = [];
     }
   };
+  ((is2) => {
+    function error(value) {
+      return value instanceof RibbonFetchError;
+    }
+    is2.error = error;
+  })(rfetch2.is || (rfetch2.is = {}));
 })(rfetch || (rfetch = {}));
 exports.DelimiterType = DelimiterType;
+exports.RibbonFetchError = RibbonFetchError;
 exports.assert = assert;
 exports.delay = delay;
 exports.never = never;

package/dist/index.js

@@ -39,6 +39,13 @@ async function retry(fn, n) {
     }
   }
 }
+class RibbonFetchError extends Error {
+  constructor({ status, content }) {
+    super();
+    this.status = status;
+    this.content = content;
+  }
+}
 var DelimiterType = /* @__PURE__ */ ((DelimiterType2) => {
   DelimiterType2[DelimiterType2["COMMA"] = 0] = "COMMA";
   DelimiterType2[DelimiterType2["DUPLICATE"] = 1] = "DUPLICATE";
@@ -98,10 +105,12 @@ async function rfetch(url, { params, body, ...options } = {}) {
   if (response.ok) {
     return content;
   }
-  return Promise.reject({
-    status: response.status,
-    content
-  });
+  return Promise.reject(
+    new RibbonFetchError({
+      status: response.status,
+      content
+    })
+  );
 }
 ((rfetch2) => {
   async function get(url, options) {
@@ -156,9 +165,16 @@ async function rfetch(url, { params, body, ...options } = {}) {
       fetchInterceptors = [];
     }
   };
+  ((is2) => {
+    function error(value) {
+      return value instanceof RibbonFetchError;
+    }
+    is2.error = error;
+  })(rfetch2.is || (rfetch2.is = {}));
 })(rfetch || (rfetch = {}));
 export {
   DelimiterType,
+  RibbonFetchError,
   assert,
   delay,
   never,

package/dist/promises/never.d.ts

@@ -2,4 +2,4 @@
  * Purely for testing spinners / skeletons
  * @returns A promise that never resolves
  */
-export declare function never(p?: Promise<any>): Promise<void>;
+export declare function never<T>(p?: Promise<T>): Promise<T>;

package/dist/rfetch.d.ts

@@ -6,10 +6,14 @@ export type RibbonFetchOptions = {
 } & Omit<RequestInit, 'body' | 'headers' | 'method'>;
 export type RibbonFetchBasicOptions = Omit<RibbonFetchOptions, 'method' | 'body'>;
 export type RibbonFetchBodyOptions = Omit<RibbonFetchOptions, 'method'>;
-export type RibbonFetchError<R> = {
+export declare class RibbonFetchError<R> extends Error {
     status: number;
     content: R;
-};
+    constructor({ status, content }: {
+        status: number;
+        content: R;
+    });
+}
 export type RibbonFetchInterceptor = (url: URL, options: RequestInit) => RequestInit | Promise<RequestInit>;
 export declare enum DelimiterType {
     COMMA = 0,
@@ -71,4 +75,7 @@ export declare namespace rfetch {
         remove(interceptor: RibbonFetchInterceptor): void;
         clear(): void;
     };
+    namespace is {
+        function error<T = any>(value: any): value is RibbonFetchError<T>;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ribbon-studios/js-utils",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Collection of generic javascript utilities curated by the Rainbow Cafe~",
   "type": "module",
   "source": "src/*.ts",