Skip to content

Commit bd6f812

Browse files
committed
docs: generate api docs
1 parent 6c7318f commit bd6f812

File tree

5 files changed

+33
-7
lines changed

5 files changed

+33
-7
lines changed

apps/website/docs/api-reference/tasks/classes/sqlite-driver.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
1313

1414
## SQLiteDriver
1515

16-
<GenerationInfo sourceFile="packages/tasks/src/drivers/sqlite.ts" sourceLine="20" packageName="@commandkit/tasks" />
16+
<GenerationInfo sourceFile="packages/tasks/src/drivers/sqlite.ts" sourceLine="21" packageName="@commandkit/tasks" />
1717

1818
SQLite-based persistent job queue manager for CommandKit tasks.
1919

@@ -35,7 +35,9 @@ setDriver(driver);
3535

3636
```ts title="Signature"
3737
class SQLiteDriver implements TaskDriver {
38-
constructor(dbPath: = './commandkit-tasks.db')
38+
constructor(dbPath: = './commandkit-tasks.db', pollingInterval: = 5_000)
39+
getPollingInterval() => ;
40+
setPollingInterval(pollingInterval: number) => ;
3941
destroy() => ;
4042
create(task: TaskData) => Promise<string>;
4143
delete(identifier: string) => Promise<void>;
@@ -50,9 +52,19 @@ class SQLiteDriver implements TaskDriver {
5052

5153
### constructor
5254

53-
<MemberInfo kind="method" type={`(dbPath: = './commandkit-tasks.db') => SQLiteDriver`} />
55+
<MemberInfo kind="method" type={`(dbPath: = './commandkit-tasks.db', pollingInterval: = 5_000) => SQLiteDriver`} />
5456

5557
Create a new SQLiteDriver instance.
58+
### getPollingInterval
59+
60+
<MemberInfo kind="method" type={`() => `} />
61+
62+
Get the polling interval.
63+
### setPollingInterval
64+
65+
<MemberInfo kind="method" type={`(pollingInterval: number) => `} />
66+
67+
Set the polling interval.
5668
### destroy
5769

5870
<MemberInfo kind="method" type={`() => `} />

apps/website/docs/api-reference/tasks/classes/task.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import { task } from '@commandkit/tasks';
3030

3131
export default task({
3232
name: 'cleanup-old-data',
33-
schedule: { type: 'cron', value: '0 2 * * *' }, // Daily at 2 AM
33+
schedule: '0 2 * * *', // Daily at 2 AM
3434
async prepare(ctx) {
3535
// Only run if there's old data to clean
3636
return await hasOldData();

apps/website/docs/api-reference/tasks/classes/tasks-plugin.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
1313

1414
## TasksPlugin
1515

16-
<GenerationInfo sourceFile="packages/tasks/src/plugin.ts" sourceLine="54" packageName="@commandkit/tasks" />
16+
<GenerationInfo sourceFile="packages/tasks/src/plugin.ts" sourceLine="66" packageName="@commandkit/tasks" />
1717

1818
CommandKit plugin that provides task management capabilities.
1919

apps/website/docs/api-reference/tasks/functions/task.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
1313

1414
## task
1515

16-
<GenerationInfo sourceFile="packages/tasks/src/task.ts" sourceLine="139" packageName="@commandkit/tasks" />
16+
<GenerationInfo sourceFile="packages/tasks/src/task.ts" sourceLine="140" packageName="@commandkit/tasks" />
1717

1818
Creates a new task definition.
1919

@@ -31,7 +31,7 @@ import { task } from '@commandkit/tasks';
3131
// Simple scheduled task
3232
export default task({
3333
name: 'daily-backup',
34-
schedule: { type: 'cron', value: '0 0 * * *' },
34+
schedule: '0 0 * * *',
3535
async execute(ctx) {
3636
await performBackup();
3737
},

apps/website/docs/api-reference/tasks/interfaces/tasks-plugin-options.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Future versions may support customizing the tasks directory path and HMR behavio
2323
```ts title="Signature"
2424
interface TasksPluginOptions {
2525
initializeDefaultDriver?: boolean;
26+
sqliteDriverPollingInterval?: number;
27+
sqliteDriverDatabasePath?: string;
2628
}
2729
```
2830

@@ -36,6 +38,18 @@ Whether to initialize the default driver.
3638

3739
If true, the plugin will initialize the default driver.
3840
If false, the plugin will not initialize the default driver.
41+
### sqliteDriverPollingInterval
42+
43+
<MemberInfo kind="property" type={`number`} default={`5_000`} />
44+
45+
The polling interval for the default sqlite driver.
46+
Default is 5_000.
47+
### sqliteDriverDatabasePath
48+
49+
<MemberInfo kind="property" type={`string`} default={`'./<a href='/docs/api-reference/commandkit/variables/commandkit#commandkit'>commandkit</a>-<a href='/docs/api-reference/tasks/functions/tasks#tasks'>tasks</a>.db'`} />
50+
51+
The path to the sqlite database file for the default sqlite driver.
52+
Default is './commandkit-tasks.db' but `:memory:` can be used for an in-memory database.
3953

4054

4155
</div>

0 commit comments

Comments
 (0)