fix: jsDocs description containing pipes

src/lib/markdown.ts

@@ -112,7 +112,7 @@ const interfacesToMarkdown = ({
     );
 
     markdown.push(
-      `| \`${name}\` | \`${parseType(type ?? '')}\` | ${documentation !== undefined && documentation !== '' ? `${parseType(documentation).replace(/\r?\n|\r/g, '')}` : ''}${jsDocsDescription.length > 0 ? ` ${jsDocsDescription.join('')}` : ''} |`
+      `| \`${name}\` | \`${parseType(type ?? '')}\` | ${documentation !== undefined && documentation !== '' ? `${parseType(documentation).replace(/\r?\n|\r/g, '')}` : ''}${jsDocsDescription.length > 0 ? ` ${parseType(jsDocsDescription.join(''))}` : ''} |`
     );
   });
 
@@ -180,7 +180,7 @@ const toMarkdown = ({
   const rows: Row[] = entries.map(
     ({name, type, documentation, parameters, jsDocs, url}: DocEntry) => ({
       name,
-      type: type ?? '',
+      type: parseType(type ?? ''),
       documentation: documentation ?? '',
       params: [...toParams(parameters), ...jsDocsToParams(jsDocs ?? [])],
       examples: [...jsDocsToExamples(jsDocs ?? [])],

src/test/mock.json

@@ -373,5 +373,80 @@
     ],
     "doc_type": "function",
     "fileName": "src/test/mock.ts"
+  },
+  {
+    "name": "StorageConfigSourceGlob",
+    "documentation": "",
+    "jsDocs": [],
+    "doc_type": "type",
+    "fileName": "src/test/mock.ts"
+  },
+  {
+    "name": "StorageConfigRedirect",
+    "documentation": "Use a URL redirect to prevent broken links if you've moved a page or to shorten URLs.",
+    "type": "any",
+    "jsDocs": [
+      {
+        "name": "interface",
+        "text": [
+          {
+            "text": "StorageConfigRedirect",
+            "kind": "text"
+          }
+        ]
+      }
+    ],
+    "doc_type": "interface",
+    "properties": [
+      {
+        "name": "source",
+        "documentation": "The glob pattern or specific path to match for incoming requests that should be redirected.",
+        "type": "string",
+        "jsDocs": [
+          {
+            "name": "type",
+            "text": [
+              {
+                "text": "{StorageConfigSourceGlob}",
+                "kind": "text"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "name": "location",
+        "documentation": "The URL or path to which the request should be redirected.",
+        "type": "string",
+        "jsDocs": [
+          {
+            "name": "type",
+            "text": [
+              {
+                "text": "{string}",
+                "kind": "text"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "name": "code",
+        "documentation": "The HTTP status code to use for the redirect, typically 301 (permanent redirect) or 302 (temporary redirect).",
+        "type": "301 | 302",
+        "jsDocs": [
+          {
+            "name": "type",
+            "text": [
+              {
+                "text": "{301 | 302}",
+                "kind": "text"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "fileName": "src/test/mock.ts"
   }
 ]

src/test/mock.md

@@ -231,6 +231,7 @@ Description
 ## :tropical_drink: Interfaces
 
 - [Foo](#gear-foo)
+- [StorageConfigRedirect](#gear-storageconfigredirect)
 
 ### :gear: Foo
 
@@ -243,10 +244,22 @@ A Foo interface description.
 | `abc` | `Abc` |  |
 
 
+### :gear: StorageConfigRedirect
+
+Use a URL redirect to prevent broken links if you've moved a page or to shorten URLs.
+
+| Property | Type | Description |
+| ---------- | ---------- | ---------- |
+| `source` | `string` | The glob pattern or specific path to match for incoming requests that should be redirected. type: {StorageConfigSourceGlob} |
+| `location` | `string` | The URL or path to which the request should be redirected. type: {string} |
+| `code` | `301 or 302` | The HTTP status code to use for the redirect, typically 301 (permanent redirect) or 302 (temporary redirect). type: {301 or 302} |
+
+
 ## :cocktail: Types
 
 - [yolo](#gear-yolo)
 - [Abc](#gear-abc)
+- [StorageConfigSourceGlob](#gear-storageconfigsourceglob)
 
 ### :gear: yolo
 
@@ -268,3 +281,11 @@ A type yolo
 
 [:link: Source](https://github.com/peterpeterparker/tsdoc-markdown/tree/main/src/test/mock.ts#L148)
 
+### :gear: StorageConfigSourceGlob
+
+| Type | Type |
+| ---------- | ---------- |
+| `StorageConfigSourceGlob` |  |
+
+[:link: Source](https://github.com/peterpeterparker/tsdoc-markdown/tree/main/src/test/mock.ts#L219)
+

src/test/mock.ts

@@ -211,3 +211,33 @@ export function formInvalidateHandler(form: any, err: any, cb?: (msg: string) =>
     if (msg && cb) cb(msg);
   }
 }
+
+/**
+ * Represents a glob pattern for matching files in the Storage configuration.
+ * @typedef {string} StorageConfigSourceGlob
+ */
+export type StorageConfigSourceGlob = string;
+
+/**
+ * Use a URL redirect to prevent broken links if you've moved a page or to shorten URLs.
+ * @interface StorageConfigRedirect
+ */
+export interface StorageConfigRedirect {
+  /**
+   * The glob pattern or specific path to match for incoming requests that should be redirected.
+   * @type {StorageConfigSourceGlob}
+   */
+  source: StorageConfigSourceGlob;
+
+  /**
+   * The URL or path to which the request should be redirected.
+   * @type {string}
+   */
+  location: string;
+
+  /**
+   * The HTTP status code to use for the redirect, typically 301 (permanent redirect) or 302 (temporary redirect).
+   * @type {301 | 302}
+   */
+  code: 301 | 302;
+}