@kingsworld/plugin-cron 1.0.0 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/structures/CronTask.d.ts +2 -1
- package/dist/lib/structures/CronTask.d.ts.map +1 -1
- package/dist/lib/structures/CronTask.js +1 -1
- package/dist/lib/structures/CronTask.js.map +1 -1
- package/dist/lib/structures/CronTaskStore.d.ts.map +1 -1
- package/dist/lib/structures/CronTaskStore.js +1 -1
- package/dist/lib/structures/CronTaskStore.js.map +1 -1
- package/dist/lib/types/CronTaskTypes.d.ts.map +1 -1
- package/dist/register.d.ts.map +1 -1
- package/dist/register.js.map +1 -1
- package/package.json +11 -19
- package/LICENSE +0 -21
- package/README.md +0 -103
|
@@ -2,12 +2,13 @@ import { Piece } from "@sapphire/pieces";
|
|
|
2
2
|
import { CronJob } from "cron";
|
|
3
3
|
import type { CronTaskStore } from "./CronTaskStore";
|
|
4
4
|
import type { CronJobOptions } from "../types/CronTaskTypes";
|
|
5
|
+
import type { Awaitable } from "@sapphire/framework";
|
|
5
6
|
export declare abstract class CronTask extends Piece {
|
|
6
7
|
job: CronJob;
|
|
7
8
|
store: CronTaskStore;
|
|
8
9
|
options: CronTask.Options;
|
|
9
10
|
constructor(context: Piece.Context, options: CronTask.Options);
|
|
10
|
-
abstract run(): unknown
|
|
11
|
+
abstract run(): Awaitable<unknown>;
|
|
11
12
|
info(message: string, ...other: unknown[]): void;
|
|
12
13
|
error(message: string, ...other: unknown[]): void;
|
|
13
14
|
warn(message: string, ...other: unknown[]): void;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CronTask.d.ts","sourceRoot":"","sources":["../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"CronTask.d.ts","sourceRoot":"","sources":["../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,8BAAsB,QAAS,SAAQ,KAAK;IACxC,GAAG,EAAE,OAAO,CAAC;IAEL,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;gBAEtB,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO;IAY7D,QAAQ,CAAC,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC;IAElC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAOzC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAO1C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAOzC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAO1C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAOjC,MAAM;CASlB;AAED,yBAAiB,QAAQ,CAAC;IACtB,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC;IACrD,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;CACvC"}
|
|
@@ -17,7 +17,7 @@ class CronTask extends pieces_1.Piece {
|
|
|
17
17
|
start: false,
|
|
18
18
|
context: this,
|
|
19
19
|
onTick: this.run.bind(this),
|
|
20
|
-
timeZone: options.timeZone ?? this.container.cron.defaultTimezone
|
|
20
|
+
timeZone: options.timeZone ?? this.container.cron.defaultTimezone,
|
|
21
21
|
});
|
|
22
22
|
}
|
|
23
23
|
info(message, ...other) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CronTask.js","sourceRoot":"","sources":["../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AACzC,+BAA+B;
|
|
1
|
+
{"version":3,"file":"CronTask.js","sourceRoot":"","sources":["../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AACzC,+BAA+B;AAK/B,MAAsB,QAAS,SAAQ,cAAK;IAMxC,YAAY,OAAsB,EAAE,OAAyB;QACzD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAN5B;;;;;WAAa;QAQT,IAAI,CAAC,GAAG,GAAG,IAAI,cAAO,CAAC;YACnB,GAAG,OAAO;YACV,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3B,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe;SACpE,CAAC,CAAC;IACP,CAAC;IAID,IAAI,CAAC,OAAe,EAAE,GAAG,KAAgB;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAC7B,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAC9B,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAG,KAAgB;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAC7B,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAC9B,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAC9B,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAEQ,MAAM;QACX,yEAAyE;QACzE,6EAA6E;QAC7E,IAAI,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE;YACnB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;SACnB;QAED,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;CACJ;AAhED,4BAgEC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CronTaskStore.d.ts","sourceRoot":"","sources":["../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,qBAAa,aAAc,SAAQ,KAAK,CAAC,QAAQ,CAAC;;IAK9C,QAAQ;
|
|
1
|
+
{"version":3,"file":"CronTaskStore.d.ts","sourceRoot":"","sources":["../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,qBAAa,aAAc,SAAQ,KAAK,CAAC,QAAQ,CAAC;;IAK9C,QAAQ;IAYR,OAAO;IAYE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,IAAI;IAuBvC,MAAM,CAAC,GAAG,EAAE,MAAM;IASlB,KAAK;CAIjB"}
|
|
@@ -34,7 +34,7 @@ class CronTaskStore extends pieces_1.Store {
|
|
|
34
34
|
start: false,
|
|
35
35
|
context: value,
|
|
36
36
|
onTick: value.run.bind(value),
|
|
37
|
-
timeZone: options.timeZone ?? this.container.cron.defaultTimezone
|
|
37
|
+
timeZone: options.timeZone ?? this.container.cron.defaultTimezone,
|
|
38
38
|
});
|
|
39
39
|
}
|
|
40
40
|
catch (error) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CronTaskStore.js","sourceRoot":"","sources":["../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AACzC,yCAAsC;AACtC,+BAA+B;AAE/B,MAAa,aAAc,SAAQ,cAAe;IAC9C;QACI,KAAK,CAAC,mBAAQ,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,QAAQ;QACJ,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,SAAS;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;SACpB;QAED,cAAK,CAAC,MAAM,EAAE,
|
|
1
|
+
{"version":3,"file":"CronTaskStore.js","sourceRoot":"","sources":["../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AACzC,yCAAsC;AACtC,+BAA+B;AAE/B,MAAa,aAAc,SAAQ,cAAe;IAC9C;QACI,KAAK,CAAC,mBAAQ,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,QAAQ;QACJ,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,SAAS;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;SACpB;QAED,cAAK,CAAC,MAAM,EAAE,CACV,aAAa,IAAI,CAAC,IAAI,sCAAsC,CAC/D,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO;QACH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO;gBAAE,SAAS;YAChC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;SACnB;QAED,cAAK,CAAC,MAAM,EAAE,CACV,aAAa,IAAI,CAAC,IAAI,qCAAqC,CAC9D,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAEQ,GAAG,CAAC,GAAW,EAAE,KAAe;QACrC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE9B,IAAI;YACA,KAAK,CAAC,GAAG,GAAG,IAAI,cAAO,CAAC;gBACpB,GAAG,OAAO;gBACV,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC7B,QAAQ,EACJ,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe;aAC9D,CAAC,CAAC;SACN;QAAC,OAAO,KAAK,EAAE;YACZ,KAAK,CAAC,KAAK,CACP,kDAAkD,EAClD,KAAK,CACR,CAAC;YACF,KAAK,CAAC,MAAM,EAAE,CAAC;SAClB;QAED,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAEQ,MAAM,CAAC,GAAW;QACvB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE;YACnB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;SACnB;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEQ,KAAK;QACV,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;CACJ;AAjED,sCAiEC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CronTaskTypes.d.ts","sourceRoot":"","sources":["../../../src/lib/types/CronTaskTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAE9C,MAAM,WAAW,sBAAsB;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAC7B,iBAAiB,EACjB,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,SAAS,CAChD,
|
|
1
|
+
{"version":3,"file":"CronTaskTypes.d.ts","sourceRoot":"","sources":["../../../src/lib/types/CronTaskTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAE9C,MAAM,WAAW,sBAAsB;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAC7B,iBAAiB,EACjB,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,SAAS,CAChD,CAAC"}
|
package/dist/register.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,CAAC;AAEjB,OAAO,
|
|
1
|
+
{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,CAAC;AAEjB,OAAO,EAEH,MAAM,EACN,kBAAkB,EAClB,SAAS,EACT,yBAAyB,EACzB,cAAc,EACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAKhD,qBAAa,cAAe,SAAQ,MAAM;IACtC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B,MAAM,CAAC,CAAC,yBAAyB,CAAC,CAC9B,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,aAAa;IAK1B,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,cAAc;IAIhD,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,cAAc;CAG1C"}
|
package/dist/register.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":";;;AAAA,mBAAiB;AAEjB,
|
|
1
|
+
{"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":";;;AAAA,mBAAiB;AAEjB,mDAO6B;AAG7B,kEAA+D;AAC/D,2DAAwD;AAExD,MAAa,cAAe,SAAQ,kBAAM;IAA1C;;QACI;;;;;WAA4B;IAgBhC,CAAC;IAdG,MAAM,CAAC,CAAC,qCAAyB,CAAC,CAE9B,OAAsB;QAEtB,qBAAS,CAAC,IAAI,GAAG,IAAI,iCAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,CAAC,8BAAkB,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,6BAAa,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,CAAC,qBAAS,CAAC;QACd,qBAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;CACJ;AAjBD,wCAiBC;AAED,0BAAc,CAAC,OAAO,CAAC,qCAAqC,CACxD,cAAc,CAAC,qCAAyB,CAAC,EACzC,qCAAqC,CACxC,CAAC;AAEF,0BAAc,CAAC,OAAO,CAAC,8BAA8B,CACjD,cAAc,CAAC,8BAAkB,CAAC,EAClC,8BAA8B,CACjC,CAAC;AAEF,0BAAc,CAAC,OAAO,CAAC,qBAAqB,CACxC,cAAc,CAAC,qBAAS,CAAC,EACzB,qBAAqB,CACxB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kingsworld/plugin-cron",
|
|
3
|
-
"
|
|
3
|
+
"description": "A simple @sapphire/framework plugin that aims to make use of the cron package and allow users to make cron jobs within their Sapphire discord bot.",
|
|
4
|
+
"version": "1.0.3",
|
|
4
5
|
"author": "Seren_Modz 21 <seren@kings-world.net>",
|
|
5
6
|
"license": "MIT",
|
|
6
7
|
"main": "dist/index.js",
|
|
@@ -27,32 +28,24 @@
|
|
|
27
28
|
"build": "tsc && yarn esm:register && yarn esm:default",
|
|
28
29
|
"clean:build": "rimraf dist && yarn build",
|
|
29
30
|
"esm:register": "gen-esm-wrapper dist/register.js dist/register.mjs",
|
|
30
|
-
"esm:default": "gen-esm-wrapper dist/index.js dist/index.mjs"
|
|
31
|
-
"postinstall": "is-ci || husky install"
|
|
31
|
+
"esm:default": "gen-esm-wrapper dist/index.js dist/index.mjs"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"cron": "^2.3.1",
|
|
35
35
|
"tslib": "^2.6.0"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@commitlint/cli": "^17.6.6",
|
|
39
|
-
"@commitlint/config-conventional": "^17.6.6",
|
|
40
|
-
"@sapphire/framework": "^4.5.0",
|
|
41
|
-
"@sapphire/pieces": "^3.6.3",
|
|
42
|
-
"@sapphire/ts-config": "^4.0.0",
|
|
43
38
|
"@types/cron": "^2",
|
|
44
|
-
"@types/is-ci": "^3",
|
|
45
39
|
"@types/node": "^20.4.2",
|
|
46
|
-
"discord.js": "^14.11.0",
|
|
47
40
|
"gen-esm-wrapper": "^1.1.3",
|
|
48
|
-
"husky": "^8.0.3",
|
|
49
|
-
"is-ci": "^3.0.1",
|
|
50
|
-
"prettier": "^2.8.8",
|
|
51
|
-
"pretty-quick": "^3.1.3",
|
|
52
41
|
"typescript": "^5.1.6"
|
|
53
42
|
},
|
|
54
|
-
"homepage": "https://github.com/Kings-World/
|
|
55
|
-
"repository":
|
|
43
|
+
"homepage": "https://github.com/Kings-World/sapphire-plugins",
|
|
44
|
+
"repository": {
|
|
45
|
+
"type": "git",
|
|
46
|
+
"url": "git+https://github.com/Kings-World/sapphire-plugins.git",
|
|
47
|
+
"directory": "packages/cron"
|
|
48
|
+
},
|
|
56
49
|
"keywords": [
|
|
57
50
|
"sapphire",
|
|
58
51
|
"plugin",
|
|
@@ -64,7 +57,7 @@
|
|
|
64
57
|
"bot"
|
|
65
58
|
],
|
|
66
59
|
"bugs": {
|
|
67
|
-
"url": "https://github.com/Kings-World/
|
|
60
|
+
"url": "https://github.com/Kings-World/sapphire-plugins/issues",
|
|
68
61
|
"email": "seren@kings-world.net"
|
|
69
62
|
},
|
|
70
63
|
"files": [
|
|
@@ -74,6 +67,5 @@
|
|
|
74
67
|
],
|
|
75
68
|
"publishConfig": {
|
|
76
69
|
"access": "public"
|
|
77
|
-
}
|
|
78
|
-
"packageManager": "yarn@3.6.1"
|
|
70
|
+
}
|
|
79
71
|
}
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2023 Kings World
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
package/README.md
DELETED
|
@@ -1,103 +0,0 @@
|
|
|
1
|
-
# @kingsworld/plugin-cron
|
|
2
|
-
|
|
3
|
-
A simple [@sapphire/framework](https://www.npmjs.com/package/@sapphire/framework) plugin that aims to make use of the [cron](https://www.npmjs.com/package/cron) package and allow users to make cron jobs within their Sapphire discord bot.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
```sh
|
|
8
|
-
yarn add @kingsworld/plugin-cron @sapphire/framework
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Usage
|
|
12
|
-
|
|
13
|
-
Make sure to register the plegin before creating the client
|
|
14
|
-
|
|
15
|
-
```ts
|
|
16
|
-
import "@kingsworld/plugin-cron/register";
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
If you would like to set the default cron job timezone for all your cron jobs, you can do so within the client options. A list of TZ identifers can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
20
|
-
|
|
21
|
-
```ts
|
|
22
|
-
new SapphireClient({
|
|
23
|
-
...otherClientOptions,
|
|
24
|
-
cron: {
|
|
25
|
-
// the cron object is optional
|
|
26
|
-
defaultTimezone: "Europe/London", // the cron pacakge defaults to UTC
|
|
27
|
-
},
|
|
28
|
-
});
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
However, if you would like to do so for a single task, you can do so in the cron task options
|
|
32
|
-
|
|
33
|
-
```js
|
|
34
|
-
{
|
|
35
|
-
cronTime: "* * * * *", // every minute
|
|
36
|
-
timeZone: "Europe/London"
|
|
37
|
-
}
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### Creating a task
|
|
41
|
-
|
|
42
|
-
Cron Tasks come with their own store, just like Sapphire commands, listeners, and so on. They must be located within a `cron-tasks` directory that is located alongside your other stores.
|
|
43
|
-
|
|
44
|
-
```
|
|
45
|
-
src
|
|
46
|
-
├── listeners
|
|
47
|
-
| └── ready.ts
|
|
48
|
-
└── cron-tasks
|
|
49
|
-
└── ping.ts
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Using decorators from [@sapphire/decorators](https://www.npmjs.com/package/@sapphire/decorators):
|
|
53
|
-
|
|
54
|
-
```ts
|
|
55
|
-
import { ApplyOptions } from "@sapphire/decorators";
|
|
56
|
-
import { CronTask } from "@kingsworld/plugin-cron";
|
|
57
|
-
|
|
58
|
-
@ApplyOptions<CronTask.Options>({
|
|
59
|
-
cronTime: "* * * * *",
|
|
60
|
-
})
|
|
61
|
-
export class PingPong extends CronTask {
|
|
62
|
-
run() {
|
|
63
|
-
this.container.logger.info("Ping Pong! 🏓");
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Using the command constructor:
|
|
69
|
-
|
|
70
|
-
```ts
|
|
71
|
-
import { CronTask } from "@kingsworld/plugin-cron";
|
|
72
|
-
|
|
73
|
-
export class PingPong extends CronTask {
|
|
74
|
-
constructor(context: CronTask.Context, options: CronTask.Options) {
|
|
75
|
-
super(context, {
|
|
76
|
-
...options,
|
|
77
|
-
cronTime: "* * * * *",
|
|
78
|
-
});
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
run() {
|
|
82
|
-
this.container.logger.info("Ping Pong! 🏓");
|
|
83
|
-
}
|
|
84
|
-
}
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### Frequently Asked Questions
|
|
88
|
-
|
|
89
|
-
##### What does the `this.info()`, `this.error()`, `this.warn()`, `this.debug()`, and `this.trace()` methods do instead the CronTask#run() method?
|
|
90
|
-
|
|
91
|
-
These methods are small helpers towards Sapphire's logger that prefixes logs with `CronTask[$name]`. The helpers are optional, however, I find them useful when using them in my own projects.
|
|
92
|
-
|
|
93
|
-
```ts
|
|
94
|
-
export class PingPong extends CronTask {
|
|
95
|
-
run() {
|
|
96
|
-
this.info("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - INFO - CronTask[ping] Ping Pong! 🏓
|
|
97
|
-
this.error("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - ERROR - CronTask[ping] Ping Pong! 🏓
|
|
98
|
-
this.warn("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - WARN - CronTask[ping] Ping Pong! 🏓
|
|
99
|
-
this.debug("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - DEBUG - CronTask[ping] Ping Pong! 🏓
|
|
100
|
-
this.trace("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - TRACE - CronTask[ping] Ping Pong! 🏓
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
```
|