Merge pull request #298 from MichaelBuhler/fix-docs

A solution for the docs generation error

Author: constantinius

.jsdoc.json

@@ -1,5 +1,5 @@
 {
-    "plugins": ["plugins/markdown", "jsdoc-plugin-typescript"],
+    "plugins": ["plugins/markdown", "jsdoc-plugin-typescript", "jsdoc-plugin-intersection"],
     "typescript": {
         "moduleRoot": "src"
     }

package-lock.json

@@ -56,6 +56,7 @@
     "fs-extra": "^7.0.1",
     "isomorphic-fetch": "^2.2.1",
     "jsdoc": "^3.6.4",
+    "jsdoc-plugin-intersection": "^1.0.4",
     "jsdoc-plugin-typescript": "^2.0.6",
     "jshint-stylish": "^2.2.1",
     "mocha": "^7.1.0",

package.json

@@ -28,7 +28,28 @@ export { setLogger };
  */
 
 /**
- * @typedef { (TypedArray | TypedArray[]) & { height: number; width: number } } ReadRasterResult
+ * @typedef {{ height:number, width: number }} Dimensions
+ */
+
+/**
+ * The autogenerated docs are a little confusing here. The effective type is:
+ *
+ * `TypedArray & { height: number; width: number}`
+ * @typedef {TypedArray & Dimensions} TypedArrayWithDimensions
+ */
+
+/**
+ * The autogenerated docs are a little confusing here. The effective type is:
+ *
+ * `TypedArray[] & { height: number; width: number}`
+ * @typedef {TypedArray[] & Dimensions} TypedArrayArrayWithDimensions
+ */
+
+/**
+ *  The autogenerated docs are a little confusing here. The effective type is:
+ *
+ * `(TypedArray | TypedArray[]) & { height: number; width: number}`
+ * @typedef {TypedArrayWithDimensions | TypedArrayArrayWithDimensions} ReadRasterResult
  */
 
 function getFieldTypeLength(fieldType) {
@@ -186,7 +207,7 @@ class GeoTIFFBase {
    * image is called and the result returned.
    * @see GeoTIFFImage.readRasters
    * @param {import('./geotiffimage').ReadRasterOptions} [options={}] optional parameters
-   * @returns {Promise<ReadRasterResult>} the decoded arrays as a promise
+   * @returns {Promise<ReadRasterResult>} the decoded array(s), with `height` and `width`, as a promise
    */
   async readRasters(options = {}) {
     const { window: imageWindow, width, height } = options;