Regenerate API docs

Author: marcusolsson

docs/api/classes/App.md

@@ -8,6 +8,18 @@ constructor();
 
 ## Properties
 
+### keymap
+
+```ts
+keymap: Keymap
+```
+
+### scope
+
+```ts
+scope: Scope
+```
+
 ### workspace
 
 ```ts

docs/api/classes/Component.md

@@ -107,7 +107,7 @@ Registers an key event to be detached when unloading
 ### registerInterval
 
 ```ts
-registerInterval(id: number): void;
+registerInterval(id: number): number;
 ```
 
 Registers an interval (from setInterval) to be cancelled when unloading

docs/api/classes/Editor.md

@@ -202,3 +202,9 @@ abstract posToOffset(pos: EditorPosition): number;
 ```ts
 abstract offsetToPos(offset: number): EditorPosition;
 ```
+
+### processLines
+
+```ts
+processLines<T>(read: (line: number, lineText: string) => T | null, write: (line: number, lineText: string, value: T | null) => EditorChange | void, ignoreEmpty?: boolean): void;
+```

docs/api/classes/Keymap.md

@@ -8,6 +8,18 @@ constructor();
 
 ## Methods
 
+### pushScope
+
+```ts
+pushScope(scope: Scope): void;
+```
+
+### popScope
+
+```ts
+popScope(scope: Scope): void;
+```
+
 ### isModifier
 
 ```ts

docs/api/classes/MarkdownSourceView.md

@@ -13,7 +13,7 @@ constructor(view: MarkdownView);
 ### cmEditor
 
 ```ts
-cmEditor: Editor
+cmEditor: any
 ```
 
 ### hoverPopover

docs/api/classes/MetadataCache.md

@@ -68,10 +68,25 @@ If not unique, use full path.
 ### on
 
 ```ts
-on(name: 'changed', callback: (file: TFile) => any, ctx?: any): EventRef;
+on(name: 'changed', callback: (file: TFile, data: string, cache: CachedMetadata) => any, ctx?: any): EventRef;
 ```
 
 Called when a file has been indexed, and its (updated) cache is now available.
+Called when a file has been deleted. A best-effort previous version of the cached metadata is presented,
+but it could be null in case the file was not successfully cached previously.
+Called when a file has been resolved for `resolvedLinks` and `unresolvedLinks`.
+This happens sometimes after a file has been indexed.
+Called when all files has been resolved. This will be fired each time files get modified after the initial load.
+
+### on
+
+```ts
+on(name: 'deleted', callback: (file: TFile, prevCache: CachedMetadata | null) => any, ctx?: any): EventRef;
+```
+
+Called when a file has been indexed, and its (updated) cache is now available.
+Called when a file has been deleted. A best-effort previous version of the cached metadata is presented,
+but it could be null in case the file was not successfully cached previously.
 Called when a file has been resolved for `resolvedLinks` and `unresolvedLinks`.
 This happens sometimes after a file has been indexed.
 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;
 ```
 
 Called when a file has been indexed, and its (updated) cache is now available.
+Called when a file has been deleted. A best-effort previous version of the cached metadata is presented,
+but it could be null in case the file was not successfully cached previously.
 Called when a file has been resolved for `resolvedLinks` and `unresolvedLinks`.
 This happens sometimes after a file has been indexed.
 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;
 ```
 
 Called when a file has been indexed, and its (updated) cache is now available.
+Called when a file has been deleted. A best-effort previous version of the cached metadata is presented,
+but it could be null in case the file was not successfully cached previously.
 Called when a file has been resolved for `resolvedLinks` and `unresolvedLinks`.
 This happens sometimes after a file has been indexed.
 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

