fix(api): change JSDocs mediaType param to reflect code (#72)

* Option object key name mediaType -> mediaTypes * MediaType is an object, not String
dcmjs-org · Aug 10, 2023 · 6d6ae85 · 6d6ae85
1 parent 4cff356
commit 6d6ae85
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/src/api.js b/src/api.js
@@ -1338,14 +1338,20 @@ class DICOMwebClient {
     );
   }
 
+ /**
+ * Element in mediaTypes parameter
+ * @typedef {Object} MediaType
+ * @param {String} [MediaType.mediaType] - ie 'image/jpeg', 'image/png'...
+ */
+
   /**
    * Retrieves an individual, server-side rendered DICOM Instance.
    *
    * @param {Object} options
    * @param {String} options.studyInstanceUID - Study Instance UID
    * @param {String} options.seriesInstanceUID - Series Instance UID
    * @param {String} options.sopInstanceUID - SOP Instance UID
-   * @param {String[]} [options.mediaType] - Acceptable HTTP media types
+   * @param {MediaType[]} [options.mediaTypes] - Acceptable HTTP media types
    * @param {Object} [options.queryParams] - HTTP query parameters
    * @returns {Promise<ArrayBuffer>} Rendered DICOM Instance
    */
@@ -1446,7 +1452,7 @@ class DICOMwebClient {
    * @param {String} options.studyInstanceUID - Study Instance UID
    * @param {String} options.seriesInstanceUID - Series Instance UID
    * @param {String} options.sopInstanceUID - SOP Instance UID
-   * @param {String[]} [options.mediaType] - Acceptable HTTP media types
+   * @param {MediaType[]} [options.mediaTypes] - Acceptable HTTP media types
    * @param {Object} [options.queryParams] - HTTP query parameters
    * @returns {ArrayBuffer} Thumbnail
    */
@@ -1522,7 +1528,7 @@ class DICOMwebClient {
    * @param {String} options.seriesInstanceUID - Series Instance UID
    * @param {String} options.sopInstanceUID - SOP Instance UID
    * @param {String} options.frameNumbers - One-based indices of Frame Items
-   * @param {String[]} [options.mediaType] - Acceptable HTTP media types
+   * @param {MediaType[]} [options.mediaTypes] - Acceptable HTTP media types
    * @param {Object} [options.queryParams] - HTTP query parameters
    * @returns {ArrayBuffer[]} Rendered Frame Items as byte arrays
    */