@sapphire/plugin-scheduled-tasks NPM

@sapphire/plugin-scheduled-tasks

Plugin for @sapphire/framework to add support for scheduled tasks.

Description

Many bots have features that need to run periodically, such as uploading analytics data, reminders for users, birthdays, scheduled giveaways, undoing moderation actions, and more. Several implemented solutions exist for this, but as with many time-based processing attempts, they are often flawed and unreliable. This plugin is our solution, enabling you to schedule tasks and save them in services like Redis and SQS with ease.

Features

Full TypeScript support
Includes ESM entrypoint

Installation

@sapphire/plugin-scheduled-tasks depends on the following packages. Be sure to install these along with this package!

@sapphire/framework

In case you want to use bull as your provider:

bull

In case you want to use sqs as your provider:

You can use the following command to install this package with bull, or replace npm install with your package manager of choice.

npm install @sapphire/plugin-scheduled-tasks @sapphire/framework bull

Usage

This registers the necessary options and methods in the Sapphire client to be able to use the schedule plugin.

// Main bot file
// Be sure to register the plugin before instantiating the client.
import { ScheduledTaskRedisStrategy } from '@sapphire/plugin-scheduled-tasks/register-redis';

// Or if you want to use sqs
import { ScheduledTaskSQSStrategy } from '@sapphire/plugin-scheduled-tasks/register-sqs';

Then, you can pass the imported Strategy into the configuration options in your SapphireClient extension class or initializer. This will either be located in your new SapphireClient constructor call, or super in your constructor method if you use an extension class.

const options = {
	...otherClientOptionsGoHere,
	tasks: {
		strategy: new ScheduledTaskRedisStrategy(),
		// or with sqs
		strategy: new ScheduledTaskSQSStrategy({
			/* you can add your SQS options here */
		})
	}
};

In order to use the scheduled tasks anywhere other than a piece (commands, arguments, preconditions, etc.), you must first import the container property of @sapphire/framework. For pieces, you can simply use this.container.tasks to access this plugin's methods.

This is a simple example that creates a task to be run in 2 seconds from a service.

import { container } from '@sapphire/framework';

export class MyAwesomeService {
	public createAwesomeTask() {
		container.tasks.create('name', { id: '123' }, 2000);
	}
}

Here is an example mute command, demonstrating the use of this.container.tasks from within a piece by omitting the explicit import.

// mute command

import { Command, CommandOptions, PieceContext } from '@sapphire/framework';
import type { Message } from 'discord.js';

export class MuteCommand extends Command {
	public constructor(context: PieceContext) {
		super(context, {
			description: 'Mute a user'
		});
	}

	public async run(message: Message) {
		// create a task to unmute the user in 1 minute
		this.container.tasks.create('unmute', { authorId: message.author.id }, 60000);
	}
}

Create a task handler

Scheduled tasks use their own store, like other types of pieces. You can create a directory alongside your commands directory named scheduled-tasks and place your tasks there, but they must inherit from ScheduledTask, like so.

Manual task example

Creating the Piece:

import type { PieceContext } from '@sapphire/framework';
import { ScheduledTask } from '@sapphire/plugin-scheduled-tasks';

export class ManualTask extends ScheduledTask {
	public constructor(context: PieceContext) {
		super(context);
	}

	public async run(payload: unknown) {
		this.container.logger.info('I ran!', payload);
	}
}

declare module '@sapphire/framework' {
	interface ScheduledTasks {
		manual: never;
	}
}

Using Manual Tasks

container.tasks.create('manual', payload, 5000);

Cron Task Example

Cron jobs are currently only supported by the Redis strategy.

Creating the Piece:

import type { PieceContext } from '@sapphire/framework';
import { ScheduledTask } from '@sapphire/plugin-scheduled-tasks';

export class CronTask extends ScheduledTask {
	public constructor(context: PieceContext) {
		super(context, {
			cron: '0 * * * *'
		});
	}

	public async run() {
		this.container.logger.info('I run every hour at *:00');
	}
}

declare module '@sapphire/framework' {
	interface ScheduledTasks {
		cron: never;
	}
}

Using Cron tasks

Cron & Interval tasks are loaded automatically.

