Merge pull request #34 from sern-handler/chore/docs

chore: update docs
This commit is contained in:
Jacob Nguyen
2023-04-19 12:58:13 -05:00
committed by GitHub
60 changed files with 1685 additions and 2130 deletions

View File

@@ -39,7 +39,7 @@ If you're using ESM, configure dotenv with `import 'dotenv/config'` instead of `
### And... that's it?
Yes, that's it. Here's a little FAQ to get you started. You can also join the [Discord](https://sern-handler.js.org/discord) for any problems.
Yes, that's it. Here's a little FAQ to get you started. You can also join the [Discord](https://sern.dev/discord) for any problems.
### Extra: Video tutorial!
@@ -59,4 +59,4 @@ Yes, that's it. Here's a little FAQ to get you started. You can also join the [D
**A**: Yeah, just search `sern Snippets` made by a verified publisher called Sr Izan (haha yeah me funny!)
**Q**: HEEEELLLPPPP!!!!
**A**: Hey, don't panic! We're here to help so, join the [Discord](https://sern-handler.js.org/discord). We're trying to get to 100 members!
**A**: Hey, don't panic! We're here to help so, join the [Discord](https://sern.dev/discord). We're trying to get to 100 members!

View File

@@ -5,11 +5,11 @@ jacoobes:
image_url: https://github.com/jacoobes.png
Sr Izan:
name: Sr Izan
title: Contributor
title: Developer
url: https://github.com/SrIzan10
image_url: https://github.com/SrIzan10.png
Murtatrxx:
name: Murtatrxx
title: Developer
url: https://github.com/Murtatrxx
image_url: https://github.com/Murtatrxx.png
image_url: https://github.com/Murtatrxx.png

View File

@@ -36,7 +36,7 @@ Will be refactored / changed in future
#### Defined in
[src/handler/sern.ts:121](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L121)
[src/handler/sern.ts:127](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L127)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
[src/handler/sern.ts:120](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L120)
[src/handler/sern.ts:126](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L126)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
[src/handler/sern.ts:119](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L119)
[src/handler/sern.ts:125](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L125)
___
@@ -66,4 +66,4 @@ ___
#### Defined in
[src/handler/sern.ts:118](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L118)
[src/handler/sern.ts:124](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L124)

View File

@@ -6,6 +6,9 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
1.0.0
Provides values shared between
Message and ChatInputCommandInteraction
@@ -23,7 +26,7 @@ Message and ChatInputCommandInteraction
#### Defined in
[src/handler/structures/context.ts:22](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L22)
[src/handler/structures/context.ts:23](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L23)
## Accessors
@@ -37,7 +40,7 @@ Message and ChatInputCommandInteraction
#### Defined in
[src/handler/structures/context.ts:45](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L45)
[src/handler/structures/context.ts:46](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L46)
___
@@ -51,7 +54,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:75](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L75)
[src/handler/structures/context.ts:76](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L76)
___
@@ -65,7 +68,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L56)
[src/handler/structures/context.ts:57](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L57)
___
@@ -79,7 +82,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:60](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L60)
[src/handler/structures/context.ts:61](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L61)
___
@@ -93,7 +96,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:64](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L64)
[src/handler/structures/context.ts:65](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L65)
___
@@ -107,7 +110,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:41](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L41)
[src/handler/structures/context.ts:42](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L42)
___
@@ -121,7 +124,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:79](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L79)
[src/handler/structures/context.ts:80](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L80)
___
@@ -139,7 +142,7 @@ Message
#### Defined in
[src/handler/structures/context.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L37)
[src/handler/structures/context.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L38)
___
@@ -153,7 +156,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:71](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L71)
[src/handler/structures/context.ts:72](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L72)
___
@@ -171,7 +174,7 @@ ChatInputCommandInteraction
#### Defined in
[src/handler/structures/context.ts:29](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L29)
[src/handler/structures/context.ts:30](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L30)
___
@@ -188,7 +191,7 @@ else, interaction.user
#### Defined in
[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L52)
[src/handler/structures/context.ts:53](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L53)
## Methods
@@ -202,7 +205,7 @@ else, interaction.user
#### Defined in
[src/handler/structures/context.ts:82](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L82)
[src/handler/structures/context.ts:83](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L83)
___
@@ -216,7 +219,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:86](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L86)
[src/handler/structures/context.ts:87](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L87)
___
@@ -236,7 +239,7 @@ ___
#### Defined in
[src/handler/structures/context.ts:97](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L97)
[src/handler/structures/context.ts:98](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L98)
___
@@ -256,4 +259,4 @@ ___
#### Defined in
[src/handler/structures/context.ts:90](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/context.ts#L90)
[src/handler/structures/context.ts:91](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/context.ts#L91)

View File

@@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
2.0.0
## Implements
- [`ErrorHandling`](../interfaces/ErrorHandling.md)
@@ -30,7 +34,7 @@ Number of times the process should throw an error until crashing and exiting
#### Defined in
[src/handler/contracts/errorHandling.ts:24](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L24)
[src/handler/contracts/errorHandling.ts:29](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L29)
## Methods
@@ -56,13 +60,13 @@ Utility function to crash
#### Defined in
[src/handler/contracts/errorHandling.ts:25](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L25)
[src/handler/contracts/errorHandling.ts:30](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L30)
___
### updateAlive
**updateAlive**(`e`): `void`
**updateAlive**(`_`): `void`
A function that is called on every crash. Updates keepAlive
@@ -70,7 +74,7 @@ A function that is called on every crash. Updates keepAlive
| Name | Type |
| :------ | :------ |
| `e` | `Error` |
| `_` | `Error` |
#### Returns
@@ -82,4 +86,4 @@ A function that is called on every crash. Updates keepAlive
#### Defined in
[src/handler/contracts/errorHandling.ts:28](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L28)
[src/handler/contracts/errorHandling.ts:33](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L33)

View File

@@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
2.0.0
## Implements
- [`Logging`](../interfaces/Logging.md)
@@ -28,7 +32,7 @@ custom_edit_url: null
#### Defined in
[src/handler/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L11)
[src/handler/contracts/logging.ts:15](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L15)
___
@@ -52,7 +56,7 @@ ___
#### Defined in
[src/handler/contracts/logging.ts:12](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L12)
[src/handler/contracts/logging.ts:16](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L16)
___
@@ -76,7 +80,7 @@ ___
#### Defined in
[src/handler/contracts/logging.ts:16](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L16)
[src/handler/contracts/logging.ts:20](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L20)
___
@@ -100,7 +104,7 @@ ___
#### Defined in
[src/handler/contracts/logging.ts:20](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L20)
[src/handler/contracts/logging.ts:24](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L24)
___
@@ -124,4 +128,4 @@ ___
#### Defined in
[src/handler/contracts/logging.ts:24](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L24)
[src/handler/contracts/logging.ts:28](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L28)

View File

@@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
2.0.0
## Implements
- [`ModuleManager`](../interfaces/ModuleManager.md)
@@ -24,7 +28,7 @@ custom_edit_url: null
#### Defined in
[src/handler/contracts/moduleManager.ts:13](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/moduleManager.ts#L13)
[src/handler/contracts/moduleManager.ts:17](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/moduleManager.ts#L17)
## Methods
@@ -54,7 +58,7 @@ custom_edit_url: null
#### Defined in
[src/handler/contracts/moduleManager.ts:14](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/moduleManager.ts#L14)
[src/handler/contracts/moduleManager.ts:18](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/moduleManager.ts#L18)
___
@@ -78,4 +82,4 @@ ___
#### Defined in
[src/handler/contracts/moduleManager.ts:20](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/moduleManager.ts#L20)
[src/handler/contracts/moduleManager.ts:24](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/moduleManager.ts#L24)

View File

@@ -36,7 +36,7 @@ Will be refactored in future
#### Defined in
[src/handler/sern.ts:130](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L130)
[src/handler/sern.ts:137](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L137)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
[src/handler/sern.ts:129](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L129)
[src/handler/sern.ts:136](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L136)
___
@@ -56,7 +56,7 @@ ___
#### Defined in
[src/handler/sern.ts:128](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L128)
[src/handler/sern.ts:135](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L135)
___
@@ -66,4 +66,4 @@ ___
#### Defined in
[src/handler/sern.ts:127](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L127)
[src/handler/sern.ts:134](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L134)

View File

@@ -6,6 +6,9 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
2.0.0
Storing all command modules
This dependency is usually injected into ModuleManager
@@ -31,7 +34,7 @@ This dependency is usually injected into ModuleManager
#### Defined in
[src/handler/structures/moduleStore.ts:11](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/moduleStore.ts#L11)
[src/handler/structures/moduleStore.ts:12](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/moduleStore.ts#L12)
___
@@ -41,7 +44,7 @@ ___
#### Defined in
[src/handler/structures/moduleStore.ts:10](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/moduleStore.ts#L10)
[src/handler/structures/moduleStore.ts:11](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/moduleStore.ts#L11)
___
@@ -62,7 +65,7 @@ ___
#### Defined in
[src/handler/structures/moduleStore.ts:18](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/moduleStore.ts#L18)
[src/handler/structures/moduleStore.ts:19](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/moduleStore.ts#L19)
___
@@ -72,7 +75,7 @@ ___
#### Defined in
[src/handler/structures/moduleStore.ts:16](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/moduleStore.ts#L16)
[src/handler/structures/moduleStore.ts:17](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/moduleStore.ts#L17)
___
@@ -82,4 +85,4 @@ ___
#### Defined in
[src/handler/structures/moduleStore.ts:17](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/moduleStore.ts#L17)
[src/handler/structures/moduleStore.ts:18](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/moduleStore.ts#L18)

View File

@@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
1.0.0
## Hierarchy
- `EventEmitter`
@@ -30,7 +34,7 @@ EventEmitter.constructor
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:111
node_modules/@types/node/ts4.8/events.d.ts:111
## Properties
@@ -44,7 +48,7 @@ EventEmitter.captureRejectionSymbol
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:328
node_modules/@types/node/ts4.8/events.d.ts:328
___
@@ -60,7 +64,7 @@ EventEmitter.captureRejections
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:333
node_modules/@types/node/ts4.8/events.d.ts:333
___
@@ -74,7 +78,7 @@ EventEmitter.defaultMaxListeners
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:334
node_modules/@types/node/ts4.8/events.d.ts:334
___
@@ -96,7 +100,7 @@ EventEmitter.errorMonitor
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:327
node_modules/@types/node/ts4.8/events.d.ts:327
## Methods
@@ -127,7 +131,7 @@ EventEmitter.addListener
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:354
node_modules/@types/node/ts4.8/events.d.ts:354
___
@@ -160,7 +164,7 @@ EventEmitter.emit
#### Defined in
[src/handler/sernEmitter.ts:34](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sernEmitter.ts#L34)
[src/handler/sernEmitter.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sernEmitter.ts#L37)
___
@@ -198,7 +202,7 @@ EventEmitter.eventNames
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:669
node_modules/@types/node/ts4.8/events.d.ts:669
___
@@ -223,7 +227,7 @@ EventEmitter.getMaxListeners
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:526
node_modules/@types/node/ts4.8/events.d.ts:526
___
@@ -253,7 +257,7 @@ EventEmitter.listenerCount
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:616
node_modules/@types/node/ts4.8/events.d.ts:616
___
@@ -291,7 +295,7 @@ EventEmitter.listeners
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:539
node_modules/@types/node/ts4.8/events.d.ts:539
___
@@ -322,7 +326,7 @@ EventEmitter.off
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:499
node_modules/@types/node/ts4.8/events.d.ts:499
___
@@ -355,7 +359,7 @@ EventEmitter.on
#### Defined in
[src/handler/sernEmitter.ts:12](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sernEmitter.ts#L12)
[src/handler/sernEmitter.ts:15](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sernEmitter.ts#L15)
___
@@ -388,7 +392,7 @@ EventEmitter.once
#### Defined in
[src/handler/sernEmitter.ts:23](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sernEmitter.ts#L23)
[src/handler/sernEmitter.ts:26](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sernEmitter.ts#L26)
___
@@ -430,7 +434,7 @@ EventEmitter.prependListener
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:634
node_modules/@types/node/ts4.8/events.d.ts:634
___
@@ -470,7 +474,7 @@ EventEmitter.prependOnceListener
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:650
node_modules/@types/node/ts4.8/events.d.ts:650
___
@@ -525,7 +529,7 @@ EventEmitter.rawListeners
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:569
node_modules/@types/node/ts4.8/events.d.ts:569
___
@@ -561,7 +565,7 @@ EventEmitter.removeAllListeners
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:510
node_modules/@types/node/ts4.8/events.d.ts:510
___
@@ -667,7 +671,7 @@ EventEmitter.removeListener
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:494
node_modules/@types/node/ts4.8/events.d.ts:494
___
@@ -702,7 +706,7 @@ EventEmitter.setMaxListeners
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:520
node_modules/@types/node/ts4.8/events.d.ts:520
___
@@ -725,7 +729,7 @@ Creates a compliant SernEmitter failure payload
#### Defined in
[src/handler/sernEmitter.ts:53](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sernEmitter.ts#L53)
[src/handler/sernEmitter.ts:56](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sernEmitter.ts#L56)
___
@@ -779,7 +783,7 @@ EventEmitter.getEventListeners
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:299
node_modules/@types/node/ts4.8/events.d.ts:299
___
@@ -823,7 +827,7 @@ EventEmitter.listenerCount
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:271
node_modules/@types/node/ts4.8/events.d.ts:271
___
@@ -909,7 +913,7 @@ EventEmitter.on
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:254
node_modules/@types/node/ts4.8/events.d.ts:254
`Static` **on**<`E`, `K`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`\>
@@ -937,7 +941,7 @@ EventEmitter.on
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:222
node_modules/discord.js/typings/index.d.ts:228
___
@@ -1047,7 +1051,7 @@ EventEmitter.once
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:194
node_modules/@types/node/ts4.8/events.d.ts:194
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
@@ -1069,7 +1073,7 @@ EventEmitter.once
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:195
node_modules/@types/node/ts4.8/events.d.ts:195
`Static` **once**<`E`, `K`\>(`eventEmitter`, `eventName`): `Promise`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`[]\>
@@ -1097,7 +1101,7 @@ EventEmitter.once
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:218
node_modules/discord.js/typings/index.d.ts:224
___
@@ -1125,7 +1129,7 @@ ___
#### Defined in
[src/handler/sernEmitter.ts:40](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sernEmitter.ts#L40)
[src/handler/sernEmitter.ts:43](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sernEmitter.ts#L43)
___
@@ -1166,7 +1170,7 @@ EventEmitter.setMaxListeners
#### Defined in
node_modules/.pnpm/@types+node@18.11.18/node_modules/@types/node/ts4.8/events.d.ts:317
node_modules/@types/node/ts4.8/events.d.ts:317
___
@@ -1188,7 +1192,7 @@ Creates a compliant SernEmitter module success payload
#### Defined in
[src/handler/sernEmitter.ts:66](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sernEmitter.ts#L66)
[src/handler/sernEmitter.ts:69](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sernEmitter.ts#L69)
___
@@ -1210,4 +1214,4 @@ Creates a compliant SernEmitter module warning payload
#### Defined in
[src/handler/sernEmitter.ts:76](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sernEmitter.ts#L76)
[src/handler/sernEmitter.ts:79](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sernEmitter.ts#L79)

View File

@@ -6,6 +6,9 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
1.0.0
A bitfield that discriminates command modules
**`Example`**
@@ -31,7 +34,7 @@ The CommandType for hybrid commands, text and slash
#### Defined in
[src/handler/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L28)
[src/handler/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L29)
___
@@ -43,7 +46,7 @@ The CommandType for ButtonInteraction commands
#### Defined in
[src/handler/structures/enums.ts:40](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L40)
[src/handler/structures/enums.ts:41](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L41)
___
@@ -55,7 +58,7 @@ The CommandType for the other SelectMenuInteractions
#### Defined in
[src/handler/structures/enums.ts:52](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L52)
[src/handler/structures/enums.ts:53](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L53)
___
@@ -67,7 +70,7 @@ The CommandType for MessageContextMenuInteraction commands
#### Defined in
[src/handler/structures/enums.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L36)
[src/handler/structures/enums.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L37)
___
@@ -79,7 +82,7 @@ The CommandType for UserContextMenuInteraction commands
#### Defined in
[src/handler/structures/enums.ts:32](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L32)
[src/handler/structures/enums.ts:33](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L33)
___
@@ -89,7 +92,7 @@ ___
#### Defined in
[src/handler/structures/enums.ts:53](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L53)
[src/handler/structures/enums.ts:54](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L54)
___
@@ -101,7 +104,7 @@ The CommandType for ModalSubmitInteraction commands
#### Defined in
[src/handler/structures/enums.ts:48](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L48)
[src/handler/structures/enums.ts:49](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L49)
___
@@ -111,7 +114,7 @@ ___
#### Defined in
[src/handler/structures/enums.ts:54](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L54)
[src/handler/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L55)
___
@@ -123,7 +126,7 @@ The CommandType for slash commands
#### Defined in
[src/handler/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L24)
[src/handler/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L25)
___
@@ -135,7 +138,7 @@ The CommandType for StringSelectMenuInteraction commands
#### Defined in
[src/handler/structures/enums.ts:44](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L44)
[src/handler/structures/enums.ts:45](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L45)
___
@@ -147,7 +150,7 @@ The CommandType for text commands
#### Defined in
[src/handler/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L20)
[src/handler/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L21)
___
@@ -157,4 +160,4 @@ ___
#### Defined in
[src/handler/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L55)
[src/handler/structures/enums.ts:56](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L56)

View File

@@ -31,7 +31,7 @@ The EventType for handling discord events
#### Defined in
[src/handler/structures/enums.ts:77](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L77)
[src/handler/structures/enums.ts:78](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L78)
___
@@ -44,7 +44,7 @@ Could be for example, `process` events, database events
#### Defined in
[src/handler/structures/enums.ts:86](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L86)
[src/handler/structures/enums.ts:87](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L87)
___
@@ -56,4 +56,4 @@ The EventType for handling sern events
#### Defined in
[src/handler/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L81)
[src/handler/structures/enums.ts:82](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L82)

View File

@@ -16,7 +16,7 @@ The PayloadType for a SernEmitter failure event
#### Defined in
[src/handler/structures/enums.ts:134](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L134)
[src/handler/structures/enums.ts:135](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L135)
___
@@ -28,7 +28,7 @@ The PayloadType for a SernEmitter success event
#### Defined in
[src/handler/structures/enums.ts:130](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L130)
[src/handler/structures/enums.ts:131](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L131)
___
@@ -40,4 +40,4 @@ The PayloadType for a SernEmitter warning event
#### Defined in
[src/handler/structures/enums.ts:138](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L138)
[src/handler/structures/enums.ts:139](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L139)

View File

@@ -32,7 +32,7 @@ Use PluginType.Init instead
#### Defined in
[src/handler/structures/enums.ts:112](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L112)
[src/handler/structures/enums.ts:113](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L113)
___
@@ -44,7 +44,7 @@ The PluginType for EventPlugins
#### Defined in
[src/handler/structures/enums.ts:121](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L121)
[src/handler/structures/enums.ts:122](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L122)
___
@@ -58,7 +58,7 @@ Use PluginType.Control instead
#### Defined in
[src/handler/structures/enums.ts:117](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L117)
[src/handler/structures/enums.ts:118](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L118)
___
@@ -70,4 +70,4 @@ The PluginType for InitPlugins
#### Defined in
[src/handler/structures/enums.ts:107](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/enums.ts#L107)
[src/handler/structures/enums.ts:108](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/enums.ts#L108)

View File

@@ -17,7 +17,7 @@ This means it is undefined or an invalid command type was provided
#### Defined in
[src/handler/structures/errors.ts:9](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/errors.ts#L9)
[src/handler/structures/errors.ts:9](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L9)
___
@@ -29,7 +29,7 @@ A crash that occurs when accessing an invalid property of Context
#### Defined in
[src/handler/structures/errors.ts:29](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/errors.ts#L29)
[src/handler/structures/errors.ts:29](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L29)
___
@@ -41,7 +41,7 @@ Attempted to lookup module in command module store. Nothing was found!
#### Defined in
[src/handler/structures/errors.ts:17](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/errors.ts#L17)
[src/handler/structures/errors.ts:17](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L17)
___
@@ -53,7 +53,7 @@ Required Dependency not found
#### Defined in
[src/handler/structures/errors.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/errors.ts#L37)
[src/handler/structures/errors.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L37)
___
@@ -65,7 +65,7 @@ Unsupported interaction at this moment.
#### Defined in
[src/handler/structures/errors.ts:21](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/errors.ts#L21)
[src/handler/structures/errors.ts:21](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L21)
___
@@ -77,7 +77,7 @@ Unsupported feature attempted to access at this time
#### Defined in
[src/handler/structures/errors.ts:33](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/errors.ts#L33)
[src/handler/structures/errors.ts:33](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L33)
___
@@ -89,7 +89,7 @@ One plugin called `controller.stop()` (end command execution / loading)
#### Defined in
[src/handler/structures/errors.ts:25](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/errors.ts#L25)
[src/handler/structures/errors.ts:25](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L25)
___
@@ -101,4 +101,4 @@ Attempted to lookup module in command module store. Nothing was found!
#### Defined in
[src/handler/structures/errors.ts:13](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/errors.ts#L13)
[src/handler/structures/errors.ts:13](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L13)

View File

@@ -11,7 +11,7 @@ custom_edit_url: null
</div>
<h1 align="center">Handlers. Redefined.</h1>
<h4 align="center">A customizable, batteries-included, powerful discord.js framework to streamline bot development.</h4>
<h4 align="center">A complete, customizable, typesafe, & reactive framework for discord bots</h4>
<div align="center" styles="margin-top: 10px">
<img src="https://img.shields.io/badge/open-source-brightgreen" />
@@ -22,6 +22,21 @@ custom_edit_url: null
<img alt="Lines of code" src="https://img.shields.io/badge/total%20lines-2k-blue" />
</div>
## Why?
- Most handlers don't support discord.js 14.7+
- Customizable, composable commands
- Plug and play or customize to your liking
- Embraces reactive programming for consistent and reliable backend
- Customizable logger, error handling, and more
- Active development and growing [community](https://sern.dev/discord)
## 👀 Quick Look
* Support for discord.js v14 and all interactions
* Hybrid commands
* Lightweight and customizable
* ESM, CommonJS and TypeScript support
* A powerful CLI and awesome community-made plugins
## 📜 Installation
```sh
@@ -35,46 +50,56 @@ yarn add @sern/handler
```sh
pnpm add @sern/handler
```
## Why?
- Most handlers don't support discord.js 14.7+
- Customizable commands
- Plug and play or customize to your liking
- Embraces reactive programming for consistent and reliable backend
- Customizable logger, error handling, and more
- Active development and growing [community](https://sern.dev/discord)
## 👀 Quick Look
* Support for discord.js v14 and all interactions
* Hybrid commands
* Lightweight and customizable
* ESM, CommonJS and TypeScript support
* A powerful CLI and awesome community-made plugins
## 👶 Basic Usage
<details open><summary>ping.ts</summary>
#### ` index.js (CommonJS)`
```js
// Import the discord.js Client and GatewayIntentBits
const { Client, GatewayIntentBits } = require('discord.js');
// Import Sern namespace
const { Sern } = require('@sern/handler');
// Our configuration file
const { defaultPrefix, token } = require('./config.json');
const client = new Client({
intents: [
GatewayIntentBits.Guilds,
GatewayIntentBits.GuildMembers,
GatewayIntentBits.GuildMessages
]
```ts
export default commandModule({
type: CommandType.Slash,
//Installed plugin to publish to discord api and allow access to owners only.
plugins: [publish(), ownerOnly()],
description: 'A ping pong command',
execute(ctx) {
ctx.reply('Hello owner of the bot');
}
});
export const useContainer = Sern.makeDependencies({
```
</details>
<details open><summary>modal.ts</summary>
```ts
export default commandModule({
type: CommandType.Modal,
//Installed a plugin to make sure modal fields pass a validation.
plugins : [
assertFields({
fields: {
name: /^([^0-9]*)$/
},
failure: (errors, modal) => modal.reply('your submission did not pass the validations')
})
],
execute : (modal) => {
modal.reply('thanks for the submission!');
}
})
```
</details>
<details open><summary>index.ts</summary>
```ts
import { Client, GatewayIntentBits } from 'discord.js';
import { Sern, single, type Dependencies } from '@sern/handler';
//client has been declared previously
interface MyDependencies extends Dependencies {
'@sern/client': Singleton<Client>;
}
export const useContainer = Sern.makeDependencies<MyDependencies>({
build: root => root
.add({ '@sern/client': single(client) })
.add({ '@sern/logger': single(new DefaultLogging()) })
.add({ '@sern/client': single(() => client) })
});
//View docs for all options
@@ -83,29 +108,21 @@ Sern.init({
commands: 'src/commands',
// events: 'src/events' (optional),
containerConfig : {
get: useContainer
get: useContainer
}
});
client.login(token);
client.login("YOUR_BOT_TOKEN_HERE");
```
</details>
#### ` ping.js (CommonJS)`
```js
const { CommandType, commandModule } = require('@sern/handler');
exports.default = commandModule({
name: 'ping',
description: 'A ping pong command',
type: CommandType.Slash,
execute(ctx) {
ctx.reply('pong!');
}
});
```
See our [templates](https://github.com/sern-handler/templates) for TypeScript examples and more.
## 🤖 Bots Using sern
- [Community Bot](https://github.com/sern-handler/sern-community), the community bot for our [discord server](https://sern.dev/discord).
- [Vinci](https://github.com/SrIzan10/vinci), the bot for Mara Turing.
- [Bask](https://github.com/baskbotml/bask), Listen your favorite artists on Discord.
- [ava](https://github.com/SrIzan10/ava), A discord bot that plays KNGI and Gensokyo Radio.
- [Murayama](https://github.com/murayamabot/murayama), :pepega:
- [Protector (WIP)](https://github.com/needhamgary/Protector), Just a simple bot to help enhance a private minecraft server.
## 💻 CLI
@@ -117,11 +134,6 @@ It is **highly encouraged** to use the [command line interface](https://github.c
- [Support Server](https://sern.dev/discord)
## 👋 Contribute
- Read our contribution [guidelines](https://github.com/sern-handler/handler/blob/main/.github/CONTRIBUTING.md) carefully
- Pull up on [issues](https://github.com/sern-handler/handler/issues) and report bugs
- All kinds of contributions are welcomed.
## 🚈 Roadmap
You can check our [roadmap](https://github.com/sern-handler/roadmap) to see what's going to be added or patched in the future.

View File

@@ -38,7 +38,7 @@ Omit.execute
#### Defined in
[src/types/module.ts:111](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L111)
[src/types/module.ts:111](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L111)
___
@@ -52,4 +52,4 @@ Omit.onEvent
#### Defined in
[src/types/module.ts:110](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L110)
[src/types/module.ts:110](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L110)

View File

@@ -20,7 +20,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:57](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L57)
[src/types/module.ts:57](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L57)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
[src/types/module.ts:58](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L58)
[src/types/module.ts:58](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L58)
___
@@ -63,7 +63,7 @@ ___
#### Defined in
[src/types/module.ts:60](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L60)
[src/types/module.ts:60](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L60)
___
@@ -77,7 +77,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -91,7 +91,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -101,7 +101,7 @@ ___
#### Defined in
[src/types/module.ts:59](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L59)
[src/types/module.ts:59](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L59)
___
@@ -115,7 +115,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -129,4 +129,4 @@ ___
#### Defined in
[src/types/module.ts:56](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L56)
[src/types/module.ts:56](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L56)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:75](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L75)
[src/types/module.ts:75](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L75)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:74](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L74)
[src/types/module.ts:74](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L74)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:85](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L85)
[src/types/module.ts:85](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L85)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:84](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L84)
[src/types/module.ts:84](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L84)

View File

@@ -24,7 +24,7 @@ Use the newer helper functions and import { controller } from '@sern/handler'
#### Defined in
[src/types/plugin.ts:51](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L51)
[src/types/plugin.ts:51](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L51)
___
@@ -49,7 +49,7 @@ ___
#### Defined in
[src/types/plugin.ts:53](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L53)
[src/types/plugin.ts:53](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L53)
___
@@ -59,7 +59,7 @@ ___
#### Defined in
[src/types/plugin.ts:50](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L50)
[src/types/plugin.ts:50](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L50)
___
@@ -69,4 +69,4 @@ ___
#### Defined in
[src/types/plugin.ts:52](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L52)
[src/types/plugin.ts:52](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L52)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:70](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L70)
[src/types/module.ts:70](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L70)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:69](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L69)
[src/types/module.ts:69](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L69)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:65](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L65)
[src/types/module.ts:65](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L65)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:64](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L64)
[src/types/module.ts:64](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L64)

View File

@@ -34,7 +34,7 @@ custom_edit_url: null
#### Defined in
[src/types/plugin.ts:39](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L39)
[src/types/plugin.ts:39](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L39)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
[src/types/plugin.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L38)
[src/types/plugin.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L38)

View File

@@ -22,7 +22,7 @@ custom_edit_url: null
#### Defined in
[src/types/plugin.ts:25](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L25)
[src/types/plugin.ts:25](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L25)
___
@@ -40,4 +40,4 @@ ___
#### Defined in
[src/types/plugin.ts:26](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L26)
[src/types/plugin.ts:26](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L26)

View File

@@ -14,7 +14,7 @@ custom_edit_url: null
#### Defined in
[src/types/handler.ts:40](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L40)
[src/types/handler.ts:40](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L40)
___
@@ -24,7 +24,7 @@ ___
#### Defined in
[src/types/handler.ts:42](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L42)
[src/types/handler.ts:42](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L42)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
[src/types/handler.ts:45](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L45)
[src/types/handler.ts:45](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L45)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
[src/types/handler.ts:41](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L41)
[src/types/handler.ts:41](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L41)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
[src/types/handler.ts:44](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L44)
[src/types/handler.ts:44](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L44)
___
@@ -64,4 +64,4 @@ ___
#### Defined in
[src/types/handler.ts:43](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L43)
[src/types/handler.ts:43](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L43)

View File

@@ -34,7 +34,7 @@ custom_edit_url: null
#### Defined in
[src/types/handler.ts:68](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L68)
[src/types/handler.ts:68](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L68)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
[src/types/handler.ts:67](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L67)
[src/types/handler.ts:67](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L67)

View File

@@ -30,7 +30,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
[src/types/module.ts:123](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L123)
[src/types/module.ts:123](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L123)
___
@@ -58,7 +58,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
[src/types/module.ts:124](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L124)
[src/types/module.ts:124](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L124)
## Methods
@@ -110,4 +110,4 @@ Module.execute
#### Defined in
[src/types/module.ts:125](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L125)
[src/types/module.ts:125](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L125)

View File

@@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
2.0.0
## Implemented by
- [`DefaultErrorHandling`](../classes/DefaultErrorHandling.md)
@@ -20,7 +24,7 @@ Number of times the process should throw an error until crashing and exiting
#### Defined in
[src/handler/contracts/errorHandling.ts:8](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L8)
[src/handler/contracts/errorHandling.ts:11](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L11)
## Methods
@@ -42,7 +46,7 @@ Utility function to crash
#### Defined in
[src/handler/contracts/errorHandling.ts:14](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L14)
[src/handler/contracts/errorHandling.ts:17](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L17)
___
@@ -64,4 +68,4 @@ A function that is called on every crash. Updates keepAlive
#### Defined in
[src/handler/contracts/errorHandling.ts:20](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/errorHandling.ts#L20)
[src/handler/contracts/errorHandling.ts:23](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/errorHandling.ts#L23)

View File

@@ -24,7 +24,7 @@ Use the newer helper functions
#### Defined in
[src/types/plugin.ts:61](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L61)
[src/types/plugin.ts:64](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L64)
___
@@ -49,7 +49,7 @@ ___
#### Defined in
[src/types/plugin.ts:63](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L63)
[src/types/plugin.ts:66](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L66)
___
@@ -59,7 +59,7 @@ ___
#### Defined in
[src/types/plugin.ts:60](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L60)
[src/types/plugin.ts:63](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L63)
___
@@ -69,4 +69,4 @@ ___
#### Defined in
[src/types/plugin.ts:62](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L62)
[src/types/plugin.ts:65](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L65)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
[src/types/module.ts:130](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L130)
[src/types/module.ts:130](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L130)
___
@@ -48,7 +48,7 @@ ___
#### Defined in
[src/types/module.ts:129](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L129)
[src/types/module.ts:129](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L129)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -90,7 +90,7 @@ ___
#### Defined in
[src/types/module.ts:131](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L131)
[src/types/module.ts:131](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L131)
## Methods
@@ -114,4 +114,4 @@ Module.execute
#### Defined in
[src/types/module.ts:132](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L132)
[src/types/module.ts:132](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L132)

View File

@@ -20,7 +20,7 @@ custom_edit_url: null
#### Defined in
[src/handler/plugins/args.ts:106](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/args.ts#L106)
[src/handler/plugins/args.ts:107](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/args.ts#L107)
___
@@ -30,4 +30,4 @@ ___
#### Defined in
[src/handler/plugins/args.ts:105](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/args.ts#L105)
[src/handler/plugins/args.ts:106](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/args.ts#L106)

View File

@@ -34,7 +34,7 @@ custom_edit_url: null
#### Defined in
[src/types/plugin.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L35)
[src/types/plugin.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L35)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
[src/types/plugin.ts:34](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L34)
[src/types/plugin.ts:34](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L34)

View File

@@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
2.0.0
## Type parameters
| Name | Type |
@@ -34,7 +38,7 @@ custom_edit_url: null
#### Defined in
[src/handler/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L7)
[src/handler/contracts/logging.ts:9](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L9)
___
@@ -54,7 +58,7 @@ ___
#### Defined in
[src/handler/contracts/logging.ts:4](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L4)
[src/handler/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L6)
___
@@ -74,7 +78,7 @@ ___
#### Defined in
[src/handler/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L6)
[src/handler/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L8)
___
@@ -94,4 +98,4 @@ ___
#### Defined in
[src/handler/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/logging.ts#L5)
[src/handler/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/logging.ts#L7)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:95](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L95)
[src/types/module.ts:95](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L95)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:94](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L94)
[src/types/module.ts:94](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L94)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:105](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L105)
[src/types/module.ts:105](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L105)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:104](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L104)
[src/types/module.ts:104](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L104)

View File

@@ -48,7 +48,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[src/types/module.ts:39](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L39)
[src/types/module.ts:39](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L39)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -92,7 +92,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -112,4 +112,4 @@ ___
#### Defined in
[src/types/module.ts:34](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L34)
[src/types/module.ts:34](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L34)

View File

@@ -6,6 +6,10 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
2.0.0
## Implemented by
- [`DefaultModuleManager`](../classes/DefaultModuleManager.md)
@@ -14,7 +18,7 @@ custom_edit_url: null
### get
**get**<`T`\>(`strat`): `undefined` \| [`CommandModuleDefs`](../modules.md#commandmoduledefs)[`T`]
**get**<`T`\>(`strat`): `undefined` \| [`Processed`](../modules.md#processed)<[`CommandModuleDefs`](../modules.md#commandmoduledefs)[`T`]\>
#### Type parameters
@@ -30,11 +34,11 @@ custom_edit_url: null
#### Returns
`undefined` \| [`CommandModuleDefs`](../modules.md#commandmoduledefs)[`T`]
`undefined` \| [`Processed`](../modules.md#processed)<[`CommandModuleDefs`](../modules.md#commandmoduledefs)[`T`]\>
#### Defined in
[src/handler/contracts/moduleManager.ts:6](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/moduleManager.ts#L6)
[src/handler/contracts/moduleManager.ts:8](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/moduleManager.ts#L8)
___
@@ -54,4 +58,4 @@ ___
#### Defined in
[src/handler/contracts/moduleManager.ts:9](https://github.com/sern-handler/handler/blob/33f1446/src/handler/contracts/moduleManager.ts#L9)
[src/handler/contracts/moduleManager.ts:11](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/contracts/moduleManager.ts#L11)

View File

@@ -34,7 +34,7 @@ custom_edit_url: null
#### Defined in
[src/types/plugin.ts:30](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L30)
[src/types/plugin.ts:30](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L30)
___
@@ -44,4 +44,4 @@ ___
#### Defined in
[src/types/plugin.ts:29](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L29)
[src/types/plugin.ts:29](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L29)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:90](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L90)
[src/types/module.ts:90](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L90)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:89](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L89)
[src/types/module.ts:89](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L89)

View File

@@ -20,7 +20,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:177](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L177)
[src/types/module.ts:177](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L177)
___
@@ -30,7 +30,7 @@ ___
#### Defined in
[src/types/module.ts:182](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L182)
[src/types/module.ts:182](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L182)
___
@@ -44,7 +44,7 @@ Omit.description
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4200
node_modules/discord.js/typings/index.d.ts:4316
___
@@ -58,7 +58,7 @@ Omit.descriptionLocalizations
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4201
node_modules/discord.js/typings/index.d.ts:4317
___
@@ -72,7 +72,7 @@ Omit.name
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4198
node_modules/discord.js/typings/index.d.ts:4314
___
@@ -86,7 +86,7 @@ Omit.nameLocalizations
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4199
node_modules/discord.js/typings/index.d.ts:4315
___
@@ -100,7 +100,7 @@ Omit.required
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4202
node_modules/discord.js/typings/index.d.ts:4318
___
@@ -110,4 +110,4 @@ ___
#### Defined in
[src/types/module.ts:178](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L178)
[src/types/module.ts:178](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L178)

View File

@@ -30,7 +30,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
[src/types/module.ts:116](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L116)
[src/types/module.ts:116](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L116)
___
@@ -58,7 +58,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
[src/types/module.ts:117](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L117)
[src/types/module.ts:117](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L117)
## Methods
@@ -110,4 +110,4 @@ Module.execute
#### Defined in
[src/types/module.ts:118](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L118)
[src/types/module.ts:118](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L118)

View File

@@ -24,7 +24,7 @@ BaseApplicationCommandOptionsData.autocomplete
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4203
node_modules/discord.js/typings/index.d.ts:4319
___
@@ -38,7 +38,7 @@ BaseApplicationCommandOptionsData.description
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4200
node_modules/discord.js/typings/index.d.ts:4316
___
@@ -52,7 +52,7 @@ BaseApplicationCommandOptionsData.descriptionLocalizations
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4201
node_modules/discord.js/typings/index.d.ts:4317
___
@@ -66,7 +66,7 @@ BaseApplicationCommandOptionsData.name
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4198
node_modules/discord.js/typings/index.d.ts:4314
___
@@ -80,7 +80,7 @@ BaseApplicationCommandOptionsData.nameLocalizations
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4199
node_modules/discord.js/typings/index.d.ts:4315
___
@@ -90,7 +90,7 @@ ___
#### Defined in
[src/types/module.ts:214](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L214)
[src/types/module.ts:214](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L214)
___
@@ -104,7 +104,7 @@ BaseApplicationCommandOptionsData.required
#### Defined in
[src/types/module.ts:213](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L213)
[src/types/module.ts:213](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L213)
___
@@ -114,4 +114,4 @@ ___
#### Defined in
[src/types/module.ts:212](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L212)
[src/types/module.ts:212](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L212)

View File

@@ -24,7 +24,7 @@ BaseApplicationCommandOptionsData.autocomplete
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4203
node_modules/discord.js/typings/index.d.ts:4319
___
@@ -38,7 +38,7 @@ BaseApplicationCommandOptionsData.description
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4200
node_modules/discord.js/typings/index.d.ts:4316
___
@@ -52,7 +52,7 @@ BaseApplicationCommandOptionsData.descriptionLocalizations
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4201
node_modules/discord.js/typings/index.d.ts:4317
___
@@ -66,7 +66,7 @@ BaseApplicationCommandOptionsData.name
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4198
node_modules/discord.js/typings/index.d.ts:4314
___
@@ -80,7 +80,7 @@ BaseApplicationCommandOptionsData.nameLocalizations
#### Defined in
node_modules/.pnpm/discord.js@14.7.1/node_modules/discord.js/typings/index.d.ts:4199
node_modules/discord.js/typings/index.d.ts:4315
___
@@ -90,7 +90,7 @@ ___
#### Defined in
[src/types/module.ts:220](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L220)
[src/types/module.ts:220](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L220)
___
@@ -104,7 +104,7 @@ BaseApplicationCommandOptionsData.required
#### Defined in
[src/types/module.ts:219](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L219)
[src/types/module.ts:219](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L219)
___
@@ -114,4 +114,4 @@ ___
#### Defined in
[src/types/module.ts:218](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L218)
[src/types/module.ts:218](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L218)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:50](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L50)
[src/types/module.ts:50](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L50)
___
@@ -53,7 +53,7 @@ ___
#### Defined in
[src/types/module.ts:52](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L52)
[src/types/module.ts:52](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L52)
___
@@ -67,7 +67,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -81,7 +81,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -91,7 +91,7 @@ ___
#### Defined in
[src/types/module.ts:51](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L51)
[src/types/module.ts:51](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L51)
___
@@ -105,7 +105,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -119,4 +119,4 @@ ___
#### Defined in
[src/types/module.ts:49](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L49)
[src/types/module.ts:49](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L49)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:80](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L80)
[src/types/module.ts:80](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L80)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:79](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L79)
[src/types/module.ts:79](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L79)

View File

@@ -20,7 +20,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:44](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L44)
[src/types/module.ts:44](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L44)
___
@@ -34,7 +34,7 @@ ___
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -63,7 +63,7 @@ ___
#### Defined in
[src/types/module.ts:45](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L45)
[src/types/module.ts:45](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L45)
___
@@ -77,7 +77,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -91,7 +91,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -105,7 +105,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -119,4 +119,4 @@ ___
#### Defined in
[src/types/module.ts:43](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L43)
[src/types/module.ts:43](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L43)

View File

@@ -24,7 +24,7 @@ custom_edit_url: null
#### Defined in
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L38)
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
[src/types/module.ts:100](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L100)
[src/types/module.ts:100](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L100)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L35)
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L36)
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L37)
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
___
@@ -108,4 +108,4 @@ ___
#### Defined in
[src/types/module.ts:99](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L99)
[src/types/module.ts:99](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L99)

View File

@@ -6,6 +6,9 @@ sidebar_position: 0
custom_edit_url: null
---
**`Since`**
1.0.0
An object to be passed into Sern#init() function.
## Properties
@@ -16,7 +19,7 @@ An object to be passed into Sern#init() function.
#### Defined in
[src/handler/structures/wrapper.ts:9](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/wrapper.ts#L9)
[src/handler/structures/wrapper.ts:14](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/wrapper.ts#L14)
___
@@ -32,7 +35,7 @@ ___
#### Defined in
[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/wrapper.ts#L11)
[src/handler/structures/wrapper.ts:16](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/wrapper.ts#L16)
___
@@ -40,9 +43,13 @@ ___
`Optional` `Readonly` **defaultPrefix**: `string`
**`Deprecated`**
This will be moved to a new field in 3.0.0
#### Defined in
[src/handler/structures/wrapper.ts:8](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/wrapper.ts#L8)
[src/handler/structures/wrapper.ts:13](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/wrapper.ts#L13)
___
@@ -52,4 +59,4 @@ ___
#### Defined in
[src/handler/structures/wrapper.ts:10](https://github.com/sern-handler/handler/blob/33f1446/src/handler/structures/wrapper.ts#L10)
[src/handler/structures/wrapper.ts:15](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/wrapper.ts#L15)

View File

@@ -73,7 +73,7 @@ custom_edit_url: null
#### Defined in
[src/types/plugin.ts:42](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L42)
[src/types/plugin.ts:42](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L42)
___
@@ -86,7 +86,7 @@ are provided to Module. This type represents that transformation
#### Defined in
[src/types/handler.ts:24](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L24)
[src/types/handler.ts:24](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L24)
___
@@ -96,7 +96,7 @@ ___
#### Defined in
[src/types/plugin.ts:43](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L43)
[src/types/plugin.ts:43](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L43)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[src/types/module.ts:150](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L150)
[src/types/module.ts:150](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L150)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
[src/types/handler.ts:16](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L16)
[src/types/handler.ts:16](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L16)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
[src/types/plugin.ts:68](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L68)
[src/types/plugin.ts:71](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L71)
___
@@ -138,7 +138,7 @@ Type that replaces autocomplete with [SernAutocompleteData](interfaces/SernAutoc
#### Defined in
[src/types/module.ts:203](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L203)
[src/types/module.ts:203](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L203)
___
@@ -155,7 +155,7 @@ ___
#### Defined in
[src/handler/plugins/args.ts:109](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/args.ts#L109)
[src/handler/plugins/args.ts:110](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/args.ts#L110)
___
@@ -165,7 +165,7 @@ ___
#### Defined in
[src/types/module.ts:136](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L136)
[src/types/module.ts:136](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L136)
___
@@ -192,7 +192,7 @@ ___
#### Defined in
[src/types/module.ts:154](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L154)
[src/types/module.ts:154](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L154)
___
@@ -202,7 +202,7 @@ ___
#### Defined in
[src/types/module.ts:185](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L185)
[src/types/module.ts:185](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L185)
___
@@ -218,7 +218,7 @@ ___
#### Defined in
[src/types/handler.ts:65](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L65)
[src/types/handler.ts:65](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L65)
___
@@ -228,7 +228,7 @@ ___
#### Defined in
[src/types/plugin.ts:65](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L65)
[src/types/plugin.ts:68](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L68)
___
@@ -238,7 +238,7 @@ ___
#### Defined in
[src/types/plugin.ts:71](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L71)
[src/types/plugin.ts:74](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L74)
___
@@ -255,7 +255,7 @@ ___
#### Defined in
[src/handler/plugins/args.ts:113](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/args.ts#L113)
[src/handler/plugins/args.ts:114](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/args.ts#L114)
___
@@ -265,7 +265,7 @@ ___
#### Defined in
[src/types/module.ts:135](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L135)
[src/types/module.ts:135](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L135)
___
@@ -283,7 +283,7 @@ ___
#### Defined in
[src/types/module.ts:169](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L169)
[src/types/module.ts:169](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L169)
___
@@ -293,7 +293,7 @@ ___
#### Defined in
[src/types/module.ts:188](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L188)
[src/types/module.ts:188](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L188)
___
@@ -303,7 +303,7 @@ ___
#### Defined in
[src/types/plugin.ts:66](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L66)
[src/types/plugin.ts:69](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L69)
___
@@ -313,7 +313,30 @@ ___
#### Defined in
[src/types/plugin.ts:70](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L70)
[src/types/plugin.ts:73](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L73)
___
### ImportPayload
Ƭ **ImportPayload**<`T`\>: `Object`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Type declaration
| Name | Type |
| :------ | :------ |
| `absPath` | `string` |
| `module` | `T` |
#### Defined in
[src/types/handler.ts:71](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L71)
___
@@ -323,7 +346,7 @@ ___
#### Defined in
[src/types/module.ts:196](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L196)
[src/types/module.ts:196](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L196)
___
@@ -333,7 +356,7 @@ ___
#### Defined in
[src/types/module.ts:192](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L192)
[src/types/module.ts:192](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L192)
___
@@ -355,7 +378,7 @@ ___
#### Defined in
[src/types/handler.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L35)
[src/types/handler.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L35)
___
@@ -372,7 +395,7 @@ ___
#### Defined in
[src/types/handler.ts:53](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L53)
[src/types/handler.ts:53](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L53)
___
@@ -382,7 +405,7 @@ ___
#### Defined in
[src/types/handler.ts:63](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L63)
[src/types/handler.ts:63](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L63)
___
@@ -398,7 +421,7 @@ ___
#### Defined in
[src/types/handler.ts:12](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L12)
[src/types/handler.ts:12](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L12)
___
@@ -408,7 +431,7 @@ ___
#### Defined in
[src/types/handler.ts:25](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L25)
[src/types/handler.ts:25](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L25)
___
@@ -418,7 +441,7 @@ ___
#### Defined in
[src/types/plugin.ts:21](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L21)
[src/types/plugin.ts:21](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L21)
___
@@ -434,7 +457,7 @@ ___
#### Defined in
[src/types/handler.ts:64](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L64)
[src/types/handler.ts:64](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L64)
___
@@ -444,7 +467,7 @@ ___
#### Defined in
[src/types/handler.ts:48](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L48)
[src/types/handler.ts:48](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L48)
___
@@ -454,7 +477,7 @@ ___
#### Defined in
[src/types/plugin.ts:67](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L67)
[src/types/plugin.ts:70](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L70)
___
@@ -464,7 +487,7 @@ ___
#### Defined in
[src/types/plugin.ts:69](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L69)
[src/types/plugin.ts:72](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L72)
___
@@ -483,7 +506,7 @@ ___
#### Defined in
[src/types/handler.ts:29](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L29)
[src/types/handler.ts:29](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L29)
___
@@ -499,7 +522,7 @@ ___
#### Defined in
[src/types/module.ts:223](https://github.com/sern-handler/handler/blob/33f1446/src/types/module.ts#L223)
[src/types/module.ts:223](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L223)
___
@@ -523,7 +546,7 @@ ___
#### Defined in
[src/types/handler.ts:36](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L36)
[src/types/handler.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L36)
___
@@ -533,7 +556,7 @@ ___
#### Defined in
[src/types/handler.ts:18](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L18)
[src/types/handler.ts:18](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L18)
___
@@ -563,7 +586,7 @@ ___
#### Defined in
[src/types/handler.ts:37](https://github.com/sern-handler/handler/blob/33f1446/src/types/handler.ts#L37)
[src/types/handler.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L37)
___
@@ -573,7 +596,7 @@ ___
#### Defined in
[src/types/plugin.ts:22](https://github.com/sern-handler/handler/blob/33f1446/src/types/plugin.ts#L22)
[src/types/plugin.ts:22](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L22)
## Variables
@@ -581,6 +604,9 @@ ___
• `Const` **controller**: `Object`
**`Since`**
1.0.0
The object passed into every plugin to control a command's behavior
#### Type declaration
@@ -592,7 +618,7 @@ The object passed into every plugin to control a command's behavior
#### Defined in
[src/handler/sern.ts:55](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L55)
[src/handler/sern.ts:58](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L58)
___
@@ -602,7 +628,7 @@ ___
#### Defined in
[src/handler/plugins/createPlugin.ts:5](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/createPlugin.ts#L5)
[src/handler/plugins/createPlugin.ts:5](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/createPlugin.ts#L5)
## Functions
@@ -610,6 +636,10 @@ ___
▸ **CommandControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
**`Since`**
2.5.0
#### Type parameters
| Name | Type |
@@ -628,7 +658,7 @@ ___
#### Defined in
[src/handler/plugins/createPlugin.ts:29](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/createPlugin.ts#L29)
[src/handler/plugins/createPlugin.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/createPlugin.ts#L38)
___
@@ -636,6 +666,10 @@ ___
▸ **CommandInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
**`Since`**
2.5.0
#### Type parameters
| Name | Type |
@@ -654,7 +688,7 @@ ___
#### Defined in
[src/handler/plugins/createPlugin.ts:23](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/createPlugin.ts#L23)
[src/handler/plugins/createPlugin.ts:29](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/createPlugin.ts#L29)
___
@@ -662,6 +696,10 @@ ___
▸ **DiscordEventControlPlugin**<`T`\>(`name`, `execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
**`Since`**
2.5.0
**`Experimental`**
A specialized function for creating control plugins with discord.js ClientEvents.
@@ -686,7 +724,7 @@ Will probably be moved one day!
#### Defined in
[src/handler/plugins/createPlugin.ts:46](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/createPlugin.ts#L46)
[src/handler/plugins/createPlugin.ts:59](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/createPlugin.ts#L59)
___
@@ -694,6 +732,10 @@ ___
▸ **EventControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
**`Since`**
2.5.0
#### Type parameters
| Name | Type |
@@ -712,7 +754,7 @@ ___
#### Defined in
[src/handler/plugins/createPlugin.ts:35](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/createPlugin.ts#L35)
[src/handler/plugins/createPlugin.ts:47](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/createPlugin.ts#L47)
___
@@ -720,6 +762,10 @@ ___
▸ **EventInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
**`Since`**
2.5.0
#### Type parameters
| Name | Type |
@@ -738,7 +784,7 @@ ___
#### Defined in
[src/handler/plugins/createPlugin.ts:17](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/createPlugin.ts#L17)
[src/handler/plugins/createPlugin.ts:20](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/createPlugin.ts#L20)
___
@@ -746,6 +792,9 @@ ___
▸ **commandModule**(`mod`): [`CommandModule`](modules.md#commandmodule)
**`Since`**
1.0.0
The wrapper function to define command modules for sern
#### Parameters
@@ -760,7 +809,7 @@ The wrapper function to define command modules for sern
#### Defined in
[src/handler/sern.ts:64](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L64)
[src/handler/sern.ts:68](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L68)
___
@@ -793,7 +842,7 @@ where typings can be very bad.
#### Defined in
[src/handler/sern.ts:97](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L97)
[src/handler/sern.ts:102](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L102)
___
@@ -801,6 +850,9 @@ ___
▸ **eventModule**(`mod`): [`EventModule`](modules.md#eventmodule)
**`Since`**
1.0.0
The wrapper function to define event modules for sern
#### Parameters
@@ -815,7 +867,7 @@ The wrapper function to define event modules for sern
#### Defined in
[src/handler/sern.ts:79](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L79)
[src/handler/sern.ts:84](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L84)
___
@@ -842,7 +894,7 @@ ___
#### Defined in
[src/handler/plugins/createPlugin.ts:6](https://github.com/sern-handler/handler/blob/33f1446/src/handler/plugins/createPlugin.ts#L6)
[src/handler/plugins/createPlugin.ts:6](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/createPlugin.ts#L6)
___
@@ -850,6 +902,8 @@ ___
▸ **many**<`T`\>(`value`): () => () => `T`
@__PURE__
**`Deprecated`**
#### Type parameters
@@ -882,7 +936,7 @@ ___
#### Defined in
[src/handler/dependencies/lifetimeFunctions.ts:50](https://github.com/sern-handler/handler/blob/33f1446/src/handler/dependencies/lifetimeFunctions.ts#L50)
[src/handler/dependencies/lifetimeFunctions.ts:63](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/dependencies/lifetimeFunctions.ts#L63)
___
@@ -916,12 +970,16 @@ ___
#### Defined in
[src/handler/dependencies/lifetimeFunctions.ts:11](https://github.com/sern-handler/handler/blob/33f1446/src/handler/dependencies/lifetimeFunctions.ts#L11)
[src/handler/dependencies/lifetimeFunctions.ts:18](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/dependencies/lifetimeFunctions.ts#L18)
▸ **single**<`T`\>(`cb`): `T`
New signature
**`Since`**
2.0.0
#### Type parameters
| Name | Type |
@@ -940,7 +998,7 @@ New signature
#### Defined in
[src/handler/dependencies/lifetimeFunctions.ts:16](https://github.com/sern-handler/handler/blob/33f1446/src/handler/dependencies/lifetimeFunctions.ts#L16)
[src/handler/dependencies/lifetimeFunctions.ts:24](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/dependencies/lifetimeFunctions.ts#L24)
___
@@ -980,10 +1038,15 @@ ___
#### Defined in
[src/handler/dependencies/lifetimeFunctions.ts:32](https://github.com/sern-handler/handler/blob/33f1446/src/handler/dependencies/lifetimeFunctions.ts#L32)
[src/handler/dependencies/lifetimeFunctions.ts:42](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/dependencies/lifetimeFunctions.ts#L42)
▸ **transient**<`T`\>(`cb`): `T`
@__PURE__
**`Since`**
2.0.0
Following iti's singleton and transient implementation,
use transient if you want a new dependency every time your container getter is called
@@ -1005,7 +1068,7 @@ use transient if you want a new dependency every time your container getter is c
#### Defined in
[src/handler/dependencies/lifetimeFunctions.ts:33](https://github.com/sern-handler/handler/blob/33f1446/src/handler/dependencies/lifetimeFunctions.ts#L33)
[src/handler/dependencies/lifetimeFunctions.ts:43](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/dependencies/lifetimeFunctions.ts#L43)
___
@@ -1029,4 +1092,4 @@ Exposes some methods from iti
#### Defined in
[src/handler/dependencies/provider.ts:54](https://github.com/sern-handler/handler/blob/33f1446/src/handler/dependencies/provider.ts#L54)
[src/handler/dependencies/provider.ts:51](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/dependencies/provider.ts#L51)

View File

@@ -48,6 +48,10 @@ Re-exports [eventModule](../modules.md#eventmodule-1)
**init**(`wrapper`): `void`
**`Since`**
1.0.0
**`Example`**
```ts title="src/index.ts"
@@ -73,7 +77,7 @@ Sern.init({
#### Defined in
[src/handler/sern.ts:38](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L38)
[src/handler/sern.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L38)
___
@@ -81,6 +85,10 @@ ___
▸ **makeDependencies**<`T`\>(`conf`): <V\>(...`keys`: [...V[]]) => [`MapDeps`](../modules.md#mapdeps)<`T`, `V`\>
**`Since`**
2.0.0
#### Type parameters
| Name | Type |
@@ -117,4 +125,4 @@ ___
#### Defined in
[src/handler/sern.ts:107](https://github.com/sern-handler/handler/blob/33f1446/src/handler/sern.ts#L107)
[src/handler/sern.ts:113](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/sern.ts#L113)

View File

@@ -1,8 +1,8 @@
---
sidebar_position: 8
sidebar_position: 9
---
# Conclusion
If you reached this far, thank you for reading! We hope you have learned the necessities you need
to create a bot with the sern framework. If you have any other questions, bugs, feature requests, concerns, please join our
[community server](https://sern.dev/discord), and we'll be glad to answer your questions.
[community server](https://sern.dev/discord), and we'll be glad to answer your questions.

View File

@@ -0,0 +1,66 @@
---
sidebar_position: 7
---
Since version 2.0.0, dependency injection, thanks to [iti](https://github.com/molszanski/iti), is a feature to customize your bot's utilities and structures.
Minimal setup for any project.
```ts
const client = new Client({
...options
})
Sern.makeDependencies<MyDependencies>({
build: root =>
root.add({
'@sern/client': single(() => client)
})
})
```
For any typescript project, you'll need to add an interface to get intellisense and typings.
```typescript
interface MyDependencies extends Dependencies {
'@sern/client': Singleton<Client>
}
```
Full Dependency Injection setup
```typescript
const client = new Client({
...options
})
interface MyDependencies extends Dependencies {
'@sern/client': Singleton<Client>
}
export const useContainer = Sern.makeDependencies<MyDependencies>({
build: root =>
root.add({
'@sern/client': single(() => client)
})
})
```
Everything else is handled. However, you may want customize things.
## Adding dependencies to root
Each sern built dependency must implement its contracts.
- `@sern/logger`: Log data. [Logging](../../api/interfaces/Logging)
- `@sern/errors`: Handling errors and lifetime. [ErrorHandling](../../api/interfaces/ErrorHandling)
- `@sern/modules`: Managing all command modules. [ModuleManager](../../api/interfaces/ModuleManager)
- `@sern/emitter`: is the key to emit events and occurences in a project. [SernEmitter](../../api/classes/SernEmitter)
You may also add disposers so that when the application crashes, the targeted dependency calls that function.
```typescript
export const useContainer = Sern.makeDependencies<MyDependencies>({
build: root =>
root.add({
'@sern/client': single(() => client)
})
.addDisposer({ '@sern/client': client => client.destroy() })
})
```

View File

@@ -8,7 +8,7 @@ Typescript:
```typescript
export default eventModule({
type: EventType.Sern,
plugins : [], //NOT SUPPORTED YET!!
plugins : [],
name: 'module.activate', //name of event.
execute(event) {
console.log(event);
@@ -19,7 +19,7 @@ Javascript:
```javascript
exports.default = eventModule({
type: EventType.Sern,
plugins : [], //NOT SUPPORTED YET!!
plugins : [],
name: 'module.activate',
execute(event) {
console.log(event);
@@ -33,7 +33,6 @@ To view what each of these properties mean in depth, visit the [official documen
<br />
Event modules are laid out similarly to command modules. These listen to any and all event you provide.
In the current version 1.1.0-beta, plugins are not supported.
### Another example of an event module
@@ -54,7 +53,7 @@ Javascript:
exports.default = eventModule({
type: EventType.Discord,
plugins : [], //NOT SUPPORTED YET!!
plugins : [],
name: 'guildMemberAdd', //name of event.
async execute(member) {
(await member.guild.channels.fetch('channel-id')).send(`Welcome, ${member}`);

View File

@@ -2,8 +2,13 @@
sidebar_position: 1
---
# Walkthrough
This walkthrough will be written in [TypeScript](https://www.typescriptlang.org/) but will have JavaScript snippets throughout.
# Goal
sern strives to be minimalist, but with all batteries included. Meaning, this framework provides the necessary tools
to start up a bot in minutes, and leaves plenty room space to customize your experience and create an amazing project.
It should include all the tools for any bot at any scale.

View File

@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
---
# Good to know
@@ -21,4 +21,4 @@ Or, if this is a brand-new project, `sern init` automatically installs it.
"commands": "commands"
}
}
```
```

View File

@@ -42,18 +42,18 @@ export function serenOnly() {
}
```
<br /> As part of our extensibility, the plugins feature make sern just as powerful, if not more powerful than
<br /> As part of being extensibile, plugins make sern just as powerful, if not more powerful than
standard handlers.
Plugins modify and add new behavior to standard modules, extending customizability and implementing automation.
Plugins modify and add new behavior to standard modules.
<br /> At the moment, there are two types of plugins:
- Command Plugins
- Event Plugins
- Init Plugins
- Control Plugins
## Command Plugins
All modules are registered into sern's system. With command plugins, you can modify how commands are loaded,
or do some kind of preprocessing before they are loaded.
## Init Plugins
All modules are registered into sern's system. Init plugins modify how commands are loaded.
or do some kind of preprocessing before loaded.
### The controller object
```typescript
export interface Controller {
@@ -67,8 +67,8 @@ Typescript:
```typescript
export function inDir(dir : string) : CommandPlugin<CommandType.Both> {
return {
type: PluginType.Command,
async execute(wrapper, { absPath, module }, controller) {
type: PluginType.Init,
async execute({ absPath, module }) {
if(path.dirname(absPath) !== dir) {
console.log(+new Date(), `${module.name} is not in the correct directory!`);
return controller.stop()
@@ -83,8 +83,8 @@ Javascript:
```javascript
export function inDir(dir : string) {
return {
type: PluginType.Command,
async execute(wrapper, { absPath, module }, controller) {
type: PluginType.Init,
async execute({ absPath, module }) {
if(path.dirname(absPath) !== dir) {
console.log(+new Date(), `${module.name} is not in the correct directory!`);
return controller.stop()
@@ -98,10 +98,10 @@ export function inDir(dir : string) {
Above, this simple plugin logs that the module has been loaded along with a timestamp. <br />
Again, it is up to **you** to define plugin logic! The possibilities to customize your bots are endless.
:::tip
Command Plugins are good for ensuring the shape, location, and preprocessing of your commands.
Init Plugins are good for ensuring the shape, maintaining location, and preprocessing commands.
:::
## Event Plugins
![event-plugins](../../../static/img/eventplugins.drawio.svg) <br />
![control-plugins](../../../static/img/eventplugins.drawio.svg) <br />
- An event is emitted by discord.js.
- This event is passed to all plugins (**in order!!**),
- If all are successful,
@@ -154,4 +154,4 @@ Can you predict the behavior of this command?
Event Plugins are good for filtering, preconditions, parsing.
:::
If all plugins return `controller.next()`, this command replies `Pong 🏓`
If all plugins return `controller.next()`, this command replies `Pong 🏓`

View File

@@ -159,16 +159,16 @@ const config = {
darkTheme: darkCodeTheme,
},
}),
// plugins : [
// [
// 'docusaurus-plugin-typedoc',
// {
// //if you're editing website, please change this to your local branch of sern to generate documentation
// entryPoints: ['../sernHandlerV2/src/index.ts'],
// tsconfig: '../sernHandlerV2/tsconfig-esm.json',
// },
// ]
// ]
plugins : [
// [
// 'docusaurus-plugin-typedoc',
// {
// //if you're editing website, please change this to your local branch of sern to generate documentation
// entryPoints: ['../sernHandlerV2/src/index.ts'],
// tsconfig: '../sernHandlerV2/tsconfig-esm.json',
// },
// ]
]
};
module.exports = config;

2762
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -17,10 +17,10 @@
"typedoc-json": "typedoc --json ../sern-community/docs.json --pretty --entryPoints ../sernHandlerV2/src/index.ts --tsconfig ../sernHandlerV2/tsconfig-esm.json --excludeExternals"
},
"dependencies": {
"@docusaurus/core": "2.0.0-rc.1",
"@docusaurus/plugin-content-pages": "^2.0.1",
"@docusaurus/preset-classic": "2.0.0-rc.1",
"@docusaurus/theme-search-algolia": "^2.0.0-rc.1",
"@docusaurus/core": "^2.4.0",
"@docusaurus/plugin-content-pages": "^2.4.0",
"@docusaurus/preset-classic": "^2.4.0",
"@docusaurus/theme-search-algolia": "^2.4.0",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
"jsdoc-parse-plus": "^1.3.0",