feat: add JSDoc example

.gitignore

@@ -9,3 +9,4 @@ node_modules/
 /playwright-report/
 /playwright/.cache/
 $__StoryList.tid
+types/generated/

core/modules/wiki.js

@@ -22,6 +22,13 @@ Adds the following properties to the wiki object:
 /*global $tw: false */
 "use strict";
 
+/**
+ * @typedef {import('$:/core/modules/widgets/widget.js').widget} Widget
+ */
+
+/**
+ * @type {Widget}
+ */
 var widget = require("$:/core/modules/widgets/widget.js");
 
 var USER_NAME_TITLE = "$:/status/UserName",

package.json

@@ -13,6 +13,7 @@
   "bin": {
     "tiddlywiki": "./tiddlywiki.js"
   },
+  "types": "./types",
   "main": "./boot/boot.js",
   "repository": {
     "type": "git",

tsconfig.json

@@ -11,15 +11,16 @@
     "allowSyntheticDefaultImports": true,
     "checkJs": true,
     "declaration": true,
-    "declarationDir": "types",
+    "declarationDir": "types/generated",
     "declarationMap": true,
     "emitDeclarationOnly": true,
     "lib": ["ES2020", "DOM", "DOM.Iterable"],
     "module": "Node16",
-    "outDir": "types",
-    "rootDir": "core",
+    "outDir": "types/generated",
+    "rootDir": ".",
     "skipLibCheck": true,
     "target": "ESNext"
   },
-  "include": ["./core/**/*.js", "**/*.d.ts"]
+  "include": ["./core/**/*.js", "./core/**/*.d.ts", "types/tw.d.ts"],
+  "exclude": ["types/generated"]
 }

types/tw.d.ts

@@ -0,0 +1,7 @@
+import * as Wiki from '../core/modules/wiki';
+
+declare global {
+  var $tw: {
+    wiki: typeof Wiki;
+  };
+}