chore: update api documentation

2026-06-23 00:02:30 +00:00 · 2024-01-07 21:30:44 +00:00
parent 92959c3319
commit edd1d1492d
52 changed files with 548 additions and 367 deletions
--- a/docs/api/classes/CommandExecutable.md
+++ b/docs/api/classes/CommandExecutable.md
@@ -6,9 +6,9 @@ sidebar_position: 0
 custom_edit_url: null
 ---

-**`Experimental`**
+**`Deprecated`**

-Will be refactored / changed in future
+Will be removed in future

 ## Type parameters

@@ -20,7 +20,7 @@ Will be refactored / changed in future

 ### constructor

-• **new CommandExecutable**<`Type`\>()
+• **new CommandExecutable**<`Type`\>(): [`CommandExecutable`](CommandExecutable.md)<`Type`\>

 #### Type parameters

@@ -28,6 +28,10 @@ Will be refactored / changed in future
 | :------ | :------ |
 | `Type` | extends [`CommandType`](../enums/CommandType.md) = [`CommandType`](../enums/CommandType.md) |

+#### Returns
+
+[`CommandExecutable`](CommandExecutable.md)<`Type`\>
+
 ## Properties

 ### plugins
@@ -36,7 +40,7 @@ Will be refactored / changed in future

 #### Defined in

-[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L79)
+[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L80)

 ___

@@ -46,7 +50,7 @@ ___

 #### Defined in

-[src/core/modules.ts:78](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L78)
+[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L79)

 ___

@@ -56,13 +60,13 @@ ___

 #### Defined in

-[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L80)
+[src/core/modules.ts:81](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L81)

 ## Methods

 ### execute

-▸ `Abstract` **execute**(`...args`): `unknown`
+▸ **execute**(`...args`): `unknown`

 #### Parameters

@@ -76,13 +80,13 @@ ___

 #### Defined in

-[src/core/modules.ts:91](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L91)
+[src/core/modules.ts:92](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L92)

 ___

 ### getInstance

-▸ `Static` **getInstance**(): [`CommandModule`](../modules.md#commandmodule)
+▸ **getInstance**(): [`CommandModule`](../modules.md#commandmodule)

 #### Returns

@@ -90,4 +94,4 @@ ___

 #### Defined in

-[src/core/modules.ts:82](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L82)
+[src/core/modules.ts:83](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L83)
--- a/docs/api/classes/Context.md
+++ b/docs/api/classes/Context.md
@@ -22,7 +22,7 @@ Message and ChatInputCommandInteraction

 ### constructor

-• `Protected` **new Context**(`ctx`)
+• **new Context**(`ctx`): [`Context`](Context.md)

 #### Parameters

@@ -30,13 +30,17 @@ Message and ChatInputCommandInteraction
 | :------ | :------ |
 | `ctx` | `Result`<`Message`<`boolean`\>, `ChatInputCommandInteraction`<`CacheType`\>\> |

+#### Returns
+
+[`Context`](Context.md)
+
 #### Overrides

-CoreContext&lt;Message, ChatInputCommandInteraction\&gt;.constructor
+CoreContext\&lt;Message, ChatInputCommandInteraction\&gt;.constructor

 #### Defined in

-[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L29)
+[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L29)

 ## Properties

@@ -50,7 +54,7 @@ CoreContext.ctx

 #### Defined in

-[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L29)
+[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L29)

 ## Accessors

@@ -64,7 +68,7 @@ CoreContext.ctx

 #### Defined in

-[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L39)
+[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L39)

 ___

@@ -78,7 +82,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L45)
+[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L45)

 ___

@@ -92,7 +96,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L91)
+[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L91)

 ___

@@ -106,7 +110,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L65)
+[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L65)

 ___

@@ -120,7 +124,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L71)
+[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L71)

 ___

@@ -134,7 +138,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L77)
+[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L77)

 ___

@@ -148,7 +152,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L33)
+[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L33)

 ___

@@ -162,7 +166,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L97)
+[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L97)

 ___

@@ -180,7 +184,7 @@ CoreContext.interaction

 #### Defined in

