An extension to the official obsidian
type definitions that provides access to undocumented and internal Obsidian APIs.
This project aims to provide quality typings that are relevant across a range of public Obsidian versions.
Use npm
or yarn
to install type definitions for undocumented Obsidian APIs:
npm install obsidian-undocumented
Import the type definitions and use the as
keyword to cast the official, documented API type into the unofficial one.
import {Plugin} from "obsidian";
import {App} from "obsidian-undocumented";
export default MyPlugin extends Plugin {
async onload() {
// Get the enabled instance of the "other-plugin" plugin.
const otherPlugin = (this.app as App).plugins.getPlugin("other-plugin");
otherPlugin.doSomething();
}
}
There are two flavors of type definitions available: the default (safe) definitions, and the unsafe
definitions. The safe definitions provide typings for harmless functions and fields, and the unsafe definitions provide typings that can accidentally break Obsidian or be abused to manipulate other plugins.
The definition flavors can be picked by either importing obsidian-undocumented
for the safe definitions or obsidian-undocumented/unsafe
for the unsafe ones.
Example:
import {Plugin} from "obsidian";
import {App} from "obsidian-undocumented/unsafe";
export default MyPlugin extends Plugin {
async onload() {
(this.app as App).plugins.disablePlugin(this.manifest.id);
}
}
If your plugin has different logic for different Obsidian versions, it is possible to select type definitions matching the specific version. All of the definitions exported by obsidian-undocumented
contain a generic parameter V
, which should be a string for one of the supported versions.
If the parameter is omitted, type definitions will be selected for the latest Obsidian version that is supported by this package.
Example:
import { Plugin, apiVersion } from "obsidian";
import { App, v1_0_0 } from "obsidian-undocumented";
export default class ExamplePlugin extends Plugin {
async onload() {
if (apiVersion === '1.0.0') {
const app = this.app as App<v1_0_0>;
// Do something specific to API version 1.0.0
}
}
}
Undocumented API type definitions are available for the following Obsidian versions:
There are currently no plans to support pre-release or beta versions of Obsidian.