npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

obsidian-undocumented

v0.1.3

Published

Undocumented/private API definitions for Obsidian.md

Downloads

2,452

Readme

obsidian-undocumented

latest supported version total downloads

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.

Installation

Use npm or yarn to install type definitions for undocumented Obsidian APIs:

npm install obsidian-undocumented

Usage

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();
	}
}

Unsafe API

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);
	}
}

Targeting Specific Obsidian Versions

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
		}
	}
}

Supported Versions

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.