Interval task example

Creating the Piece:

import type { PieceContext } from '@sapphire/framework';
import { ScheduledTask } from '@sapphire/plugin-scheduled-tasks';

export class IntervalTask extends ScheduledTask {
	public constructor(context: PieceContext) {
		super(context, {
			interval: 60 * 1000 // 60 seconds
		});
	}

	public async run() {
		this.container.logger.info('I run every minute');
	}
}

declare module '@sapphire/framework' {
	interface ScheduledTasks {
		interval: never;
	}
}

Using Interval tasks

Cron & Interval tasks are loaded automatically.

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With	Address
Open Collective	Click Here
Ko-fi	Click Here
Patreon	Click Here
PayPal	Click Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

sapphiredev plugin bot typescript ts yarn discord sapphire

@sapphire/stopwatch @sapphire/utilities bullmq

@infinitebrahmanuniverse/nolb-_sapp @everything-registry/sub-chunk-807 @zalastax/nolb-_sapp cardinal-bot

10.0.2-next.f9230eb.0

19 hours ago

10.0.2-next.c3e54a4.0

20 hours ago

10.0.2-next.2cef2b9.0

3 days ago

10.0.2-next.68a7a96.0

5 days ago

10.0.2-next.34ced65.0

7 days ago

10.0.2-next.9c95894.0

12 days ago

10.0.2-next.fae3a34.0

12 days ago

10.0.2-next.e83bf41.0

19 days ago

10.0.2-next.9713e77.0

26 days ago

10.0.2-next.23c23e4.0

29 days ago

10.0.2-next.73f41bb.0

1 month ago

10.0.2-next.89a491c.0

1 month ago

10.0.2-next.ad126b7.0

2 months ago

10.0.2-next.e9641eb.0

2 months ago

10.0.2-next.d4efcc9.0

2 months ago

10.0.2-next.c7fda07.0

2 months ago

10.0.2-next.c0249b3.0

2 months ago

10.0.2-next.b0a7934.0

2 months ago

10.0.2-next.dfb9453.0

2 months ago

10.0.2-next.0bc107c.0

3 months ago

10.0.2-next.ed7a730.0

3 months ago

10.0.2-next.003e06b.0

3 months ago

10.0.2-next.fe95a62.0

3 months ago

10.0.2-next.cc484b0.0

3 months ago

10.0.2-next.ee64834.0

3 months ago

10.0.2-next.9d57b2f.0

3 months ago

10.0.2-next.d0baf59.0

3 months ago

10.0.2-next.cca97fe.0

3 months ago

10.0.2-next.936dcdd.0

3 months ago

10.0.2-next.09a6004.0

3 months ago

10.0.2-next.9c7fa9b.0

3 months ago

10.0.2-next.22a5678.0

3 months ago

10.0.2-next.8c48875.0

3 months ago

10.0.2-next.8b2085c.0

4 months ago

10.0.1

4 months ago

10.0.2-next.5cc2312.0

4 months ago

10.0.2-next.92b3bf5.0

4 months ago

10.0.1-next.43dd84c.0

4 months ago

10.0.1-next.6f863f8.0

4 months ago

10.0.1-next.79dff88.0

4 months ago

10.0.1-next.b8240d6.0

4 months ago

10.0.1-next.b690b4c.0

4 months ago

10.0.1-next.adac80a.0

4 months ago

10.0.1-next.070be34.0

4 months ago

10.0.1-next.2434057.0

4 months ago

10.0.1-next.95e65d3.0

4 months ago

10.0.1-pr-534.00b527b.0

4 months ago

10.0.1-next.8efcaee.0

4 months ago

10.0.1-next.906a2fc.0

4 months ago

10.0.1-next.7f5b169.0

4 months ago

10.0.1-next.8638659.0

4 months ago

10.0.1-next.f6cd4b6.0

4 months ago

10.0.1-next.beaa62f.0

4 months ago

10.0.1-next.f9dd45c.0

4 months ago

10.0.1-pr-531.68fab22.0

4 months ago

10.0.1-next.3fd39ed.0

4 months ago

10.0.1-next.ea9e732.0

4 months ago

10.0.0

