obsidian-typings 3.2.0 → 3.2.2

package/dist/cjs/types.d.cts

@@ -2821,7 +2821,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link blur} instead.
 		 */
-		blur__(): void;
+		blur__?(): void;
 		/**
 		 * Convert editor position to screen position.
 		 *
@@ -2852,7 +2852,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link focus} instead.
 		 */
-		focus__(): void;
+		focus__?(): void;
 		/**
 		 * Unfolds all folded lines one level up.
 		 *
@@ -2938,7 +2938,7 @@ declare module "obsidian" {
 		 * @returns The scroll info.
 		 * @official
 		 */
-		getScrollInfo__(): {
+		getScrollInfo__?(): {
 			/** @official */
 			top: number;
 			/** @official */
@@ -2951,7 +2951,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link getSelection} instead.
 		 */
-		getSelection__(): string;
+		getSelection__?(): string;
 		/**
 		 * Get the content of the editor.
 		 *
@@ -2959,14 +2959,14 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link getValue} instead.
 		 */
-		getValue__(): string;
+		getValue__?(): string;
 		/**
 		 * Check if the editor is focused.
 		 *
 		 * @returns Whether the editor is focused.
 		 * @official
 		 */
-		hasFocus__(): boolean;
+		hasFocus__?(): boolean;
 		/**
 		 * Checks whether the editor has a highlight of specified class.
 		 *
@@ -2988,7 +2988,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link lastLine} instead.
 		 */
-		lastLine__(): number;
+		lastLine__?(): number;
 		/**
 		 * Gets the amount of lines in the document.
 		 *
@@ -2996,7 +2996,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link lineCount} instead.
 		 */
-		lineCount__(): number;
+		lineCount__?(): number;
 		/**
 		 * Get the list of selections if multiple cursors are active.
 		 *
@@ -3004,7 +3004,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link listSelections} instead.
 		 */
-		listSelections__(): EditorSelection[];
+		listSelections__?(): EditorSelection[];
 		/**
 		 * Convert an offset to a position.
 		 *
@@ -3068,7 +3068,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link redo} instead.
 		 */
-		redo__(): void;
+		redo__?(): void;
 		/**
 		 * Refresh the editor.
 		 *
@@ -3079,7 +3079,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link refresh} instead.
 		 */
-		refresh__(): void;
+		refresh__?(): void;
 		/**
 		 * Removes all highlights of specified class.
 		 *
@@ -3222,7 +3222,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link undo} instead.
 		 */
-		undo__(): void;
+		undo__?(): void;
 		/**
 		 * Get the word at a specific position.
 		 *
@@ -3355,7 +3355,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link constructor} instead.
 		 */
-		constructor__(): this;
+		constructor__?(): this;
 		/**
 		 * Hide the menu.
 		 *
@@ -4216,7 +4216,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link constructor} instead.
 		 */
-		constructor__(): this;
+		constructor__?(): this;
 		/**
 		 * Executes the callback of the onClick event (if not disabled).
 		 *
@@ -4419,7 +4419,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link file} instead.
 		 */
-		get file__(): TFile;
+		file__?(): TFile;
 		/**
 		 * @todo Documentation incomplete.
 		 * @unofficial
@@ -4762,7 +4762,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link display} instead.
 		 */
-		display__(): void;
+		display__?(): void;
 		/**
 		 * Hides the contents of the setting tab.
 		 * Any registered components should be unloaded when the view is hidden.
@@ -5638,7 +5638,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link getValue} instead.
 		 */
-		getValue__(): T;
+		getValue__?(): T;
 		/**
 		 * Register an option listener.
 		 *
@@ -5783,7 +5783,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link file} instead.
 		 */
-		get file__(): TFile | null;
+		file__?(): TFile | null;
 		/**
 		 * Add property to inline metadata editor or properties plugin.
 		 *
@@ -8616,7 +8616,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link getDisplayText} instead.
 		 */
-		getDisplayText__(): string;
+		getDisplayText__?(): string;
 		/**
 		 * Get the ephemeral state of the view.
 		 *
@@ -8651,7 +8651,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link getViewType} instead.
 		 */
-		getViewType__(): string;
+		getViewType__?(): string;
 		/**
 		 * Handle copy event on metadata editor and serialize properties.
 		 *
@@ -8677,7 +8677,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link onClose} instead.
 		 */
-		onClose__(): Promise<void>;
+		onClose__?(): Promise<void>;
 		/**
 		 * @deprecated use `onPaneMenu` instead
 		 * @unofficial
@@ -8690,7 +8690,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link onOpen} instead.
 		 */
-		onOpen__(): Promise<void>;
+		onOpen__?(): Promise<void>;
 		/**
 		 * Populates the pane menu.
 		 *
@@ -11757,7 +11757,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link getItems} instead.
 		 */
-		getItems__(): T[];
+		getItems__?(): T[];
 		/**
 		 * Get the text to be used in the fuzzy search.
 		 *
@@ -12878,7 +12878,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link file} instead.
 		 */
-		get file__(): TFile | null;
+		file__?(): TFile | null;
 	}
 }
 declare module "obsidian" {
@@ -12925,7 +12925,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link file} instead.
 		 */
-		get file__(): TFile;
+		file__?(): TFile;
 		/**
 		 * @todo Documentation incomplete.
 		 * @unofficial
@@ -13529,7 +13529,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link clear} instead.
 		 */
-		clear__(): void;
+		clear__?(): void;
 		/**
 		 * Create a new text file view.
 		 *
@@ -13544,7 +13544,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link getViewData} instead.
 		 */
-		getViewData__(): string;
+		getViewData__?(): string;
 		/**
 		 * @todo Documentation incomplete.
 		 * @unofficial
@@ -13798,7 +13798,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link file} instead.
 		 */
-		get file__(): TFile;
+		file__?(): TFile;
 		/**
 		 * Apply the scroll position to the edit view.
 		 *
@@ -15185,7 +15185,7 @@ declare module "obsidian" {
 		 * @official
 		 * @deprecated - Added only for typing purposes. Use {@link isDeferred} instead.
 		 */
-		get isDeferred__(): boolean;
+		isDeferred__?(): boolean;
 		/**
 		 * Detach this leaf from its parent.
 		 *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-typings",
-    "version": "3.2.0",
+    "version": "3.2.2",
     "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
     "main": "",
     "module": "",
@@ -89,6 +89,9 @@
         "patch-package": "^8.0.0",
         "ts-morph": "^25.0.1"
     },
+    "peerDependencies": {
+        "typescript": ">=4.8.0"
+    },
     "overrides": {
         "boolean": "npm:dry-uninstall"
     },