update to 0.3.1

Author: mProjectsCode

bun.lockb

@@ -14,16 +14,16 @@
 		"@astrojs/starlight": "0.31.1",
 		"@astrojs/svelte": "7.0.4",
 		"astro": "5.3.0",
-		"rehype-mathjax": "^7.0.0",
+		"rehype-mathjax": "^7.1.0",
 		"remark-math": "^6.0.0",
 		"sharp": "^0.33.5",
 		"starlight-links-validator": "^0.14.3",
 		"starlight-site-graph": "0.2.2",
 		"starlight-typedoc": "^0.18.0",
-		"svelte": "^5.20.0",
+		"svelte": "^5.20.2",
 		"typedoc": "^0.27.7",
 		"typedoc-plugin-markdown": "^4.4.2",
-		"typedoc-plugin-mdn-links": "^4.0.12",
+		"typedoc-plugin-mdn-links": "^4.0.13",
 		"typescript": "^5.7.3"
 	},
 	"devDependencies": {

obsidian-js-engine-plugin

@@ -5,15 +5,15 @@ prev: false
 title: "API"
 ---
 
-Defined in: [jsEngine/api/API.ts:18](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L18)
+Defined in: [jsEngine/api/API.ts:18](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L18)
 
 ## Constructors
 
 ### new API()
 
 > **new API**(`app`, `plugin`, `instanceId`): [`API`](/obsidian-js-engine-plugin-docs/api/classes/api/)
 
-Defined in: [jsEngine/api/API.ts:51](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L51)
+Defined in: [jsEngine/api/API.ts:51](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L51)
 
 #### Parameters
 
@@ -74,7 +74,7 @@ Defined in: [jsEngine/api/API.ts:51](https://github.com/mProjectsCode/obsidian-j
 
 > `readonly` **app**: `App`
 
-Defined in: [jsEngine/api/API.ts:22](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L22)
+Defined in: [jsEngine/api/API.ts:22](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L22)
 
 Reference to the obsidian app.
 
@@ -84,15 +84,15 @@ Reference to the obsidian app.
 
 > `readonly` **instanceId**: [`InstanceId`](/obsidian-js-engine-plugin-docs/api/classes/instanceid/)
 
-Defined in: [jsEngine/api/API.ts:27](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L27)
+Defined in: [jsEngine/api/API.ts:27](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L27)
 
 ***
 
 ### internal
 
 > `readonly` **internal**: [`InternalAPI`](/obsidian-js-engine-plugin-docs/api/classes/internalapi/)
 
-Defined in: [jsEngine/api/API.ts:49](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L49)
+Defined in: [jsEngine/api/API.ts:49](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L49)
 
 API to interact with js engines internals.
 
@@ -102,7 +102,7 @@ API to interact with js engines internals.
 
 > `readonly` **lib**: [`LibAPI`](/obsidian-js-engine-plugin-docs/api/classes/libapi/)
 
-Defined in: [jsEngine/api/API.ts:40](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L40)
+Defined in: [jsEngine/api/API.ts:40](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L40)
 
 API to interact with packaged libraries.
 
@@ -112,7 +112,7 @@ API to interact with packaged libraries.
 
 > `readonly` **markdown**: [`MarkdownAPI`](/obsidian-js-engine-plugin-docs/api/classes/markdownapi/)
 
-Defined in: [jsEngine/api/API.ts:32](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L32)
+Defined in: [jsEngine/api/API.ts:32](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L32)
 
 API to interact with markdown.
 
@@ -122,7 +122,7 @@ API to interact with markdown.
 
 > `readonly` **message**: [`MessageAPI`](/obsidian-js-engine-plugin-docs/api/classes/messageapi/)
 
-Defined in: [jsEngine/api/API.ts:36](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L36)
+Defined in: [jsEngine/api/API.ts:36](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L36)
 
 API to interact with the plugins message system.
 
@@ -132,7 +132,7 @@ API to interact with the plugins message system.
 
 > `readonly` **plugin**: `JsEnginePlugin`
 
-Defined in: [jsEngine/api/API.ts:26](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L26)
+Defined in: [jsEngine/api/API.ts:26](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L26)
 
 Reference the JS Engine plugin.
 
@@ -142,15 +142,15 @@ Reference the JS Engine plugin.
 
 > `readonly` **prompt**: [`PromptAPI`](/obsidian-js-engine-plugin-docs/api/classes/promptapi/)
 
-Defined in: [jsEngine/api/API.ts:45](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L45)
+Defined in: [jsEngine/api/API.ts:45](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L45)
 
 ***
 
 ### query
 
 > `readonly` **query**: [`QueryAPI`](/obsidian-js-engine-plugin-docs/api/classes/queryapi/)
 
-Defined in: [jsEngine/api/API.ts:44](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L44)
+Defined in: [jsEngine/api/API.ts:44](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L44)
 
 API to query your vault with simple javascript functions.
 
@@ -160,15 +160,15 @@ API to query your vault with simple javascript functions.
 
 > `readonly` **validators**: `Validators`
 
-Defined in: [jsEngine/api/API.ts:28](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L28)
+Defined in: [jsEngine/api/API.ts:28](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L28)
 
 ## Methods
 
 ### getObsidianModule()
 
 > **getObsidianModule**(): `__module`
 
-Defined in: [jsEngine/api/API.ts:110](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L110)
+Defined in: [jsEngine/api/API.ts:110](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L110)
 
 Gets the obsidian module.
 This allows you to access all things exported by the obsidian module.
@@ -190,7 +190,7 @@ new obsidian.Notice('Hello World!');
 
 > **getPlugin**(`pluginId`): `undefined` \| `Plugin`
 
-Defined in: [jsEngine/api/API.ts:94](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L94)
+Defined in: [jsEngine/api/API.ts:94](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L94)
 
 Gets a plugin by its id. A plugin id can be found by looking at its manifest.
 If the plugin is not enabled, this will return undefined.
@@ -236,7 +236,7 @@ the id of the plugin.
 
 > **importJs**(`path`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`unknown`\>
 
-Defined in: [jsEngine/api/API.ts:74](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L74)
+Defined in: [jsEngine/api/API.ts:74](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L74)
 
 Loads an ECMAScript module from a vault relative path.
 Everything you import via this function will be loaded as an ECMAScript module.
@@ -285,7 +285,7 @@ the vault relative path of the file to import
 
 > **parseLink**(`link`): `undefined` \| `MarkdownLink`
 
-Defined in: [jsEngine/api/API.ts:149](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L149)
+Defined in: [jsEngine/api/API.ts:149](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L149)
 
 Parses a markdown link.
 This link can be a markdown link or a wiki link.
@@ -331,7 +331,7 @@ the link to parse.
 
 > **reactive**(`fn`, ...`initialArgs`): [`ReactiveComponent`](/obsidian-js-engine-plugin-docs/api/classes/reactivecomponent/)
 
-Defined in: [jsEngine/api/API.ts:121](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L121)
+Defined in: [jsEngine/api/API.ts:121](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L121)
 
 Creates a reactive component.
 Reactive components are useful for creating dynamic content.
@@ -394,7 +394,7 @@ the initial arguments (for the first render) to pass to the function.
 
 > **resolveLinkToTFile**(`link`, `sourcePath`): `undefined` \| `TFile`
 
-Defined in: [jsEngine/api/API.ts:135](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/8502428515e4bbbda63a1c50981c15858802b7c4/jsEngine/api/API.ts#L135)
+Defined in: [jsEngine/api/API.ts:135](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/fff05749aaa23f9a775003f5828b7e747db4ed95/jsEngine/api/API.ts#L135)
 
 Gets the target file of a link.
 This link can be a markdown link or a wiki link.