Skip to main content
Version: 1.x

TasksPluginOptions

TasksPluginOptions​

@commandkit/tasksplugin.ts

Configuration options for the tasks plugin.

Currently, the plugin uses default settings for task loading and HMR. Future versions may support customizing the tasks directory path and HMR behavior.

Signature
interface TasksPluginOptions {
    initializeDefaultDriver?: boolean;
    sqliteDriverPollingInterval?: number;
    sqliteDriverDatabasePath?: string;
}

initializeDefaultDriver​

property
boolean
default:
true

Whether to initialize the default driver.

If true, the plugin will initialize the default driver. If false, the plugin will not initialize the default driver.

sqliteDriverPollingInterval​

property
number
default:
5_000

The polling interval for the default sqlite driver. Default is 5_000.

sqliteDriverDatabasePath​

property
string
default:
'./commandkit-tasks.db'

The path to the sqlite database file for the default sqlite driver. Default is './commandkit-tasks.db' but :memory: can be used for an in-memory database.