chore: update api documentation

2026-06-27 02:02:23 +00:00 · 2023-09-04 23:27:10 +02:00
parent 948b3bb8cf
commit f2388eb23d
49 changed files with 330 additions and 275 deletions
--- a/docs/api/classes/CommandExecutable.md
+++ b/docs/api/classes/CommandExecutable.md
@@ -36,7 +36,7 @@ Will be refactored / changed in future

 #### Defined in

-[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L79)
+[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L79)

 ___

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

 #### Defined in

-[src/core/modules.ts:78](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L78)
+[src/core/modules.ts:78](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L78)

 ___

@@ -56,7 +56,7 @@ ___

 #### Defined in

-[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L80)
+[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L80)

 ## Methods

@@ -76,7 +76,7 @@ ___

 #### Defined in

-[src/core/modules.ts:91](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L91)
+[src/core/modules.ts:91](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L91)

 ___

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

 #### Defined in

-[src/core/modules.ts:82](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L82)
+[src/core/modules.ts:82](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L82)
--- a/docs/api/classes/Context.md
+++ b/docs/api/classes/Context.md
@@ -36,7 +36,7 @@ CoreContext&lt;Message, ChatInputCommandInteraction\&gt;.constructor

 #### Defined in

-[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L29)
+[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L29)

 ## Properties

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

 #### Defined in

-[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L29)
+[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L29)

 ## Accessors

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

 #### Defined in

-[src/core/structures/context.ts:37](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L37)
+[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L39)
+
+___
+
+### channelId
+
+• `get` **channelId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L45)

 ___

@@ -78,7 +92,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:66](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L66)
+[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L91)

 ___

@@ -92,7 +106,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:48](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L48)
+[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L65)

 ___

@@ -106,7 +120,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:52](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L52)
+[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L71)

 ___

@@ -120,7 +134,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:56](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L56)
+[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L77)

 ___

@@ -134,7 +148,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L33)
+[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L33)

 ___

@@ -148,7 +162,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:70](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L70)
+[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L97)

 ___

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

 #### Defined in

-[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/core-context.ts#L15)
+[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L15)

 ___

@@ -180,7 +194,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:62](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L62)
+[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L85)

 ___

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

 #### Defined in

-[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/core-context.ts#L12)
+[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L12)

 ___

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

 #### Defined in

-[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L26)
+[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L26)

 ___

@@ -233,7 +247,21 @@ else, interaction.user

 #### Defined in

-[src/core/structures/context.ts:44](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L44)
+[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L55)
+
+___
+
+### userId
+
+• `get` **userId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L61)

 ## Methods

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

 #### Defined in

