@forklaunch/universal-sdk 0.2.3 → 0.2.5

package/lib/index.js

@@ -175,24 +175,75 @@ var UniversalSdk = class {
       headers: response.headers
     };
   }
+  /**
+   * Executes a request with path parameters.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {'GET' | 'DELETE'} method - The HTTP method.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async pathParamRequest(route, method, request) {
     return this.execute(route, method, request);
   }
+  /**
+   * Executes a request with a body.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {'POST' | 'PUT' | 'PATCH'} method - The HTTP method.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async bodyRequest(route, method, request) {
     return this.execute(route, method, request);
   }
+  /**
+   * Executes a GET request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async get(route, request) {
     return this.pathParamRequest(route, "GET", request);
   }
+  /**
+   * Executes a POST request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async post(route, request) {
     return this.bodyRequest(route, "POST", request);
   }
+  /**
+   * Executes a PUT request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async put(route, request) {
     return this.bodyRequest(route, "PUT", request);
   }
+  /**
+   * Executes a PATCH request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async patch(route, request) {
     return this.bodyRequest(route, "PATCH", request);
   }
+  /**
+   * Executes a DELETE request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async delete(route, request) {
     return this.pathParamRequest(route, "DELETE", request);
   }

package/lib/index.mjs

@@ -149,24 +149,75 @@ var UniversalSdk = class {
       headers: response.headers
     };
   }
+  /**
+   * Executes a request with path parameters.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {'GET' | 'DELETE'} method - The HTTP method.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async pathParamRequest(route, method, request) {
     return this.execute(route, method, request);
   }
+  /**
+   * Executes a request with a body.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {'POST' | 'PUT' | 'PATCH'} method - The HTTP method.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async bodyRequest(route, method, request) {
     return this.execute(route, method, request);
   }
+  /**
+   * Executes a GET request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async get(route, request) {
     return this.pathParamRequest(route, "GET", request);
   }
+  /**
+   * Executes a POST request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async post(route, request) {
     return this.bodyRequest(route, "POST", request);
   }
+  /**
+   * Executes a PUT request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async put(route, request) {
     return this.bodyRequest(route, "PUT", request);
   }
+  /**
+   * Executes a PATCH request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async patch(route, request) {
     return this.bodyRequest(route, "PATCH", request);
   }
+  /**
+   * Executes a DELETE request.
+   *
+   * @param {string} route - The route path for the request.
+   * @param {RequestType} [request] - The request object.
+   * @returns {Promise<ResponseType>} - The response object.
+   */
   async delete(route, request) {
     return this.pathParamRequest(route, "DELETE", request);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/universal-sdk",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Cross runtime fetch library for forklaunch router sdks",
   "keywords": [
     "fetch",
@@ -33,9 +33,9 @@
   "devDependencies": {
     "fetch-mock": "^12.5.2",
     "jest": "^29.7.0",
-    "ts-jest": "^29.3.1",
+    "ts-jest": "^29.3.2",
     "tsup": "^8.4.0",
-    "typedoc": "^0.28.1"
+    "typedoc": "^0.28.2"
   },
   "scripts": {
     "build": "tsc --noEmit && tsup index.ts --format cjs,esm --no-splitting --dts --tsconfig tsconfig.json --out-dir lib --clean",