Notice: This utility has been discontinued. The functionality provided by this module has been merged into jellyfish-worker
.
This library contains the building blocks of the Jellyfish Plugin system:
PluginManager
. The plugin manager is provided with a list of plugins and is responsible for instantiating, validating (e.g. checking for duplicate slugs across plugins) and loading these plugins in the correct order (for example respecting where one plugin requires
another).JellyfishPluginBase
- an 'abstract' class which all Jellyfish plugins should extend. This class encapsulates the logic/helper methods for validating and loading cards, integrations, actions, lenses etc and exposing them in the format expected (e.g. an object of cards keyed by slugs).JellyfishPluginBase
Below is an example how to use the JellyfishPluginBase
base class exported by this library:
const {
JellyfishPluginBase
} = require('@balena/jellyfish-plugin-base')
class MyPlugin extends JellyfishPluginBase {
constructor() {
super({
slug: 'my-plugin',
name: 'My Plugin',
version: '1.0.0',
cards: [],
mixins: {},
integrations: [],
actions: [],
})
}
}
The JellyfishPluginBase
constructor takes a single argument with the following properties:
Note: the order of cards in the cards array is important. Specifically, any type cards must be placed above/before any cards of that type.
PluginManager
Below is an example how to use the plugin manager exported by this library:
const {
PluginManager
} = require('@balena/jellyfish-plugin-base')
const DefaultPlugin = require('@balena/jellyfish-plugin-default')
const pluginManager = new PluginManager(
context, {
plugins: [
DefaultPlugin
]
}
)
const cards = pluginManager.getCards(context, mixins)
Visit the website for complete documentation: https://product-os.github.io/jellyfish-plugin-base
Generated using TypeDoc