Skip to content
Obsidian Typings
A partially blurred cyan Obsidian logo, partially unblurred by a frame. A partially blurred cyan Obsidian logo, partially unblurred by a frame.

Obsidian Typings

Typescript typings for private parts of the Obsidian API.
Getting Started Disclaimer

Features

Typesafe access to Private API

Adds typings for the private API of Obsidian, allowing you to access undocumented methods in a typesafe way.

Explanations and examples

Adds explanations and examples for methods to help you understand how to properly use them.

Custom implementations

Provides custom methods for adding mocks or accessing unexposed API.

Next steps

Read the disclaimer

Read the disclaimer to understand the limitations of the typings.

Contribute to the project

Follow the contribution guide to help improve the typings and expand this project!