4 months ago

10.0.1-next.1ed9b51.0

4 months ago

10.0.0-next.4278ab0.0

4 months ago

10.0.0-next.9fbf980.0

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

9.0.0-pr-513.cc0467d.0

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

9.0.0-pr-513.97f3b7c.0

5 months ago

9.0.0-next.dede596.0

5 months ago

9.0.0-pr-513.f0e9a18.0

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

9.0.0-pr-512.86f3d06.0

5 months ago

5 months ago

5 months ago

7 months ago

9 months ago

8 months ago

6 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

9 months ago

8 months ago

6 months ago

8 months ago

7 months ago

8 months ago

10 months ago

9 months ago

7 months ago

9 months ago

10 months ago

7.1.2-pr-469.d3a0e5e.0

9 months ago

6 months ago

10 months ago

7 months ago

8 months ago

7 months ago

7 months ago

10 months ago

6 months ago

10 months ago

6 months ago

6 months ago

8 months ago

10 months ago

7 months ago

7.1.3-pr-475.db0d5cc.0

8 months ago

6 months ago

9 months ago

7 months ago

6 months ago

6 months ago

7 months ago

7.1.2-pr-465.0a92431.0

9 months ago

8 months ago

7 months ago

8 months ago

10 months ago

7 months ago

7 months ago

10 months ago

9 months ago

9 months ago

6 months ago

8 months ago

7 months ago

6 months ago

6 months ago

7 months ago

7.1.3-pr-475.0a017c0.0

8 months ago

6 months ago

8 months ago

9 months ago

9 months ago

6 months ago

8 months ago

7 months ago

9 months ago

8 months ago

6 months ago

8 months ago

8 months ago

8 months ago

7 months ago

10 months ago

9 months ago

6 months ago

6 months ago

5 months ago

6 months ago

7 months ago

10 months ago

10 months ago

9 months ago

7 months ago

8 months ago

6 months ago

6 months ago

7 months ago

6 months ago

8 months ago

9 months ago

8 months ago

6 months ago

9 months ago

8 months ago

6 months ago

6 months ago

9 months ago

10 months ago

10 months ago

10 months ago

9 months ago

8 months ago

9 months ago

6 months ago

8 months ago

6 months ago

7 months ago

6 months ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

11 months ago

1 year ago

11 months ago

12 months ago

12 months ago

1 year ago

12 months ago

7.0.0-pr-437.cfcbc0f.0

1 year ago

12 months ago

11 months ago

1 year ago

12 months ago

11 months ago

11 months ago

1 year ago

12 months ago

1 year ago

11 months ago

12 months ago

12 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

6.0.1-pr-403.fc7bac3.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

6.0.1-pr-403.05623a4.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

6.0.1-pr-403.8a883d6.0

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

1 year ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

4.0.2-pr-363.e4e2a04.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.0.1-pr-334.52c8c14.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

4.0.0-pr-271.fde7e776.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

4.0.0-pr-271.0258c7b7.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.4.0-pr-271.8a04ac90.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.4.0-pr-271.36d909f3.0

2 years ago

2.3.4-next.3bc645f.0

2 years ago

2.3.4-next.a0cac3d.0

2 years ago

2.3.4-next.e19ee4d.0

2 years ago

2.4.0-pr-271.67d865d1.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.4.0-pr-271.50e50e04.0

2 years ago

2.3.4-next.660b231.0

2 years ago

2.4.0-pr-271.38beab4b.0

2 years ago

2.3.4-next.d1ca2be.0

2 years ago

2.3.4-next.971054c.0

2 years ago

2.3.4-pr-285.d64fcad.0

2 years ago

2.3.4-next.741bf92.0

2 years ago

2.3.4-next.866735d.0

2 years ago

2.4.0-pr-271.cde343c3.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.4.0-pr-271.3e0f2c71.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1.2.0-pr-202.829d20d.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.2.1-pr-250.4033e6f.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.2.0-pr-232.d613844.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.2.0-pr-232.1c7c921.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1.2.0-pr-202.f36bf5c.0

2 years ago

2.1.0-next.26a8c41.0

2 years ago

1.1.1-pr-201.6c5b003.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago