Skip to content

README.md

Latest commit

 

History

History
80 lines (59 loc) · 2.12 KB

README.md

File metadata and controls

80 lines (59 loc) · 2.12 KB

kernel-script Example

A practical example demonstrating kernel-script v2.0 with React, TypeScript, Vite, and Bun.

Quick Start

bun install
bun dev
bun build

Features

  • Task Queue - Queue, schedule, and execute tasks with background processing
  • Persistence - IndexedDB storage for task state
  • Queue Hook - useWorker React hook for task management
  • Engine Registry - New registry-based engine system

Using kernel-script

File Description
src/background.ts Engine setup with registry
src/hooks/use-task-worker.ts useWorker hook
src/stores/task.store.ts Task store with persistence
src/engines/ Engine implementations

API Example

// src/background.ts
import { engineRegistry } from '@/engines';
import { setupKernelScript } from 'kernel-script';

setupKernelScript(engineRegistry, {
  debug: true,
});
// src/hooks/use-task-worker.ts
import { pluginTask, useWorker } from 'kernel-script';

export const useTaskWorker = useWorker({
  engine: noopEngine,
  identifier: 'default',
  funcs: pluginTask(useTestTaskStore),
});

// Hook returns: addTask, start, stop, pause, resume, clear,
// getStatus, getTasks, cancelTask, cancelTasks, publishTasks,
// deleteTasks, retryTasks, skipTaskIds, setTaskConfig

Installation

bun install
bun build

  1. Load in Chrome

    • Open chrome://extensions
    • Enable Developer mode
    • Click Load unpacked
    • Select the dist folder

  2. Reload after changes

    • Run bun dev
    • Click reload icon on extension in chrome://extensions

Development

  • Popup: Right-click extension icon → "Inspect popup"
  • Background: In chrome://extensions → "Service worker" → "Inspect views"

License

MIT