obsidian-typings 2.26.0 → 2.27.0

package/dist/cjs/implementations.d.cts

@@ -1075,8 +1075,8 @@ export interface BookmarksViewConstructor extends TypedViewConstructor<Bookmarks
 }
 /** @public */
 export interface Bracket {
-	pos: EditorPosition;
 	ch: string;
+	pos: EditorPosition;
 }
 /** @todo Documentation incomplete */
 /** @public */
@@ -1295,8 +1295,8 @@ export interface CanvasPluginInstanceOptions {
 	cardLabelVisibility?: "always" | "hover" | "never";
 	defaultModDragBehavior?: "card" | "group" | "media" | "menu" | "note" | "webpage";
 	defaultWheelBehavior?: "pan" | "zoom";
-	newFileLocation?: "root" | "current" | "folder";
 	newFileFolderPath?: string;
+	newFileLocation?: "root" | "current" | "folder";
 	snapToGrid?: boolean;
 	snapToObjects?: boolean;
 	zoomBreakpoint?: number;
@@ -1773,8 +1773,8 @@ export interface CapacitorFileEntry extends Partial<FileStats> {
 }
 /** @public */
 export interface ClickableToken {
-	start: EditorPosition;
 	end: EditorPosition;
+	start: EditorPosition;
 	text: string;
 	type: string;
 }
@@ -1857,11 +1857,11 @@ export interface CodeMirrorAdapterEx {
 /** @public */
 export interface CodeMirrorAdapterExCommands {
 	cursorCharLeft(editor: CodeMirrorEditor): void;
-	redo(editor: CodeMirrorEditor): void;
-	undo(editor: CodeMirrorEditor): void;
+	indentAuto(editor: CodeMirrorEditor): void;
 	newlineAndIndent(editor: CodeMirrorEditor): void;
 	newlineAndIndentBefore(editor: CodeMirrorEditor): void;
-	indentAuto(editor: CodeMirrorEditor): void;
+	redo(editor: CodeMirrorEditor): void;
+	undo(editor: CodeMirrorEditor): void;
 }
 /** @public */
 export interface CodeMirrorEditor {
@@ -1949,12 +1949,12 @@ export interface CodeMirrorEditorMode {
 }
 /** @public */
 export interface CodeMirrorEditorSearchCursor {
+	find(reverse?: boolean): boolean;
 	findNext(): boolean;
 	findPrevious(): boolean;
-	find(reverse?: boolean): boolean;
 	from(): EditorPosition | void;
-	to(): EditorPosition | void;
 	replace(text: string): void;
+	to(): EditorPosition | void;
 }
 /** @public */
 export interface CommandPalettePlugin extends InternalPlugin<CommandPalettePluginInstance> {
@@ -2034,10 +2034,10 @@ export interface ConstructorBase<Args extends unknown[], Instance> {
 }
 /** @public */
 export interface Coords {
+	bottom: number;
 	left: number;
 	right: number;
 	top: number;
-	bottom: number;
 }
 /** @public */
 export interface CoordsLeftTop {
@@ -2732,8 +2732,8 @@ export interface EmptyViewConstructor extends TypedViewConstructor<EmptyView> {
 }
 /** @public */
 export interface EnclosingTag {
-	open: EditorRangeEx;
 	close: EditorRangeEx;
+	open: EditorRangeEx;
 }
 /** @public */
 export interface EventsEntry {
@@ -3156,11 +3156,11 @@ export interface FrameDom {
 }
 /** @public */
 export interface GetRecentFilesOptions {
-	showMarkdown: boolean;
+	maxCount: number;
 	showCanvas: boolean;
-	showNonImageAttachments: boolean;
 	showImages: boolean;
-	maxCount: number;
+	showMarkdown: boolean;
+	showNonImageAttachments: boolean;
 }
 /** @public */
 export interface GetTypeInfoOptions {
@@ -3489,10 +3489,10 @@ export interface GroupBookmarkItem extends BookmarkItem {
 }
 /** @public */
 export interface HardWrapOptions {
+	allowMerge?: boolean;
 	column?: number;
 	from?: number;
 	to?: number;
-	allowMerge?: boolean;
 }
 /** @public */
 export interface HotkeyManager {
@@ -3698,9 +3698,9 @@ export interface InfoFileView extends FileView {
 }
 /** @public */
 export interface InstallThemeOptions {
+	author: string;
 	name: string;
 	repo: string;
-	author: string;
 }
 /** @todo Documentation incomplete */
 /** @public */
@@ -4713,9 +4713,9 @@ export interface ObsidianTouchEvent {
 }
 /** @public */
 export interface ObsidianTouchEventRegisterCallback {
-	move(x: number): void;
 	cancel(): void;
 	finish(x: number, y: number, z: number): void;
+	move(x: number): void;
 }
 /** @public */
 export interface OpenDialogOptions {
@@ -4731,8 +4731,8 @@ export interface OpenDialogOptions {
 }
 /** @public */
 export interface OpenNotificationOptions {
-	duration?: number;
 	bottom?: boolean;
+	duration?: number;
 }
 /** @public */
 export interface OutgoingLinkPlugin extends InternalPlugin<OutgoingLinkPluginInstance> {
@@ -4833,9 +4833,9 @@ export interface PagePreviewPluginInstance extends InternalPluginInstance<PagePr
 /** @public */
 export interface PdfExportSettings {
 	/**
-	 * Default: 'letter'
+	 * Default: 100
 	 */
-	pageSize: string;
+	downscalePercent: number;
 	/**
 	 * Default: false
 	 */
@@ -4845,9 +4845,9 @@ export interface PdfExportSettings {
 	 */
 	margin: string;
 	/**
-	 * Default: 100
+	 * Default: 'letter'
 	 */
-	downscalePercent: number;
+	pageSize: string;
 }
 /** @todo Documentation incomplete */
 /** @public */
@@ -5286,12 +5286,12 @@ export interface SQLTransaction {
 }
 /** @public */
 export interface ScrollInfo {
+	clientHeight: number;
+	clientWidth: number;
+	height: number;
 	left: number;
 	top: number;
-	height: number;
 	width: number;
-	clientHeight: number;
-	clientWidth: number;
 }
 /** @public */
 export interface SearchBookmarkItem extends BookmarkItem {
@@ -5446,11 +5446,11 @@ export interface SetBookmarkOptions {
 }
 /** @public */
 export interface SetHighlightMatch {
-	focus: boolean;
-	startLoc?: number;
 	endLoc?: number;
+	focus: boolean;
 	line?: number;
 	match?: unknown;
+	startLoc?: number;
 }
 /** @public */
 export interface SetSelectionOptions {
@@ -5553,8 +5553,8 @@ export interface StatusBar {
 }
 /** @public */
 export interface Submenu {
-	title: string;
 	icon: string;
+	title: string;
 }
 /** @public */
 export interface SuggestionContainer<T> {
@@ -5943,14 +5943,14 @@ export interface TreeNodeInfo {
 }
 /** @public */
 export interface TreeNodeVChildren<T> {
-	addChild: (item: TreeNode<T>) => void;
 	_children: TreeNode<T>[];
+	addChild: (item: TreeNode<T>) => void;
 	owner: TreeNode<T>;
 }
 /** @public */
 export interface TypeInfo {
-	inferred: PropertyWidget<unknown>;
 	expected: PropertyWidget<unknown>;
+	inferred: PropertyWidget<unknown>;
 }
 /**
  * A constructor for a view that is typed to a specific view type.
@@ -5995,9 +5995,9 @@ export interface VideoViewConstructor extends TypedViewConstructor<VideoView> {
 }
 /** @public */
 export interface ViewEphemeralState {
+	cursor?: EditorRangeOrCaret;
 	focus: boolean;
 	focusOnMobile: boolean;
-	cursor?: EditorRangeOrCaret;
 }
 /** @public */
 export interface ViewRegistry extends Events {

package/dist/cjs/types.d.cts

@@ -1388,6 +1388,8 @@ declare module "obsidian" {
 		 * Reference to electron ipcRenderer module
 		 */
 		ipcRenderer?: IpcRenderer;
+		/** @internal */
+		killLastAction: null | ((e: Error) => void);
 		/**
 		 * Reference to node path module
 		 */
@@ -1419,8 +1421,6 @@ declare module "obsidian" {
 		getFilePath(normalizedPath: string): string;
 		/** @internal Kill file system action due to timeout */
 		kill(): void;
-		/** @internal */
-		killLastAction: null | ((e: Error) => void);
 		/** @internal Generates `this.files` from the file system */
 		listAll(): Promise<void>;
 		/**
@@ -1439,7 +1439,7 @@ declare module "obsidian" {
 		/** @internal */
 		reconcileFileInternal(normalizedPath: string, normalizedNewPath: string): Promise<void>;
 		/** @internal */
-		startWatchpath(normalizedPath: string): Promise<void>;
+		startWatchPath(normalizedPath: string): Promise<void>;
 		/** @internal Remove listener on specific path */
 		stopWatchPath(normalizedPath: string): void;
 		/** @internal */
@@ -2057,14 +2057,12 @@ declare module "obsidian" {
 }
 declare module "obsidian" {
 	interface MetadataCache extends Events {
+		/** @internal Called by preload() which is in turn called by initialize() */
+		_preload: () => Promise<void>;
 		/**
 		 * Reference to App
 		 */
 		app: App;
-		/** @internal Called by preload() which is in turn called by initialize() */
-		_preload: () => Promise<void>;
-		preloadPromise: Promise<void> | null;
-		preload: () => Promise<void>;
 		/** @internal */
 		blockCache: BlockCache;
 		/** @internal IndexedDB database */
@@ -2083,6 +2081,8 @@ declare module "obsidian" {
 		metadataCache: MetadataCacheMetadataCacheRecord;
 		/** @internal Callbacks to execute on cache clean */
 		onCleanCacheCallbacks: (() => void)[];
+		preload: () => Promise<void>;
+		preloadPromise: Promise<void> | null;
 		/** @internal Mapping of filename to collection of files that share the same name */
 		uniqueFileLookup: CustomArrayDict<TFile>;
 		/** @internal */
@@ -2106,10 +2106,10 @@ declare module "obsidian" {
 		cleanupDeletedCache(): void;
 		/** @internal */
 		clear(): Promise<void>;
-		/** @internal */
-		computeMetadataAsync(arrayBuffer: ArrayBuffer): Promise<CachedMetadata | undefined>;
 		/** @internal Called by initialize() */
 		computeFileMetadataAsync(file: TFile): Promise<void>;
+		/** @internal */
+		computeMetadataAsync(arrayBuffer: ArrayBuffer): Promise<CachedMetadata | undefined>;
 		/** @internal Remove all entries that contain deleted path */
 		deletePath(path: string): void;
 		/**
@@ -2680,6 +2680,8 @@ declare module "obsidian" {
 		/** @internal Debounced function for saving config */
 		requestSaveConfig: Debouncer<[
 		], Promise<void>>;
+		/** @internal The same TFolder object as `.fileMap["/"]` */
+		root: TFolder;
 		/** @internal Add file as child/parent to respective folders */
 		addChild(file: TAbstractFile): void;
 		/** @internal Check whether new file path is available */
@@ -4299,8 +4301,8 @@ export interface BookmarksViewConstructor extends TypedViewConstructor<Bookmarks
 }
 /** @public */
 export interface Bracket {
-	pos: EditorPosition;
 	ch: string;
+	pos: EditorPosition;
 }
 /** @todo Documentation incomplete */
 /** @public */
@@ -4519,8 +4521,8 @@ export interface CanvasPluginInstanceOptions {
 	cardLabelVisibility?: "always" | "hover" | "never";
 	defaultModDragBehavior?: "card" | "group" | "media" | "menu" | "note" | "webpage";
 	defaultWheelBehavior?: "pan" | "zoom";
-	newFileLocation?: "root" | "current" | "folder";
 	newFileFolderPath?: string;
+	newFileLocation?: "root" | "current" | "folder";
 	snapToGrid?: boolean;
 	snapToObjects?: boolean;
 	zoomBreakpoint?: number;
@@ -4997,8 +4999,8 @@ export interface CapacitorFileEntry extends Partial<FileStats> {
 }
 /** @public */
 export interface ClickableToken {
-	start: EditorPosition;
 	end: EditorPosition;
+	start: EditorPosition;
 	text: string;
 	type: string;
 }
@@ -5081,11 +5083,11 @@ export interface CodeMirrorAdapterEx {
 /** @public */
 export interface CodeMirrorAdapterExCommands {
 	cursorCharLeft(editor: CodeMirrorEditor): void;
-	redo(editor: CodeMirrorEditor): void;
-	undo(editor: CodeMirrorEditor): void;
+	indentAuto(editor: CodeMirrorEditor): void;
 	newlineAndIndent(editor: CodeMirrorEditor): void;
 	newlineAndIndentBefore(editor: CodeMirrorEditor): void;
-	indentAuto(editor: CodeMirrorEditor): void;
+	redo(editor: CodeMirrorEditor): void;
+	undo(editor: CodeMirrorEditor): void;
 }
 /** @public */
 export interface CodeMirrorEditor {
@@ -5173,12 +5175,12 @@ export interface CodeMirrorEditorMode {
 }
 /** @public */
 export interface CodeMirrorEditorSearchCursor {
+	find(reverse?: boolean): boolean;
 	findNext(): boolean;
 	findPrevious(): boolean;
-	find(reverse?: boolean): boolean;
 	from(): EditorPosition | void;
-	to(): EditorPosition | void;
 	replace(text: string): void;
+	to(): EditorPosition | void;
 }
 /** @public */
 export interface CommandPalettePlugin extends InternalPlugin<CommandPalettePluginInstance> {
@@ -5258,10 +5260,10 @@ export interface ConstructorBase<Args extends unknown[], Instance> {
 }
 /** @public */
 export interface Coords {
+	bottom: number;
 	left: number;
 	right: number;
 	top: number;
-	bottom: number;
 }
 /** @public */
 export interface CoordsLeftTop {
@@ -5956,8 +5958,8 @@ export interface EmptyViewConstructor extends TypedViewConstructor<EmptyView> {
 }
 /** @public */
 export interface EnclosingTag {
-	open: EditorRangeEx;
 	close: EditorRangeEx;
+	open: EditorRangeEx;
 }
 /** @public */
 export interface EventsEntry {
@@ -6380,11 +6382,11 @@ export interface FrameDom {
 }
 /** @public */
 export interface GetRecentFilesOptions {
-	showMarkdown: boolean;
+	maxCount: number;
 	showCanvas: boolean;
-	showNonImageAttachments: boolean;
 	showImages: boolean;
-	maxCount: number;
+	showMarkdown: boolean;
+	showNonImageAttachments: boolean;
 }
 /** @public */
 export interface GetTypeInfoOptions {
@@ -6713,10 +6715,10 @@ export interface GroupBookmarkItem extends BookmarkItem {
 }
 /** @public */
 export interface HardWrapOptions {
+	allowMerge?: boolean;
 	column?: number;
 	from?: number;
 	to?: number;
-	allowMerge?: boolean;
 }
 /** @public */
 export interface HotkeyManager {
@@ -6922,9 +6924,9 @@ export interface InfoFileView extends FileView {
 }
 /** @public */
 export interface InstallThemeOptions {
+	author: string;
 	name: string;
 	repo: string;
-	author: string;
 }
 /** @todo Documentation incomplete */
 /** @public */
@@ -7937,9 +7939,9 @@ export interface ObsidianTouchEvent {
 }
 /** @public */
 export interface ObsidianTouchEventRegisterCallback {
-	move(x: number): void;
 	cancel(): void;
 	finish(x: number, y: number, z: number): void;
+	move(x: number): void;
 }
 /** @public */
 export interface OpenDialogOptions {
@@ -7955,8 +7957,8 @@ export interface OpenDialogOptions {
 }
 /** @public */
 export interface OpenNotificationOptions {
-	duration?: number;
 	bottom?: boolean;
+	duration?: number;
 }
 /** @public */
 export interface OutgoingLinkPlugin extends InternalPlugin<OutgoingLinkPluginInstance> {
@@ -8057,9 +8059,9 @@ export interface PagePreviewPluginInstance extends InternalPluginInstance<PagePr
 /** @public */
 export interface PdfExportSettings {
 	/**
-	 * Default: 'letter'
+	 * Default: 100
 	 */
-	pageSize: string;
+	downscalePercent: number;
 	/**
 	 * Default: false
 	 */
@@ -8069,9 +8071,9 @@ export interface PdfExportSettings {
 	 */
 	margin: string;
 	/**
-	 * Default: 100
+	 * Default: 'letter'
 	 */
-	downscalePercent: number;
+	pageSize: string;
 }
 /** @todo Documentation incomplete */
 /** @public */
@@ -8510,12 +8512,12 @@ export interface SQLTransaction {
 }
 /** @public */
 export interface ScrollInfo {
+	clientHeight: number;
+	clientWidth: number;
+	height: number;
 	left: number;
 	top: number;
-	height: number;
 	width: number;
-	clientHeight: number;
-	clientWidth: number;
 }
 /** @public */
 export interface SearchBookmarkItem extends BookmarkItem {
@@ -8670,11 +8672,11 @@ export interface SetBookmarkOptions {
 }
 /** @public */
 export interface SetHighlightMatch {
-	focus: boolean;
-	startLoc?: number;
 	endLoc?: number;
+	focus: boolean;
 	line?: number;
 	match?: unknown;
+	startLoc?: number;
 }
 /** @public */
 export interface SetSelectionOptions {
@@ -8777,8 +8779,8 @@ export interface StatusBar {
 }
 /** @public */
 export interface Submenu {
-	title: string;
 	icon: string;
+	title: string;
 }
 /** @public */
 export interface SuggestionContainer<T> {
@@ -9167,14 +9169,14 @@ export interface TreeNodeInfo {
 }
 /** @public */
 export interface TreeNodeVChildren<T> {
-	addChild: (item: TreeNode<T>) => void;
 	_children: TreeNode<T>[];
+	addChild: (item: TreeNode<T>) => void;
 	owner: TreeNode<T>;
 }
 /** @public */
 export interface TypeInfo {
-	inferred: PropertyWidget<unknown>;
 	expected: PropertyWidget<unknown>;
+	inferred: PropertyWidget<unknown>;
 }
 /**
  * A constructor for a view that is typed to a specific view type.
@@ -9219,9 +9221,9 @@ export interface VideoViewConstructor extends TypedViewConstructor<VideoView> {
 }
 /** @public */
 export interface ViewEphemeralState {
+	cursor?: EditorRangeOrCaret;
 	focus: boolean;
 	focusOnMobile: boolean;
-	cursor?: EditorRangeOrCaret;
 }
 /** @public */
 export interface ViewRegistry extends Events {

package/dist/obsidian-typings.api.json

@@ -31418,7 +31418,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "charCoords(\n        pos: "
+                  "text": "charCoords(pos: "
                 },
                 {
                   "kind": "Reference",
@@ -31427,7 +31427,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ",\n        mode: "
+                  "text": ", mode: "
                 },
                 {
                   "kind": "Content",
@@ -31435,7 +31435,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "\n    ): "
+                  "text": "): "
                 },
                 {
                   "kind": "Reference",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-typings",
-    "version": "2.26.0",
+    "version": "2.27.0",
     "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
     "main": "",
     "module": "",