@@ -67,13 +67,13 @@ registerExtensions(extensions: string[], viewType: string): void;
 ### registerMarkdownPostProcessor
 
 ```ts
-registerMarkdownPostProcessor(postProcessor: MarkdownPostProcessor): MarkdownPostProcessor;
+registerMarkdownPostProcessor(postProcessor: MarkdownPostProcessor, sortOrder?: number): MarkdownPostProcessor;
 ```
 
 ### registerMarkdownCodeBlockProcessor
 
 ```ts
-registerMarkdownCodeBlockProcessor(language: string, handler: (source: string, el: HTMLElement, ctx: MarkdownPostProcessorContext) => Promise<any> | void): MarkdownPostProcessor;
+registerMarkdownCodeBlockProcessor(language: string, handler: (source: string, el: HTMLElement, ctx: MarkdownPostProcessorContext) => Promise<any> | void, sortOrder?: number): MarkdownPostProcessor;
 ```
 
 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;
 Runs callback on all currently loaded instances of CodeMirror,
 then registers the callback for all future CodeMirror instances.
 
+### registerEditorExtension
+
+```ts
+registerEditorExtension(extension: Extension): void;
+```
+
+Registers a CodeMirror 6 extension.
+To reconfigure cm6 extensions for your plugin on the fly, you can pass an array here and dynamically
+modify it. Once this array is modified, call `Workspace.updateOptions()` to have the changes applied.
+
 ### registerObsidianProtocolHandler
 
 ```ts

docs/api/classes/Scope.md

@@ -3,7 +3,7 @@
 ## Constructor
 
 ```ts
-constructor();
+constructor(parent: Scope);
 ```
 
 ## Methods

docs/api/classes/Setting.md

@@ -143,3 +143,9 @@ then(cb: (setting: this) => any): this;
 ```
 
 Facilitates chaining
+
+### clear
+
+```ts
+clear(): this;
+```

docs/api/classes/SuggestModal.md

@@ -67,7 +67,7 @@ Called when the user makes a selection.
 ### getSuggestions
 
 ```ts
-abstract getSuggestions(query: string): T[];
+abstract getSuggestions(query: string): T[] | Promise<T[]>;
 ```
 
 ### renderSuggestion

docs/api/classes/TAbstractFile.md

@@ -1,5 +1,7 @@
 # TAbstractFile
 
+This can be either a `TFile` or a `TFolder`.
+
 ## Constructor
 
 ```ts

docs/api/classes/Workspace.md

@@ -126,7 +126,7 @@ splitLeafOrActive(leaf?: WorkspaceLeaf, direction?: SplitDirection): WorkspaceLe
 ### duplicateLeaf
 
 ```ts
-duplicateLeaf(leaf: WorkspaceLeaf, direction?: SplitDirection): Promise<void>;
+duplicateLeaf(leaf: WorkspaceLeaf, direction?: SplitDirection): Promise<WorkspaceLeaf>;
 ```
 
 ### getUnpinnedLeaf
@@ -233,6 +233,15 @@ revealLeaf(leaf: WorkspaceLeaf): void;
 getLastOpenFiles(): string[];
 ```
 
+### updateOptions
+
+```ts
+updateOptions(): void;
+```
+
+Calling this function will update/reconfigure the options of all markdown panes.
+It is fairly expensive, so it should not be called frequently.
+
 ### iterateCodeMirrors
 
 ```ts
@@ -280,7 +289,7 @@ Perform some best effort cleanup here.
 ### on
 
 ```ts
-on(name: 'click', callback: () => any, ctx?: any): EventRef;
+on(name: 'click', callback: (evt: MouseEvent) => any, ctx?: any): EventRef;
 ```
 
 Triggered when the CSS of the app has changed.

docs/api/functions/request.md

@@ -1,9 +1,12 @@
 # request
 
 ```ts
