Drive-by fix: use MediaType instead of string in parameter type decl.

DisyInformationssysteme · Nov 6, 2023 · 5ea8c57 · 5ea8c57
1 parent 4e16f41
commit 5ea8c57
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/cadenza.js b/src/cadenza.js
@@ -171,7 +171,7 @@ export class CadenzaClient {
    * @param {boolean} [options.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
    * @param {boolean} [options.hideWorkbookToolBar] - Whether to hide the workbook toolbar
    * @param {GlobalId} [options.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
-   * @param {string} [options.mediaType] - Set to 'application/pdf' for views of type "JasperReports report"
+   * @param {MediaType} [options.mediaType] - Set to 'application/pdf' for views of type "JasperReports report"
    *     to show the report PDF directly, without any Cadenza headers or footers.
    * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
    * @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
@@ -678,7 +678,7 @@ function assertSupportedMediaType(
   /** @type MediaType */ type,
   /** @type MediaType[] */ supportedTypes = Object.values(MediaType),
 ) {
-  return assert(supportedTypes.includes(type), `Invalid media type: ${type}`);
+  assert(supportedTypes.includes(type), `Invalid media type: ${type}`);
 }
 
 /**
@@ -691,7 +691,7 @@ function assertSupportedMediaType(
  * @param {GlobalId} [params.highlightGlobalId]
  * @param {string} [params.locationFinder]
  * @param {Extent} [params.mapExtent]
- * @param {string} [params.mediaType]
+ * @param {MediaType} [params.mediaType]
  * @param {number} [params.minScale]
  * @param {TablePart[]} [params.parts]
  * @param {boolean} [params.useMapSrs]