-[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/core-context.ts#L19)
+[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L19)

 ___

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

 #### Defined in

-[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/core-context.ts#L23)
+[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L23)

 ___

@@ -289,7 +317,7 @@ ___

 #### Defined in

-[src/core/structures/context.ts:74](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L74)
+[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L103)

 ___

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

 #### Defined in

-[src/core/structures/context.ts:84](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/context.ts#L84)
+[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L113)
--- a/docs/api/classes/DefaultErrorHandling.md
+++ b/docs/api/classes/DefaultErrorHandling.md
@@ -35,7 +35,7 @@ Number of times the process should throw an error until crashing and exiting

 #### Defined in

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

 ## Methods

@@ -63,7 +63,7 @@ Version 4 will remove this method

 #### Defined in

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

 ___

@@ -90,4 +90,4 @@ If keepAlive is 0, the process crashes.

 #### Defined in

-[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/services/error-handling.ts#L15)
+[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/error-handling.ts#L15)
--- a/docs/api/classes/DefaultLogging.md
+++ b/docs/api/classes/DefaultLogging.md
@@ -33,7 +33,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/81cdde2/src/core/structures/services/logger.ts#L9)
+[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/logger.ts#L9)

 ___

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

 #### Defined in

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

 ___

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

 #### Defined in

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

 ___

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

 #### Defined in

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

 ___

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

 #### Defined in

-[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/services/logger.ts#L22)
+[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/logger.ts#L22)
--- a/docs/api/classes/DefaultModuleManager.md
+++ b/docs/api/classes/DefaultModuleManager.md
@@ -29,7 +29,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/81cdde2/src/core/structures/services/module-manager.ts#L12)
+[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L12)

 ## Properties

@@ -39,7 +39,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/81cdde2/src/core/structures/services/module-manager.ts#L12)
+[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L12)

 ## Methods

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

 #### Defined in

-[src/core/structures/services/module-manager.ts:34](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/services/module-manager.ts#L34)
+[src/core/structures/services/module-manager.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L34)

 ___

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

 #### Defined in

-[src/core/structures/services/module-manager.ts:14](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/services/module-manager.ts#L14)
+[src/core/structures/services/module-manager.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L14)

 ___

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

 #### Defined in

-[src/core/structures/services/module-manager.ts:26](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/services/module-manager.ts#L26)
+[src/core/structures/services/module-manager.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L26)

 ___

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

 #### Defined in

-[src/core/structures/services/module-manager.ts:41](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/services/module-manager.ts#L41)
+[src/core/structures/services/module-manager.ts:41](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L41)

 ___

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

 #### Defined in

-[src/core/structures/services/module-manager.ts:37](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/services/module-manager.ts#L37)
+[src/core/structures/services/module-manager.ts:37](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L37)

 ___

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

 #### Defined in

-[src/core/structures/services/module-manager.ts:22](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/services/module-manager.ts#L22)
+[src/core/structures/services/module-manager.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L22)
--- a/docs/api/classes/EventExecutable.md
+++ b/docs/api/classes/EventExecutable.md
@@ -36,7 +36,7 @@ Will be refactored in future

 #### Defined in

-[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L100)
+[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L100)

 ___

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

 #### Defined in

-[src/core/modules.ts:99](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L99)
+[src/core/modules.ts:99](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L99)

 ___

@@ -56,7 +56,7 @@ ___

 #### Defined in

-[src/core/modules.ts:102](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L102)
+[src/core/modules.ts:102](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L102)

 ## Methods

@@ -76,7 +76,7 @@ ___

 #### Defined in

-[src/core/modules.ts:111](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L111)
+[src/core/modules.ts:111](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L111)

 ___

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

 #### Defined in

-[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/81cdde2/src/core/modules.ts#L103)
+[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L103)
--- a/docs/api/classes/ModuleStore.md
+++ b/docs/api/classes/ModuleStore.md
@@ -30,7 +30,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/81cdde2/src/core/structures/module-store.ts#L11)
+[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/module-store.ts#L11)

 ___

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

 #### Defined in

-[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/module-store.ts#L10)
+[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/module-store.ts#L10)
--- a/docs/api/classes/SernEmitter.md
+++ b/docs/api/classes/SernEmitter.md
@@ -28,7 +28,7 @@ EventEmitter.constructor

 #### Defined in

-[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/sern-emitter.ts#L10)
+[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L10)

 ## Properties

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

 #### Defined in

-[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/sern-emitter.ts#L40)
+[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L40)

 ___

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

 #### Defined in

-[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/sern-emitter.ts#L18)
+[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L18)

 ___

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

 #### Defined in

-[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/sern-emitter.ts#L29)
+[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L29)

 ___

@@ -727,7 +727,7 @@ Creates a compliant SernEmitter failure payload

 #### Defined in

-[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/sern-emitter.ts#L59)
+[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L59)

 ___

@@ -1127,7 +1127,7 @@ ___

 #### Defined in

-[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/sern-emitter.ts#L46)
+[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L46)

 ___

@@ -1190,7 +1190,7 @@ Creates a compliant SernEmitter module success payload

 #### Defined in

-[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/sern-emitter.ts#L72)
+[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L72)

 ___

@@ -1212,4 +1212,4 @@ Creates a compliant SernEmitter module warning payload

 #### Defined in

-[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/81cdde2/src/core/structures/sern-emitter.ts#L82)
+[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L82)