more comments

Author: mProjectsCode

exampleVault/Test.md

@@ -158,4 +158,13 @@ component.registerEvent(unloadCb);
 
 // return the reactive component
 return reactive;
-```
+```
+
+# Obsidian Module
+
+```js-engine
+const el = container.createEl("button", {text: "Click me"})
+el.addEventListener("click", () => {
+	new obsidian.Notice("Hello")
+}); 
+```

jsEngine/engine/JsExecution.ts

@@ -17,20 +17,47 @@ export type JsFunc = (...args: unknown[]) => Promise<unknown>;
  * Context provided to a {@link JsExecution}.
  */
 export interface JsExecutionContext {
+	/**
+	 * The file that the execution was triggered from.
+	 */
 	file: TFile;
+	/**
+	 * The metadata of the file that the execution was triggered from.
+	 */
 	metadata: CachedMetadata | null;
+	/**
+	 * Currently unused.
+	 */
 	line: number;
 }
 
 /**
  * Global variables provided to a {@link JsExecution}.
  */
 export interface JsExecutionGlobals {
+	/**
+	 * Reference to the obsidian [app](https://docs.obsidian.md/Reference/TypeScript+API/App) (obsidian API).
+	 */
 	app: App;
+	/**
+	 * Reference to this plugins API.
+	 */
 	engine: API;
+	/**
+	 * Obsidian [component](https://docs.obsidian.md/Reference/TypeScript+API/Component) for lifecycle management.
+	 */
 	component: Component;
+	/**
+	 * The context provided. This can be undefined and extended by other properties.
+	 */
 	context: (JsExecutionContext | undefined) & Record<string, unknown>;
+	/**
+	 * The container element that the execution can render to. This can be undefined.
+	 */
 	container: HTMLElement | undefined;
+	/**
+	 * The entire obsidian module, e.g. a notice can be constructed like this: `new obsidian.Notice('Hello World')`.
+	 */
 	obsidian: typeof Obsidian;
 }