Skip to content

beekeeper-studio/plugin

Repository files navigation

@beekeeperstudio/plugin

A tiny wrapper of window.postMessage for building Beekeeper Studio plugins with TypeScript support.

Installation

npm install @beekeeperstudio/plugin
# or
yarn add @beekeeperstudio/plugin

Quick Start

import { getTables, runQuery } from '@beekeeperstudio/plugin';

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

// Run a SQL query
const result = await 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

Packages

No packages published