https://github.com/beekeeper-studio/plugin
A simple TypeScript wrapper to send messages from your Beekeeper Studio plugin to the main app.
https://github.com/beekeeper-studio/plugin
Last synced: 7 months ago
JSON representation
A simple TypeScript wrapper to send messages from your Beekeeper Studio plugin to the main app.
- Host: GitHub
- URL: https://github.com/beekeeper-studio/plugin
- Owner: beekeeper-studio
- License: mit
- Created: 2025-06-03T07:17:21.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-19T05:59:31.000Z (7 months ago)
- Last Synced: 2025-06-26T10:57:07.030Z (7 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@beekeeperstudio/plugin
- Size: 56.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @beekeeperstudio/plugin
A TypeScript wrapper library for building Beekeeper Studio plugins that enables communication between your plugin and the main application.
## Installation
```bash
npm install github:beekeeper-studio/plugin
# or
yarn add github:beekeeper-studio/plugin
```
## Quick Start
```typescript
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
```bash
# Build the library
npm run build
# Prepare for publishing
npm run prepublishOnly
```
## License
MIT