spearkit 0.1.0 → 0.2.0
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 +11 -0
- package/dist/index.cjs +974 -12
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +753 -206
- package/dist/index.d.ts +753 -206
- package/dist/index.js +955 -14
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,6 +12,17 @@ custom-id params and modal fields are all inferred.
|
|
|
12
12
|
npm install spearkit discord.js
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
+
## Batteries included
|
|
16
|
+
|
|
17
|
+
- **Type-safe slash commands**, options, subcommands, autocomplete, buttons, selects and modals — no `interactionCreate` switch.
|
|
18
|
+
- **Cooldowns** — per user/role/guild/channel, with exemptions and per-role/per-user overrides ([guide](./docs/cooldown.md)).
|
|
19
|
+
- **Scheduled tasks** — cron and interval jobs, started on ready ([guide](./docs/scheduler.md)).
|
|
20
|
+
- **Prefix commands** — classic `!text` commands that share cooldowns ([guide](./docs/prefix.md)).
|
|
21
|
+
- **Structured logging** — leveled, scoped, pluggable; every error flows through it ([guide](./docs/logging.md)).
|
|
22
|
+
- **Usage tracking** — record who used what to a database and/or a Discord channel ([guide](./docs/usage.md)).
|
|
23
|
+
- **dotenv built in** — auto-load `.env` and read typed env vars ([guide](./docs/env.md)).
|
|
24
|
+
- **Plugins & file-based loading** for organising larger bots.
|
|
25
|
+
|
|
15
26
|
## Documentation
|
|
16
27
|
|
|
17
28
|
- **Docs site** ([`website/`](./website)) — a [Fumadocs](https://fumadocs.dev) site themed like the discord.js docs. Run it with `cd website && pnpm install && pnpm dev`.
|