Skip to content

Commit fd38cc5

Browse files
authored
Merge pull request #383 from underctrl-io/docs
docs: fix examples
2 parents 39eb127 + c8c361d commit fd38cc5

File tree

8 files changed

+29
-30
lines changed

8 files changed

+29
-30
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ and a temporary store for sharing data between prepare and execute functions.
2727
```ts
2828
import { task } from '@commandkit/tasks';
2929

30-
export const reminderTask = task({
30+
export default task({
3131
name: 'reminder',
3232
async execute(ctx) {
3333
// Access custom data passed to the task
@@ -71,7 +71,7 @@ and execute phases of task execution.
7171
*Example*
7272

7373
```ts
74-
export const conditionalTask = task({
74+
export default task({
7575
name: 'conditional-task',
7676
async prepare(ctx) {
7777
const shouldRun = await checkConditions();

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ and provide a context for accessing CommandKit and Discord.js functionality.
2828
```ts
2929
import { task } from '@commandkit/tasks';
3030

31-
export const cleanupTask = task({
31+
export default task({
3232
name: 'cleanup-old-data',
3333
schedule: { type: 'cron', value: '0 2 * * *' }, // Daily at 2 AM
3434
async prepare(ctx) {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ logic to conditionally execute based on runtime conditions.
2929
import { task } from '@commandkit/tasks';
3030

3131
// Simple scheduled task
32-
export const dailyBackup = task({
32+
export default task({
3333
name: 'daily-backup',
3434
schedule: { type: 'cron', value: '0 0 * * *' },
3535
async execute(ctx) {

apps/website/docs/guide/17-tasks/01-getting-started.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Create a file in `src/app/tasks/` to define your tasks:
5050
```ts
5151
import { task } from '@commandkit/tasks';
5252

53-
export const dailyBackup = task({
53+
export default task({
5454
name: 'daily-backup',
5555
schedule: '0 0 * * *', // Daily at midnight (cron string)
5656
async execute(ctx) {
@@ -77,7 +77,7 @@ Every task has the following components:
7777
Use cron expressions for recurring tasks:
7878

7979
```ts
80-
export const hourlyTask = task({
80+
export default task({
8181
name: 'hourly-task',
8282
schedule: '0 * * * *', // Every hour
8383
async execute(ctx) {
@@ -91,7 +91,7 @@ export const hourlyTask = task({
9191
Schedule tasks for specific times:
9292

9393
```ts
94-
export const reminderTask = task({
94+
export default task({
9595
name: 'reminder',
9696
schedule: new Date('2024-01-01T12:00:00Z'), // Specific date
9797
async execute(ctx) {
@@ -100,7 +100,7 @@ export const reminderTask = task({
100100
});
101101

102102
// Or use timestamps
103-
export const timestampTask = task({
103+
export default task({
104104
name: 'timestamp-task',
105105
schedule: Date.now() + 60000, // 1 minute from now
106106
async execute(ctx) {
@@ -114,7 +114,7 @@ export const timestampTask = task({
114114
The `execute` function receives a context object with useful properties:
115115

116116
```ts
117-
export const contextExample = task({
117+
export default task({
118118
name: 'context-example',
119119
schedule: '0 */6 * * *', // Every 6 hours
120120
async execute(ctx) {
@@ -141,7 +141,7 @@ export const contextExample = task({
141141
Use the `prepare` function to conditionally execute tasks:
142142

143143
```ts
144-
export const conditionalTask = task({
144+
export default task({
145145
name: 'conditional-task',
146146
schedule: '0 */2 * * *', // Every 2 hours
147147
async prepare(ctx) {

apps/website/docs/guide/17-tasks/04-advanced-patterns.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Organize related tasks to create complex workflows:
1515
// src/app/tasks/data-processing.ts
1616
import { task } from '@commandkit/tasks';
1717

18-
export const dataProcessing = task({
18+
export default task({
1919
name: 'data-processing',
2020
schedule: '0 2 * * *', // Daily at 2 AM
2121
async execute(ctx) {
@@ -43,7 +43,7 @@ Implement custom retry logic for failed tasks:
4343
// src/app/tasks/retry-example.ts
4444
import { task } from '@commandkit/tasks';
4545

46-
export const retryTask = task({
46+
export default task({
4747
name: 'retry-task',
4848
async execute(ctx) {
4949
const { attempt = 1, maxAttempts = 3 } = ctx.data;
@@ -87,7 +87,7 @@ Manage tasks that depend on other conditions:
8787
// src/app/tasks/dependency-example.ts
8888
import { task } from '@commandkit/tasks';
8989

90-
export const dependencyTask = task({
90+
export default task({
9191
name: 'dependency-task',
9292
async execute(ctx) {
9393
const { requiredData } = ctx.data;
@@ -114,7 +114,7 @@ Process multiple items in batches:
114114
// src/app/tasks/batch-processing.ts
115115
import { task } from '@commandkit/tasks';
116116

117-
export const batchProcessor = task({
117+
export default task({
118118
name: 'batch-processor',
119119
schedule: '0 */6 * * *', // Every 6 hours
120120
async execute(ctx) {
@@ -156,7 +156,7 @@ Track task execution metrics:
156156
// src/app/tasks/metrics.ts
157157
import { task } from '@commandkit/tasks';
158158

159-
export const metricsTask = task({
159+
export default task({
160160
name: 'metrics-task',
161161
schedule: '0 * * * *', // Every hour
162162
async execute(ctx) {
@@ -197,7 +197,7 @@ Use the context store to manage state across task executions:
197197
// src/app/tasks/state-management.ts
198198
import { task } from '@commandkit/tasks';
199199

200-
export const statefulTask = task({
200+
export default task({
201201
name: 'stateful-task',
202202
schedule: '0 */2 * * *', // Every 2 hours
203203
async prepare(ctx) {
@@ -235,7 +235,7 @@ Implement cleanup tasks for resource management:
235235
// src/app/tasks/cleanup.ts
236236
import { task } from '@commandkit/tasks';
237237

238-
export const cleanupTask = task({
238+
export default task({
239239
name: 'cleanup',
240240
schedule: '0 3 * * *', // Daily at 3 AM
241241
async execute(ctx) {
@@ -263,7 +263,7 @@ Implement robust error recovery mechanisms:
263263
// src/app/tasks/error-recovery.ts
264264
import { task } from '@commandkit/tasks';
265265

266-
export const resilientTask = task({
266+
export default task({
267267
name: 'resilient-task',
268268
async execute(ctx) {
269269
const { operation, fallbackOperation } = ctx.data;
@@ -303,7 +303,7 @@ export const resilientTask = task({
303303
// src/app/tasks/rolling-window.ts
304304
import { task } from '@commandkit/tasks';
305305

306-
export const rollingWindowTask = task({
306+
export default task({
307307
name: 'rolling-window',
308308
schedule: '*/15 * * * *', // Every 15 minutes
309309
async execute(ctx) {
@@ -325,7 +325,7 @@ export const rollingWindowTask = task({
325325
// src/app/tasks/adaptive-processing.ts
326326
import { task } from '@commandkit/tasks';
327327

328-
export const adaptiveTask = task({
328+
export default task({
329329
name: 'adaptive-task',
330330
schedule: '*/5 * * * *', // Every 5 minutes
331331
async execute(ctx) {

packages/tasks/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,12 @@ npm install @commandkit/tasks
2121
### 1. Add the plugin to your CommandKit configuration
2222

2323
```ts
24+
import { defineConfig } from 'commandkit/config';
2425
import { tasks } from '@commandkit/tasks';
2526

26-
export default {
27-
plugins: [
28-
tasks(),
29-
],
30-
};
27+
export default defineConfig({
28+
plugins: [tasks()],
29+
});
3130
```
3231

3332
### 2. Set up a driver
@@ -46,7 +45,7 @@ Create a file in `src/app/tasks/`:
4645
```ts
4746
import { task } from '@commandkit/tasks';
4847

49-
export const refreshExchangeRate = task({
48+
export default task({
5049
name: 'refresh-exchange-rate',
5150
schedule: { type: 'cron', value: '0 0 * * *' }, // daily at midnight
5251
async execute(ctx) {

packages/tasks/src/context.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface TaskContextData<
2828
* ```ts
2929
* import { task } from '@commandkit/tasks';
3030
*
31-
* export const reminderTask = task({
31+
* export default task({
3232
* name: 'reminder',
3333
* async execute(ctx) {
3434
* // Access custom data passed to the task
@@ -54,7 +54,7 @@ export class TaskContext<T extends Record<string, any> = Record<string, any>> {
5454
*
5555
* @example
5656
* ```ts
57-
* export const conditionalTask = task({
57+
* export default task({
5858
* name: 'conditional-task',
5959
* async prepare(ctx) {
6060
* const shouldRun = await checkConditions();

packages/tasks/src/task.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { TaskDefinition, TaskSchedule } from './types';
1212
* ```ts
1313
* import { task } from '@commandkit/tasks';
1414
*
15-
* export const cleanupTask = task({
15+
* export default task({
1616
* name: 'cleanup-old-data',
1717
* schedule: { type: 'cron', value: '0 2 * * *' }, // Daily at 2 AM
1818
* async prepare(ctx) {
@@ -124,7 +124,7 @@ export class Task<T extends Record<string, any> = Record<string, any>> {
124124
* import { task } from '@commandkit/tasks';
125125
*
126126
* // Simple scheduled task
127-
* export const dailyBackup = task({
127+
* export default task({
128128
* name: 'daily-backup',
129129
* schedule: { type: 'cron', value: '0 0 * * *' },
130130
* async execute(ctx) {

0 commit comments

Comments
 (0)