-export function request(request: RequestParam): Promise<string>;
+export function request(request: RequestUrlParam): Promise<string>;
 ```
 
+Similar to `fetch()`, request a URL using HTTP/HTTPS, without any CORS restrictions.
+Returns the text value of the response.
+
 ## Parameters
 
 | Parameter | Description |

docs/api/functions/requestUrl.md

@@ -0,0 +1,13 @@
+# requestUrl
+
+```ts
+export function requestUrl(request: RequestUrlParam): Promise<RequestUrlResponse>;
+```
+
+Similar to `fetch()`, request a URL using HTTP/HTTPS, without any CORS restrictions.
+
+## Parameters
+
+| Parameter | Description |
+|-----------|-------------|
+| `request` | |

docs/api/functions/requireApiVersion.md

@@ -0,0 +1,15 @@
+# requireApiVersion
+
+```ts
+export function requireApiVersion(version: string): boolean;
+```
+
+Returns true if the API version is equal or higher than the requested version.
+Use this to limit functionality that require specific API versions to avoid
+crashing on older Obsidian builds.
+
+## Parameters
+
+| Parameter | Description |
+|-----------|-------------|
+| `version` | |

docs/api/interfaces/AjaxOptions.md

@@ -43,3 +43,9 @@ headers: Record<string, string>
 ```ts
 withCredentials: boolean
 ```
+
+### req
+
+```ts
+req: XMLHttpRequest
+```

docs/api/interfaces/BlockSubpathResult.md

@@ -13,3 +13,9 @@ type: "block"
 ```ts
 block: BlockCache
 ```
+
+### list
+
+```ts
+list: ListItemCache
+```

docs/api/interfaces/Command.md

@@ -76,4 +76,5 @@ Overrides `editorCallback`, `callback` and `checkCallback`
 hotkeys: Hotkey[]
 ```
 
-Sets the default hotkey
+Sets the default hotkey. It is recommended for plugins to avoid setting default hotkeys if possible,
+to avoid conflicting hotkeys with one that's set by the user, even though customized hotkeys have higher priority.

docs/api/interfaces/RequestUrlParam.md

@@ -0,0 +1,33 @@
+# RequestUrlParam
+
+## Properties
+
+### url
+
+```ts
+url: string
+```
+
+### method
+
+```ts
+method: string
+```
+
+### contentType
+
+```ts
+contentType: string
+```
+
+### body
+
+```ts
+body: string | ArrayBuffer
+```
+
+### headers
+
+```ts
+headers: Record<string, string>
+```

docs/api/interfaces/RequestUrlResponse.md

@@ -0,0 +1,33 @@
+# RequestUrlResponse
+
+## Properties
+
+### status
+
+```ts
+status: number
+```
+
+### headers
+
+```ts
+headers: Record<string, string>
+```
+
+### arrayBuffer
+
+```ts
+arrayBuffer: ArrayBuffer
+```
+
+### json
+
+```ts
+json: any
+```
+
+### text
+
+```ts
+text: string
+```

docs/api/overview.md

@@ -106,6 +106,8 @@ The [script](https://github.com/marcusolsson/dts-docs) used to generate the docu
 - [renderMath](functions/renderMath.md)
 - [renderResults](functions/renderResults.md)
 - [request](functions/request.md)
+- [requestUrl](functions/requestUrl.md)
+- [requireApiVersion](functions/requireApiVersion.md)
 - [resolveSubpath](functions/resolveSubpath.md)
 - [sanitizeHTMLToDom](functions/sanitizeHTMLToDom.md)
 - [setIcon](functions/setIcon.md)
@@ -167,7 +169,8 @@ The [script](https://github.com/marcusolsson/dts-docs) used to generate the docu
 - [PreparedQuery](interfaces/PreparedQuery.md)
 - [Rect_2](interfaces/Rect_2.md)
 - [ReferenceCache](interfaces/ReferenceCache.md)
-- [RequestParam](interfaces/RequestParam.md)
+- [RequestUrlParam](interfaces/RequestUrlParam.md)
+- [RequestUrlResponse](interfaces/RequestUrlResponse.md)
 - [SearchResult](interfaces/SearchResult.md)
 - [SearchResultContainer](interfaces/SearchResultContainer.md)
 - [SectionCache](interfaces/SectionCache.md)

docs/api/types/MarkdownViewModeType.md

@@ -1,7 +1,7 @@
 # MarkdownViewModeType
 
 ```ts
-export type MarkdownViewModeType = 'source' | 'preview' | 'live';
+export type MarkdownViewModeType = 'source' | 'preview';
 ```