@kingsworld/plugin-cron 1.0.4 → 1.0.6
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/README.md +7 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ yarn add @kingsworld/plugin-cron @sapphire/framework
|
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
13
|
-
Make sure to register the
|
|
13
|
+
Make sure to register the plugin before creating the client
|
|
14
14
|
|
|
15
15
|
```ts
|
|
16
16
|
import "@kingsworld/plugin-cron/register";
|
|
@@ -65,7 +65,7 @@ export class PingPong extends CronTask {
|
|
|
65
65
|
}
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Using the
|
|
68
|
+
Using the class constructor:
|
|
69
69
|
|
|
70
70
|
```ts
|
|
71
71
|
import { CronTask } from "@kingsworld/plugin-cron";
|
|
@@ -86,7 +86,7 @@ export class PingPong extends CronTask {
|
|
|
86
86
|
|
|
87
87
|
### Frequently Asked Questions
|
|
88
88
|
|
|
89
|
-
##### What does the `this.info()`, `this.error()`, `this.warn()`, `this.debug()`, and `this.trace()` methods do
|
|
89
|
+
##### What does the `this.info()`, `this.error()`, `this.warn()`, `this.debug()`, and `this.trace()` methods do in the CronTask#run() method?
|
|
90
90
|
|
|
91
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
92
|
|
|
@@ -109,16 +109,14 @@ export class PingPong extends CronTask {
|
|
|
109
109
|
First, clone the repo using git SSH, the GitHub CLI, or HTTP
|
|
110
110
|
|
|
111
111
|
```sh
|
|
112
|
-
git clone git@github.com:Kings-World/
|
|
113
|
-
git clone https://github.com/Kings-World/
|
|
114
|
-
gh repo clone Kings-World/
|
|
112
|
+
git clone git@github.com:Kings-World/sapphire-plugins.git # ssh
|
|
113
|
+
git clone https://github.com/Kings-World/sapphire-plugins.git # http
|
|
114
|
+
gh repo clone Kings-World/sapphire-plugins # github cli
|
|
115
115
|
```
|
|
116
116
|
|
|
117
|
-
|
|
117
|
+
Finally, install the dependencies using Yarn
|
|
118
118
|
|
|
119
119
|
```sh
|
|
120
120
|
yarn # shorthand
|
|
121
121
|
yarn install # full command
|
|
122
122
|
```
|
|
123
|
-
|
|
124
|
-
Finally, install Husky to leverage prettier and commitlint validation
|
package/package.json
CHANGED
|
@@ -1,7 +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.
|
|
4
|
+
"version": "1.0.6",
|
|
5
5
|
"author": "Seren_Modz 21 <seren@kings-world.net>",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"main": "dist/index.js",
|