Merge pull request #407 from ahocevar/request-arg-types

Fix types of the request() method
geotiffjs · Nov 16, 2023 · 1f9e65a · 1f9e65a
2 parents 07f9007 + 6e6f981
commit 1f9e65a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/source/client/base.js b/src/source/client/base.js
@@ -37,7 +37,8 @@ export class BaseClient {
 
   /**
    * Send a request with the options
-   * @param {object} [options]
+   * @param {{headers: HeadersInit, credentials: RequestCredentials, signal: AbortSignal}} [options={}]
+   * @returns {Promise<BaseResponse>}
    */
   async request({ headers, credentials, signal } = {}) { // eslint-disable-line no-unused-vars
     throw new Error('request is not implemented');

diff --git a/src/source/client/fetch.js b/src/source/client/fetch.js
@@ -32,6 +32,10 @@ export class FetchClient extends BaseClient {
     this.credentials = credentials;
   }
 
+  /**
+   * @param {{headers: HeadersInit, credentials: RequestCredentials, signal: AbortSignal}} [options={}]
+   * @returns {Promise<FetchResponse>}
+   */
   async request({ headers, credentials, signal } = {}) {
     const response = await fetch(this.url, {
       headers, credentials, signal,