obsidian-typings 4.55.0 → 4.57.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ import type { Tree as LezerTree } from '@lezer/common';
8
8
  import type { App as App$1, BrowserWindow } from 'electron';
9
9
  import type { default as moment$1 } from 'moment';
10
10
  import type { FSWatcher } from 'node:fs';
11
- import type { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs } from 'obsidian';
11
+ import type { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs } from 'obsidian';
12
12
  import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle } from 'pixi.js';
13
13
 
14
14
  /**
@@ -1934,7 +1934,12 @@ export interface BasesLinkConstructor extends ConstructorBase<[
1934
1934
  displayText: string
1935
1935
  ], BasesLink> {
1936
1936
  /**
1937
- * @todo Documentation incomplete.
1937
+ * Parse {@link BasesLink} from string.
1938
+ *
1939
+ * @param app - The Obsidian application instance.
1940
+ * @param str - The string to parse.
1941
+ * @param sourcePath - The source path.
1942
+ * @returns The parsed {@link BasesLink}.
1938
1943
  */
1939
1944
  parseFromString(app: App, str: string, sourcePath: string): BasesLink;
1940
1945
  }
@@ -4285,14 +4290,24 @@ export interface Coords {
4285
4290
  top: number;
4286
4291
  }
4287
4292
  /**
4288
- * @todo Documentation incomplete.
4293
+ * Left and top coordinates.
4294
+ *
4289
4295
  * @public
4290
4296
  * @unofficial
4297
+ * @since 0.11.11
4291
4298
  */
4292
4299
  export interface CoordsLeftTop {
4293
- /** @todo Documentation incomplete. */
4300
+ /**
4301
+ * Left coordinate
4302
+ *
4303
+ * @since 0.11.11
4304
+ */
4294
4305
  left: number;
4295
- /** @todo Documentation incomplete. */
4306
+ /**
4307
+ * Top coordinate
4308
+ *
4309
+ * @since 0.11.11
4310
+ */
4296
4311
  top: number;
4297
4312
  }
4298
4313
  /**
@@ -6796,7 +6811,7 @@ export interface GraphRenderer {
6796
6811
  mouseY: number | null;
6797
6812
  /** Record of the nodes currently rendered, with `GraphNode.id` used as key. */
6798
6813
  nodeLookup: Record<string, GraphNode>;
6799
- /** List of nodes currenly rendered. */
6814
+ /** List of nodes currently rendered. */
6800
6815
  nodes: GraphNode[];
6801
6816
  /** Scale of the nodes based on the zoom level of the graph view. */
6802
6817
  nodeScale: number;
@@ -6824,7 +6839,7 @@ export interface GraphRenderer {
6824
6839
  textAlpha: number;
6825
6840
  /** @todo Documentation incomplete. */
6826
6841
  viewport: Coords;
6827
- /** Widt of the graph view, in pixel. */
6842
+ /** Width of the graph view, in pixel. */
6828
6843
  width: number;
6829
6844
  /** Web Worker thread running the graph simulation. */
6830
6845
  worker: Worker;
@@ -10206,14 +10221,6 @@ export interface ReleaseNotesView extends ItemView {
10206
10221
  */
10207
10222
  export interface ReleaseNotesViewConstructor extends TypedViewConstructor<ReleaseNotesView> {
10208
10223
  }
10209
- /**
10210
- * Render context.
10211
- *
10212
- * @public
10213
- * @unofficial
10214
- */
10215
- export interface RenderContext {
10216
- }
10217
10224
  /**
10218
10225
  * @todo Documentation incomplete.
10219
10226
  * @public