Skip to content

Commit 2cf2c3a

Browse files
committed
update docs to 0.1.16
1 parent d45025d commit 2cf2c3a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1399
-325
lines changed

src/content/docs/api/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ title: "obsidian-js-engine-plugin"
3838
## Interfaces
3939

4040
- [Block](/obsidian-js-engine-plugin-docs/api/interfaces/block/)
41+
- [ButtonPromptButtonOptions](/obsidian-js-engine-plugin-docs/api/interfaces/buttonpromptbuttonoptions/)
4142
- [ButtonPromptOptions](/obsidian-js-engine-plugin-docs/api/interfaces/buttonpromptoptions/)
4243
- [ConfirmPromptOptions](/obsidian-js-engine-plugin-docs/api/interfaces/confirmpromptoptions/)
4344
- [EngineExecutionParams](/obsidian-js-engine-plugin-docs/api/interfaces/engineexecutionparams/)

src/content/docs/api/classes/API.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ title: "API"
6666

6767
#### Defined in
6868

69-
[jsEngine/api/API.ts:45](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L45)
69+
[jsEngine/api/API.ts:49](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L49)
7070

7171
## Properties
7272

@@ -78,7 +78,7 @@ Reference to the obsidian app.
7878

7979
#### Defined in
8080

81-
[jsEngine/api/API.ts:17](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L17)
81+
[jsEngine/api/API.ts:20](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L20)
8282

8383
***
8484

@@ -88,7 +88,7 @@ Reference to the obsidian app.
8888
8989
#### Defined in
9090

91-
[jsEngine/api/API.ts:22](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L22)
91+
[jsEngine/api/API.ts:25](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L25)
9292

9393
***
9494

@@ -100,7 +100,7 @@ API to interact with js engines internals.
100100

101101
#### Defined in
102102

103-
[jsEngine/api/API.ts:43](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L43)
103+
[jsEngine/api/API.ts:47](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L47)
104104

105105
***
106106

@@ -112,7 +112,7 @@ API to interact with packaged libraries.
112112

113113
#### Defined in
114114

115-
[jsEngine/api/API.ts:34](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L34)
115+
[jsEngine/api/API.ts:38](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L38)
116116

117117
***
118118

@@ -124,7 +124,7 @@ API to interact with markdown.
124124

125125
#### Defined in
126126

127-
[jsEngine/api/API.ts:26](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L26)
127+
[jsEngine/api/API.ts:30](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L30)
128128

129129
***
130130

@@ -136,7 +136,7 @@ API to interact with the plugins message system.
136136

137137
#### Defined in
138138

139-
[jsEngine/api/API.ts:30](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L30)
139+
[jsEngine/api/API.ts:34](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L34)
140140

141141
***
142142

@@ -148,7 +148,7 @@ Reference the JS Engine plugin.
148148

149149
#### Defined in
150150

151-
[jsEngine/api/API.ts:21](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L21)
151+
[jsEngine/api/API.ts:24](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L24)
152152

153153
***
154154

@@ -158,7 +158,7 @@ Reference the JS Engine plugin.
158158
159159
#### Defined in
160160

161-
[jsEngine/api/API.ts:39](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L39)
161+
[jsEngine/api/API.ts:43](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L43)
162162

163163
***
164164

@@ -170,7 +170,17 @@ API to query your vault with simple javascript functions.
170170

171171
#### Defined in
172172

173-
[jsEngine/api/API.ts:38](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L38)
173+
[jsEngine/api/API.ts:42](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L42)
174+
175+
***
176+
177+
### validators
178+
179+
> `readonly` **validators**: `Validators`
180+
181+
#### Defined in
182+
183+
[jsEngine/api/API.ts:26](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L26)
174184

175185
## Methods
176186

@@ -218,7 +228,7 @@ the id of the plugin.
218228

219229
#### Defined in
220230

221-
[jsEngine/api/API.ts:85](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L85)
231+
[jsEngine/api/API.ts:92](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L92)
222232

223233
***
224234

@@ -269,7 +279,7 @@ the vault relative path of the file to import
269279

270280
#### Defined in
271281

272-
[jsEngine/api/API.ts:67](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L67)
282+
[jsEngine/api/API.ts:72](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L72)
273283

274284
***
275285

@@ -334,4 +344,4 @@ the initial arguments (for the first render) to pass to the function.
334344

335345
#### Defined in
336346

337-
[jsEngine/api/API.ts:96](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/1f0648da628182867a83f5d8f76c6abab1f05793/jsEngine/api/API.ts#L96)
347+
[jsEngine/api/API.ts:105](https://github.com/mProjectsCode/obsidian-js-engine-plugin/blob/2a2cfe4836b2dabd89bbe1da5831eff3e3e8be62/jsEngine/api/API.ts#L105)

0 commit comments

Comments
 (0)