add jsdoc for Response class

hellotext · Jan 11, 2025 · d63d30c · d63d30c
1 parent 289ad1e
commit d63d30c
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/src/api/response.js b/src/api/response.js
@@ -14,18 +14,34 @@ class Response {
     this.#success = success
   }
 
+  /**
+   * Get the response data
+   * @returns {*}
+   */
   get data() {
     return this.response
   }
 
+  /**
+   * Parse the response as JSON
+   * @returns {Promise<*>}
+   */
   async json() {
     return await this.response.json()
   }
 
+  /**
+   * Has the request failed?
+   * @returns {boolean}
+   */
   get failed() {
     return this.#success === false
   }
 
+  /**
+   * Has the request succeeded?
+   * @returns {boolean}
+   */
   get succeeded() {
     return this.#success === true
   }