Skip to content

beekeeper-studio/plugin

Repository files navigation

@beekeeperstudio/plugin

A TypeScript wrapper library for building Beekeeper Studio plugins that enables communication between your plugin and the main application.

Installation

npm install github:beekeeper-studio/plugin
# or
yarn add github:beekeeper-studio/plugin

Quick Start

import { request, notify } from '@beekeeperstudio/plugin';

// Get all tables in the current database
const tables = await request('getTables');

// Run a SQL query
const result = await request('runQuery', { query: 'SELECT * FROM users LIMIT 10' });

Development

# Build the library
npm run build

# Prepare for publishing
npm run prepublishOnly

License

MIT

About

A simple TypeScript wrapper to send messages from your Beekeeper Studio plugin to the main app.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published