Skip to content

Commit 67579ca

Browse files
committed
Regenerate API docs
1 parent e8eeb9d commit 67579ca

24 files changed

+4162
-13
lines changed

docs/api/classes/App.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ constructor();
88

99
## Properties
1010

11+
### keymap
12+
13+
```ts
14+
keymap: Keymap
15+
```
16+
17+
### scope
18+
19+
```ts
20+
scope: Scope
21+
```
22+
1123
### workspace
1224

1325
```ts

docs/api/classes/Component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Registers an key event to be detached when unloading
107107
### registerInterval
108108
109109
```ts
110-
registerInterval(id: number): void;
110+
registerInterval(id: number): number;
111111
```
112112
113113
Registers an interval (from setInterval) to be cancelled when unloading

docs/api/classes/Editor.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,9 @@ abstract posToOffset(pos: EditorPosition): number;
202202
```ts
203203
abstract offsetToPos(offset: number): EditorPosition;
204204
```
205+
206+
### processLines
207+
208+
```ts
209+
processLines<T>(read: (line: number, lineText: string) => T | null, write: (line: number, lineText: string, value: T | null) => EditorChange | void, ignoreEmpty?: boolean): void;
210+
```

docs/api/classes/Keymap.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ constructor();
88

99
## Methods
1010

11+
### pushScope
12+
13+
```ts
14+
pushScope(scope: Scope): void;
15+
```
16+
17+
### popScope
18+
19+
```ts
20+
popScope(scope: Scope): void;
21+
```
22+
1123
### isModifier
1224

1325
```ts

docs/api/classes/MarkdownSourceView.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ constructor(view: MarkdownView);
1313
### cmEditor
1414

1515
```ts
16-
cmEditor: Editor
16+
cmEditor: any
1717
```
1818

1919
### hoverPopover

docs/api/classes/MetadataCache.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,25 @@ If not unique, use full path.
6868
### on
6969

7070
```ts
71-
on(name: 'changed', callback: (file: TFile) => any, ctx?: any): EventRef;
71+
on(name: 'changed', callback: (file: TFile, data: string, cache: CachedMetadata) => any, ctx?: any): EventRef;
7272
```
7373

7474
Called when a file has been indexed, and its (updated) cache is now available.
75+
Called when a file has been deleted. A best-effort previous version of the cached metadata is presented,
76+
but it could be null in case the file was not successfully cached previously.
77+
Called when a file has been resolved for `resolvedLinks` and `unresolvedLinks`.
78+
This happens sometimes after a file has been indexed.
79+
Called when all files has been resolved. This will be fired each time files get modified after the initial load.
80+
81+
### on
82+
83+
```ts
84+
on(name: 'deleted', callback: (file: TFile, prevCache: CachedMetadata | null) => any, ctx?: any): EventRef;
85+
```
86+
87+
Called when a file has been indexed, and its (updated) cache is now available.
88+
Called when a file has been deleted. A best-effort previous version of the cached metadata is presented,
89+
but it could be null in case the file was not successfully cached previously.
7590
Called when a file has been resolved for `resolvedLinks` and `unresolvedLinks`.
7691
This happens sometimes after a file has been indexed.
7792
Called when all files has been resolved. This will be fired each time files get modified after the initial load.
@@ -83,6 +98,8 @@ on(name: 'resolve', callback: (file: TFile) => any, ctx?: any): EventRef;
8398
```
8499

85100
Called when a file has been indexed, and its (updated) cache is now available.
101+
Called when a file has been deleted. A best-effort previous version of the cached metadata is presented,
102+
but it could be null in case the file was not successfully cached previously.
86103
Called when a file has been resolved for `resolvedLinks` and `unresolvedLinks`.
87104
This happens sometimes after a file has been indexed.
88105
Called when all files has been resolved. This will be fired each time files get modified after the initial load.
@@ -94,6 +111,8 @@ on(name: 'resolved', callback: () => any, ctx?: any): EventRef;
94111
```
95112

96113
Called when a file has been indexed, and its (updated) cache is now available.
114+
Called when a file has been deleted. A best-effort previous version of the cached metadata is presented,
115+
but it could be null in case the file was not successfully cached previously.
97116
Called when a file has been resolved for `resolvedLinks` and `unresolvedLinks`.
98117
This happens sometimes after a file has been indexed.
99118
Called when all files has been resolved. This will be fired each time files get modified after the initial load.

docs/api/classes/Plugin_2.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ registerExtensions(extensions: string[], viewType: string): void;
6767
### registerMarkdownPostProcessor
6868

6969
```ts
70-
registerMarkdownPostProcessor(postProcessor: MarkdownPostProcessor): MarkdownPostProcessor;
70+
registerMarkdownPostProcessor(postProcessor: MarkdownPostProcessor, sortOrder?: number): MarkdownPostProcessor;
7171
```
7272

7373
### registerMarkdownCodeBlockProcessor
7474

7575
```ts
76-
registerMarkdownCodeBlockProcessor(language: string, handler: (source: string, el: HTMLElement, ctx: MarkdownPostProcessorContext) => Promise<any> | void): MarkdownPostProcessor;
76+
registerMarkdownCodeBlockProcessor(language: string, handler: (source: string, el: HTMLElement, ctx: MarkdownPostProcessorContext) => Promise<any> | void, sortOrder?: number): MarkdownPostProcessor;
7777
```
7878

7979
Register a special post processor that handles fenced code given a language and a handler.
@@ -89,6 +89,16 @@ registerCodeMirror(callback: (cm: CodeMirror.Editor) => any): void;
8989
Runs callback on all currently loaded instances of CodeMirror,
9090
then registers the callback for all future CodeMirror instances.
9191

92+
### registerEditorExtension
93+
94+
```ts
95+
registerEditorExtension(extension: Extension): void;
96+
```
97+
98+
Registers a CodeMirror 6 extension.
99+
To reconfigure cm6 extensions for your plugin on the fly, you can pass an array here and dynamically
100+
modify it. Once this array is modified, call `Workspace.updateOptions()` to have the changes applied.
101+
92102
### registerObsidianProtocolHandler
93103

94104
```ts

docs/api/classes/Scope.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Constructor
44

55
```ts
6-
constructor();
6+
constructor(parent: Scope);
77
```
88

99
## Methods

docs/api/classes/Setting.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,9 @@ then(cb: (setting: this) => any): this;
143143
```
144144

145145
Facilitates chaining
146+
147+
### clear
148+
149+
```ts
150+
clear(): this;
151+
```

docs/api/classes/SuggestModal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Called when the user makes a selection.
6767
### getSuggestions
6868

6969
```ts
70-
abstract getSuggestions(query: string): T[];
70+
abstract getSuggestions(query: string): T[] | Promise<T[]>;
7171
```
7272

7373
### renderSuggestion

0 commit comments

Comments
 (0)