fix(docs): Add workaround for ErrorMetadata typedef (#8737)

videojs · May 23, 2024 · 4de09e4 · 4de09e4
1 parent 35de64c
commit 4de09e4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/.jsdoc.js b/.jsdoc.js
@@ -61,6 +61,7 @@ module.exports = {
   plugins: [
     'plugins/markdown',
     'build/jsdoc-typeof-plugin',
+    'build/jsdoc-workarounds',
   ],
   markdown: {
     tags: ['example'],

diff --git a/build/jsdoc-workarounds.js b/build/jsdoc-workarounds.js
@@ -0,0 +1,13 @@
+/**
+ * This jsdoc plugin works around some typescript-flavoured jsdoc that isn't actual jsdoc,
+ * so docs:api doesn't fail
+ */
+exports.handlers = {
+  jsdocCommentFound: event => {
+    // Special case for media-error.js
+    event.comment = (event.comment || '').replace(
+      '@typedef {{errorType: string, [key: string]: any}} ErrorMetadata',
+      '@typedef {Object} ErrorMetadata\n * @property {string} errorType Error type'
+    );
+  }
+};