Skip to content

Commit 6d6ae85

Browse files
authored
fix(api): change JSDocs mediaType param to reflect code (#72)
* Option object key name mediaType -> mediaTypes * MediaType is an object, not String
1 parent 4cff356 commit 6d6ae85

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

src/api.js

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1338,14 +1338,20 @@ class DICOMwebClient {
13381338
);
13391339
}
13401340

1341+
/**
1342+
* Element in mediaTypes parameter
1343+
* @typedef {Object} MediaType
1344+
* @param {String} [MediaType.mediaType] - ie 'image/jpeg', 'image/png'...
1345+
*/
1346+
13411347
/**
13421348
* Retrieves an individual, server-side rendered DICOM Instance.
13431349
*
13441350
* @param {Object} options
13451351
* @param {String} options.studyInstanceUID - Study Instance UID
13461352
* @param {String} options.seriesInstanceUID - Series Instance UID
13471353
* @param {String} options.sopInstanceUID - SOP Instance UID
1348-
* @param {String[]} [options.mediaType] - Acceptable HTTP media types
1354+
* @param {MediaType[]} [options.mediaTypes] - Acceptable HTTP media types
13491355
* @param {Object} [options.queryParams] - HTTP query parameters
13501356
* @returns {Promise<ArrayBuffer>} Rendered DICOM Instance
13511357
*/
@@ -1446,7 +1452,7 @@ class DICOMwebClient {
14461452
* @param {String} options.studyInstanceUID - Study Instance UID
14471453
* @param {String} options.seriesInstanceUID - Series Instance UID
14481454
* @param {String} options.sopInstanceUID - SOP Instance UID
1449-
* @param {String[]} [options.mediaType] - Acceptable HTTP media types
1455+
* @param {MediaType[]} [options.mediaTypes] - Acceptable HTTP media types
14501456
* @param {Object} [options.queryParams] - HTTP query parameters
14511457
* @returns {ArrayBuffer} Thumbnail
14521458
*/
@@ -1522,7 +1528,7 @@ class DICOMwebClient {
15221528
* @param {String} options.seriesInstanceUID - Series Instance UID
15231529
* @param {String} options.sopInstanceUID - SOP Instance UID
15241530
* @param {String} options.frameNumbers - One-based indices of Frame Items
1525-
* @param {String[]} [options.mediaType] - Acceptable HTTP media types
1531+
* @param {MediaType[]} [options.mediaTypes] - Acceptable HTTP media types
15261532
* @param {Object} [options.queryParams] - HTTP query parameters
15271533
* @returns {ArrayBuffer[]} Rendered Frame Items as byte arrays
15281534
*/

0 commit comments

Comments
 (0)