@ribbon-studios/js-utils 2.0.0 → 2.1.0

package/README.md

@@ -26,7 +26,7 @@ Collection of generic javascript utilities curated by the Ribbon Studios Team~
     - [`rfetch.put`](#rfetchput)
     - [`rfetch.post`](#rfetchpost)
     - [`rfetch.patch`](#rfetchpatch)
-    - [`rfetch.remove`](#rfetchremove)
+    - [`rfetch.delete`](#rfetchdelete)
     - [`rfetch.interceptors`](#rfetchinterceptors)
     - [`rfetch.delimiters`](#rfetchdelimiters)
 
@@ -195,7 +195,7 @@ import { rfetch, type RibbonFetchError } from '@ribbon-studios/js-utils';
 await rfetch.patch<MyExpectedResponse>('https://ribbonstudios.com');
 ```
 
-### `rfetch.remove`
+### `rfetch.delete`
 
 Shorthand for DELETE requests.
 
@@ -203,7 +203,7 @@ Shorthand for DELETE requests.
 import { rfetch, type RibbonFetchError } from '@ribbon-studios/js-utils';
 
 // Shorthand for DELETE requests.
-await rfetch.remove<MyExpectedResponse>('https://ribbonstudios.com');
+await rfetch.delete<MyExpectedResponse>('https://ribbonstudios.com');
 ```
 
 ### `rfetch.interceptors`

package/dist/index.cjs

@@ -113,6 +113,12 @@ async function rfetch(url, { params, body, ...options } = {}) {
     })
   );
 }
+rfetch.delete = (url, options) => {
+  return rfetch(url, {
+    ...options,
+    method: "DELETE"
+  });
+};
 ((rfetch2) => {
   async function get(url, options) {
     return rfetch2(url, {
@@ -143,10 +149,7 @@ async function rfetch(url, { params, body, ...options } = {}) {
   }
   rfetch2.patch = patch;
   async function remove(url, options) {
-    return rfetch2(url, {
-      ...options,
-      method: "DELETE"
-    });
+    return rfetch2.delete(url, options);
   }
   rfetch2.remove = remove;
   async function delimiters(type) {

package/dist/index.js

@@ -111,6 +111,12 @@ async function rfetch(url, { params, body, ...options } = {}) {
     })
   );
 }
+rfetch.delete = (url, options) => {
+  return rfetch(url, {
+    ...options,
+    method: "DELETE"
+  });
+};
 ((rfetch2) => {
   async function get(url, options) {
     return rfetch2(url, {
@@ -141,10 +147,7 @@ async function rfetch(url, { params, body, ...options } = {}) {
   }
   rfetch2.patch = patch;
   async function remove(url, options) {
-    return rfetch2(url, {
-      ...options,
-      method: "DELETE"
-    });
+    return rfetch2.delete(url, options);
   }
   rfetch2.remove = remove;
   async function delimiters(type) {

package/dist/rfetch.d.ts

@@ -27,6 +27,10 @@ export declare enum DelimiterType {
  * @returns The typed response or an error containing the `status` and the `content`
  */
 export declare function rfetch<T = any>(url: string | URL, { params, body, ...options }?: RibbonFetchOptions): Promise<T>;
+export declare namespace rfetch {
+    var _a: <T>(url: string | URL, options?: RibbonFetchBodyOptions) => Promise<T>;
+    export { _a as delete };
+}
 export declare namespace rfetch {
     /**
      * Shorthand method for a GET request
@@ -66,7 +70,7 @@ export declare namespace rfetch {
      * @param url The url you wish to fetch.
      * @param options The request options.
      * @returns The typed response or an error containing the `status` and the `content`
-     * @note This is named `remove` purely because `delete` is a reserved key
+     * @deprecated in favor of {@link rfetch.delete}
      */
     function remove<T>(url: string | URL, options?: RibbonFetchBodyOptions): Promise<T>;
     function delimiters(type: DelimiterType): Promise<void>;

package/package.json

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