From 55a691e7878ca20af610b49071ab3e5833c94878 Mon Sep 17 00:00:00 2001 From: sern bot <129876409+sernbot@users.noreply.github.com> Date: Sat, 16 Dec 2023 23:50:28 +0000 Subject: [PATCH] chore: update api documentation --- docs/api/classes/CommandExecutable.md | 10 +- docs/api/classes/Context.md | 40 +-- docs/api/classes/DefaultErrorHandling.md | 29 +- docs/api/classes/DefaultLogging.md | 10 +- docs/api/classes/DefaultModuleManager.md | 16 +- docs/api/classes/EventExecutable.md | 10 +- docs/api/classes/ModuleStore.md | 4 +- docs/api/classes/SernEmitter.md | 276 +++++++++++------- docs/api/enums/CommandType.md | 24 +- docs/api/enums/EventType.md | 6 +- docs/api/enums/PayloadType.md | 6 +- docs/api/enums/PluginType.md | 4 +- docs/api/index.md | 3 +- docs/api/interfaces/BothCommand.md | 16 +- docs/api/interfaces/ButtonCommand.md | 12 +- docs/api/interfaces/ChannelSelectCommand.md | 12 +- docs/api/interfaces/CommandError.Response.md | 45 +++ docs/api/interfaces/CommandModuleDefs.md | 24 +- docs/api/interfaces/ContextMenuMsg.md | 12 +- docs/api/interfaces/ContextMenuUser.md | 12 +- docs/api/interfaces/ControlPlugin.md | 4 +- docs/api/interfaces/Controller.md | 4 +- docs/api/interfaces/CoreDependencies.md | 12 +- docs/api/interfaces/CoreModuleStore.md | 4 +- docs/api/interfaces/DiscordEventCommand.md | 12 +- docs/api/interfaces/Disposable.md | 2 +- docs/api/interfaces/Emitter.md | 6 +- docs/api/interfaces/ErrorHandling.md | 27 +- docs/api/interfaces/EventModuleDefs.md | 6 +- docs/api/interfaces/ExternalEventCommand.md | 14 +- docs/api/interfaces/Init.md | 2 +- docs/api/interfaces/InitPlugin.md | 4 +- docs/api/interfaces/Logging.md | 8 +- .../interfaces/MentionableSelectCommand.md | 12 +- docs/api/interfaces/ModalSubmitCommand.md | 12 +- docs/api/interfaces/ModuleManager.md | 27 +- docs/api/interfaces/Plugin.md | 4 +- docs/api/interfaces/RoleSelectCommand.md | 12 +- docs/api/interfaces/SernAutocompleteData.md | 16 +- docs/api/interfaces/SernEventCommand.md | 12 +- docs/api/interfaces/SernEventsMapping.md | 10 +- docs/api/interfaces/SernSubCommandData.md | 4 +- .../api/interfaces/SernSubCommandGroupData.md | 16 +- docs/api/interfaces/SlashCommand.md | 14 +- docs/api/interfaces/StringSelectCommand.md | 12 +- docs/api/interfaces/TextCommand.md | 14 +- docs/api/interfaces/UserSelectCommand.md | 12 +- docs/api/interfaces/Wrapper.md | 10 +- docs/api/modules.md | 205 +++++++------ docs/api/namespaces/CommandError.md | 31 ++ docs/api/namespaces/Sern.md | 24 +- 51 files changed, 622 insertions(+), 501 deletions(-) create mode 100644 docs/api/interfaces/CommandError.Response.md create mode 100644 docs/api/namespaces/CommandError.md diff --git a/docs/api/classes/CommandExecutable.md b/docs/api/classes/CommandExecutable.md index 47659dcce..006ff4e61 100644 --- 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/e1059f9/src/core/modules.ts#L79) +[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L79) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[src/core/modules.ts:78](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L78) +[src/core/modules.ts:78](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L78) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L80) +[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L80) ## Methods @@ -76,7 +76,7 @@ ___ #### Defined in -[src/core/modules.ts:91](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L91) +[src/core/modules.ts:91](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L91) ___ @@ -90,4 +90,4 @@ ___ #### Defined in -[src/core/modules.ts:82](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L82) +[src/core/modules.ts:82](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L82) diff --git a/docs/api/classes/Context.md b/docs/api/classes/Context.md index 6c62262a9..bbe42200a 100644 --- a/docs/api/classes/Context.md +++ b/docs/api/classes/Context.md @@ -36,7 +36,7 @@ CoreContext<Message, ChatInputCommandInteraction\>.constructor #### Defined in -[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L29) +[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/context.ts#L29) +[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L29) ## Accessors @@ -64,7 +64,7 @@ CoreContext.ctx #### Defined in -[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L39) +[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L39) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L45) +[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L45) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L91) +[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L91) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L65) +[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L65) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L71) +[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L71) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L77) +[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L77) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L33) +[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L33) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L97) +[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L97) ___ @@ -180,7 +180,7 @@ CoreContext.interaction #### Defined in -[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L15) +[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/core-context.ts#L15) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L85) +[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L85) ___ @@ -212,7 +212,7 @@ CoreContext.message #### Defined in -[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L12) +[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/core-context.ts#L12) ___ @@ -230,7 +230,7 @@ CoreContext.options #### Defined in -[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L26) +[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L26) ___ @@ -247,7 +247,7 @@ else, interaction.user #### Defined in -[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L55) +[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L55) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L61) +[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L61) ## Methods @@ -279,7 +279,7 @@ CoreContext.isMessage #### Defined in -[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L19) +[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/core-context.ts#L19) ___ @@ -297,7 +297,7 @@ CoreContext.isSlash #### Defined in -[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L23) +[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/core-context.ts#L23) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L103) +[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L103) ___ @@ -341,4 +341,4 @@ CoreContext.wrap #### Defined in -[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L113) +[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/context.ts#L113) diff --git a/docs/api/classes/DefaultErrorHandling.md b/docs/api/classes/DefaultErrorHandling.md index 2ca554122..3207c0580 100644 --- a/docs/api/classes/DefaultErrorHandling.md +++ b/docs/api/classes/DefaultErrorHandling.md @@ -9,7 +9,7 @@ custom_edit_url: null **`Since`** 2.0.0 -Version 4.0.0 will internalize this api. Please refrain from using ModuleStore! +Version 4.0.0 will internalize this api. Please refrain from using the defaults! ## Implements @@ -23,19 +23,13 @@ Version 4.0.0 will internalize this api. Please refrain from using ModuleStore! ## Properties -### keepAlive +### #keepAlive -• **keepAlive**: `number` = `5` - -Number of times the process should throw an error until crashing and exiting - -#### Implementation of - -[ErrorHandling](../interfaces/ErrorHandling.md).[keepAlive](../interfaces/ErrorHandling.md#keepalive) +• `Private` **#keepAlive**: `number` = `5` #### Defined in -[src/core/structures/services/error-handling.ts:13](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/error-handling.ts#L13) +[src/core/structures/services/error-handling.ts:13](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/error-handling.ts#L13) ## Methods @@ -43,10 +37,6 @@ Number of times the process should throw an error until crashing and exiting ▸ **crash**(`err`): `never` -**`Deprecated`** - -Version 4 will remove this method - #### Parameters | Name | Type | @@ -57,13 +47,17 @@ Version 4 will remove this method `never` +**`Deprecated`** + +Version 4 will remove this method + #### Implementation of [ErrorHandling](../interfaces/ErrorHandling.md).[crash](../interfaces/ErrorHandling.md#crash) #### Defined in -[src/core/structures/services/error-handling.ts:9](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/error-handling.ts#L9) +[src/core/structures/services/error-handling.ts:9](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/error-handling.ts#L9) ___ @@ -71,8 +65,7 @@ ___ ▸ **updateAlive**(`err`): `void` -A function that is called on every crash. Updates keepAlive. -If keepAlive is 0, the process crashes. +A function that is called on every throw. #### Parameters @@ -90,4 +83,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/e1059f9/src/core/structures/services/error-handling.ts#L15) +[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/error-handling.ts#L15) diff --git a/docs/api/classes/DefaultLogging.md b/docs/api/classes/DefaultLogging.md index 54d58ed09..6499800c9 100644 --- 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/e1059f9/src/core/structures/services/logger.ts#L9) +[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/services/logger.ts#L10) +[src/core/structures/services/logger.ts:10](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/services/logger.ts#L14) +[src/core/structures/services/logger.ts:14](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/services/logger.ts#L18) +[src/core/structures/services/logger.ts:18](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/services/logger.ts#L22) +[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/logger.ts#L22) diff --git a/docs/api/classes/DefaultModuleManager.md b/docs/api/classes/DefaultModuleManager.md index 1ba0fabac..d4c1be6b4 100644 --- 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/e1059f9/src/core/structures/services/module-manager.ts#L12) +[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/services/module-manager.ts#L12) +[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/services/module-manager.ts#L34) +[src/core/structures/services/module-manager.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/module-manager.ts#L35) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[src/core/structures/services/module-manager.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L14) +[src/core/structures/services/module-manager.ts:15](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/module-manager.ts#L15) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[src/core/structures/services/module-manager.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L26) +[src/core/structures/services/module-manager.ts:27](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/module-manager.ts#L27) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[src/core/structures/services/module-manager.ts:41](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L41) +[src/core/structures/services/module-manager.ts:42](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/module-manager.ts#L42) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -[src/core/structures/services/module-manager.ts:37](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L37) +[src/core/structures/services/module-manager.ts:38](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/module-manager.ts#L38) ___ @@ -186,4 +186,4 @@ ___ #### Defined in -[src/core/structures/services/module-manager.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L22) +[src/core/structures/services/module-manager.ts:23](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/services/module-manager.ts#L23) diff --git a/docs/api/classes/EventExecutable.md b/docs/api/classes/EventExecutable.md index ba4cef1de..cf85894e8 100644 --- 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/e1059f9/src/core/modules.ts#L100) +[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L100) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[src/core/modules.ts:99](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L99) +[src/core/modules.ts:99](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L99) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[src/core/modules.ts:102](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L102) +[src/core/modules.ts:102](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L102) ## Methods @@ -76,7 +76,7 @@ ___ #### Defined in -[src/core/modules.ts:111](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L111) +[src/core/modules.ts:111](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L111) ___ @@ -90,4 +90,4 @@ ___ #### Defined in -[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L103) +[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L103) diff --git a/docs/api/classes/ModuleStore.md b/docs/api/classes/ModuleStore.md index 2eea49e86..e4ef500db 100644 --- 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/e1059f9/src/core/structures/module-store.ts#L11) +[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/module-store.ts#L10) +[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/module-store.ts#L10) diff --git a/docs/api/classes/SernEmitter.md b/docs/api/classes/SernEmitter.md index 5ca6e067b..5bddaa1fa 100644 --- 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/e1059f9/src/core/structures/sern-emitter.ts#L10) +[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/sern-emitter.ts#L10) ## Properties @@ -42,7 +42,7 @@ EventEmitter.captureRejectionSymbol #### Defined in -node_modules/@types/node/events.d.ts:328 +node_modules/@types/node/events.d.ts:357 ___ @@ -58,7 +58,7 @@ EventEmitter.captureRejections #### Defined in -node_modules/@types/node/events.d.ts:333 +node_modules/@types/node/events.d.ts:362 ___ @@ -72,7 +72,7 @@ EventEmitter.defaultMaxListeners #### Defined in -node_modules/@types/node/events.d.ts:334 +node_modules/@types/node/events.d.ts:363 ___ @@ -94,7 +94,7 @@ EventEmitter.errorMonitor #### Defined in -node_modules/@types/node/events.d.ts:327 +node_modules/@types/node/events.d.ts:356 ## Methods @@ -104,10 +104,6 @@ node_modules/@types/node/events.d.ts:327 Alias for `emitter.on(eventName, listener)`. -**`Since`** - -v0.1.26 - #### Parameters | Name | Type | @@ -119,13 +115,17 @@ v0.1.26 [`SernEmitter`](SernEmitter.md) +**`Since`** + +v0.1.26 + #### Inherited from EventEmitter.addListener #### Defined in -node_modules/@types/node/events.d.ts:354 +node_modules/@types/node/events.d.ts:383 ___ @@ -158,7 +158,7 @@ EventEmitter.emit #### Defined in -[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L40) +[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/sern-emitter.ts#L40) ___ @@ -182,21 +182,21 @@ console.log(myEE.eventNames()); // Prints: [ 'foo', 'bar', Symbol(symbol) ] ``` -**`Since`** - -v6.0.0 - #### Returns (`string` \| `symbol`)[] +**`Since`** + +v6.0.0 + #### Inherited from EventEmitter.eventNames #### Defined in -node_modules/@types/node/events.d.ts:673 +node_modules/@types/node/events.d.ts:702 ___ @@ -207,21 +207,21 @@ ___ Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](SernEmitter.md#defaultmaxlisteners). -**`Since`** - -v1.0.0 - #### Returns `number` +**`Since`** + +v1.0.0 + #### Inherited from EventEmitter.getMaxListeners #### Defined in -node_modules/@types/node/events.d.ts:526 +node_modules/@types/node/events.d.ts:555 ___ @@ -234,10 +234,6 @@ Returns the number of listeners listening to the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event. -**`Since`** - -v3.2.0 - #### Parameters | Name | Type | Description | @@ -249,13 +245,17 @@ v3.2.0 `number` +**`Since`** + +v3.2.0 + #### Inherited from EventEmitter.listenerCount #### Defined in -node_modules/@types/node/events.d.ts:620 +node_modules/@types/node/events.d.ts:649 ___ @@ -273,10 +273,6 @@ console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ] ``` -**`Since`** - -v0.1.26 - #### Parameters | Name | Type | @@ -287,13 +283,17 @@ v0.1.26 `Function`[] +**`Since`** + +v0.1.26 + #### Inherited from EventEmitter.listeners #### Defined in -node_modules/@types/node/events.d.ts:539 +node_modules/@types/node/events.d.ts:568 ___ @@ -303,10 +303,6 @@ ___ Alias for `emitter.removeListener()`. -**`Since`** - -v10.0.0 - #### Parameters | Name | Type | @@ -318,13 +314,17 @@ v10.0.0 [`SernEmitter`](SernEmitter.md) +**`Since`** + +v10.0.0 + #### Inherited from EventEmitter.off #### Defined in -node_modules/@types/node/events.d.ts:499 +node_modules/@types/node/events.d.ts:528 ___ @@ -357,7 +357,7 @@ EventEmitter.on #### Defined in -[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L18) +[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/a579e27/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/e1059f9/src/core/structures/sern-emitter.ts#L29) +[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/sern-emitter.ts#L29) ___ @@ -411,10 +411,6 @@ server.prependListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -**`Since`** - -v6.0.0 - #### Parameters | Name | Type | Description | @@ -426,13 +422,17 @@ v6.0.0 [`SernEmitter`](SernEmitter.md) +**`Since`** + +v6.0.0 + #### Inherited from EventEmitter.prependListener #### Defined in -node_modules/@types/node/events.d.ts:638 +node_modules/@types/node/events.d.ts:667 ___ @@ -451,10 +451,6 @@ server.prependOnceListener('connection', (stream) => { Returns a reference to the `EventEmitter`, so that calls can be chained. -**`Since`** - -v6.0.0 - #### Parameters | Name | Type | Description | @@ -466,13 +462,17 @@ v6.0.0 [`SernEmitter`](SernEmitter.md) +**`Since`** + +v6.0.0 + #### Inherited from EventEmitter.prependOnceListener #### Defined in -node_modules/@types/node/events.d.ts:654 +node_modules/@types/node/events.d.ts:683 ___ @@ -507,10 +507,6 @@ newListeners[0](); emitter.emit('log'); ``` -**`Since`** - -v9.4.0 - #### Parameters | Name | Type | @@ -521,13 +517,17 @@ v9.4.0 `Function`[] +**`Since`** + +v9.4.0 + #### Inherited from EventEmitter.rawListeners #### Defined in -node_modules/@types/node/events.d.ts:569 +node_modules/@types/node/events.d.ts:598 ___ @@ -543,10 +543,6 @@ component or module (e.g. sockets or file streams). Returns a reference to the `EventEmitter`, so that calls can be chained. -**`Since`** - -v0.1.26 - #### Parameters | Name | Type | @@ -557,13 +553,17 @@ v0.1.26 [`SernEmitter`](SernEmitter.md) +**`Since`** + +v0.1.26 + #### Inherited from EventEmitter.removeAllListeners #### Defined in -node_modules/@types/node/events.d.ts:510 +node_modules/@types/node/events.d.ts:539 ___ @@ -648,10 +648,6 @@ ee.emit('ping'); Returns a reference to the `EventEmitter`, so that calls can be chained. -**`Since`** - -v0.1.26 - #### Parameters | Name | Type | @@ -663,13 +659,17 @@ v0.1.26 [`SernEmitter`](SernEmitter.md) +**`Since`** + +v0.1.26 + #### Inherited from EventEmitter.removeListener #### Defined in -node_modules/@types/node/events.d.ts:494 +node_modules/@types/node/events.d.ts:523 ___ @@ -684,10 +684,6 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi Returns a reference to the `EventEmitter`, so that calls can be chained. -**`Since`** - -v0.3.5 - #### Parameters | Name | Type | @@ -698,13 +694,17 @@ v0.3.5 [`SernEmitter`](SernEmitter.md) +**`Since`** + +v0.3.5 + #### Inherited from EventEmitter.setMaxListeners #### Defined in -node_modules/@types/node/events.d.ts:520 +node_modules/@types/node/events.d.ts:549 ___ @@ -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/e1059f9/src/core/structures/sern-emitter.ts#L59) +[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/sern-emitter.ts#L59) ___ @@ -760,10 +760,6 @@ const { getEventListeners, EventEmitter } = require('events'); } ``` -**`Since`** - -v15.2.0, v14.17.0 - #### Parameters | Name | Type | @@ -775,6 +771,10 @@ v15.2.0, v14.17.0 `Function`[] +**`Since`** + +v15.2.0, v14.17.0 + #### Inherited from EventEmitter.getEventListeners @@ -785,6 +785,60 @@ node_modules/@types/node/events.d.ts:299 ___ +### getMaxListeners + +▸ `Static` **getMaxListeners**(`emitter`): `number` + +Returns the currently set max amount of listeners. + +For `EventEmitter`s this behaves exactly the same as calling `.getMaxListeners` on +the emitter. + +For `EventTarget`s this is the only way to get the max event listeners for the +event target. If the number of event handlers on a single EventTarget exceeds +the max set, the EventTarget will print a warning. + +```js +import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + console.log(getMaxListeners(ee)); // 10 + setMaxListeners(11, ee); + console.log(getMaxListeners(ee)); // 11 +} +{ + const et = new EventTarget(); + console.log(getMaxListeners(et)); // 10 + setMaxListeners(11, et); + console.log(getMaxListeners(et)); // 11 +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | `EventEmitter` \| `_DOMEventTarget` | + +#### Returns + +`number` + +**`Since`** + +v18.17.0 + +#### Inherited from + +EventEmitter.getMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:328 + +___ + ### listenerCount ▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` @@ -800,14 +854,6 @@ console.log(listenerCount(myEmitter, 'event')); // Prints: 2 ``` -**`Since`** - -v0.9.12 - -**`Deprecated`** - -Since v3.2.0 - Use `listenerCount` instead. - #### Parameters | Name | Type | Description | @@ -819,6 +865,14 @@ Since v3.2.0 - Use `listenerCount` instead. `number` +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + #### Inherited from EventEmitter.listenerCount @@ -887,10 +941,6 @@ const ac = new AbortController(); process.nextTick(() => ac.abort()); ``` -**`Since`** - -v13.6.0, v12.16.0 - #### Parameters | Name | Type | Description | @@ -905,6 +955,10 @@ v13.6.0, v12.16.0 that iterates `eventName` events emitted by the `emitter` +**`Since`** + +v13.6.0, v12.16.0 + #### Inherited from EventEmitter.on @@ -913,25 +967,25 @@ EventEmitter.on node_modules/@types/node/events.d.ts:254 -▸ `Static` **on**<`E`, `K`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`\> +▸ `Static` **on**<`Emitter`, `Events`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Events`] : `any`\> #### Type parameters | Name | Type | | :------ | :------ | -| `E` | extends `__module` | -| `K` | extends keyof `ClientEvents` | +| `Emitter` | extends `__module` | +| `Events` | extends keyof `ClientEvents` | #### Parameters | Name | Type | | :------ | :------ | -| `eventEmitter` | `E` | -| `eventName` | `E` extends `Client`<`boolean`\> ? `K` : `string` | +| `eventEmitter` | `Emitter` | +| `eventName` | `Emitter` extends `Client`<`boolean`\> ? `Events` : `string` | #### Returns -`AsyncIterableIterator`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`\> +`AsyncIterableIterator`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Events`] : `any`\> #### Inherited from @@ -939,7 +993,7 @@ EventEmitter.on #### Defined in -node_modules/discord.js/typings/index.d.ts:229 +node_modules/discord.js/typings/index.d.ts:243 ___ @@ -1027,10 +1081,6 @@ ac.abort(); // Abort waiting for the event ee.emit('foo'); // Prints: Waiting for the event was canceled! ``` -**`Since`** - -v11.13.0, v10.16.0 - #### Parameters | Name | Type | @@ -1043,6 +1093,10 @@ v11.13.0, v10.16.0 `Promise`<`any`[]\> +**`Since`** + +v11.13.0, v10.16.0 + #### Inherited from EventEmitter.once @@ -1073,25 +1127,25 @@ EventEmitter.once node_modules/@types/node/events.d.ts:195 -▸ `Static` **once**<`E`, `K`\>(`eventEmitter`, `eventName`): `Promise`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`[]\> +▸ `Static` **once**<`Emitter`, `Event`\>(`eventEmitter`, `eventName`): `Promise`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Event`] : `any`[]\> #### Type parameters | Name | Type | | :------ | :------ | -| `E` | extends `__module` | -| `K` | extends keyof `ClientEvents` | +| `Emitter` | extends `__module` | +| `Event` | extends keyof `ClientEvents` | #### Parameters | Name | Type | | :------ | :------ | -| `eventEmitter` | `E` | -| `eventName` | `E` extends `Client`<`boolean`\> ? `K` : `string` | +| `eventEmitter` | `Emitter` | +| `eventName` | `Emitter` extends `Client`<`boolean`\> ? `Event` : `string` | #### Returns -`Promise`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`[]\> +`Promise`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Event`] : `any`[]\> #### Inherited from @@ -1099,7 +1153,7 @@ EventEmitter.once #### Defined in -node_modules/discord.js/typings/index.d.ts:225 +node_modules/discord.js/typings/index.d.ts:239 ___ @@ -1127,7 +1181,7 @@ ___ #### Defined in -[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L46) +[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/sern-emitter.ts#L46) ___ @@ -1147,10 +1201,6 @@ const emitter = new EventEmitter(); setMaxListeners(5, target, emitter); ``` -**`Since`** - -v15.4.0 - #### Parameters | Name | Type | Description | @@ -1162,13 +1212,17 @@ v15.4.0 `void` +**`Since`** + +v15.4.0 + #### Inherited from EventEmitter.setMaxListeners #### Defined in -node_modules/@types/node/events.d.ts:317 +node_modules/@types/node/events.d.ts:346 ___ @@ -1190,7 +1244,7 @@ Creates a compliant SernEmitter module success payload #### Defined in -[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L72) +[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/sern-emitter.ts#L72) ___ @@ -1212,4 +1266,4 @@ Creates a compliant SernEmitter module warning payload #### Defined in -[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L82) +[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/sern-emitter.ts#L82) diff --git a/docs/api/enums/CommandType.md b/docs/api/enums/CommandType.md index 1ba93e9b5..0f0a41fce 100644 --- a/docs/api/enums/CommandType.md +++ b/docs/api/enums/CommandType.md @@ -32,7 +32,7 @@ export default commandModule({ #### Defined in -[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L20) +[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L20) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L23) +[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L23) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L29) +[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L29) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L22) +[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L22) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L21) +[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L21) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L28) +[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L28) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L25) +[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L25) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L27) +[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L27) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L19) +[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L19) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L24) +[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L24) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L18) +[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L18) ___ @@ -142,4 +142,4 @@ ___ #### Defined in -[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L26) +[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L26) diff --git a/docs/api/enums/EventType.md b/docs/api/enums/EventType.md index c00c72426..edddea6b1 100644 --- a/docs/api/enums/EventType.md +++ b/docs/api/enums/EventType.md @@ -31,7 +31,7 @@ The EventType for handling discord events #### Defined in -[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L51) +[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L51) ___ @@ -44,7 +44,7 @@ Could be for example, `process` events, database events #### Defined in -[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L60) +[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L60) ___ @@ -56,4 +56,4 @@ The EventType for handling sern events #### Defined in -[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L55) +[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L55) diff --git a/docs/api/enums/PayloadType.md b/docs/api/enums/PayloadType.md index 13162c728..057ffc060 100644 --- a/docs/api/enums/PayloadType.md +++ b/docs/api/enums/PayloadType.md @@ -16,7 +16,7 @@ The PayloadType for a SernEmitter failure event #### Defined in -[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L98) +[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L98) ___ @@ -28,7 +28,7 @@ The PayloadType for a SernEmitter success event #### Defined in -[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L94) +[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L94) ___ @@ -40,4 +40,4 @@ The PayloadType for a SernEmitter warning event #### Defined in -[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L102) +[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L102) diff --git a/docs/api/enums/PluginType.md b/docs/api/enums/PluginType.md index 1c7f6967a..5e1b43df0 100644 --- a/docs/api/enums/PluginType.md +++ b/docs/api/enums/PluginType.md @@ -30,7 +30,7 @@ The PluginType for EventPlugins #### Defined in -[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L85) +[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L85) ___ @@ -42,4 +42,4 @@ The PluginType for InitPlugins #### Defined in -[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L81) +[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/enums.ts#L81) diff --git a/docs/api/index.md b/docs/api/index.md index 46b11844e..bf6e9ead1 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -26,10 +26,9 @@ custom_edit_url: null - For you. A framework that's tailored to your exact needs. - Lightweight. Does a lot while being small. - Latest features. Support for discord.js v14 and all of its interactions. -- Hybrid, customizable and composable commands. Create them just how you like. - Start quickly. Plug and play or customize to your liking. -- Embraces reactive programming. For consistent and reliable backend. - Switch and customize how errors are handled, logging, and more. +- works with [bun](https://bun.sh/) and [node](https://nodejs.org/en) out the box! - Use it with TypeScript or JavaScript. CommonJS and ESM supported. - Active and growing community, always here to help. [Join us](https://sern.dev/discord) - Unleash its full potential with a powerful CLI and awesome plugins. diff --git a/docs/api/interfaces/BothCommand.md b/docs/api/interfaces/BothCommand.md index 4ca313cf5..a51e9998a 100644 --- a/docs/api/interfaces/BothCommand.md +++ b/docs/api/interfaces/BothCommand.md @@ -20,7 +20,7 @@ custom_edit_url: null #### Defined in -[src/types/core-modules.ts:124](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L124) +[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L126) ___ @@ -34,7 +34,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L125) +[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L127) ___ @@ -63,7 +63,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L127) +[src/types/core-modules.ts:129](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L129) ___ @@ -77,7 +77,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -91,7 +91,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L126) +[src/types/core-modules.ts:128](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L128) ___ @@ -115,7 +115,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -129,4 +129,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L123) +[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L125) diff --git a/docs/api/interfaces/ButtonCommand.md b/docs/api/interfaces/ButtonCommand.md index d5dca3787..410de9b45 100644 --- a/docs/api/interfaces/ButtonCommand.md +++ b/docs/api/interfaces/ButtonCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:64](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L64) +[src/types/core-modules.ts:66](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L66) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:63](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L63) +[src/types/core-modules.ts:65](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L65) diff --git a/docs/api/interfaces/ChannelSelectCommand.md b/docs/api/interfaces/ChannelSelectCommand.md index 4352c2ebf..fa4621877 100644 --- a/docs/api/interfaces/ChannelSelectCommand.md +++ b/docs/api/interfaces/ChannelSelectCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:74](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L74) +[src/types/core-modules.ts:76](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L76) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:73](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L73) +[src/types/core-modules.ts:75](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L75) diff --git a/docs/api/interfaces/CommandError.Response.md b/docs/api/interfaces/CommandError.Response.md new file mode 100644 index 000000000..16666e910 --- /dev/null +++ b/docs/api/interfaces/CommandError.Response.md @@ -0,0 +1,45 @@ +--- +id: "CommandError.Response" +title: "Interface: Response" +sidebar_label: "Response" +custom_edit_url: null +--- + +[CommandError](../namespaces/CommandError.md).Response + +## Properties + +### body + +• `Optional` **body**: `ReplyOptions` + +#### Defined in + +[src/core/structures/command-error.ts:6](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/command-error.ts#L6) + +___ + +### log + +• `Optional` **log**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `message` | `unknown` | +| `type` | keyof [`Logging`](Logging.md)<`unknown`\> | + +#### Defined in + +[src/core/structures/command-error.ts:7](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/command-error.ts#L7) + +___ + +### type + +• **type**: ``"fail"`` \| ``"continue"`` + +#### Defined in + +[src/core/structures/command-error.ts:5](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/command-error.ts#L5) diff --git a/docs/api/interfaces/CommandModuleDefs.md b/docs/api/interfaces/CommandModuleDefs.md index cd7c93df3..83208f93c 100644 --- a/docs/api/interfaces/CommandModuleDefs.md +++ b/docs/api/interfaces/CommandModuleDefs.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[src/types/core-modules.ts:149](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L149) +[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L151) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L157) +[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L159) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L159) +[src/types/core-modules.ts:161](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L161) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L154) +[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L156) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[src/types/core-modules.ts:150](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L150) +[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L152) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L156) +[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L158) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L151) +[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L153) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L155) +[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L157) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L153) +[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L155) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L158) +[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L160) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L160) +[src/types/core-modules.ts:162](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L162) ___ @@ -124,4 +124,4 @@ ___ #### Defined in -[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L152) +[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L154) diff --git a/docs/api/interfaces/ContextMenuMsg.md b/docs/api/interfaces/ContextMenuMsg.md index 1c32f2067..87844ea54 100644 --- a/docs/api/interfaces/ContextMenuMsg.md +++ b/docs/api/interfaces/ContextMenuMsg.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:59](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L59) +[src/types/core-modules.ts:61](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L61) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:58](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L58) +[src/types/core-modules.ts:60](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L60) diff --git a/docs/api/interfaces/ContextMenuUser.md b/docs/api/interfaces/ContextMenuUser.md index 6586f8cf7..5082dc70c 100644 --- a/docs/api/interfaces/ContextMenuUser.md +++ b/docs/api/interfaces/ContextMenuUser.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:54](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L54) +[src/types/core-modules.ts:56](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L56) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:53](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L53) +[src/types/core-modules.ts:55](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L55) diff --git a/docs/api/interfaces/ControlPlugin.md b/docs/api/interfaces/ControlPlugin.md index 81dbf9609..4a4a96e68 100644 --- a/docs/api/interfaces/ControlPlugin.md +++ b/docs/api/interfaces/ControlPlugin.md @@ -34,7 +34,7 @@ custom_edit_url: null #### Defined in -[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L73) +[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L73) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L72) +[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L72) diff --git a/docs/api/interfaces/Controller.md b/docs/api/interfaces/Controller.md index 3f2bcd655..2e8e6fc5b 100644 --- a/docs/api/interfaces/Controller.md +++ b/docs/api/interfaces/Controller.md @@ -22,7 +22,7 @@ custom_edit_url: null #### Defined in -[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L59) +[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L59) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L60) +[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L60) diff --git a/docs/api/interfaces/CoreDependencies.md b/docs/api/interfaces/CoreDependencies.md index c881722e0..6617aa1f7 100644 --- a/docs/api/interfaces/CoreDependencies.md +++ b/docs/api/interfaces/CoreDependencies.md @@ -22,7 +22,7 @@ custom_edit_url: null #### Defined in -[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L28) +[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L28) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[src/types/ioc.ts:30](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L30) +[src/types/ioc.ts:30](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L30) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[src/types/ioc.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L33) +[src/types/ioc.ts:33](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L33) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L29) +[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L29) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[src/types/ioc.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L32) +[src/types/ioc.ts:32](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L32) ___ @@ -112,4 +112,4 @@ ___ #### Defined in -[src/types/ioc.ts:31](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L31) +[src/types/ioc.ts:31](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L31) diff --git a/docs/api/interfaces/CoreModuleStore.md b/docs/api/interfaces/CoreModuleStore.md index 1127f36b2..65c3a09e1 100644 --- a/docs/api/interfaces/CoreModuleStore.md +++ b/docs/api/interfaces/CoreModuleStore.md @@ -20,7 +20,7 @@ Represents a core module store that stores IDs mapped to file paths. #### Defined in -[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-store.ts#L7) +[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/module-store.ts#L7) ___ @@ -30,4 +30,4 @@ ___ #### Defined in -[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-store.ts#L8) +[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/module-store.ts#L8) diff --git a/docs/api/interfaces/DiscordEventCommand.md b/docs/api/interfaces/DiscordEventCommand.md index e9747927b..6c86c1079 100644 --- a/docs/api/interfaces/DiscordEventCommand.md +++ b/docs/api/interfaces/DiscordEventCommand.md @@ -30,7 +30,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -44,7 +44,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:105](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L105) +[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L107) ___ @@ -58,7 +58,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -72,7 +72,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -86,7 +86,7 @@ Module.type #### Defined in -[src/types/core-modules.ts:106](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L106) +[src/types/core-modules.ts:108](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L108) ## Methods @@ -110,4 +110,4 @@ Module.execute #### Defined in -[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L107) +[src/types/core-modules.ts:109](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L109) diff --git a/docs/api/interfaces/Disposable.md b/docs/api/interfaces/Disposable.md index 98fbe0003..60300eeb5 100644 --- a/docs/api/interfaces/Disposable.md +++ b/docs/api/interfaces/Disposable.md @@ -21,4 +21,4 @@ Let dependencies implement this to dispose and cleanup. #### Defined in -[src/core/contracts/disposable.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/disposable.ts#L8) +[src/core/contracts/disposable.ts:8](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/disposable.ts#L8) diff --git a/docs/api/interfaces/Emitter.md b/docs/api/interfaces/Emitter.md index d5a6f46bd..4069d76c6 100644 --- a/docs/api/interfaces/Emitter.md +++ b/docs/api/interfaces/Emitter.md @@ -25,7 +25,7 @@ custom_edit_url: null #### Defined in -[src/core/contracts/emitter.ts:4](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/emitter.ts#L4) +[src/core/contracts/emitter.ts:4](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/emitter.ts#L4) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/emitter.ts#L6) +[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/emitter.ts#L6) ___ @@ -67,4 +67,4 @@ ___ #### Defined in -[src/core/contracts/emitter.ts:5](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/emitter.ts#L5) +[src/core/contracts/emitter.ts:5](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/emitter.ts#L5) diff --git a/docs/api/interfaces/ErrorHandling.md b/docs/api/interfaces/ErrorHandling.md index f68f1d8ce..7d057aa2d 100644 --- a/docs/api/interfaces/ErrorHandling.md +++ b/docs/api/interfaces/ErrorHandling.md @@ -14,28 +14,12 @@ custom_edit_url: null - [`DefaultErrorHandling`](../classes/DefaultErrorHandling.md) -## Properties - -### keepAlive - -• **keepAlive**: `number` - -Number of times the process should throw an error until crashing and exiting - -#### Defined in - -[src/core/contracts/error-handling.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/error-handling.ts#L8) - ## Methods ### crash ▸ **crash**(`err`): `never` -**`Deprecated`** - -Version 4 will remove this method - #### Parameters | Name | Type | @@ -46,9 +30,13 @@ Version 4 will remove this method `never` +**`Deprecated`** + +Version 4 will remove this method + #### Defined in -[src/core/contracts/error-handling.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/error-handling.ts#L14) +[src/core/contracts/error-handling.ts:11](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/error-handling.ts#L11) ___ @@ -56,8 +44,7 @@ ___ ▸ **updateAlive**(`error`): `void` -A function that is called on every crash. Updates keepAlive. -If keepAlive is 0, the process crashes. +A function that is called on every throw. #### Parameters @@ -71,4 +58,4 @@ If keepAlive is 0, the process crashes. #### Defined in -[src/core/contracts/error-handling.ts:20](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/error-handling.ts#L20) +[src/core/contracts/error-handling.ts:16](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/error-handling.ts#L16) diff --git a/docs/api/interfaces/EventModuleDefs.md b/docs/api/interfaces/EventModuleDefs.md index 99135ce66..dc048ee0c 100644 --- a/docs/api/interfaces/EventModuleDefs.md +++ b/docs/api/interfaces/EventModuleDefs.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[src/types/core-modules.ts:165](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L165) +[src/types/core-modules.ts:167](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L167) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[src/types/core-modules.ts:164](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L164) +[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L166) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L166) +[src/types/core-modules.ts:168](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L168) diff --git a/docs/api/interfaces/ExternalEventCommand.md b/docs/api/interfaces/ExternalEventCommand.md index 9d957eca1..77a6d038e 100644 --- a/docs/api/interfaces/ExternalEventCommand.md +++ b/docs/api/interfaces/ExternalEventCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/types/core-modules.ts:47](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L47) +[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L49) ___ @@ -48,7 +48,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:46](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L46) +[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L48) ___ @@ -62,7 +62,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -76,7 +76,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -90,7 +90,7 @@ Module.type #### Defined in -[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L48) +[src/types/core-modules.ts:50](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L50) ## Methods @@ -114,4 +114,4 @@ Module.execute #### Defined in -[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L49) +[src/types/core-modules.ts:51](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L51) diff --git a/docs/api/interfaces/Init.md b/docs/api/interfaces/Init.md index 3aedffb20..f80a3c993 100644 --- a/docs/api/interfaces/Init.md +++ b/docs/api/interfaces/Init.md @@ -21,4 +21,4 @@ Let dependencies implement this to initiate some logic. #### Defined in -[src/core/contracts/init.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/init.ts#L8) +[src/core/contracts/init.ts:8](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/init.ts#L8) diff --git a/docs/api/interfaces/InitPlugin.md b/docs/api/interfaces/InitPlugin.md index d7d5eb2bd..af07d64b9 100644 --- a/docs/api/interfaces/InitPlugin.md +++ b/docs/api/interfaces/InitPlugin.md @@ -34,7 +34,7 @@ custom_edit_url: null #### Defined in -[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L69) +[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L69) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L68) +[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L68) diff --git a/docs/api/interfaces/Logging.md b/docs/api/interfaces/Logging.md index 47cda27fe..76d6bb057 100644 --- a/docs/api/interfaces/Logging.md +++ b/docs/api/interfaces/Logging.md @@ -38,7 +38,7 @@ custom_edit_url: null #### Defined in -[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L8) +[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/logging.ts#L8) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L5) +[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/logging.ts#L5) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L7) +[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/logging.ts#L7) ___ @@ -98,4 +98,4 @@ ___ #### Defined in -[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L6) +[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/logging.ts#L6) diff --git a/docs/api/interfaces/MentionableSelectCommand.md b/docs/api/interfaces/MentionableSelectCommand.md index 065ee354b..2f7a6d3ef 100644 --- a/docs/api/interfaces/MentionableSelectCommand.md +++ b/docs/api/interfaces/MentionableSelectCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:84](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L84) +[src/types/core-modules.ts:86](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L86) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:83](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L83) +[src/types/core-modules.ts:85](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L85) diff --git a/docs/api/interfaces/ModalSubmitCommand.md b/docs/api/interfaces/ModalSubmitCommand.md index 11238b649..b3e578e1a 100644 --- a/docs/api/interfaces/ModalSubmitCommand.md +++ b/docs/api/interfaces/ModalSubmitCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:94](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L94) +[src/types/core-modules.ts:96](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L96) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:93](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L93) +[src/types/core-modules.ts:95](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L95) diff --git a/docs/api/interfaces/ModuleManager.md b/docs/api/interfaces/ModuleManager.md index 8912e6159..677358fc9 100644 --- a/docs/api/interfaces/ModuleManager.md +++ b/docs/api/interfaces/ModuleManager.md @@ -9,6 +9,13 @@ custom_edit_url: null **`Since`** 2.0.0 + - direct access to the module manager will be removed in version 4 + +## Hierarchy + +- `MetadataAccess` + + ↳ **`ModuleManager`** ## Implemented by @@ -32,7 +39,7 @@ custom_edit_url: null #### Defined in -[src/core/contracts/module-manager.ts:13](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L13) +[src/core/contracts/module-manager.ts:19](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/module-manager.ts#L19) ___ @@ -59,7 +66,7 @@ ___ #### Defined in -[src/core/contracts/module-manager.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L18) +[src/core/contracts/module-manager.ts:23](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/module-manager.ts#L23) ___ @@ -77,9 +84,13 @@ ___ `undefined` \| `CommandMeta` +#### Inherited from + +MetadataAccess.getMetadata + #### Defined in -[src/core/contracts/module-manager.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L14) +[src/core/contracts/module-manager.ts:10](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/module-manager.ts#L10) ___ @@ -93,7 +104,7 @@ ___ #### Defined in -[src/core/contracts/module-manager.ts:17](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L17) +[src/core/contracts/module-manager.ts:22](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/module-manager.ts#L22) ___ @@ -114,7 +125,7 @@ ___ #### Defined in -[src/core/contracts/module-manager.ts:16](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L16) +[src/core/contracts/module-manager.ts:21](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/module-manager.ts#L21) ___ @@ -133,6 +144,10 @@ ___ `void` +#### Inherited from + +MetadataAccess.setMetadata + #### Defined in -[src/core/contracts/module-manager.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L15) +[src/core/contracts/module-manager.ts:11](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/module-manager.ts#L11) diff --git a/docs/api/interfaces/Plugin.md b/docs/api/interfaces/Plugin.md index 453b31181..b0e119562 100644 --- a/docs/api/interfaces/Plugin.md +++ b/docs/api/interfaces/Plugin.md @@ -34,7 +34,7 @@ custom_edit_url: null #### Defined in -[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L64) +[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L64) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L63) +[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L63) diff --git a/docs/api/interfaces/RoleSelectCommand.md b/docs/api/interfaces/RoleSelectCommand.md index 0d9045194..19ef08539 100644 --- a/docs/api/interfaces/RoleSelectCommand.md +++ b/docs/api/interfaces/RoleSelectCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:79](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L79) +[src/types/core-modules.ts:81](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L81) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:78](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L78) +[src/types/core-modules.ts:80](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L80) diff --git a/docs/api/interfaces/SernAutocompleteData.md b/docs/api/interfaces/SernAutocompleteData.md index 702aa9341..28f7387cd 100644 --- a/docs/api/interfaces/SernAutocompleteData.md +++ b/docs/api/interfaces/SernAutocompleteData.md @@ -20,7 +20,7 @@ custom_edit_url: null #### Defined in -[src/types/core-modules.ts:171](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L171) +[src/types/core-modules.ts:173](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L173) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[src/types/core-modules.ts:176](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L176) +[src/types/core-modules.ts:178](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L178) ___ @@ -44,7 +44,7 @@ Omit.description #### Defined in -node_modules/discord.js/typings/index.d.ts:4301 +node_modules/discord.js/typings/index.d.ts:4493 ___ @@ -58,7 +58,7 @@ Omit.descriptionLocalizations #### Defined in -node_modules/discord.js/typings/index.d.ts:4302 +node_modules/discord.js/typings/index.d.ts:4494 ___ @@ -72,7 +72,7 @@ Omit.name #### Defined in -node_modules/discord.js/typings/index.d.ts:4299 +node_modules/discord.js/typings/index.d.ts:4491 ___ @@ -86,7 +86,7 @@ Omit.nameLocalizations #### Defined in -node_modules/discord.js/typings/index.d.ts:4300 +node_modules/discord.js/typings/index.d.ts:4492 ___ @@ -100,7 +100,7 @@ Omit.required #### Defined in -node_modules/discord.js/typings/index.d.ts:4303 +node_modules/discord.js/typings/index.d.ts:4495 ___ @@ -110,4 +110,4 @@ ___ #### Defined in -[src/types/core-modules.ts:172](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L172) +[src/types/core-modules.ts:174](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L174) diff --git a/docs/api/interfaces/SernEventCommand.md b/docs/api/interfaces/SernEventCommand.md index 1d54dab70..e7cac58e0 100644 --- a/docs/api/interfaces/SernEventCommand.md +++ b/docs/api/interfaces/SernEventCommand.md @@ -30,7 +30,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -44,7 +44,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:41](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L41) +[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L43) ___ @@ -58,7 +58,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -72,7 +72,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -86,7 +86,7 @@ Module.type #### Defined in -[src/types/core-modules.ts:42](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L42) +[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L44) ## Methods @@ -110,4 +110,4 @@ Module.execute #### Defined in -[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L43) +[src/types/core-modules.ts:45](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L45) diff --git a/docs/api/interfaces/SernEventsMapping.md b/docs/api/interfaces/SernEventsMapping.md index 37cbe1b4f..1cc0b5d47 100644 --- a/docs/api/interfaces/SernEventsMapping.md +++ b/docs/api/interfaces/SernEventsMapping.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L21) +[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/a579e27/src/types/utility.ts#L21) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L20) +[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/a579e27/src/types/utility.ts#L20) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L19) +[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/a579e27/src/types/utility.ts#L19) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L23) +[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/a579e27/src/types/utility.ts#L23) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L22) +[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/a579e27/src/types/utility.ts#L22) diff --git a/docs/api/interfaces/SernSubCommandData.md b/docs/api/interfaces/SernSubCommandData.md index 02e1f3c2c..6c2dd8216 100644 --- a/docs/api/interfaces/SernSubCommandData.md +++ b/docs/api/interfaces/SernSubCommandData.md @@ -76,7 +76,7 @@ ___ #### Defined in -[src/types/core-modules.ts:208](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L208) +[src/types/core-modules.ts:210](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L210) ___ @@ -104,4 +104,4 @@ APIApplicationCommandOptionBase.type #### Defined in -[src/types/core-modules.ts:207](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L207) +[src/types/core-modules.ts:209](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L209) diff --git a/docs/api/interfaces/SernSubCommandGroupData.md b/docs/api/interfaces/SernSubCommandGroupData.md index 7b89e6998..75c8d93c5 100644 --- a/docs/api/interfaces/SernSubCommandGroupData.md +++ b/docs/api/interfaces/SernSubCommandGroupData.md @@ -24,7 +24,7 @@ BaseApplicationCommandOptionsData.autocomplete #### Defined in -node_modules/discord.js/typings/index.d.ts:4304 +node_modules/discord.js/typings/index.d.ts:4496 ___ @@ -38,7 +38,7 @@ BaseApplicationCommandOptionsData.description #### Defined in -node_modules/discord.js/typings/index.d.ts:4301 +node_modules/discord.js/typings/index.d.ts:4493 ___ @@ -52,7 +52,7 @@ BaseApplicationCommandOptionsData.descriptionLocalizations #### Defined in -node_modules/discord.js/typings/index.d.ts:4302 +node_modules/discord.js/typings/index.d.ts:4494 ___ @@ -66,7 +66,7 @@ BaseApplicationCommandOptionsData.name #### Defined in -node_modules/discord.js/typings/index.d.ts:4299 +node_modules/discord.js/typings/index.d.ts:4491 ___ @@ -80,7 +80,7 @@ BaseApplicationCommandOptionsData.nameLocalizations #### Defined in -node_modules/discord.js/typings/index.d.ts:4300 +node_modules/discord.js/typings/index.d.ts:4492 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[src/types/core-modules.ts:213](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L213) +[src/types/core-modules.ts:215](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L215) ___ @@ -104,7 +104,7 @@ BaseApplicationCommandOptionsData.required #### Defined in -node_modules/discord.js/typings/index.d.ts:4303 +node_modules/discord.js/typings/index.d.ts:4495 ___ @@ -114,4 +114,4 @@ ___ #### Defined in -[src/types/core-modules.ts:212](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L212) +[src/types/core-modules.ts:214](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L214) diff --git a/docs/api/interfaces/SlashCommand.md b/docs/api/interfaces/SlashCommand.md index 5db0f51dd..a376453bb 100644 --- a/docs/api/interfaces/SlashCommand.md +++ b/docs/api/interfaces/SlashCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:117](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L117) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L119) ___ @@ -53,7 +53,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L119) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L121) ___ @@ -67,7 +67,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -81,7 +81,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L118) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L120) ___ @@ -105,7 +105,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -119,4 +119,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:116](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L116) +[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L118) diff --git a/docs/api/interfaces/StringSelectCommand.md b/docs/api/interfaces/StringSelectCommand.md index 5837a188b..e944ac736 100644 --- a/docs/api/interfaces/StringSelectCommand.md +++ b/docs/api/interfaces/StringSelectCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:69](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L69) +[src/types/core-modules.ts:71](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L71) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:68](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L68) +[src/types/core-modules.ts:70](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L70) diff --git a/docs/api/interfaces/TextCommand.md b/docs/api/interfaces/TextCommand.md index 60fdd07f6..da302505c 100644 --- a/docs/api/interfaces/TextCommand.md +++ b/docs/api/interfaces/TextCommand.md @@ -20,7 +20,7 @@ custom_edit_url: null #### Defined in -[src/types/core-modules.ts:111](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L111) +[src/types/core-modules.ts:113](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L113) ___ @@ -34,7 +34,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -63,7 +63,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L112) +[src/types/core-modules.ts:114](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L114) ___ @@ -77,7 +77,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -91,7 +91,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -105,7 +105,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -119,4 +119,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:110](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L110) +[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L112) diff --git a/docs/api/interfaces/UserSelectCommand.md b/docs/api/interfaces/UserSelectCommand.md index 23dd93056..525520c2a 100644 --- a/docs/api/interfaces/UserSelectCommand.md +++ b/docs/api/interfaces/UserSelectCommand.md @@ -24,7 +24,7 @@ Module.description #### Defined in -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L37) ___ @@ -52,7 +52,7 @@ Module.execute #### Defined in -[src/types/core-modules.ts:89](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L89) +[src/types/core-modules.ts:91](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L91) ___ @@ -66,7 +66,7 @@ Module.name #### Defined in -[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L34) ___ @@ -80,7 +80,7 @@ Module.onEvent #### Defined in -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L35) ___ @@ -94,7 +94,7 @@ Module.plugins #### Defined in -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L36) ___ @@ -108,4 +108,4 @@ Module.type #### Defined in -[src/types/core-modules.ts:88](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L88) +[src/types/core-modules.ts:90](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L90) diff --git a/docs/api/interfaces/Wrapper.md b/docs/api/interfaces/Wrapper.md index 6c71ad9a3..ef63db3b2 100644 --- a/docs/api/interfaces/Wrapper.md +++ b/docs/api/interfaces/Wrapper.md @@ -14,7 +14,7 @@ custom_edit_url: null #### Defined in -[src/types/core.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L8) +[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/a579e27/src/types/core.ts#L9) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[src/types/core.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L19) +[src/types/core.ts:20](https://github.com/sern-handler/handler/blob/a579e27/src/types/core.ts#L20) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L9) +[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/a579e27/src/types/core.ts#L10) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L10) +[src/types/core.ts:11](https://github.com/sern-handler/handler/blob/a579e27/src/types/core.ts#L11) ___ @@ -66,4 +66,4 @@ Overload to enable mode in case developer does not use a .env file. #### Defined in -[src/types/core.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L15) +[src/types/core.ts:16](https://github.com/sern-handler/handler/blob/a579e27/src/types/core.ts#L16) diff --git a/docs/api/modules.md b/docs/api/modules.md index d48560df4..35e86dfec 100644 --- a/docs/api/modules.md +++ b/docs/api/modules.md @@ -8,6 +8,7 @@ custom_edit_url: null ## Namespaces +- [CommandError](namespaces/CommandError.md) - [Sern](namespaces/Sern.md) ## Enumerations @@ -79,7 +80,7 @@ Re-exports [controller](namespaces/Sern.md#controller) #### Defined in -[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L76) +[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L76) ___ @@ -89,7 +90,7 @@ ___ #### Defined in -[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L77) +[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L77) ___ @@ -99,7 +100,7 @@ ___ #### Defined in -[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L16) +[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/a579e27/src/types/utility.ts#L16) ___ @@ -109,7 +110,7 @@ ___ #### Defined in -[src/types/core-modules.ts:131](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L131) +[src/types/core-modules.ts:133](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L133) ___ @@ -119,7 +120,7 @@ ___ #### Defined in -[src/types/core-modules.ts:130](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L130) +[src/types/core-modules.ts:132](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L132) ___ @@ -138,7 +139,7 @@ If T has an init method, this will be called. #### Defined in -[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L17) +[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L17) ___ @@ -160,7 +161,7 @@ ___ #### Defined in -[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L11) +[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/a579e27/src/core/contracts/logging.ts#L11) ___ @@ -170,7 +171,7 @@ ___ #### Defined in -[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L26) +[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/a579e27/src/types/utility.ts#L26) ___ @@ -180,7 +181,7 @@ ___ #### Defined in -[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L51) +[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-plugin.ts#L51) ___ @@ -192,7 +193,7 @@ Type that replaces autocomplete with [SernAutocompleteData](interfaces/SernAutoc #### Defined in -[src/types/core-modules.ts:199](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L199) +[src/types/core-modules.ts:201](https://github.com/sern-handler/handler/blob/a579e27/src/types/core-modules.ts#L201) ___ @@ -219,7 +220,7 @@ T is created once and lazily. #### Defined in -[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L7) +[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L7) ___ @@ -229,7 +230,7 @@ ___ #### Defined in -[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L14) +[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/a579e27/src/types/utility.ts#L14) ___ @@ -262,7 +263,7 @@ Every time this is called, a new object is created #### Defined in -[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L12) +[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/a579e27/src/types/ioc.ts#L12) ## Functions @@ -270,11 +271,6 @@ Every time this is called, a new object is created ▸ **CommandControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> -**`Since`** - -2.5.0 -@__PURE__ - #### Type parameters | Name | Type | @@ -291,9 +287,14 @@ Every time this is called, a new object is created [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> +**`Since`** + +2.5.0 +@__PURE__ + #### Defined in -[src/core/create-plugins.ts:36](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L36) +[src/core/create-plugins.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/core/create-plugins.ts#L36) ___ @@ -301,11 +302,6 @@ ___ ▸ **CommandInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> -**`Since`** - -2.5.0 -@__PURE__ - #### Type parameters | Name | Type | @@ -322,9 +318,14 @@ ___ [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> +**`Since`** + +2.5.0 +@__PURE__ + #### Defined in -[src/core/create-plugins.ts:27](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L27) +[src/core/create-plugins.ts:27](https://github.com/sern-handler/handler/blob/a579e27/src/core/create-plugins.ts#L27) ___ @@ -332,15 +333,6 @@ ___ ▸ **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. -Will probably be moved one day! - #### Type parameters | Name | Type | @@ -358,9 +350,18 @@ Will probably be moved one day! [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> +**`Since`** + +2.5.0 + +**`Experimental`** + +A specialized function for creating control plugins with discord.js ClientEvents. +Will probably be moved one day! + #### Defined in -[src/core/create-plugins.ts:57](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L57) +[src/core/create-plugins.ts:57](https://github.com/sern-handler/handler/blob/a579e27/src/core/create-plugins.ts#L57) ___ @@ -368,11 +369,6 @@ ___ ▸ **EventControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> -**`Since`** - -2.5.0 -@__PURE__ - #### Type parameters | Name | Type | @@ -389,9 +385,14 @@ ___ [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> +**`Since`** + +2.5.0 +@__PURE__ + #### Defined in -[src/core/create-plugins.ts:45](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L45) +[src/core/create-plugins.ts:45](https://github.com/sern-handler/handler/blob/a579e27/src/core/create-plugins.ts#L45) ___ @@ -399,11 +400,6 @@ ___ ▸ **EventInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> -**`Since`** - -2.5.0 -@__PURE__ - #### Type parameters | Name | Type | @@ -420,9 +416,14 @@ ___ [`Plugin`](interfaces/Plugin.md)<`unknown`[]\> +**`Since`** + +2.5.0 +@__PURE__ + #### Defined in -[src/core/create-plugins.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L18) +[src/core/create-plugins.ts:18](https://github.com/sern-handler/handler/blob/a579e27/src/core/create-plugins.ts#L18) ___ @@ -434,16 +435,6 @@ The new Service api, a cleaner alternative to useContainer To obtain intellisense, ensure a .d.ts file exists in the root of compilation. Usually our scaffolding tool takes care of this. -**`Since`** - -3.0.0 - -**`Example`** - -```ts -const client = Service('@sern/client'); -``` - #### Type parameters | Name | Type | @@ -460,9 +451,19 @@ const client = Service('@sern/client'); `NonNullable`<`UnpackFunction`<`Partial`<`Dependencies`\>[`T`]\>\> +**`Since`** + +3.0.0 + +**`Example`** + +```ts +const client = Service('@sern/client'); +``` + #### Defined in -[src/core/ioc/dependency-injection.ts:37](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/dependency-injection.ts#L37) +[src/core/ioc/dependency-injection.ts:36](https://github.com/sern-handler/handler/blob/a579e27/src/core/ioc/dependency-injection.ts#L36) ___ @@ -470,11 +471,6 @@ ___ ▸ **Services**<`T`\>(`...keys`): `IntoDependencies`<`T`\> -**`Since`** - -3.0.0 -The plural version of [Service](modules.md#service) - #### Type parameters | Name | Type | @@ -493,9 +489,14 @@ The plural version of [Service](modules.md#service) array of dependencies, in the same order of keys provided +**`Since`** + +3.0.0 +The plural version of [Service](modules.md#service) + #### Defined in -[src/core/ioc/dependency-injection.ts:45](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/dependency-injection.ts#L45) +[src/core/ioc/dependency-injection.ts:44](https://github.com/sern-handler/handler/blob/a579e27/src/core/ioc/dependency-injection.ts#L44) ___ @@ -503,10 +504,6 @@ ___ ▸ **commandModule**(`mod`): [`CommandModule`](modules.md#commandmodule) -**`Since`** - -1.0.0 The wrapper function to define command modules for sern - #### Parameters | Name | Type | @@ -517,9 +514,13 @@ ___ [`CommandModule`](modules.md#commandmodule) +**`Since`** + +1.0.0 The wrapper function to define command modules for sern + #### Defined in -[src/core/modules.ts:25](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L25) +[src/core/modules.ts:25](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L25) ___ @@ -531,8 +532,6 @@ Create event modules from discord.js client events, This is an [eventModule](modules.md#eventmodule-1) for discord events, where typings can be very bad. -**`Experimental`** - #### Type parameters | Name | Type | @@ -552,9 +551,11 @@ where typings can be very bad. [`EventModule`](modules.md#eventmodule) +**`Experimental`** + #### Defined in -[src/core/modules.ts:53](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L53) +[src/core/modules.ts:53](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L53) ___ @@ -562,11 +563,6 @@ ___ ▸ **eventModule**(`mod`): [`EventModule`](modules.md#eventmodule) -**`Since`** - -1.0.0 -The wrapper function to define event modules for sern - #### Parameters | Name | Type | @@ -577,9 +573,14 @@ The wrapper function to define event modules for sern [`EventModule`](modules.md#eventmodule) +**`Since`** + +1.0.0 +The wrapper function to define event modules for sern + #### Defined in -[src/core/modules.ts:38](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L38) +[src/core/modules.ts:38](https://github.com/sern-handler/handler/blob/a579e27/src/core/modules.ts#L38) ___ @@ -587,10 +588,6 @@ ___ ▸ **makeDependencies**<`T`\>(`conf`): `Promise`<(...`keys`: [...V[]]) => `IntoDependencies`<`V`\>\> -**`Since`** - -2.0.0 - #### Type parameters | Name | Type | @@ -599,9 +596,9 @@ ___ #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `conf` | `DependencyConfiguration` | a configuration for creating your project dependencies | +| Name | Type | +| :------ | :------ | +| `conf` | `ValidDependencyConfig` | #### Returns @@ -609,7 +606,7 @@ ___ #### Defined in -[src/core/ioc/base.ts:27](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/base.ts#L27) +[src/core/ioc/base.ts:83](https://github.com/sern-handler/handler/blob/a579e27/src/core/ioc/base.ts#L83) ___ @@ -636,7 +633,7 @@ ___ #### Defined in -[src/core/create-plugins.ts:5](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L5) +[src/core/create-plugins.ts:5](https://github.com/sern-handler/handler/blob/a579e27/src/core/create-plugins.ts#L5) ___ @@ -646,11 +643,6 @@ ___ @__PURE__ -**`Since`** - -2.0.0. -Creates a singleton object. - #### Type parameters | Name | @@ -673,9 +665,14 @@ Creates a singleton object. `T` +**`Since`** + +2.0.0. +Creates a singleton object. + #### Defined in -[src/core/ioc/dependency-injection.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/dependency-injection.ts#L12) +[src/core/ioc/dependency-injection.ts:11](https://github.com/sern-handler/handler/blob/a579e27/src/core/ioc/dependency-injection.ts#L11) ___ @@ -685,11 +682,6 @@ ___ @__PURE__ -**`Since`** - -2.0.0 -Creates a transient object - #### Type parameters | Name | @@ -718,9 +710,14 @@ Creates a transient object `T` +**`Since`** + +2.0.0 +Creates a transient object + #### Defined in -[src/core/ioc/dependency-injection.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/dependency-injection.ts#L22) +[src/core/ioc/dependency-injection.ts:21](https://github.com/sern-handler/handler/blob/a579e27/src/core/ioc/dependency-injection.ts#L21) ___ @@ -728,16 +725,16 @@ ___ ▸ **useContainerRaw**(): `CoreContainer`<`Partial`<`Dependencies`\>\> +#### Returns + +`CoreContainer`<`Partial`<`Dependencies`\>\> + **`Deprecated`** Returns the underlying data structure holding all dependencies. Exposes methods from iti Use the Service API. The container should be readonly -#### Returns - -`CoreContainer`<`Partial`<`Dependencies`\>\> - #### Defined in -[src/core/ioc/base.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/base.ts#L15) +[src/core/ioc/base.ts:17](https://github.com/sern-handler/handler/blob/a579e27/src/core/ioc/base.ts#L17) diff --git a/docs/api/namespaces/CommandError.md b/docs/api/namespaces/CommandError.md new file mode 100644 index 000000000..55fe80e46 --- /dev/null +++ b/docs/api/namespaces/CommandError.md @@ -0,0 +1,31 @@ +--- +id: "CommandError" +title: "Namespace: CommandError" +sidebar_label: "CommandError" +sidebar_position: 0 +custom_edit_url: null +--- + +## Interfaces + +- [Response](../interfaces/CommandError.Response.md) + +## Functions + +### of + +▸ **of**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `log` | (`type`: keyof [`Logging`](../interfaces/Logging.md)<`unknown`\>, `message`: `T`) => `Record`<`PropertyKey`, `unknown`\> | +| `reply` | (`bodyContent`: `ReplyOptions`) => `Record`<`PropertyKey`, `unknown`\> | +| `status` | (`p`: ``"fail"`` \| ``"continue"``) => `Record`<`PropertyKey`, `unknown`\> | + +#### Defined in + +[src/core/structures/command-error.ts:10](https://github.com/sern-handler/handler/blob/a579e27/src/core/structures/command-error.ts#L10) diff --git a/docs/api/namespaces/Sern.md b/docs/api/namespaces/Sern.md index 5960692b8..e17a53489 100644 --- a/docs/api/namespaces/Sern.md +++ b/docs/api/namespaces/Sern.md @@ -26,7 +26,7 @@ The object passed into every plugin to control a command's behavior #### Defined in -[src/sern.ts:63](https://github.com/sern-handler/handler/blob/e1059f9/src/sern.ts#L63) +[src/sern.ts:63](https://github.com/sern-handler/handler/blob/a579e27/src/sern.ts#L63) ## Functions @@ -34,6 +34,16 @@ The object passed into every plugin to control a command's behavior ▸ **init**(`maybeWrapper`): `void` +#### Parameters + +| Name | Type | +| :------ | :------ | +| `maybeWrapper` | [`Wrapper`](../interfaces/Wrapper.md) \| ``"file"`` | + +#### Returns + +`void` + **`Since`** 1.0.0 @@ -47,16 +57,6 @@ Sern.init({ }) ``` -#### Parameters - -| Name | Type | -| :------ | :------ | -| `maybeWrapper` | [`Wrapper`](../interfaces/Wrapper.md) \| ``"file"`` | - -#### Returns - -`void` - #### Defined in -[src/sern.ts:24](https://github.com/sern-handler/handler/blob/e1059f9/src/sern.ts#L24) +[src/sern.ts:24](https://github.com/sern-handler/handler/blob/a579e27/src/sern.ts#L24)