Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@dashibase/plugin-client

greentfrapp8GPL-3.00.1.1TypeScript support: included

Package for developing custom Dashibase plugins.

custom plugin, dashibase, internal tools

readme

@dashibase/plugin-client

Package for developing custom Dashibase plugins.

Usage

First install the library with

npm install @dashibase/plugin-client

Then import the package in your plugin and initialize the client.

import PluginClient from '@dashibase/plugin-client'

const client = new PluginClient()

client.onSetup((data) => {
  // Prints a log when a SETUP message is received  
  console.log(`Received SETUP message ${JSON.stringify(data)}`)
})

// Inform Dashibase that plugin is ready to be setup
client.init()

For more documentation, refer to https://dashibase.com/docs