joplin.plugins

This class provides access to plugin-related features.

Index

Methods

Methods

register

register(script: Script): Promise<void>

Registers a new plugin. This is the entry point when creating a plugin. You should pass a simple object with an onStart method to it. That onStart method will be executed as soon as the plugin is loaded.
```
joplin.plugins.register({
    onStart: async function() {
        // Run your plugin code here
    }
});
```
Parameters
- script: Script

registerContentScript

registerContentScript(type: ContentScriptType, id: string, scriptPath: string): Promise<void>

Registers a new content script. Unlike regular plugin code, which runs in a separate process, content scripts run within the main process code and thus allow improved performances and more customisations in specific cases. It can be used for example to load a Markdown or editor plugin.

Note that registering a content script in itself will do nothing - it will only be loaded in specific cases by the relevant app modules (eg. the Markdown renderer or the code editor). So it is not a way to inject and run arbitrary code in the app, which for safety and performance reasons is not supported.

View the demo plugin

Parameters
- type: ContentScriptType
  
  Defines how the script will be used. See the type definition for more information about each supported type.
- id: string
  
  A unique ID for the content script.
- scriptPath: string
  
  Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set scriptPath to "./content_script.js.