https://github.com/vanakat/plugin-api

Standartized way to expose and use Obsidian Inter-Plugin APIs
https://github.com/vanakat/plugin-api

Last synced: 3 months ago
JSON representation

Standartized way to expose and use Obsidian Inter-Plugin APIs

• Host: GitHub
• URL: https://github.com/vanakat/plugin-api
• Owner: vanakat
• License: mit
• Created: 2022-06-05T23:16:13.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-15T13:42:05.000Z (7 months ago)
• Last Synced: 2024-09-30T04:21:42.282Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 46.9 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Plugin API

Standartized way of exposing and using Obsidian Plugin APIs

## Installation

```shell

npm install --save-dev @vanakat/plugin-api

```

## Usage

This module exposes 2 functions:

* `registerAPI(name, api, plugin)` - registers plugin API in global variable (`window`)

* `pluginApi(name)` - returns plugin API based on its name

## Examples

Following plugin already use `@vanakat/plugin-api`:

* [Zotero Bridge](https://github.com/vanakat/zotero-bridge) as a API provider

* [Zotero Link](https://github.com/vanakat/zotero-link) as API consumer

## License

MIT