InstallPluginOptions

Index

Properties

• activate
• activationOptions
• humanReadableName
• onError
• targetFolderName

Properties

optionalactivate

activate?: boolean

Whether to activate the plugin after installing it.

optionalactivationOptions

activationOptions?: Record<string, unknown>

Parameters to expose to the plugin during its activation hook.

optionalhumanReadableName

humanReadableName?: string

Human-readable plugin name for progress captions and skip warnings.

optionalonError

onError?: skip-plugin | throw

Whether installation/activation failures should abort the Blueprint.

optionaltargetFolderName

targetFolderName?: string

The name of the folder to install the plugin to. Defaults to guessing from pluginData