JsExecutionGlobals

Defined in: jsEngine/engine/JsExecution.ts:104

Global variables provided to a JsExecution.

Properties

app

app: App

Defined in: jsEngine/engine/JsExecution.ts:108

Reference to the obsidian app (obsidian API).

---

component

component: Component

Defined in: jsEngine/engine/JsExecution.ts:116

Obsidian component for lifecycle management.

---

container

container: undefined | HTMLElement

Defined in: jsEngine/engine/JsExecution.ts:124

The container element that the execution can render to. This can be undefined.

---

context

context: ExecutionContext & Record<string, unknown>

Defined in: jsEngine/engine/JsExecution.ts:120

The context provided. This can be undefined and extended by other properties.

---

engine

engine: API

Defined in: jsEngine/engine/JsExecution.ts:112

Reference to this plugins API.

---

obsidian

obsidian: __module

Defined in: jsEngine/engine/JsExecution.ts:128

The entire obsidian module, e.g. a notice can be constructed like this: new obsidian.Notice('Hello World').