Extension

The Extension class contains properties and method related to the current extension. A single instance is always available via the nova.extension global property.

Properties

identifier

The identifier of the extension.

This property is readonly.

name

The user-visible name of the extension.

This property is readonly.

vendor

The vendor of the extension.

This property is readonly.

version

The version string of the extension.

This property is readonly.

path

The path to the extension on disk.

This property is readonly.

globalStoragePath

The path to a directory on disk where the extension can store global state. The directory itself may not exist, and it is up to the extension to create it, but the parent directory is guaranteed to exist.

This property is readonly.

workspaceStoragePath

The path to a workspace-specific directory on disk where the extension can store state. The directory itself may not exist, and it is up to the extension to create it, but the parent directory is guaranteed to exist.

This property is readonly.

Methods

openChangelog()

Opens the extension’s changelog in the Extension Library (under the Release Notes pane). If the extension does not provide a changelog this method will do nothing.

openHelp()

Opens the extension’s help documentation in the Extension Library (under the Help pane). If the extension does not provide a help document this method will do nothing.

openReadme()

Opens the extension’s readme in the Extension Library (under the Details pane). If the extension does not provide a readme this method will do nothing.