-[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/core-context.ts#L15)
+[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/core-context.ts#L15)

 ___

@@ -194,7 +198,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L85)
+[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L85)

 ___

@@ -212,7 +216,7 @@ CoreContext.message

 #### Defined in

-[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/core-context.ts#L12)
+[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/core-context.ts#L12)

 ___

@@ -230,7 +234,7 @@ CoreContext.options

 #### Defined in

-[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L26)
+[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L26)

 ___

@@ -247,7 +251,7 @@ else, interaction.user

 #### Defined in

-[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L55)
+[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L55)

 ___

@@ -261,7 +265,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L61)
+[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L61)

 ## Methods

@@ -279,7 +283,7 @@ CoreContext.isMessage

 #### Defined in

-[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/core-context.ts#L19)
+[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/core-context.ts#L19)

 ___

@@ -297,7 +301,7 @@ CoreContext.isSlash

 #### Defined in

-[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/core-context.ts#L23)
+[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/core-context.ts#L23)

 ___

@@ -317,13 +321,13 @@ ___

 #### Defined in

-[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L103)
+[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L103)

 ___

 ### wrap

-▸ `Static` **wrap**(`wrappable`): [`Context`](Context.md)
+▸ **wrap**(`wrappable`): [`Context`](Context.md)

 #### Parameters

@@ -341,4 +345,4 @@ CoreContext.wrap

 #### Defined in

-[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L113)
+[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L113)
--- a/docs/api/classes/DefaultErrorHandling.md
+++ b/docs/api/classes/DefaultErrorHandling.md
@@ -19,7 +19,11 @@ Version 4.0.0 will internalize this api. Please refrain from using the defaults!

 ### constructor

-• **new DefaultErrorHandling**()
+• **new DefaultErrorHandling**(): [`DefaultErrorHandling`](DefaultErrorHandling.md)
+
+#### Returns
+
+[`DefaultErrorHandling`](DefaultErrorHandling.md)

 ## Properties

@@ -29,7 +33,7 @@ Version 4.0.0 will internalize this api. Please refrain from using the defaults!

 #### Defined in

-[src/core/structures/services/error-handling.ts:13](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/error-handling.ts#L13)
+[src/core/structures/services/error-handling.ts:13](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/error-handling.ts#L13)

 ## Methods

@@ -57,7 +61,7 @@ Version 4 will remove this method

 #### Defined in

-[src/core/structures/services/error-handling.ts:9](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/error-handling.ts#L9)
+[src/core/structures/services/error-handling.ts:9](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/error-handling.ts#L9)

 ___

@@ -83,4 +87,4 @@ A function that is called on every throw.

 #### Defined in

-[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/error-handling.ts#L15)
+[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/error-handling.ts#L15)
--- a/docs/api/classes/DefaultLogging.md
+++ b/docs/api/classes/DefaultLogging.md
@@ -19,13 +19,17 @@ Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!

 ### constructor

-• **new DefaultLogging**()
+• **new DefaultLogging**(): [`DefaultLogging`](DefaultLogging.md)
+
+#### Returns
+
+[`DefaultLogging`](DefaultLogging.md)

 ## Methods

 ### date

-▸ `Private` **date**(): `Date`
+▸ **date**(): `Date`

 #### Returns

@@ -33,7 +37,7 @@ Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!

 #### Defined in

-[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L9)
+[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L9)

 ___

@@ -57,7 +61,7 @@ ___

 #### Defined in

-[src/core/structures/services/logger.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L10)
+[src/core/structures/services/logger.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L10)

 ___

@@ -81,7 +85,7 @@ ___

 #### Defined in

-[src/core/structures/services/logger.ts:14](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L14)
+[src/core/structures/services/logger.ts:14](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L14)

 ___

@@ -105,7 +109,7 @@ ___

 #### Defined in

-[src/core/structures/services/logger.ts:18](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L18)
+[src/core/structures/services/logger.ts:18](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L18)

 ___

@@ -129,4 +133,4 @@ ___

 #### Defined in

-[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L22)
+[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L22)
--- a/docs/api/classes/DefaultModuleManager.md
+++ b/docs/api/classes/DefaultModuleManager.md
@@ -19,7 +19,7 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule

 ### constructor

-• **new DefaultModuleManager**(`moduleStore`)
+• **new DefaultModuleManager**(`moduleStore`): [`DefaultModuleManager`](DefaultModuleManager.md)

 #### Parameters

@@ -27,9 +27,13 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule
 | :------ | :------ |
 | `moduleStore` | [`CoreModuleStore`](../interfaces/CoreModuleStore.md) |

+#### Returns
+
+[`DefaultModuleManager`](DefaultModuleManager.md)
+
 #### Defined in

-[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L12)
+[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L12)

 ## Properties

@@ -39,7 +43,7 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule

 #### Defined in

-[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L12)
+[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L12)

 ## Methods

@@ -63,7 +67,7 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule

 #### Defined in

-[src/core/structures/services/module-manager.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L35)
+[src/core/structures/services/module-manager.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L35)

 ___

@@ -94,7 +98,7 @@ ___

 #### Defined in

-[src/core/structures/services/module-manager.ts:15](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L15)
+[src/core/structures/services/module-manager.ts:15](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L15)

 ___

@@ -118,7 +122,7 @@ ___

 #### Defined in

-[src/core/structures/services/module-manager.ts:27](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L27)
+[src/core/structures/services/module-manager.ts:27](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L27)

 ___

@@ -136,7 +140,7 @@ ___

 #### Defined in

-[src/core/structures/services/module-manager.ts:42](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L42)
+[src/core/structures/services/module-manager.ts:42](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L42)

 ___

@@ -161,7 +165,7 @@ ___

 #### Defined in

-[src/core/structures/services/module-manager.ts:38](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L38)
+[src/core/structures/services/module-manager.ts:38](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L38)

 ___

@@ -186,4 +190,4 @@ ___

 #### Defined in

-[src/core/structures/services/module-manager.ts:23](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L23)
+[src/core/structures/services/module-manager.ts:23](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L23)
--- a/docs/api/classes/EventExecutable.md
+++ b/docs/api/classes/EventExecutable.md
@@ -6,9 +6,9 @@ sidebar_position: 0
 custom_edit_url: null
 ---

-**`Experimental`**
+**`Deprecated`**

-Will be refactored in future
+Will be removed in future

 ## Type parameters

@@ -20,7 +20,7 @@ Will be refactored in future

 ### constructor

-• **new EventExecutable**<`Type`\>()
+• **new EventExecutable**<`Type`\>(): [`EventExecutable`](EventExecutable.md)<`Type`\>

 #### Type parameters

@@ -28,6 +28,10 @@ Will be refactored in future
 | :------ | :------ |
 | `Type` | extends [`EventType`](../enums/EventType.md) |

+#### Returns
+
+[`EventExecutable`](EventExecutable.md)<`Type`\>
+
 ## Properties

 ### plugins
@@ -36,7 +40,7 @@ Will be refactored in future

 #### Defined in

-[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L100)
+[src/core/modules.ts:101](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L101)

 ___

@@ -46,7 +50,7 @@ ___

 #### Defined in

-[src/core/modules.ts:99](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L99)
+[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L100)

 ___

@@ -56,13 +60,13 @@ ___

 #### Defined in

-[src/core/modules.ts:102](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L102)
+[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L103)

 ## Methods

 ### execute

-▸ `Abstract` **execute**(`...args`): `unknown`
+▸ **execute**(`...args`): `unknown`

 #### Parameters

@@ -76,13 +80,13 @@ ___

 #### Defined in

-[src/core/modules.ts:111](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L111)
+[src/core/modules.ts:112](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L112)

 ___

 ### getInstance

-▸ `Static` **getInstance**(): [`EventModule`](../modules.md#eventmodule)
+▸ **getInstance**(): [`EventModule`](../modules.md#eventmodule)

 #### Returns

@@ -90,4 +94,4 @@ ___

 #### Defined in

-[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L103)
+[src/core/modules.ts:104](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L104)
--- a/docs/api/classes/ModuleStore.md
+++ b/docs/api/classes/ModuleStore.md
@@ -16,7 +16,11 @@ Represents a core module store that stores IDs mapped to file paths.

 ### constructor

-• **new ModuleStore**()
+• **new ModuleStore**(): [`ModuleStore`](ModuleStore.md)
+
+#### Returns
+
+[`ModuleStore`](ModuleStore.md)

 ## Properties

@@ -30,7 +34,7 @@ Represents a core module store that stores IDs mapped to file paths.

 #### Defined in

-[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/module-store.ts#L11)
+[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/module-store.ts#L11)

 ___

@@ -44,4 +48,4 @@ ___

 #### Defined in

-[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/module-store.ts#L10)
+[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/module-store.ts#L10)
--- a/docs/api/classes/SernEmitter.md
+++ b/docs/api/classes/SernEmitter.md
@@ -20,7 +20,11 @@ custom_edit_url: null

 ### constructor

-• **new SernEmitter**()
+• **new SernEmitter**(): [`SernEmitter`](SernEmitter.md)
+
+#### Returns
+
+[`SernEmitter`](SernEmitter.md)

 #### Overrides

@@ -28,7 +32,7 @@ EventEmitter.constructor

 #### Defined in

-[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L10)
+[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L10)

 ## Properties

@@ -158,7 +162,7 @@ EventEmitter.emit

 #### Defined in

-[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L40)
+[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L40)

 ___

@@ -357,7 +361,7 @@ EventEmitter.on

 #### Defined in

-[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L18)
+[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L18)

 ___

@@ -390,7 +394,7 @@ EventEmitter.once

 #### Defined in

-[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L29)
+[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L29)

 ___

@@ -710,7 +714,7 @@ ___

 ### failure

-▸ `Static` **failure**(`module?`, `reason?`): `Object`
+▸ **failure**(`module?`, `reason?`): `Object`

 Creates a compliant SernEmitter failure payload

@@ -725,15 +729,21 @@ Creates a compliant SernEmitter failure payload

 `Object`

+| Name | Type |
+| :------ | :------ |
+| `module?` | `AnyModule` |
+| `reason` | `string` \| `Error` |
+| `type` | [`Failure`](../enums/PayloadType.md#failure) |
+
 #### Defined in

-[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L59)
+[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L59)

 ___

 ### getEventListeners

-▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
+▸ **getEventListeners**(`emitter`, `name`): `Function`[]

 Returns a copy of the array of listeners for the event named `eventName`.

@@ -787,7 +797,7 @@ ___

 ### getMaxListeners

-▸ `Static` **getMaxListeners**(`emitter`): `number`
+▸ **getMaxListeners**(`emitter`): `number`

 Returns the currently set max amount of listeners.

@@ -841,7 +851,7 @@ ___

 ### listenerCount

-▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
+▸ **listenerCount**(`emitter`, `eventName`): `number`

 A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.

@@ -885,7 +895,7 @@ ___

 ### on

-▸ `Static` **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`<`any`\>
+▸ **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`<`any`\>

 ```js
 const { on, EventEmitter } = require('events');
@@ -967,7 +977,7 @@ EventEmitter.on

 node_modules/@types/node/events.d.ts:254

-▸ `Static` **on**<`Emitter`, `Events`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Events`] : `any`\>
+▸ **on**<`Emitter`, `Events`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Events`] : `any`\>

 #### Type parameters

@@ -999,7 +1009,7 @@ ___

 ### once

-▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
+▸ **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>

 Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
 event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
@@ -1105,7 +1115,7 @@ EventEmitter.once

 node_modules/@types/node/events.d.ts:194

-▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
+▸ **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>

 #### Parameters

@@ -1127,7 +1137,7 @@ EventEmitter.once

 node_modules/@types/node/events.d.ts:195

-▸ `Static` **once**<`Emitter`, `Event`\>(`eventEmitter`, `eventName`): `Promise`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Event`] : `any`[]\>
+▸ **once**<`Emitter`, `Event`\>(`eventEmitter`, `eventName`): `Promise`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Event`] : `any`[]\>

 #### Type parameters

@@ -1159,7 +1169,7 @@ ___

 ### payload

-▸ `Static` `Private` **payload**<`T`\>(`type`, `module?`, `reason?`): `T`
+▸ **payload**<`T`\>(`type`, `module?`, `reason?`): `T`

 #### Type parameters

@@ -1181,13 +1191,13 @@ ___

 #### Defined in

-[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L46)
+[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L46)

 ___

 ### setMaxListeners

-▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
+▸ **setMaxListeners**(`n?`, `...eventTargets`): `void`

 ```js
 const {
@@ -1228,7 +1238,7 @@ ___

 ### success

-▸ `Static` **success**(`module`): `Object`
+▸ **success**(`module`): `Object`

 Creates a compliant SernEmitter module success payload

@@ -1242,15 +1252,20 @@ Creates a compliant SernEmitter module success payload

 `Object`

+| Name | Type |
+| :------ | :------ |
+| `module` | `AnyModule` |
+| `type` | [`Success`](../enums/PayloadType.md#success) |
+
 #### Defined in

-[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L72)
+[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L72)

 ___

 ### warning

-▸ `Static` **warning**(`reason`): `Object`
+▸ **warning**(`reason`): `Object`

 Creates a compliant SernEmitter module warning payload

@@ -1264,6 +1279,11 @@ Creates a compliant SernEmitter module warning payload

 `Object`

+| Name | Type |
+| :------ | :------ |
+| `reason` | `string` |
+| `type` | [`Warning`](../enums/PayloadType.md#warning) |
+
 #### Defined in

-[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L82)
+[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L82)