From bfaf83d60c54a869267f01d1ed6eee471bb53df1 Mon Sep 17 00:00:00 2001 From: SrIzan10 <66965250+SrIzan10@users.noreply.github.com> Date: Fri, 24 Jan 2025 07:41:47 +0100 Subject: [PATCH] init --- src/content/docs/v3/api/classes/Context.md | 36 ++--- .../docs/v3/api/classes/ModuleStore.md | 4 +- .../docs/v3/api/enumerations/CommandType.md | 24 ++-- .../docs/v3/api/enumerations/EventType.md | 6 +- .../docs/v3/api/enumerations/PayloadType.md | 6 +- .../docs/v3/api/enumerations/PluginType.md | 4 +- .../v3/api/functions/CommandControlPlugin.md | 2 +- .../v3/api/functions/CommandInitPlugin.md | 2 +- .../functions/DiscordEventControlPlugin.md | 2 +- .../v3/api/functions/EventControlPlugin.md | 2 +- .../docs/v3/api/functions/EventInitPlugin.md | 2 +- src/content/docs/v3/api/functions/Service.md | 2 +- src/content/docs/v3/api/functions/Services.md | 2 +- .../docs/v3/api/functions/commandModule.md | 2 +- .../docs/v3/api/functions/discordEvent.md | 2 +- .../docs/v3/api/functions/eventModule.md | 2 +- .../docs/v3/api/functions/makeDependencies.md | 2 +- .../docs/v3/api/functions/makePlugin.md | 2 +- src/content/docs/v3/api/functions/single.md | 2 +- .../docs/v3/api/functions/transient.md | 2 +- .../docs/v3/api/interfaces/BothCommand.md | 16 +-- .../docs/v3/api/interfaces/ButtonCommand.md | 12 +- .../v3/api/interfaces/ChannelSelectCommand.md | 12 +- .../v3/api/interfaces/CommandModuleDefs.md | 24 ++-- .../docs/v3/api/interfaces/ContextMenuMsg.md | 12 +- .../docs/v3/api/interfaces/ContextMenuUser.md | 12 +- .../docs/v3/api/interfaces/ControlPlugin.md | 4 +- .../docs/v3/api/interfaces/Controller.md | 4 +- .../v3/api/interfaces/CoreDependencies.md | 12 +- .../docs/v3/api/interfaces/CoreModuleStore.md | 4 +- .../v3/api/interfaces/DiscordEventCommand.md | 12 +- .../docs/v3/api/interfaces/Disposable.md | 2 +- src/content/docs/v3/api/interfaces/Emitter.md | 6 +- .../docs/v3/api/interfaces/ErrorHandling.md | 4 +- .../docs/v3/api/interfaces/EventModuleDefs.md | 6 +- .../v3/api/interfaces/ExternalEventCommand.md | 14 +- src/content/docs/v3/api/interfaces/Init.md | 2 +- .../docs/v3/api/interfaces/InitPlugin.md | 4 +- src/content/docs/v3/api/interfaces/Logging.md | 8 +- .../interfaces/MentionableSelectCommand.md | 12 +- .../v3/api/interfaces/ModalSubmitCommand.md | 12 +- src/content/docs/v3/api/interfaces/Plugin.md | 4 +- .../v3/api/interfaces/RoleSelectCommand.md | 12 +- .../v3/api/interfaces/SernAutocompleteData.md | 20 +-- .../v3/api/interfaces/SernEventCommand.md | 12 +- .../v3/api/interfaces/SernEventsMapping.md | 10 +- .../v3/api/interfaces/SernSubCommandData.md | 8 +- .../api/interfaces/SernSubCommandGroupData.md | 20 +-- .../docs/v3/api/interfaces/SlashCommand.md | 14 +- .../v3/api/interfaces/StringSelectCommand.md | 12 +- .../docs/v3/api/interfaces/TextCommand.md | 14 +- .../v3/api/interfaces/UserSelectCommand.md | 12 +- src/content/docs/v3/api/interfaces/Wrapper.md | 10 +- .../namespaces/Presence/functions/module.md | 2 +- .../api/namespaces/Presence/functions/of.md | 2 +- .../namespaces/Presence/interfaces/Result.md | 12 +- .../Presence/type-aliases/Config.md | 2 +- .../v3/api/namespaces/Sern/functions/init.md | 5 +- .../v3/api/type-aliases/AnyCommandPlugin.md | 2 +- .../v3/api/type-aliases/AnyEventPlugin.md | 2 +- src/content/docs/v3/api/type-aliases/Args.md | 2 +- .../docs/v3/api/type-aliases/CommandModule.md | 2 +- .../docs/v3/api/type-aliases/EventModule.md | 2 +- .../docs/v3/api/type-aliases/Initializable.md | 2 +- .../docs/v3/api/type-aliases/LogPayload.md | 2 +- .../docs/v3/api/type-aliases/Payload.md | 2 +- .../docs/v3/api/type-aliases/PluginResult.md | 2 +- .../v3/api/type-aliases/SernOptionsData.md | 2 +- .../docs/v3/api/type-aliases/Singleton.md | 2 +- .../docs/v3/api/type-aliases/SlashOptions.md | 2 +- .../docs/v3/api/type-aliases/Transient.md | 2 +- .../docs/v3/api/variables/controller.md | 2 +- src/content/docs/v4/api/README.md | 8 +- src/content/docs/v4/api/classes/Context.md | 58 +++----- .../docs/v4/api/enumerations/CommandType.md | 24 ++-- .../docs/v4/api/enumerations/EventType.md | 16 +-- .../docs/v4/api/enumerations/PayloadType.md | 6 +- .../docs/v4/api/enumerations/PluginType.md | 4 +- .../v4/api/functions/CommandControlPlugin.md | 56 +++++++- .../v4/api/functions/CommandInitPlugin.md | 50 ++++++- .../docs/v4/api/functions/EventInitPlugin.md | 2 +- src/content/docs/v4/api/functions/Service.md | 10 +- src/content/docs/v4/api/functions/Services.md | 6 +- .../docs/v4/api/functions/commandModule.md | 44 +++++- .../docs/v4/api/functions/discordEvent.md | 14 +- .../docs/v4/api/functions/eventModule.md | 47 ++++++- .../docs/v4/api/functions/makeDependencies.md | 2 +- .../docs/v4/api/functions/makePlugin.md | 2 +- .../docs/v4/api/functions/scheduledTask.md | 48 +++++++ src/content/docs/v4/api/functions/single.md | 2 +- .../docs/v4/api/functions/transient.md | 2 +- .../docs/v4/api/interfaces/BothCommand.md | 102 ++++++++++++-- .../docs/v4/api/interfaces/ButtonCommand.md | 100 +++++++++++-- .../v4/api/interfaces/ChannelSelectCommand.md | 100 +++++++++++-- .../v4/api/interfaces/CommandModuleDefs.md | 24 ++-- .../docs/v4/api/interfaces/ContextMenuMsg.md | 100 +++++++++++-- .../docs/v4/api/interfaces/ContextMenuUser.md | 100 +++++++++++-- .../docs/v4/api/interfaces/ControlPlugin.md | 4 +- .../v4/api/interfaces/CoreDependencies.md | 20 ++- .../v4/api/interfaces/DiscordEventCommand.md | 98 +++++++++++-- .../docs/v4/api/interfaces/Disposable.md | 2 +- src/content/docs/v4/api/interfaces/Emitter.md | 6 +- .../docs/v4/api/interfaces/ErrorHandling.md | 4 +- .../docs/v4/api/interfaces/EventModuleDefs.md | 22 ++- .../v4/api/interfaces/ExternalEventCommand.md | 100 +++++++++++-- src/content/docs/v4/api/interfaces/Init.md | 2 +- .../docs/v4/api/interfaces/InitPlugin.md | 4 +- src/content/docs/v4/api/interfaces/Logging.md | 8 +- .../interfaces/MentionableSelectCommand.md | 100 +++++++++++-- .../v4/api/interfaces/ModalSubmitCommand.md | 100 +++++++++++-- src/content/docs/v4/api/interfaces/Module.md | 98 +++++++++++-- src/content/docs/v4/api/interfaces/Plugin.md | 4 +- .../docs/v4/api/interfaces/PresenceResult.md | 74 ---------- .../v4/api/interfaces/RoleSelectCommand.md | 100 +++++++++++-- src/content/docs/v4/api/interfaces/SDT.md | 133 ++++++++++++++++++ .../docs/v4/api/interfaces/ScheduledTask.md | 56 ++++++++ .../v4/api/interfaces/SernAutocompleteData.md | 20 +-- .../v4/api/interfaces/SernEventCommand.md | 98 +++++++++++-- .../v4/api/interfaces/SernEventsMapping.md | 10 +- .../v4/api/interfaces/SernSubCommandData.md | 8 +- .../api/interfaces/SernSubCommandGroupData.md | 20 +-- .../docs/v4/api/interfaces/SlashCommand.md | 102 ++++++++++++-- .../v4/api/interfaces/StringSelectCommand.md | 100 +++++++++++-- .../docs/v4/api/interfaces/TextCommand.md | 100 +++++++++++-- .../v4/api/interfaces/UserSelectCommand.md | 100 +++++++++++-- src/content/docs/v4/api/interfaces/Wrapper.md | 129 +++++++++++++++++ .../namespaces/Presence/interfaces/Result.md | 66 +++++++++ .../Presence/type-aliases/Config.md | 34 +++++ .../v4/api/namespaces/Sern/functions/init.md | 7 +- .../docs/v4/api/type-aliases/AnyPlugin.md | 2 +- .../docs/v4/api/type-aliases/CommandModule.md | 2 +- .../docs/v4/api/type-aliases/Controller.md | 2 +- .../docs/v4/api/type-aliases/EventModule.md | 4 +- .../docs/v4/api/type-aliases/LogPayload.md | 2 +- .../docs/v4/api/type-aliases/Payload.md | 2 +- .../docs/v4/api/type-aliases/PluginResult.md | 2 +- .../v4/api/type-aliases/PresenceConfig.md | 34 ----- src/content/docs/v4/api/type-aliases/SDT.md | 30 ---- .../v4/api/type-aliases/SernOptionsData.md | 2 +- src/content/docs/v4/api/variables/Presence.md | 20 ++- .../docs/v4/api/variables/controller.md | 28 +++- src/content/docs/v4/tools/publisher.mdx | 67 ++++++--- 142 files changed, 2590 insertions(+), 764 deletions(-) create mode 100644 src/content/docs/v4/api/functions/scheduledTask.md delete mode 100644 src/content/docs/v4/api/interfaces/PresenceResult.md create mode 100644 src/content/docs/v4/api/interfaces/SDT.md create mode 100644 src/content/docs/v4/api/interfaces/ScheduledTask.md create mode 100644 src/content/docs/v4/api/interfaces/Wrapper.md create mode 100644 src/content/docs/v4/api/namespaces/Presence/interfaces/Result.md create mode 100644 src/content/docs/v4/api/namespaces/Presence/type-aliases/Config.md delete mode 100644 src/content/docs/v4/api/type-aliases/PresenceConfig.md delete mode 100644 src/content/docs/v4/api/type-aliases/SDT.md diff --git a/src/content/docs/v3/api/classes/Context.md b/src/content/docs/v3/api/classes/Context.md index 9a2ff09a1..b34652c55 100644 --- a/src/content/docs/v3/api/classes/Context.md +++ b/src/content/docs/v3/api/classes/Context.md @@ -27,7 +27,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L39) +[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L39) *** @@ -41,7 +41,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L45) +[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L45) *** @@ -55,7 +55,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L91) +[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L91) *** @@ -69,7 +69,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L65) +[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L65) *** @@ -83,7 +83,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L71) +[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L71) *** @@ -97,7 +97,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L77) +[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L77) *** @@ -111,7 +111,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L33) +[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L33) *** @@ -125,7 +125,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L97) +[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L97) *** @@ -139,7 +139,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/core-context.ts#L15) +[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/core-context.ts#L15) *** @@ -153,7 +153,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L85) +[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L85) *** @@ -167,7 +167,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/core-context.ts#L12) +[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/core-context.ts#L12) *** @@ -181,7 +181,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L26) +[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L26) *** @@ -198,7 +198,7 @@ else, interaction.user #### Source -[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L55) +[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L55) *** @@ -212,7 +212,7 @@ else, interaction.user #### Source -[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L61) +[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L61) ## Methods @@ -230,7 +230,7 @@ else, interaction.user #### Source -[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/core-context.ts#L19) +[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/core-context.ts#L19) *** @@ -248,7 +248,7 @@ else, interaction.user #### Source -[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/core-context.ts#L23) +[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/core-context.ts#L23) *** @@ -266,7 +266,7 @@ else, interaction.user #### Source -[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L103) +[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L103) *** @@ -288,4 +288,4 @@ else, interaction.user #### Source -[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/context.ts#L113) +[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/context.ts#L113) diff --git a/src/content/docs/v3/api/classes/ModuleStore.md b/src/content/docs/v3/api/classes/ModuleStore.md index 46d76524e..59390daa7 100644 --- a/src/content/docs/v3/api/classes/ModuleStore.md +++ b/src/content/docs/v3/api/classes/ModuleStore.md @@ -23,7 +23,7 @@ title: "ModuleStore" #### Source -[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/module-store.ts#L10) +[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/module-store.ts#L10) *** @@ -33,4 +33,4 @@ title: "ModuleStore" #### Source -[src/core/structures/module-store.ts:9](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/module-store.ts#L9) +[src/core/structures/module-store.ts:9](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/module-store.ts#L9) diff --git a/src/content/docs/v3/api/enumerations/CommandType.md b/src/content/docs/v3/api/enumerations/CommandType.md index c03ffe693..ca715bf29 100644 --- a/src/content/docs/v3/api/enumerations/CommandType.md +++ b/src/content/docs/v3/api/enumerations/CommandType.md @@ -31,7 +31,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L20) +[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L20) *** @@ -41,7 +41,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L23) +[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L23) *** @@ -51,7 +51,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L29) +[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L29) *** @@ -61,7 +61,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L22) +[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L22) *** @@ -71,7 +71,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L21) +[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L21) *** @@ -81,7 +81,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L28) +[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L28) *** @@ -91,7 +91,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L25) +[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L25) *** @@ -101,7 +101,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L27) +[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L27) *** @@ -111,7 +111,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L19) +[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L19) *** @@ -121,7 +121,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L24) +[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L24) *** @@ -131,7 +131,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L18) +[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L18) *** @@ -141,4 +141,4 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L26) +[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L26) diff --git a/src/content/docs/v3/api/enumerations/EventType.md b/src/content/docs/v3/api/enumerations/EventType.md index d5b4bd175..4681d2035 100644 --- a/src/content/docs/v3/api/enumerations/EventType.md +++ b/src/content/docs/v3/api/enumerations/EventType.md @@ -30,7 +30,7 @@ The EventType for handling discord events #### Source -[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L51) +[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L51) *** @@ -43,7 +43,7 @@ Could be for example, `process` events, database events #### Source -[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L60) +[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L60) *** @@ -55,4 +55,4 @@ The EventType for handling sern events #### Source -[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L55) +[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L55) diff --git a/src/content/docs/v3/api/enumerations/PayloadType.md b/src/content/docs/v3/api/enumerations/PayloadType.md index 5a8701eee..b3cb7d134 100644 --- a/src/content/docs/v3/api/enumerations/PayloadType.md +++ b/src/content/docs/v3/api/enumerations/PayloadType.md @@ -15,7 +15,7 @@ The PayloadType for a SernEmitter failure event #### Source -[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L98) +[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L98) *** @@ -27,7 +27,7 @@ The PayloadType for a SernEmitter success event #### Source -[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L94) +[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L94) *** @@ -39,4 +39,4 @@ The PayloadType for a SernEmitter warning event #### Source -[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L102) +[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L102) diff --git a/src/content/docs/v3/api/enumerations/PluginType.md b/src/content/docs/v3/api/enumerations/PluginType.md index 65afa5828..9f754ab9b 100644 --- a/src/content/docs/v3/api/enumerations/PluginType.md +++ b/src/content/docs/v3/api/enumerations/PluginType.md @@ -29,7 +29,7 @@ The PluginType for EventPlugins #### Source -[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L85) +[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L85) *** @@ -41,4 +41,4 @@ The PluginType for InitPlugins #### Source -[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/structures/enums.ts#L81) +[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/structures/enums.ts#L81) diff --git a/src/content/docs/v3/api/functions/CommandControlPlugin.md b/src/content/docs/v3/api/functions/CommandControlPlugin.md index 50728f539..030baddc8 100644 --- a/src/content/docs/v3/api/functions/CommandControlPlugin.md +++ b/src/content/docs/v3/api/functions/CommandControlPlugin.md @@ -26,4 +26,4 @@ title: "CommandControlPlugin" ## Source -[src/core/create-plugins.ts:37](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/create-plugins.ts#L37) +[src/core/create-plugins.ts:37](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/create-plugins.ts#L37) diff --git a/src/content/docs/v3/api/functions/CommandInitPlugin.md b/src/content/docs/v3/api/functions/CommandInitPlugin.md index 773cbfdfb..3b7f203b6 100644 --- a/src/content/docs/v3/api/functions/CommandInitPlugin.md +++ b/src/content/docs/v3/api/functions/CommandInitPlugin.md @@ -26,4 +26,4 @@ title: "CommandInitPlugin" ## Source -[src/core/create-plugins.ts:28](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/create-plugins.ts#L28) +[src/core/create-plugins.ts:28](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/create-plugins.ts#L28) diff --git a/src/content/docs/v3/api/functions/DiscordEventControlPlugin.md b/src/content/docs/v3/api/functions/DiscordEventControlPlugin.md index 6b43e87bd..f73a09e51 100644 --- a/src/content/docs/v3/api/functions/DiscordEventControlPlugin.md +++ b/src/content/docs/v3/api/functions/DiscordEventControlPlugin.md @@ -32,4 +32,4 @@ Will probably be moved one day! ## Source -[src/core/create-plugins.ts:58](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/create-plugins.ts#L58) +[src/core/create-plugins.ts:58](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/create-plugins.ts#L58) diff --git a/src/content/docs/v3/api/functions/EventControlPlugin.md b/src/content/docs/v3/api/functions/EventControlPlugin.md index 483e65303..0f37f1749 100644 --- a/src/content/docs/v3/api/functions/EventControlPlugin.md +++ b/src/content/docs/v3/api/functions/EventControlPlugin.md @@ -26,4 +26,4 @@ title: "EventControlPlugin" ## Source -[src/core/create-plugins.ts:46](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/create-plugins.ts#L46) +[src/core/create-plugins.ts:46](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/create-plugins.ts#L46) diff --git a/src/content/docs/v3/api/functions/EventInitPlugin.md b/src/content/docs/v3/api/functions/EventInitPlugin.md index f75353259..ba61ae042 100644 --- a/src/content/docs/v3/api/functions/EventInitPlugin.md +++ b/src/content/docs/v3/api/functions/EventInitPlugin.md @@ -26,4 +26,4 @@ title: "EventInitPlugin" ## Source -[src/core/create-plugins.ts:19](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/create-plugins.ts#L19) +[src/core/create-plugins.ts:19](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/create-plugins.ts#L19) diff --git a/src/content/docs/v3/api/functions/Service.md b/src/content/docs/v3/api/functions/Service.md index ca6b17330..826b3595d 100644 --- a/src/content/docs/v3/api/functions/Service.md +++ b/src/content/docs/v3/api/functions/Service.md @@ -38,4 +38,4 @@ const client = Service('@sern/client'); ## Source -[src/core/ioc/dependency-injection.ts:37](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/ioc/dependency-injection.ts#L37) +[src/core/ioc/dependency-injection.ts:37](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/ioc/dependency-injection.ts#L37) diff --git a/src/content/docs/v3/api/functions/Services.md b/src/content/docs/v3/api/functions/Services.md index fc4d07dff..c85bfc17b 100644 --- a/src/content/docs/v3/api/functions/Services.md +++ b/src/content/docs/v3/api/functions/Services.md @@ -28,4 +28,4 @@ The plural version of [Service](../../../../../../v3/api/functions/service) ## Source -[src/core/ioc/dependency-injection.ts:47](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/ioc/dependency-injection.ts#L47) +[src/core/ioc/dependency-injection.ts:47](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/ioc/dependency-injection.ts#L47) diff --git a/src/content/docs/v3/api/functions/commandModule.md b/src/content/docs/v3/api/functions/commandModule.md index 5cba5d6fd..c3618a6fb 100644 --- a/src/content/docs/v3/api/functions/commandModule.md +++ b/src/content/docs/v3/api/functions/commandModule.md @@ -21,4 +21,4 @@ title: "commandModule" ## Source -[src/core/modules.ts:19](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/modules.ts#L19) +[src/core/modules.ts:19](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/modules.ts#L19) diff --git a/src/content/docs/v3/api/functions/discordEvent.md b/src/content/docs/v3/api/functions/discordEvent.md index 189b9c942..d75df03f0 100644 --- a/src/content/docs/v3/api/functions/discordEvent.md +++ b/src/content/docs/v3/api/functions/discordEvent.md @@ -33,4 +33,4 @@ where typings can be very bad. ## Source -[src/core/modules.ts:47](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/modules.ts#L47) +[src/core/modules.ts:47](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/modules.ts#L47) diff --git a/src/content/docs/v3/api/functions/eventModule.md b/src/content/docs/v3/api/functions/eventModule.md index f42703bb1..349fe21e7 100644 --- a/src/content/docs/v3/api/functions/eventModule.md +++ b/src/content/docs/v3/api/functions/eventModule.md @@ -22,4 +22,4 @@ The wrapper function to define event modules for sern ## Source -[src/core/modules.ts:32](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/modules.ts#L32) +[src/core/modules.ts:32](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/modules.ts#L32) diff --git a/src/content/docs/v3/api/functions/makeDependencies.md b/src/content/docs/v3/api/functions/makeDependencies.md index 182cb8b52..3129bef33 100644 --- a/src/content/docs/v3/api/functions/makeDependencies.md +++ b/src/content/docs/v3/api/functions/makeDependencies.md @@ -21,4 +21,4 @@ title: "makeDependencies" ## Source -[src/core/ioc/base.ts:144](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/ioc/base.ts#L144) +[src/core/ioc/base.ts:144](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/ioc/base.ts#L144) diff --git a/src/content/docs/v3/api/functions/makePlugin.md b/src/content/docs/v3/api/functions/makePlugin.md index 178174f30..69614e5f2 100644 --- a/src/content/docs/v3/api/functions/makePlugin.md +++ b/src/content/docs/v3/api/functions/makePlugin.md @@ -23,4 +23,4 @@ title: "makePlugin" ## Source -[src/core/create-plugins.ts:6](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/create-plugins.ts#L6) +[src/core/create-plugins.ts:6](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/create-plugins.ts#L6) diff --git a/src/content/docs/v3/api/functions/single.md b/src/content/docs/v3/api/functions/single.md index 46e65461e..98d88c104 100644 --- a/src/content/docs/v3/api/functions/single.md +++ b/src/content/docs/v3/api/functions/single.md @@ -32,4 +32,4 @@ Creates a singleton object. ## Source -[src/core/ioc/dependency-injection.ts:11](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/ioc/dependency-injection.ts#L11) +[src/core/ioc/dependency-injection.ts:11](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/ioc/dependency-injection.ts#L11) diff --git a/src/content/docs/v3/api/functions/transient.md b/src/content/docs/v3/api/functions/transient.md index ed1f0cba7..1cc546c8d 100644 --- a/src/content/docs/v3/api/functions/transient.md +++ b/src/content/docs/v3/api/functions/transient.md @@ -36,4 +36,4 @@ Creates a transient object ## Source -[src/core/ioc/dependency-injection.ts:21](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/ioc/dependency-injection.ts#L21) +[src/core/ioc/dependency-injection.ts:21](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/ioc/dependency-injection.ts#L21) diff --git a/src/content/docs/v3/api/interfaces/BothCommand.md b/src/content/docs/v3/api/interfaces/BothCommand.md index f3f0dd1df..e7d6ea236 100644 --- a/src/content/docs/v3/api/interfaces/BothCommand.md +++ b/src/content/docs/v3/api/interfaces/BothCommand.md @@ -17,7 +17,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L125) +[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L125) *** @@ -31,7 +31,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L126) +[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L126) *** @@ -55,7 +55,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:128](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L128) +[src/types/core-modules.ts:128](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L128) *** @@ -69,7 +69,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -83,7 +83,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -93,7 +93,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L127) +[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L127) *** @@ -107,7 +107,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -121,4 +121,4 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:124](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L124) +[src/types/core-modules.ts:124](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L124) diff --git a/src/content/docs/v3/api/interfaces/ButtonCommand.md b/src/content/docs/v3/api/interfaces/ButtonCommand.md index 560089489..c7124f64e 100644 --- a/src/content/docs/v3/api/interfaces/ButtonCommand.md +++ b/src/content/docs/v3/api/interfaces/ButtonCommand.md @@ -21,7 +21,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:65](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L65) +[src/types/core-modules.ts:65](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L65) *** @@ -57,7 +57,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:64](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L64) +[src/types/core-modules.ts:64](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L64) diff --git a/src/content/docs/v3/api/interfaces/ChannelSelectCommand.md b/src/content/docs/v3/api/interfaces/ChannelSelectCommand.md index 09a80229e..c6fed030b 100644 --- a/src/content/docs/v3/api/interfaces/ChannelSelectCommand.md +++ b/src/content/docs/v3/api/interfaces/ChannelSelectCommand.md @@ -21,7 +21,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:75](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L75) +[src/types/core-modules.ts:75](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L75) *** @@ -57,7 +57,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:74](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L74) +[src/types/core-modules.ts:74](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L74) diff --git a/src/content/docs/v3/api/interfaces/CommandModuleDefs.md b/src/content/docs/v3/api/interfaces/CommandModuleDefs.md index 08d3b7786..15d2c6b59 100644 --- a/src/content/docs/v3/api/interfaces/CommandModuleDefs.md +++ b/src/content/docs/v3/api/interfaces/CommandModuleDefs.md @@ -13,7 +13,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:150](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L150) +[src/types/core-modules.ts:150](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L150) *** @@ -23,7 +23,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L158) +[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L158) *** @@ -33,7 +33,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L160) +[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L160) *** @@ -43,7 +43,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L155) +[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L155) *** @@ -53,7 +53,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L151) +[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L151) *** @@ -63,7 +63,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L157) +[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L157) *** @@ -73,7 +73,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L152) +[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L152) *** @@ -83,7 +83,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L156) +[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L156) *** @@ -93,7 +93,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L154) +[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L154) *** @@ -103,7 +103,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L159) +[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L159) *** @@ -113,7 +113,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:161](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L161) +[src/types/core-modules.ts:161](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L161) *** @@ -123,4 +123,4 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L153) +[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L153) diff --git a/src/content/docs/v3/api/interfaces/ContextMenuMsg.md b/src/content/docs/v3/api/interfaces/ContextMenuMsg.md index be4126f2b..851839c5b 100644 --- a/src/content/docs/v3/api/interfaces/ContextMenuMsg.md +++ b/src/content/docs/v3/api/interfaces/ContextMenuMsg.md @@ -21,7 +21,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:60](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L60) +[src/types/core-modules.ts:60](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L60) *** @@ -57,7 +57,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:59](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L59) +[src/types/core-modules.ts:59](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L59) diff --git a/src/content/docs/v3/api/interfaces/ContextMenuUser.md b/src/content/docs/v3/api/interfaces/ContextMenuUser.md index 9eed44742..4aa7c1f78 100644 --- a/src/content/docs/v3/api/interfaces/ContextMenuUser.md +++ b/src/content/docs/v3/api/interfaces/ContextMenuUser.md @@ -21,7 +21,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:55](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L55) +[src/types/core-modules.ts:55](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L55) *** @@ -57,7 +57,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:54](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L54) +[src/types/core-modules.ts:54](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L54) diff --git a/src/content/docs/v3/api/interfaces/ControlPlugin.md b/src/content/docs/v3/api/interfaces/ControlPlugin.md index cc83d6dd0..dacab2c19 100644 --- a/src/content/docs/v3/api/interfaces/ControlPlugin.md +++ b/src/content/docs/v3/api/interfaces/ControlPlugin.md @@ -25,7 +25,7 @@ title: "ControlPlugin" #### Source -[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L73) +[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L73) *** @@ -35,4 +35,4 @@ title: "ControlPlugin" #### Source -[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L72) +[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L72) diff --git a/src/content/docs/v3/api/interfaces/Controller.md b/src/content/docs/v3/api/interfaces/Controller.md index 3df6dc02b..7aae545f1 100644 --- a/src/content/docs/v3/api/interfaces/Controller.md +++ b/src/content/docs/v3/api/interfaces/Controller.md @@ -17,7 +17,7 @@ title: "Controller" #### Source -[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L59) +[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L59) *** @@ -31,4 +31,4 @@ title: "Controller" #### Source -[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L60) +[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L60) diff --git a/src/content/docs/v3/api/interfaces/CoreDependencies.md b/src/content/docs/v3/api/interfaces/CoreDependencies.md index 7083dad8f..77ecd99db 100644 --- a/src/content/docs/v3/api/interfaces/CoreDependencies.md +++ b/src/content/docs/v3/api/interfaces/CoreDependencies.md @@ -17,7 +17,7 @@ title: "CoreDependencies" #### Source -[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L28) +[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L28) *** @@ -31,7 +31,7 @@ title: "CoreDependencies" #### Source -[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L29) +[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L29) *** @@ -45,7 +45,7 @@ title: "CoreDependencies" #### Source -[src/types/ioc.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L36) +[src/types/ioc.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L36) *** @@ -59,7 +59,7 @@ title: "CoreDependencies" #### Source -[src/types/ioc.ts:37](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L37) +[src/types/ioc.ts:37](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L37) *** @@ -73,7 +73,7 @@ title: "CoreDependencies" #### Source -[src/types/ioc.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L35) +[src/types/ioc.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L35) *** @@ -91,4 +91,4 @@ Will be removed and turned internal #### Source -[src/types/ioc.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L34) +[src/types/ioc.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L34) diff --git a/src/content/docs/v3/api/interfaces/CoreModuleStore.md b/src/content/docs/v3/api/interfaces/CoreModuleStore.md index e8a88923a..1dfc53205 100644 --- a/src/content/docs/v3/api/interfaces/CoreModuleStore.md +++ b/src/content/docs/v3/api/interfaces/CoreModuleStore.md @@ -15,7 +15,7 @@ Represents a core module store that stores IDs mapped to file paths. #### Source -[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/module-store.ts#L7) +[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/module-store.ts#L7) *** @@ -25,4 +25,4 @@ Represents a core module store that stores IDs mapped to file paths. #### Source -[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/module-store.ts#L8) +[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/module-store.ts#L8) diff --git a/src/content/docs/v3/api/interfaces/DiscordEventCommand.md b/src/content/docs/v3/api/interfaces/DiscordEventCommand.md index 2f8ac80b4..e45788316 100644 --- a/src/content/docs/v3/api/interfaces/DiscordEventCommand.md +++ b/src/content/docs/v3/api/interfaces/DiscordEventCommand.md @@ -25,7 +25,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -39,7 +39,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:106](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L106) +[src/types/core-modules.ts:106](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L106) *** @@ -53,7 +53,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -67,7 +67,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -81,7 +81,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L107) +[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L107) ## Methods @@ -103,4 +103,4 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:108](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L108) +[src/types/core-modules.ts:108](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L108) diff --git a/src/content/docs/v3/api/interfaces/Disposable.md b/src/content/docs/v3/api/interfaces/Disposable.md index 55556c63d..b648452d5 100644 --- a/src/content/docs/v3/api/interfaces/Disposable.md +++ b/src/content/docs/v3/api/interfaces/Disposable.md @@ -20,4 +20,4 @@ Let dependencies implement this to dispose and cleanup. #### Source -[src/core/contracts/hooks.ts:15](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/hooks.ts#L15) +[src/core/contracts/hooks.ts:15](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/hooks.ts#L15) diff --git a/src/content/docs/v3/api/interfaces/Emitter.md b/src/content/docs/v3/api/interfaces/Emitter.md index 6e0e0c6ff..63039e3ec 100644 --- a/src/content/docs/v3/api/interfaces/Emitter.md +++ b/src/content/docs/v3/api/interfaces/Emitter.md @@ -23,7 +23,7 @@ title: "Emitter" #### Source -[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/emitter.ts#L6) +[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/emitter.ts#L6) *** @@ -43,7 +43,7 @@ title: "Emitter" #### Source -[src/core/contracts/emitter.ts:8](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/emitter.ts#L8) +[src/core/contracts/emitter.ts:8](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/emitter.ts#L8) *** @@ -63,4 +63,4 @@ title: "Emitter" #### Source -[src/core/contracts/emitter.ts:7](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/emitter.ts#L7) +[src/core/contracts/emitter.ts:7](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/emitter.ts#L7) diff --git a/src/content/docs/v3/api/interfaces/ErrorHandling.md b/src/content/docs/v3/api/interfaces/ErrorHandling.md index c1a652389..f243b3e3d 100644 --- a/src/content/docs/v3/api/interfaces/ErrorHandling.md +++ b/src/content/docs/v3/api/interfaces/ErrorHandling.md @@ -29,7 +29,7 @@ Version 4 will remove this method #### Source -[src/core/contracts/error-handling.ts:9](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/error-handling.ts#L9) +[src/core/contracts/error-handling.ts:9](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/error-handling.ts#L9) *** @@ -49,4 +49,4 @@ A function that is called on every throw. #### Source -[src/core/contracts/error-handling.ts:14](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/error-handling.ts#L14) +[src/core/contracts/error-handling.ts:14](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/error-handling.ts#L14) diff --git a/src/content/docs/v3/api/interfaces/EventModuleDefs.md b/src/content/docs/v3/api/interfaces/EventModuleDefs.md index 44d4723d4..f2d6275cf 100644 --- a/src/content/docs/v3/api/interfaces/EventModuleDefs.md +++ b/src/content/docs/v3/api/interfaces/EventModuleDefs.md @@ -13,7 +13,7 @@ title: "EventModuleDefs" #### Source -[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L166) +[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L166) *** @@ -23,7 +23,7 @@ title: "EventModuleDefs" #### Source -[src/types/core-modules.ts:165](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L165) +[src/types/core-modules.ts:165](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L165) *** @@ -33,4 +33,4 @@ title: "EventModuleDefs" #### Source -[src/types/core-modules.ts:167](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L167) +[src/types/core-modules.ts:167](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L167) diff --git a/src/content/docs/v3/api/interfaces/ExternalEventCommand.md b/src/content/docs/v3/api/interfaces/ExternalEventCommand.md index 2c5666e79..ebd76ef99 100644 --- a/src/content/docs/v3/api/interfaces/ExternalEventCommand.md +++ b/src/content/docs/v3/api/interfaces/ExternalEventCommand.md @@ -21,7 +21,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -31,7 +31,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L48) +[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L48) *** @@ -45,7 +45,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:47](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L47) +[src/types/core-modules.ts:47](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L47) *** @@ -59,7 +59,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -73,7 +73,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -87,7 +87,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L49) +[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L49) ## Methods @@ -109,4 +109,4 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:50](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L50) +[src/types/core-modules.ts:50](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L50) diff --git a/src/content/docs/v3/api/interfaces/Init.md b/src/content/docs/v3/api/interfaces/Init.md index eeff6b130..f1c62ac94 100644 --- a/src/content/docs/v3/api/interfaces/Init.md +++ b/src/content/docs/v3/api/interfaces/Init.md @@ -20,4 +20,4 @@ Let dependencies implement this to initiate some logic. #### Source -[src/core/contracts/hooks.ts:7](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/hooks.ts#L7) +[src/core/contracts/hooks.ts:7](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/hooks.ts#L7) diff --git a/src/content/docs/v3/api/interfaces/InitPlugin.md b/src/content/docs/v3/api/interfaces/InitPlugin.md index d824f6946..870375b35 100644 --- a/src/content/docs/v3/api/interfaces/InitPlugin.md +++ b/src/content/docs/v3/api/interfaces/InitPlugin.md @@ -25,7 +25,7 @@ title: "InitPlugin" #### Source -[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L69) +[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L69) *** @@ -35,4 +35,4 @@ title: "InitPlugin" #### Source -[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L68) +[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L68) diff --git a/src/content/docs/v3/api/interfaces/Logging.md b/src/content/docs/v3/api/interfaces/Logging.md index f15b2721b..f2c88e9a4 100644 --- a/src/content/docs/v3/api/interfaces/Logging.md +++ b/src/content/docs/v3/api/interfaces/Logging.md @@ -29,7 +29,7 @@ title: "Logging" #### Source -[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/logging.ts#L8) +[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/logging.ts#L8) *** @@ -47,7 +47,7 @@ title: "Logging" #### Source -[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/logging.ts#L5) +[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/logging.ts#L5) *** @@ -65,7 +65,7 @@ title: "Logging" #### Source -[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/logging.ts#L7) +[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/logging.ts#L7) *** @@ -83,4 +83,4 @@ title: "Logging" #### Source -[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/logging.ts#L6) +[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/logging.ts#L6) diff --git a/src/content/docs/v3/api/interfaces/MentionableSelectCommand.md b/src/content/docs/v3/api/interfaces/MentionableSelectCommand.md index 1cbe57f28..61b79a678 100644 --- a/src/content/docs/v3/api/interfaces/MentionableSelectCommand.md +++ b/src/content/docs/v3/api/interfaces/MentionableSelectCommand.md @@ -21,7 +21,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:85](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L85) +[src/types/core-modules.ts:85](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L85) *** @@ -57,7 +57,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:84](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L84) +[src/types/core-modules.ts:84](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L84) diff --git a/src/content/docs/v3/api/interfaces/ModalSubmitCommand.md b/src/content/docs/v3/api/interfaces/ModalSubmitCommand.md index 5f0ea6e56..2d7313df6 100644 --- a/src/content/docs/v3/api/interfaces/ModalSubmitCommand.md +++ b/src/content/docs/v3/api/interfaces/ModalSubmitCommand.md @@ -21,7 +21,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:95](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L95) +[src/types/core-modules.ts:95](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L95) *** @@ -57,7 +57,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:94](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L94) +[src/types/core-modules.ts:94](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L94) diff --git a/src/content/docs/v3/api/interfaces/Plugin.md b/src/content/docs/v3/api/interfaces/Plugin.md index 3bae18bad..d1aa18c3e 100644 --- a/src/content/docs/v3/api/interfaces/Plugin.md +++ b/src/content/docs/v3/api/interfaces/Plugin.md @@ -25,7 +25,7 @@ title: "Plugin" #### Source -[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L64) +[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L64) *** @@ -35,4 +35,4 @@ title: "Plugin" #### Source -[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L63) +[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L63) diff --git a/src/content/docs/v3/api/interfaces/RoleSelectCommand.md b/src/content/docs/v3/api/interfaces/RoleSelectCommand.md index 75c74648d..6a3fce55a 100644 --- a/src/content/docs/v3/api/interfaces/RoleSelectCommand.md +++ b/src/content/docs/v3/api/interfaces/RoleSelectCommand.md @@ -21,7 +21,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:80](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L80) +[src/types/core-modules.ts:80](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L80) *** @@ -57,7 +57,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:79](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L79) +[src/types/core-modules.ts:79](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L79) diff --git a/src/content/docs/v3/api/interfaces/SernAutocompleteData.md b/src/content/docs/v3/api/interfaces/SernAutocompleteData.md index f636f6c64..37439ce21 100644 --- a/src/content/docs/v3/api/interfaces/SernAutocompleteData.md +++ b/src/content/docs/v3/api/interfaces/SernAutocompleteData.md @@ -17,7 +17,7 @@ title: "SernAutocompleteData" #### Source -[src/types/core-modules.ts:172](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L172) +[src/types/core-modules.ts:172](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L172) *** @@ -27,7 +27,7 @@ title: "SernAutocompleteData" #### Source -[src/types/core-modules.ts:177](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L177) +[src/types/core-modules.ts:177](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L177) *** @@ -41,13 +41,13 @@ title: "SernAutocompleteData" #### Source -node\_modules/discord.js/typings/index.d.ts:4715 +node\_modules/discord.js/typings/index.d.ts:5035 *** ### descriptionLocalizations? -> `optional` **descriptionLocalizations**: `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **descriptionLocalizations**: `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -55,7 +55,7 @@ node\_modules/discord.js/typings/index.d.ts:4715 #### Source -node\_modules/discord.js/typings/index.d.ts:4716 +node\_modules/discord.js/typings/index.d.ts:5036 *** @@ -69,13 +69,13 @@ node\_modules/discord.js/typings/index.d.ts:4716 #### Source -node\_modules/discord.js/typings/index.d.ts:4713 +node\_modules/discord.js/typings/index.d.ts:5033 *** ### nameLocalizations? -> `optional` **nameLocalizations**: `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **nameLocalizations**: `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -83,7 +83,7 @@ node\_modules/discord.js/typings/index.d.ts:4713 #### Source -node\_modules/discord.js/typings/index.d.ts:4714 +node\_modules/discord.js/typings/index.d.ts:5034 *** @@ -97,7 +97,7 @@ node\_modules/discord.js/typings/index.d.ts:4714 #### Source -node\_modules/discord.js/typings/index.d.ts:4717 +node\_modules/discord.js/typings/index.d.ts:5037 *** @@ -107,4 +107,4 @@ node\_modules/discord.js/typings/index.d.ts:4717 #### Source -[src/types/core-modules.ts:173](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L173) +[src/types/core-modules.ts:173](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L173) diff --git a/src/content/docs/v3/api/interfaces/SernEventCommand.md b/src/content/docs/v3/api/interfaces/SernEventCommand.md index 788b80488..b4397ec2a 100644 --- a/src/content/docs/v3/api/interfaces/SernEventCommand.md +++ b/src/content/docs/v3/api/interfaces/SernEventCommand.md @@ -25,7 +25,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -39,7 +39,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:42](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L42) +[src/types/core-modules.ts:42](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L42) *** @@ -53,7 +53,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -67,7 +67,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -81,7 +81,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L43) +[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L43) ## Methods @@ -103,4 +103,4 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L44) diff --git a/src/content/docs/v3/api/interfaces/SernEventsMapping.md b/src/content/docs/v3/api/interfaces/SernEventsMapping.md index c8daa49d1..099b4e68f 100644 --- a/src/content/docs/v3/api/interfaces/SernEventsMapping.md +++ b/src/content/docs/v3/api/interfaces/SernEventsMapping.md @@ -13,7 +13,7 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/utility.ts#L21) +[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/utility.ts#L21) *** @@ -23,7 +23,7 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/utility.ts#L20) +[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/utility.ts#L20) *** @@ -33,7 +33,7 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/utility.ts#L19) +[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/utility.ts#L19) *** @@ -43,7 +43,7 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/utility.ts#L23) +[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/utility.ts#L23) *** @@ -53,4 +53,4 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/utility.ts#L22) +[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/utility.ts#L22) diff --git a/src/content/docs/v3/api/interfaces/SernSubCommandData.md b/src/content/docs/v3/api/interfaces/SernSubCommandData.md index cfee85fc8..a2a442262 100644 --- a/src/content/docs/v3/api/interfaces/SernSubCommandData.md +++ b/src/content/docs/v3/api/interfaces/SernSubCommandData.md @@ -27,7 +27,7 @@ node\_modules/discord-api-types/payloads/v10/\_interactions/\_applicationCommand ### description\_localizations? -> `optional` **description\_localizations**: `null` \| `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **description\_localizations**: `null` \| `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -55,7 +55,7 @@ node\_modules/discord-api-types/payloads/v10/\_interactions/\_applicationCommand ### name\_localizations? -> `optional` **name\_localizations**: `null` \| `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **name\_localizations**: `null` \| `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -73,7 +73,7 @@ node\_modules/discord-api-types/payloads/v10/\_interactions/\_applicationCommand #### Source -[src/types/core-modules.ts:209](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L209) +[src/types/core-modules.ts:209](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L209) *** @@ -101,4 +101,4 @@ node\_modules/discord-api-types/payloads/v10/\_interactions/\_applicationCommand #### Source -[src/types/core-modules.ts:208](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L208) +[src/types/core-modules.ts:208](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L208) diff --git a/src/content/docs/v3/api/interfaces/SernSubCommandGroupData.md b/src/content/docs/v3/api/interfaces/SernSubCommandGroupData.md index 6d1b8da33..602822d81 100644 --- a/src/content/docs/v3/api/interfaces/SernSubCommandGroupData.md +++ b/src/content/docs/v3/api/interfaces/SernSubCommandGroupData.md @@ -21,7 +21,7 @@ title: "SernSubCommandGroupData" #### Source -node\_modules/discord.js/typings/index.d.ts:4718 +node\_modules/discord.js/typings/index.d.ts:5038 *** @@ -35,13 +35,13 @@ node\_modules/discord.js/typings/index.d.ts:4718 #### Source -node\_modules/discord.js/typings/index.d.ts:4715 +node\_modules/discord.js/typings/index.d.ts:5035 *** ### descriptionLocalizations? -> `optional` **descriptionLocalizations**: `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **descriptionLocalizations**: `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -49,7 +49,7 @@ node\_modules/discord.js/typings/index.d.ts:4715 #### Source -node\_modules/discord.js/typings/index.d.ts:4716 +node\_modules/discord.js/typings/index.d.ts:5036 *** @@ -63,13 +63,13 @@ node\_modules/discord.js/typings/index.d.ts:4716 #### Source -node\_modules/discord.js/typings/index.d.ts:4713 +node\_modules/discord.js/typings/index.d.ts:5033 *** ### nameLocalizations? -> `optional` **nameLocalizations**: `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **nameLocalizations**: `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -77,7 +77,7 @@ node\_modules/discord.js/typings/index.d.ts:4713 #### Source -node\_modules/discord.js/typings/index.d.ts:4714 +node\_modules/discord.js/typings/index.d.ts:5034 *** @@ -87,7 +87,7 @@ node\_modules/discord.js/typings/index.d.ts:4714 #### Source -[src/types/core-modules.ts:214](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L214) +[src/types/core-modules.ts:214](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L214) *** @@ -101,7 +101,7 @@ node\_modules/discord.js/typings/index.d.ts:4714 #### Source -node\_modules/discord.js/typings/index.d.ts:4717 +node\_modules/discord.js/typings/index.d.ts:5037 *** @@ -111,4 +111,4 @@ node\_modules/discord.js/typings/index.d.ts:4717 #### Source -[src/types/core-modules.ts:213](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L213) +[src/types/core-modules.ts:213](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L213) diff --git a/src/content/docs/v3/api/interfaces/SlashCommand.md b/src/content/docs/v3/api/interfaces/SlashCommand.md index 2c6a065c1..193295c34 100644 --- a/src/content/docs/v3/api/interfaces/SlashCommand.md +++ b/src/content/docs/v3/api/interfaces/SlashCommand.md @@ -21,7 +21,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L118) +[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L118) *** @@ -45,7 +45,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L120) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L120) *** @@ -59,7 +59,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -73,7 +73,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -83,7 +83,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L119) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L119) *** @@ -97,7 +97,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -111,4 +111,4 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:117](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L117) +[src/types/core-modules.ts:117](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L117) diff --git a/src/content/docs/v3/api/interfaces/StringSelectCommand.md b/src/content/docs/v3/api/interfaces/StringSelectCommand.md index 9b0f744cd..b9d104a53 100644 --- a/src/content/docs/v3/api/interfaces/StringSelectCommand.md +++ b/src/content/docs/v3/api/interfaces/StringSelectCommand.md @@ -21,7 +21,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:70](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L70) +[src/types/core-modules.ts:70](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L70) *** @@ -57,7 +57,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:69](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L69) +[src/types/core-modules.ts:69](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L69) diff --git a/src/content/docs/v3/api/interfaces/TextCommand.md b/src/content/docs/v3/api/interfaces/TextCommand.md index 25b4c7e0a..9b3efc705 100644 --- a/src/content/docs/v3/api/interfaces/TextCommand.md +++ b/src/content/docs/v3/api/interfaces/TextCommand.md @@ -17,7 +17,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L112) +[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L112) *** @@ -31,7 +31,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -55,7 +55,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:113](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L113) +[src/types/core-modules.ts:113](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L113) *** @@ -69,7 +69,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -83,7 +83,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -97,7 +97,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -111,4 +111,4 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:111](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L111) +[src/types/core-modules.ts:111](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L111) diff --git a/src/content/docs/v3/api/interfaces/UserSelectCommand.md b/src/content/docs/v3/api/interfaces/UserSelectCommand.md index 4ef240496..69cc9238b 100644 --- a/src/content/docs/v3/api/interfaces/UserSelectCommand.md +++ b/src/content/docs/v3/api/interfaces/UserSelectCommand.md @@ -21,7 +21,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L36) *** @@ -43,7 +43,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:90](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L90) +[src/types/core-modules.ts:90](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L90) *** @@ -57,7 +57,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L33) +[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L33) *** @@ -71,7 +71,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L34) +[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L34) *** @@ -85,7 +85,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L35) *** @@ -99,4 +99,4 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:89](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L89) +[src/types/core-modules.ts:89](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L89) diff --git a/src/content/docs/v3/api/interfaces/Wrapper.md b/src/content/docs/v3/api/interfaces/Wrapper.md index 3716dd84a..b855666e1 100644 --- a/src/content/docs/v3/api/interfaces/Wrapper.md +++ b/src/content/docs/v3/api/interfaces/Wrapper.md @@ -13,7 +13,7 @@ title: "Wrapper" #### Source -[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core.ts#L9) +[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core.ts#L9) *** @@ -35,7 +35,7 @@ title: "Wrapper" #### Source -[src/types/core.ts:20](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core.ts#L20) +[src/types/core.ts:20](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core.ts#L20) *** @@ -45,7 +45,7 @@ title: "Wrapper" #### Source -[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core.ts#L10) +[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core.ts#L10) *** @@ -55,7 +55,7 @@ title: "Wrapper" #### Source -[src/types/core.ts:11](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core.ts#L11) +[src/types/core.ts:11](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core.ts#L11) *** @@ -71,4 +71,4 @@ Overload to enable mode in case developer does not use a .env file. #### Source -[src/types/core.ts:16](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core.ts#L16) +[src/types/core.ts:16](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core.ts#L16) diff --git a/src/content/docs/v3/api/namespaces/Presence/functions/module.md b/src/content/docs/v3/api/namespaces/Presence/functions/module.md index 2b7a73169..ea1168904 100644 --- a/src/content/docs/v3/api/namespaces/Presence/functions/module.md +++ b/src/content/docs/v3/api/namespaces/Presence/functions/module.md @@ -25,4 +25,4 @@ adjacent to the file where **Sern.init** is CALLED. ## Source -[src/core/presences.ts:28](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L28) +[src/core/presences.ts:28](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L28) diff --git a/src/content/docs/v3/api/namespaces/Presence/functions/of.md b/src/content/docs/v3/api/namespaces/Presence/functions/of.md index 69a871411..a3ae3ebd4 100644 --- a/src/content/docs/v3/api/namespaces/Presence/functions/of.md +++ b/src/content/docs/v3/api/namespaces/Presence/functions/of.md @@ -94,4 +94,4 @@ Presence ## Source -[src/core/presences.ts:37](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L37) +[src/core/presences.ts:37](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L37) diff --git a/src/content/docs/v3/api/namespaces/Presence/interfaces/Result.md b/src/content/docs/v3/api/namespaces/Presence/interfaces/Result.md index 7a06246e3..1639356fb 100644 --- a/src/content/docs/v3/api/namespaces/Presence/interfaces/Result.md +++ b/src/content/docs/v3/api/namespaces/Presence/interfaces/Result.md @@ -13,7 +13,7 @@ title: "Result" #### Source -[src/core/presences.ts:11](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L11) +[src/core/presences.ts:11](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L11) *** @@ -23,7 +23,7 @@ title: "Result" #### Source -[src/core/presences.ts:10](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L10) +[src/core/presences.ts:10](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L10) *** @@ -41,7 +41,7 @@ title: "Result" #### Source -[src/core/presences.ts:14](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L14) +[src/core/presences.ts:14](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L14) *** @@ -51,7 +51,7 @@ title: "Result" #### Source -[src/core/presences.ts:13](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L13) +[src/core/presences.ts:13](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L13) *** @@ -61,7 +61,7 @@ title: "Result" #### Source -[src/core/presences.ts:12](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L12) +[src/core/presences.ts:12](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L12) *** @@ -71,4 +71,4 @@ title: "Result" #### Source -[src/core/presences.ts:9](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L9) +[src/core/presences.ts:9](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L9) diff --git a/src/content/docs/v3/api/namespaces/Presence/type-aliases/Config.md b/src/content/docs/v3/api/namespaces/Presence/type-aliases/Config.md index eb43cec90..42a62dd49 100644 --- a/src/content/docs/v3/api/namespaces/Presence/type-aliases/Config.md +++ b/src/content/docs/v3/api/namespaces/Presence/type-aliases/Config.md @@ -31,4 +31,4 @@ title: "Config" ## Source -[src/core/presences.ts:17](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/presences.ts#L17) +[src/core/presences.ts:17](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/presences.ts#L17) diff --git a/src/content/docs/v3/api/namespaces/Sern/functions/init.md b/src/content/docs/v3/api/namespaces/Sern/functions/init.md index b4a88e952..fa7382da7 100644 --- a/src/content/docs/v3/api/namespaces/Sern/functions/init.md +++ b/src/content/docs/v3/api/namespaces/Sern/functions/init.md @@ -11,9 +11,6 @@ title: "init" • **maybeWrapper**: [`Wrapper`](/v3/api/interfaces/wrapper/) \| `"file"` -Options to pass into sern. -Function to start the handler up - ## Returns `void` @@ -33,4 +30,4 @@ Sern.init({ ## Source -[src/sern.ts:26](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/sern.ts#L26) +[src/sern.ts:26](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/sern.ts#L26) diff --git a/src/content/docs/v3/api/type-aliases/AnyCommandPlugin.md b/src/content/docs/v3/api/type-aliases/AnyCommandPlugin.md index c8f9203b0..ecc9534b6 100644 --- a/src/content/docs/v3/api/type-aliases/AnyCommandPlugin.md +++ b/src/content/docs/v3/api/type-aliases/AnyCommandPlugin.md @@ -9,4 +9,4 @@ title: "AnyCommandPlugin" ## Source -[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L76) +[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L76) diff --git a/src/content/docs/v3/api/type-aliases/AnyEventPlugin.md b/src/content/docs/v3/api/type-aliases/AnyEventPlugin.md index a743b00a3..ba8d097af 100644 --- a/src/content/docs/v3/api/type-aliases/AnyEventPlugin.md +++ b/src/content/docs/v3/api/type-aliases/AnyEventPlugin.md @@ -9,4 +9,4 @@ title: "AnyEventPlugin" ## Source -[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L77) +[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L77) diff --git a/src/content/docs/v3/api/type-aliases/Args.md b/src/content/docs/v3/api/type-aliases/Args.md index 40914b8c5..cd9c5d5a5 100644 --- a/src/content/docs/v3/api/type-aliases/Args.md +++ b/src/content/docs/v3/api/type-aliases/Args.md @@ -19,4 +19,4 @@ title: "Args" ## Source -[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/utility.ts#L16) +[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/utility.ts#L16) diff --git a/src/content/docs/v3/api/type-aliases/CommandModule.md b/src/content/docs/v3/api/type-aliases/CommandModule.md index 12b2a2356..aa4954b54 100644 --- a/src/content/docs/v3/api/type-aliases/CommandModule.md +++ b/src/content/docs/v3/api/type-aliases/CommandModule.md @@ -9,4 +9,4 @@ title: "CommandModule" ## Source -[src/types/core-modules.ts:132](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L132) +[src/types/core-modules.ts:132](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L132) diff --git a/src/content/docs/v3/api/type-aliases/EventModule.md b/src/content/docs/v3/api/type-aliases/EventModule.md index f1cbc9db1..dfb18f72b 100644 --- a/src/content/docs/v3/api/type-aliases/EventModule.md +++ b/src/content/docs/v3/api/type-aliases/EventModule.md @@ -9,4 +9,4 @@ title: "EventModule" ## Source -[src/types/core-modules.ts:131](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L131) +[src/types/core-modules.ts:131](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L131) diff --git a/src/content/docs/v3/api/type-aliases/Initializable.md b/src/content/docs/v3/api/type-aliases/Initializable.md index 5d521a48e..ff0762606 100644 --- a/src/content/docs/v3/api/type-aliases/Initializable.md +++ b/src/content/docs/v3/api/type-aliases/Initializable.md @@ -16,4 +16,4 @@ If T has an init method, this will be called. ## Source -[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L17) +[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L17) diff --git a/src/content/docs/v3/api/type-aliases/LogPayload.md b/src/content/docs/v3/api/type-aliases/LogPayload.md index c899c7a37..a0f6a2755 100644 --- a/src/content/docs/v3/api/type-aliases/LogPayload.md +++ b/src/content/docs/v3/api/type-aliases/LogPayload.md @@ -19,4 +19,4 @@ title: "LogPayload" ## Source -[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/contracts/logging.ts#L11) +[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/contracts/logging.ts#L11) diff --git a/src/content/docs/v3/api/type-aliases/Payload.md b/src/content/docs/v3/api/type-aliases/Payload.md index 772bd03b7..f941d30ac 100644 --- a/src/content/docs/v3/api/type-aliases/Payload.md +++ b/src/content/docs/v3/api/type-aliases/Payload.md @@ -9,4 +9,4 @@ title: "Payload" ## Source -[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/utility.ts#L26) +[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/utility.ts#L26) diff --git a/src/content/docs/v3/api/type-aliases/PluginResult.md b/src/content/docs/v3/api/type-aliases/PluginResult.md index e502aed2d..0d325653d 100644 --- a/src/content/docs/v3/api/type-aliases/PluginResult.md +++ b/src/content/docs/v3/api/type-aliases/PluginResult.md @@ -9,4 +9,4 @@ title: "PluginResult" ## Source -[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-plugin.ts#L51) +[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-plugin.ts#L51) diff --git a/src/content/docs/v3/api/type-aliases/SernOptionsData.md b/src/content/docs/v3/api/type-aliases/SernOptionsData.md index a38e7fe9d..b0c93ff00 100644 --- a/src/content/docs/v3/api/type-aliases/SernOptionsData.md +++ b/src/content/docs/v3/api/type-aliases/SernOptionsData.md @@ -11,4 +11,4 @@ Type that replaces autocomplete with [SernAutocompleteData](../../../../../../v3 ## Source -[src/types/core-modules.ts:200](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/core-modules.ts#L200) +[src/types/core-modules.ts:200](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/core-modules.ts#L200) diff --git a/src/content/docs/v3/api/type-aliases/Singleton.md b/src/content/docs/v3/api/type-aliases/Singleton.md index 69177587c..b2e738ea8 100644 --- a/src/content/docs/v3/api/type-aliases/Singleton.md +++ b/src/content/docs/v3/api/type-aliases/Singleton.md @@ -20,4 +20,4 @@ T is created once and lazily. ## Source -[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L7) +[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L7) diff --git a/src/content/docs/v3/api/type-aliases/SlashOptions.md b/src/content/docs/v3/api/type-aliases/SlashOptions.md index 88763a6f3..e46494374 100644 --- a/src/content/docs/v3/api/type-aliases/SlashOptions.md +++ b/src/content/docs/v3/api/type-aliases/SlashOptions.md @@ -9,4 +9,4 @@ title: "SlashOptions" ## Source -[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/utility.ts#L14) +[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/utility.ts#L14) diff --git a/src/content/docs/v3/api/type-aliases/Transient.md b/src/content/docs/v3/api/type-aliases/Transient.md index fcb10c3cc..72fd674d6 100644 --- a/src/content/docs/v3/api/type-aliases/Transient.md +++ b/src/content/docs/v3/api/type-aliases/Transient.md @@ -24,4 +24,4 @@ Every time this is called, a new object is created ## Source -[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/types/ioc.ts#L12) +[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/types/ioc.ts#L12) diff --git a/src/content/docs/v3/api/variables/controller.md b/src/content/docs/v3/api/variables/controller.md index c73d51275..6612e60e9 100644 --- a/src/content/docs/v3/api/variables/controller.md +++ b/src/content/docs/v3/api/variables/controller.md @@ -32,4 +32,4 @@ The object passed into every plugin to control a command's behavior ## Source -[src/core/create-plugins.ts:69](https://github.com/sern-handler/handler/blob/04c4625bfa2f746935f4a8cee62b77cdffd86684/src/core/create-plugins.ts#L69) +[src/core/create-plugins.ts:69](https://github.com/sern-handler/handler/blob/a19edaf8838dcf088d3947f4a6aa6213d8f5bb9e/src/core/create-plugins.ts#L69) diff --git a/src/content/docs/v4/api/README.md b/src/content/docs/v4/api/README.md index 06ccfba6f..4582a3ad4 100644 --- a/src/content/docs/v4/api/README.md +++ b/src/content/docs/v4/api/README.md @@ -7,6 +7,7 @@ title: "@sern/handler" ## Namespaces +- [Presence](/v4/api/namespaces/presence/readme/) - [Sern](/v4/api/namespaces/sern/readme/) ## Enumerations @@ -43,8 +44,9 @@ title: "@sern/handler" - [ModalSubmitCommand](/v4/api/interfaces/modalsubmitcommand/) - [Module](/v4/api/interfaces/module/) - [Plugin](/v4/api/interfaces/plugin/) -- [PresenceResult](/v4/api/interfaces/presenceresult/) - [RoleSelectCommand](/v4/api/interfaces/roleselectcommand/) +- [SDT](/v4/api/interfaces/sdt/) +- [ScheduledTask](/v4/api/interfaces/scheduledtask/) - [SernAutocompleteData](/v4/api/interfaces/sernautocompletedata/) - [SernEventCommand](/v4/api/interfaces/serneventcommand/) - [SernEventsMapping](/v4/api/interfaces/serneventsmapping/) @@ -54,6 +56,7 @@ title: "@sern/handler" - [StringSelectCommand](/v4/api/interfaces/stringselectcommand/) - [TextCommand](/v4/api/interfaces/textcommand/) - [UserSelectCommand](/v4/api/interfaces/userselectcommand/) +- [Wrapper](/v4/api/interfaces/wrapper/) ## Type Aliases @@ -64,8 +67,6 @@ title: "@sern/handler" - [LogPayload](/v4/api/type-aliases/logpayload/) - [Payload](/v4/api/type-aliases/payload/) - [PluginResult](/v4/api/type-aliases/pluginresult/) -- [PresenceConfig](/v4/api/type-aliases/presenceconfig/) -- [SDT](/v4/api/type-aliases/sdt/) - [SernOptionsData](/v4/api/type-aliases/sernoptionsdata/) ## Variables @@ -85,5 +86,6 @@ title: "@sern/handler" - [eventModule](/v4/api/functions/eventmodule/) - [makeDependencies](/v4/api/functions/makedependencies/) - [makePlugin](/v4/api/functions/makeplugin/) +- [scheduledTask](/v4/api/functions/scheduledtask/) - [single](/v4/api/functions/single/) - [transient](/v4/api/functions/transient/) diff --git a/src/content/docs/v4/api/classes/Context.md b/src/content/docs/v4/api/classes/Context.md index c508c6e8e..8545c4237 100644 --- a/src/content/docs/v4/api/classes/Context.md +++ b/src/content/docs/v4/api/classes/Context.md @@ -11,10 +11,6 @@ title: "Context" Provides values shared between Message and ChatInputCommandInteraction -## Extends - -- `CoreContext`\<`Message`, `ChatInputCommandInteraction`\> - ## Accessors ### channel @@ -27,7 +23,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:49](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L49) +[src/core/structures/context.ts:43](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L43) *** @@ -41,7 +37,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:53](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L53) +[src/core/structures/context.ts:47](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L47) *** @@ -55,7 +51,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:108](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L108) +[src/core/structures/context.ts:107](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L107) *** @@ -69,7 +65,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:73](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L73) +[src/core/structures/context.ts:67](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L67) *** @@ -83,7 +79,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:79](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L79) +[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L71) *** @@ -97,7 +93,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L85) +[src/core/structures/context.ts:75](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L75) *** @@ -111,7 +107,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:43](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L43) +[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L39) *** @@ -125,7 +121,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:114](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L114) +[src/core/structures/context.ts:111](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L111) *** @@ -139,7 +135,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L103) +[src/core/structures/context.ts:99](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L99) *** @@ -153,7 +149,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:93](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L93) +[src/core/structures/context.ts:81](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L81) *** @@ -167,7 +163,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:99](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L99) +[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L85) *** @@ -181,7 +177,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L26) +[src/core/structures/context.ts:25](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L25) *** @@ -195,7 +191,7 @@ Message and ChatInputCommandInteraction #### Source -[src/core/structures/context.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L40) +[src/core/structures/context.ts:36](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L36) *** @@ -212,7 +208,7 @@ else, interaction.user #### Source -[src/core/structures/context.ts:63](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L63) +[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L55) *** @@ -226,43 +222,35 @@ else, interaction.user #### Source -[src/core/structures/context.ts:69](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L69) +[src/core/structures/context.ts:63](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L63) ## Methods ### isMessage() -> **isMessage**(): `this is CoreContext, never>` +> **isMessage**(): `this is Context & Object` #### Returns -`this is CoreContext, never>` - -#### Inherited from - -`CoreContext.isMessage` +`this is Context & Object` #### Source -[src/core/structures/core-context.ts:11](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/core-context.ts#L11) +[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L91) *** ### isSlash() -> **isSlash**(): `this is CoreContext>` +> **isSlash**(): `this is Context & Object` #### Returns -`this is CoreContext>` - -#### Inherited from - -`CoreContext.isSlash` +`this is Context & Object` #### Source -[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/core-context.ts#L15) +[src/core/structures/context.ts:95](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L95) *** @@ -280,7 +268,7 @@ else, interaction.user #### Source -[src/core/structures/context.ts:120](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L120) +[src/core/structures/context.ts:115](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L115) *** @@ -300,4 +288,4 @@ else, interaction.user #### Source -[src/core/structures/context.ts:129](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/context.ts#L129) +[src/core/structures/context.ts:124](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/context.ts#L124) diff --git a/src/content/docs/v4/api/enumerations/CommandType.md b/src/content/docs/v4/api/enumerations/CommandType.md index 450846988..75f063fa9 100644 --- a/src/content/docs/v4/api/enumerations/CommandType.md +++ b/src/content/docs/v4/api/enumerations/CommandType.md @@ -31,7 +31,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L20) +[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L20) *** @@ -41,7 +41,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L23) +[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L23) *** @@ -51,7 +51,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L29) +[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L29) *** @@ -61,7 +61,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L22) +[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L22) *** @@ -71,7 +71,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L21) +[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L21) *** @@ -81,7 +81,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L28) +[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L28) *** @@ -91,7 +91,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L25) +[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L25) *** @@ -101,7 +101,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L27) +[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L27) *** @@ -111,7 +111,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L19) +[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L19) *** @@ -121,7 +121,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L24) +[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L24) *** @@ -131,7 +131,7 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L18) +[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L18) *** @@ -141,4 +141,4 @@ export default commandModule({ #### Source -[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L26) +[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L26) diff --git a/src/content/docs/v4/api/enumerations/EventType.md b/src/content/docs/v4/api/enumerations/EventType.md index 611279662..17a43d438 100644 --- a/src/content/docs/v4/api/enumerations/EventType.md +++ b/src/content/docs/v4/api/enumerations/EventType.md @@ -22,16 +22,6 @@ export default eventModule({ ## Enumeration Members -### Cron - -> **Cron**: `3` - -#### Source - -[src/core/structures/enums.ts:61](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L61) - -*** - ### Discord > **Discord**: `0` @@ -40,7 +30,7 @@ The EventType for handling discord events #### Source -[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L51) +[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L51) *** @@ -53,7 +43,7 @@ Could be for example, `process` events, database events #### Source -[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L60) +[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L60) *** @@ -65,4 +55,4 @@ The EventType for handling sern events #### Source -[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L55) +[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L55) diff --git a/src/content/docs/v4/api/enumerations/PayloadType.md b/src/content/docs/v4/api/enumerations/PayloadType.md index a9e1facbc..3852d54f0 100644 --- a/src/content/docs/v4/api/enumerations/PayloadType.md +++ b/src/content/docs/v4/api/enumerations/PayloadType.md @@ -17,7 +17,7 @@ title: "PayloadType" #### Source -[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L94) +[src/core/structures/enums.ts:93](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L93) *** @@ -27,7 +27,7 @@ title: "PayloadType" #### Source -[src/core/structures/enums.ts:93](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L93) +[src/core/structures/enums.ts:92](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L92) *** @@ -37,4 +37,4 @@ title: "PayloadType" #### Source -[src/core/structures/enums.ts:95](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L95) +[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L94) diff --git a/src/content/docs/v4/api/enumerations/PluginType.md b/src/content/docs/v4/api/enumerations/PluginType.md index 5b1596b66..d1a24df0e 100644 --- a/src/content/docs/v4/api/enumerations/PluginType.md +++ b/src/content/docs/v4/api/enumerations/PluginType.md @@ -29,7 +29,7 @@ The PluginType for EventPlugins #### Source -[src/core/structures/enums.ts:86](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L86) +[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L85) *** @@ -41,4 +41,4 @@ The PluginType for InitPlugins #### Source -[src/core/structures/enums.ts:82](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/structures/enums.ts#L82) +[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/structures/enums.ts#L81) diff --git a/src/content/docs/v4/api/functions/CommandControlPlugin.md b/src/content/docs/v4/api/functions/CommandControlPlugin.md index 3f4f32bab..030d5b65f 100644 --- a/src/content/docs/v4/api/functions/CommandControlPlugin.md +++ b/src/content/docs/v4/api/functions/CommandControlPlugin.md @@ -7,22 +7,76 @@ title: "CommandControlPlugin" > **CommandControlPlugin**\<`I`\>(`execute`): [`Plugin`](/v4/api/interfaces/plugin/)\<`unknown`[]\> +Creates a control plugin for command preprocessing, filtering, and state management + ## Type parameters • **I** *extends* [`CommandType`](/v4/api/enumerations/commandtype/) +Extends CommandType to enforce type safety for command modules + ## Parameters • **execute** +Function to execute during command control flow + ## Returns [`Plugin`](/v4/api/interfaces/plugin/)\<`unknown`[]\> +A plugin that runs during command execution flow + ## Since 2.5.0 +## Example + +```ts +// Plugin to restrict command to specific guild +export const inGuild = (guildId: string) => { + return CommandControlPlugin((ctx, sdt) => { + if(ctx.guild.id !== guildId) { + return controller.stop(); + } + return controller.next(); + }); +}; +``` + +## Example + +```ts +// Plugins passing state through the chain +const plugin1 = CommandControlPlugin((ctx, sdt) => { + return controller.next({ 'plugin1/data': 'from plugin1' }); +}); + +const plugin2 = CommandControlPlugin((ctx, sdt) => { + return controller.next({ 'plugin2/data': ctx.user.id }); +}); + +export default commandModule({ + type: CommandType.Slash, + plugins: [plugin1, plugin2], + execute: (ctx, sdt) => { + console.log(sdt.state); // Access accumulated state + } +}); +``` + +## Remarks + +- Control plugins are executed in order when a discord.js event is emitted +- Use controller.next() to continue to next plugin or controller.stop() to halt execution +- State can be passed between plugins using controller.next({ key: value }) +- State keys should be namespaced to avoid collisions (e.g., 'plugin-name/key') +- Final accumulated state is passed to the command's execute function +- All plugins must succeed for the command to execute +- Plugins have access to dependencies through the sdt.deps object +- Useful for implementing preconditions, filters, and command preprocessing + ## Source -[src/core/create-plugins.ts:28](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/create-plugins.ts#L28) +[src/core/plugin.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/plugin.ts#L120) diff --git a/src/content/docs/v4/api/functions/CommandInitPlugin.md b/src/content/docs/v4/api/functions/CommandInitPlugin.md index d070c5f39..1432c4902 100644 --- a/src/content/docs/v4/api/functions/CommandInitPlugin.md +++ b/src/content/docs/v4/api/functions/CommandInitPlugin.md @@ -5,24 +5,68 @@ prev: false title: "CommandInitPlugin" --- -> **CommandInitPlugin**\<`I`\>(`execute`): [`Plugin`](/v4/api/interfaces/plugin/)\<`unknown`[]\> +> **CommandInitPlugin**\<`I`\>(`execute`): [`Plugin`](/v4/api/interfaces/plugin/) + +Creates an initialization plugin for command preprocessing and modification ## Type parameters • **I** *extends* [`CommandType`](/v4/api/enumerations/commandtype/) +Extends CommandType to enforce type safety for command modules + ## Parameters • **execute** +Function to execute during command initialization + ## Returns -[`Plugin`](/v4/api/interfaces/plugin/)\<`unknown`[]\> +[`Plugin`](/v4/api/interfaces/plugin/) + +A plugin that runs during command initialization ## Since 2.5.0 +## Example + +```ts +// Plugin to update command description +export const updateDescription = (description: string) => { + return CommandInitPlugin(({ deps }) => { + if(description.length > 100) { + deps.logger?.info({ message: "Invalid description" }) + return controller.stop("From updateDescription: description is invalid"); + } + module.description = description; + return controller.next(); + }); +}; +``` + +## Example + +```ts +// Plugin to store registration date in module locals +export const dateRegistered = () => { + return CommandInitPlugin(({ module }) => { + module.locals.registered = Date.now() + return controller.next(); + }); +}; +``` + +## Remarks + +- Init plugins can modify how commands are loaded and perform preprocessing +- The module.locals object can be used to store custom plugin-specific data +- Be careful when modifying module fields as multiple plugins may interact with them +- Use controller.next() to continue to the next plugin +- Use controller.stop(reason) to halt plugin execution + ## Source -[src/core/create-plugins.ts:20](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/create-plugins.ts#L20) +[src/core/plugin.ts:62](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/plugin.ts#L62) diff --git a/src/content/docs/v4/api/functions/EventInitPlugin.md b/src/content/docs/v4/api/functions/EventInitPlugin.md index b5f8eab3f..e79b534e8 100644 --- a/src/content/docs/v4/api/functions/EventInitPlugin.md +++ b/src/content/docs/v4/api/functions/EventInitPlugin.md @@ -21,4 +21,4 @@ title: "EventInitPlugin" ## Source -[src/core/create-plugins.ts:14](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/create-plugins.ts#L14) +[src/core/plugin.ts:15](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/plugin.ts#L15) diff --git a/src/content/docs/v4/api/functions/Service.md b/src/content/docs/v4/api/functions/Service.md index 939554892..290e0f50f 100644 --- a/src/content/docs/v4/api/functions/Service.md +++ b/src/content/docs/v4/api/functions/Service.md @@ -7,9 +7,9 @@ title: "Service" > **Service**\<`T`\>(`key`): `Dependencies`\[`T`\] -The new Service api, a cleaner alternative to useContainer +The Service api, which allows users to access dependencies in places IOC cannot reach. To obtain intellisense, ensure a .d.ts file exists in the root of compilation. -Usually our scaffolding tool takes care of this. +Our scaffolding tool takes care of this. Note: this method only works AFTER your container has been initiated ## Type parameters @@ -36,6 +36,10 @@ a key that corresponds to a dependency registered. const client = Service('@sern/client'); ``` +## Throws + +if container is absent or not present + ## Source -[src/core/ioc.ts:87](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/ioc.ts#L87) +[src/core/ioc.ts:93](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L93) diff --git a/src/content/docs/v4/api/functions/Services.md b/src/content/docs/v4/api/functions/Services.md index 2a125f4bf..c9d239192 100644 --- a/src/content/docs/v4/api/functions/Services.md +++ b/src/content/docs/v4/api/functions/Services.md @@ -26,6 +26,10 @@ array of dependencies, in the same order of keys provided 3.0.0 The plural version of [Service](../../../../../../v4/api/functions/service) +## Throws + +if container is absent or not present + ## Source -[src/core/ioc.ts:95](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/ioc.ts#L95) +[src/core/ioc.ts:103](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L103) diff --git a/src/content/docs/v4/api/functions/commandModule.md b/src/content/docs/v4/api/functions/commandModule.md index c2f3c2045..aff77a99a 100644 --- a/src/content/docs/v4/api/functions/commandModule.md +++ b/src/content/docs/v4/api/functions/commandModule.md @@ -7,18 +7,58 @@ title: "commandModule" > **commandModule**(`mod`): [`Module`](/v4/api/interfaces/module/) +Creates a command module with standardized structure and plugin support. + ## Parameters • **mod**: `InputCommand` +Command module configuration + ## Returns [`Module`](/v4/api/interfaces/module/) +Processed command module ready for registration + ## Since -1.0.0 The wrapper function to define command modules for sern +1.0.0 + +## Example + +```ts +// Basic slash command +export default commandModule({ + type: CommandType.Slash, + description: "Ping command", + execute: async (ctx) => { + await ctx.reply("Pong! 🏓"); + } +}); +``` + +## Example + +```ts +// Command with component interaction +export default commandModule({ + type: CommandType.Slash, + description: "Interactive command", + execute: async (ctx) => { + const button = new ButtonBuilder({ + customId: "btn/someData", + label: "Click me", + style: ButtonStyle.Primary + }); + await ctx.reply({ + content: "Interactive message", + components: [new ActionRowBuilder().addComponents(button)] + }); + } +}); +``` ## Source -[src/core/modules.ts:15](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/modules.ts#L15) +[src/core/modules.ts:47](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/modules.ts#L47) diff --git a/src/content/docs/v4/api/functions/discordEvent.md b/src/content/docs/v4/api/functions/discordEvent.md index f9041bd97..cf82bda8d 100644 --- a/src/content/docs/v4/api/functions/discordEvent.md +++ b/src/content/docs/v4/api/functions/discordEvent.md @@ -8,8 +8,12 @@ title: "discordEvent" > **discordEvent**\<`T`\>(`mod`): [`Module`](/v4/api/interfaces/module/) Create event modules from discord.js client events, -This is an [eventModule](../../../../../../v4/api/functions/eventmodule) for discord events, -where typings can be very bad. +This was an [eventModule](../../../../../../v4/api/functions/eventmodule) for discord events, +where typings were bad. + +:::caution[Deprecated] +Use [eventModule](/v4/api/functions/eventmodule/) instead +::: ## Type parameters @@ -23,12 +27,12 @@ where typings can be very bad. • **mod.name**: `T` +• **mod.once?**: `boolean` + ## Returns [`Module`](/v4/api/interfaces/module/) -## Experimental - ## Source -[src/core/modules.ts:42](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/modules.ts#L42) +[src/core/modules.ts:97](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/modules.ts#L97) diff --git a/src/content/docs/v4/api/functions/eventModule.md b/src/content/docs/v4/api/functions/eventModule.md index 1340e4a48..b380baede 100644 --- a/src/content/docs/v4/api/functions/eventModule.md +++ b/src/content/docs/v4/api/functions/eventModule.md @@ -5,21 +5,60 @@ prev: false title: "eventModule" --- -> **eventModule**(`mod`): [`Module`](/v4/api/interfaces/module/) +> **eventModule**\<`T`\>(`mod`): [`Module`](/v4/api/interfaces/module/) + +Creates an event module for handling Discord.js or custom events. + +## Type parameters + +• **T** *extends* keyof `ClientEvents` = keyof `ClientEvents` + +Event name from ClientEvents ## Parameters -• **mod**: `InputEvent` +• **mod**: `InputEvent`\<`T`\> + +Event module configuration ## Returns [`Module`](/v4/api/interfaces/module/) +Processed event module ready for registration + ## Since 1.0.0 -The wrapper function to define event modules for sern + +## Throws + +If ControlPlugins are used in event modules + +## Example + +```ts +// Discord event listener +export default eventModule({ + type: EventType.Discord, + execute: async (message) => { + console.log(`${message.author.tag}: ${message.content}`); + } +}); +``` + +## Example + +```ts +// Custom sern event +export default eventModule({ + type: EventType.Sern, + execute: async (eventData) => { + // Handle sern-specific event + } +}); +``` ## Source -[src/core/modules.ts:28](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/modules.ts#L28) +[src/core/modules.ts:83](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/modules.ts#L83) diff --git a/src/content/docs/v4/api/functions/makeDependencies.md b/src/content/docs/v4/api/functions/makeDependencies.md index 2290998cf..bf98faba3 100644 --- a/src/content/docs/v4/api/functions/makeDependencies.md +++ b/src/content/docs/v4/api/functions/makeDependencies.md @@ -28,4 +28,4 @@ await makeDependencies(({ add }) => { ## Source -[src/core/ioc.ts:56](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/ioc.ts#L56) +[src/core/ioc.ts:63](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L63) diff --git a/src/content/docs/v4/api/functions/makePlugin.md b/src/content/docs/v4/api/functions/makePlugin.md index 70186bba7..868ce5c61 100644 --- a/src/content/docs/v4/api/functions/makePlugin.md +++ b/src/content/docs/v4/api/functions/makePlugin.md @@ -23,4 +23,4 @@ title: "makePlugin" ## Source -[src/core/create-plugins.ts:5](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/create-plugins.ts#L5) +[src/core/plugin.ts:6](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/plugin.ts#L6) diff --git a/src/content/docs/v4/api/functions/scheduledTask.md b/src/content/docs/v4/api/functions/scheduledTask.md new file mode 100644 index 000000000..526cc3a1c --- /dev/null +++ b/src/content/docs/v4/api/functions/scheduledTask.md @@ -0,0 +1,48 @@ +--- +editUrl: false +next: false +prev: false +title: "scheduledTask" +--- + +> **scheduledTask**(`ism`): [`ScheduledTask`](/v4/api/interfaces/scheduledtask/) + +Creates a scheduled task that can be executed at specified intervals using cron patterns + +## Parameters + +• **ism**: [`ScheduledTask`](/v4/api/interfaces/scheduledtask/) + +The scheduled task configuration object + +## Returns + +[`ScheduledTask`](/v4/api/interfaces/scheduledtask/) + +The configured scheduled task + +## Example + +```ts +// Create a task that runs every minute +export default scheduledTask({ + trigger: "* * * * *", + execute: (context) => { + console.log("Task executed!"); + } +}); +``` + +## Remarks + +- Tasks must be placed in the 'tasks' directory specified in your config +- The file name serves as a unique identifier for the task +- Tasks can be cancelled using deps['@sern/scheduler'].kill(uuid) + +## See + +[https://crontab.guru/](https://crontab.guru/) for testing and creating cron patterns + +## Source + +[src/core/modules.ts:132](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/modules.ts#L132) diff --git a/src/content/docs/v4/api/functions/single.md b/src/content/docs/v4/api/functions/single.md index 1cb59834e..871b12ea4 100644 --- a/src/content/docs/v4/api/functions/single.md +++ b/src/content/docs/v4/api/functions/single.md @@ -25,4 +25,4 @@ Creates a singleton object. ## Source -[src/core/ioc.ts:104](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/ioc.ts#L104) +[src/core/ioc.ts:112](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L112) diff --git a/src/content/docs/v4/api/functions/transient.md b/src/content/docs/v4/api/functions/transient.md index c671df78f..f50e06bba 100644 --- a/src/content/docs/v4/api/functions/transient.md +++ b/src/content/docs/v4/api/functions/transient.md @@ -30,4 +30,4 @@ Creates a transient object ## Source -[src/core/ioc.ts:115](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/ioc.ts#L115) +[src/core/ioc.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L123) diff --git a/src/content/docs/v4/api/interfaces/BothCommand.md b/src/content/docs/v4/api/interfaces/BothCommand.md index b3bf0db53..07591abd7 100644 --- a/src/content/docs/v4/api/interfaces/BothCommand.md +++ b/src/content/docs/v4/api/interfaces/BothCommand.md @@ -21,7 +21,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:140](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L140) +[src/types/core-modules.ts:284](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L284) *** @@ -33,7 +33,7 @@ title: "BothCommand" • **ctx**: [`Context`](/v4/api/classes/context/) -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:142](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L142) +[src/types/core-modules.ts:286](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L286) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -119,7 +199,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:141](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L141) +[src/types/core-modules.ts:285](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L285) *** @@ -133,7 +213,7 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -147,4 +227,4 @@ title: "BothCommand" #### Source -[src/types/core-modules.ts:139](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L139) +[src/types/core-modules.ts:283](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L283) diff --git a/src/content/docs/v4/api/interfaces/ButtonCommand.md b/src/content/docs/v4/api/interfaces/ButtonCommand.md index 56a726900..d24b20b93 100644 --- a/src/content/docs/v4/api/interfaces/ButtonCommand.md +++ b/src/content/docs/v4/api/interfaces/ButtonCommand.md @@ -21,7 +21,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "ButtonCommand" • **ctx**: `ButtonInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:82](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L82) +[src/types/core-modules.ts:226](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L226) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "ButtonCommand" #### Source -[src/types/core-modules.ts:81](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L81) +[src/types/core-modules.ts:225](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L225) diff --git a/src/content/docs/v4/api/interfaces/ChannelSelectCommand.md b/src/content/docs/v4/api/interfaces/ChannelSelectCommand.md index a684c4762..de1e78041 100644 --- a/src/content/docs/v4/api/interfaces/ChannelSelectCommand.md +++ b/src/content/docs/v4/api/interfaces/ChannelSelectCommand.md @@ -21,7 +21,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "ChannelSelectCommand" • **ctx**: `ChannelSelectMenuInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:92](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L92) +[src/types/core-modules.ts:236](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L236) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "ChannelSelectCommand" #### Source -[src/types/core-modules.ts:91](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L91) +[src/types/core-modules.ts:235](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L235) diff --git a/src/content/docs/v4/api/interfaces/CommandModuleDefs.md b/src/content/docs/v4/api/interfaces/CommandModuleDefs.md index df1e657cd..0e6bbdf48 100644 --- a/src/content/docs/v4/api/interfaces/CommandModuleDefs.md +++ b/src/content/docs/v4/api/interfaces/CommandModuleDefs.md @@ -13,7 +13,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:163](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L163) +[src/types/core-modules.ts:307](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L307) *** @@ -23,7 +23,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:171](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L171) +[src/types/core-modules.ts:315](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L315) *** @@ -33,7 +33,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:173](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L173) +[src/types/core-modules.ts:317](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L317) *** @@ -43,7 +43,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:168](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L168) +[src/types/core-modules.ts:312](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L312) *** @@ -53,7 +53,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:164](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L164) +[src/types/core-modules.ts:308](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L308) *** @@ -63,7 +63,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:170](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L170) +[src/types/core-modules.ts:314](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L314) *** @@ -73,7 +73,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:165](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L165) +[src/types/core-modules.ts:309](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L309) *** @@ -83,7 +83,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:169](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L169) +[src/types/core-modules.ts:313](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L313) *** @@ -93,7 +93,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:167](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L167) +[src/types/core-modules.ts:311](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L311) *** @@ -103,7 +103,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:172](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L172) +[src/types/core-modules.ts:316](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L316) *** @@ -113,7 +113,7 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:174](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L174) +[src/types/core-modules.ts:318](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L318) *** @@ -123,4 +123,4 @@ title: "CommandModuleDefs" #### Source -[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L166) +[src/types/core-modules.ts:310](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L310) diff --git a/src/content/docs/v4/api/interfaces/ContextMenuMsg.md b/src/content/docs/v4/api/interfaces/ContextMenuMsg.md index 519ee4b8d..7d0a9cf93 100644 --- a/src/content/docs/v4/api/interfaces/ContextMenuMsg.md +++ b/src/content/docs/v4/api/interfaces/ContextMenuMsg.md @@ -21,7 +21,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "ContextMenuMsg" • **ctx**: `MessageContextMenuCommandInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:77](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L77) +[src/types/core-modules.ts:221](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L221) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "ContextMenuMsg" #### Source -[src/types/core-modules.ts:76](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L76) +[src/types/core-modules.ts:220](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L220) diff --git a/src/content/docs/v4/api/interfaces/ContextMenuUser.md b/src/content/docs/v4/api/interfaces/ContextMenuUser.md index b09968a8f..e4e02945e 100644 --- a/src/content/docs/v4/api/interfaces/ContextMenuUser.md +++ b/src/content/docs/v4/api/interfaces/ContextMenuUser.md @@ -21,7 +21,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "ContextMenuUser" • **ctx**: `UserContextMenuCommandInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:72](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L72) +[src/types/core-modules.ts:216](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L216) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "ContextMenuUser" #### Source -[src/types/core-modules.ts:71](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L71) +[src/types/core-modules.ts:215](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L215) diff --git a/src/content/docs/v4/api/interfaces/ControlPlugin.md b/src/content/docs/v4/api/interfaces/ControlPlugin.md index 85c6c1ae2..c4281e0a9 100644 --- a/src/content/docs/v4/api/interfaces/ControlPlugin.md +++ b/src/content/docs/v4/api/interfaces/ControlPlugin.md @@ -33,7 +33,7 @@ title: "ControlPlugin" #### Source -[src/types/core-plugin.ts:43](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-plugin.ts#L43) +[src/types/core-plugin.ts:44](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-plugin.ts#L44) *** @@ -47,4 +47,4 @@ title: "ControlPlugin" #### Source -[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-plugin.ts#L51) +[src/types/core-plugin.ts:52](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-plugin.ts#L52) diff --git a/src/content/docs/v4/api/interfaces/CoreDependencies.md b/src/content/docs/v4/api/interfaces/CoreDependencies.md index f805ab420..916a34b0c 100644 --- a/src/content/docs/v4/api/interfaces/CoreDependencies.md +++ b/src/content/docs/v4/api/interfaces/CoreDependencies.md @@ -15,7 +15,7 @@ discord.js client. #### Source -[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/ioc.ts#L12) +[src/core/ioc.ts:140](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L140) *** @@ -28,7 +28,7 @@ the handler. some include module.register, module.activate. #### Source -[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/ioc.ts#L17) +[src/core/ioc.ts:145](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L145) *** @@ -41,7 +41,7 @@ the sern process actually crashes. #### Source -[src/types/ioc.ts:22](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/ioc.ts#L22) +[src/core/ioc.ts:150](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L150) *** @@ -53,7 +53,7 @@ Optional logger. Performs ... logging #### Source -[src/types/ioc.ts:26](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/ioc.ts#L26) +[src/core/ioc.ts:154](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L154) *** @@ -66,4 +66,14 @@ by module.meta.id -> Module #### Source -[src/types/ioc.ts:31](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/ioc.ts#L31) +[src/core/ioc.ts:159](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L159) + +*** + +### @sern/scheduler + +> **@sern/scheduler**: `TaskScheduler` + +#### Source + +[src/core/ioc.ts:161](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/ioc.ts#L161) diff --git a/src/content/docs/v4/api/interfaces/DiscordEventCommand.md b/src/content/docs/v4/api/interfaces/DiscordEventCommand.md index d1f07c5ca..12fd52ab1 100644 --- a/src/content/docs/v4/api/interfaces/DiscordEventCommand.md +++ b/src/content/docs/v4/api/interfaces/DiscordEventCommand.md @@ -25,13 +25,93 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -39,7 +119,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -61,7 +141,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -75,7 +155,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L122) +[src/types/core-modules.ts:266](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L266) *** @@ -89,7 +169,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -103,7 +183,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -117,7 +197,7 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L123) +[src/types/core-modules.ts:267](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L267) ## Methods @@ -139,4 +219,4 @@ title: "DiscordEventCommand" #### Source -[src/types/core-modules.ts:124](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L124) +[src/types/core-modules.ts:268](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L268) diff --git a/src/content/docs/v4/api/interfaces/Disposable.md b/src/content/docs/v4/api/interfaces/Disposable.md index 205d8069f..ab6eb37a9 100644 --- a/src/content/docs/v4/api/interfaces/Disposable.md +++ b/src/content/docs/v4/api/interfaces/Disposable.md @@ -20,4 +20,4 @@ Let dependencies implement this to dispose and cleanup. #### Source -[src/core/interfaces.ts:17](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L17) +[src/core/interfaces.ts:17](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L17) diff --git a/src/content/docs/v4/api/interfaces/Emitter.md b/src/content/docs/v4/api/interfaces/Emitter.md index afd5581db..24fa31788 100644 --- a/src/content/docs/v4/api/interfaces/Emitter.md +++ b/src/content/docs/v4/api/interfaces/Emitter.md @@ -23,7 +23,7 @@ title: "Emitter" #### Source -[src/core/interfaces.ts:22](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L22) +[src/core/interfaces.ts:22](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L22) *** @@ -43,7 +43,7 @@ title: "Emitter" #### Source -[src/core/interfaces.ts:24](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L24) +[src/core/interfaces.ts:24](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L24) *** @@ -63,4 +63,4 @@ title: "Emitter" #### Source -[src/core/interfaces.ts:23](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L23) +[src/core/interfaces.ts:23](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L23) diff --git a/src/content/docs/v4/api/interfaces/ErrorHandling.md b/src/content/docs/v4/api/interfaces/ErrorHandling.md index 4f9261397..4016a7dd9 100644 --- a/src/content/docs/v4/api/interfaces/ErrorHandling.md +++ b/src/content/docs/v4/api/interfaces/ErrorHandling.md @@ -29,7 +29,7 @@ Version 4 will remove this method #### Source -[src/core/interfaces.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L36) +[src/core/interfaces.ts:36](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L36) *** @@ -49,4 +49,4 @@ A function that is called on every throw. #### Source -[src/core/interfaces.ts:41](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L41) +[src/core/interfaces.ts:41](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L41) diff --git a/src/content/docs/v4/api/interfaces/EventModuleDefs.md b/src/content/docs/v4/api/interfaces/EventModuleDefs.md index 7cb269d0d..bdbddb337 100644 --- a/src/content/docs/v4/api/interfaces/EventModuleDefs.md +++ b/src/content/docs/v4/api/interfaces/EventModuleDefs.md @@ -5,15 +5,19 @@ prev: false title: "EventModuleDefs" --- +## Type parameters + +• **T** *extends* keyof `ClientEvents` = keyof `ClientEvents` + ## Properties ### 0 -> **0**: [`DiscordEventCommand`](/v4/api/interfaces/discordeventcommand/)\ +> **0**: [`DiscordEventCommand`](/v4/api/interfaces/discordeventcommand/)\<`T`\> #### Source -[src/types/core-modules.ts:179](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L179) +[src/types/core-modules.ts:323](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L323) *** @@ -23,7 +27,7 @@ title: "EventModuleDefs" #### Source -[src/types/core-modules.ts:178](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L178) +[src/types/core-modules.ts:322](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L322) *** @@ -33,14 +37,4 @@ title: "EventModuleDefs" #### Source -[src/types/core-modules.ts:180](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L180) - -*** - -### 3 - -> **3**: `CronEventCommand` - -#### Source - -[src/types/core-modules.ts:181](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L181) +[src/types/core-modules.ts:324](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L324) diff --git a/src/content/docs/v4/api/interfaces/ExternalEventCommand.md b/src/content/docs/v4/api/interfaces/ExternalEventCommand.md index aa999edb0..43021bbf3 100644 --- a/src/content/docs/v4/api/interfaces/ExternalEventCommand.md +++ b/src/content/docs/v4/api/interfaces/ExternalEventCommand.md @@ -21,7 +21,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -31,13 +31,93 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:57](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L57) +[src/types/core-modules.ts:208](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L208) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -45,7 +125,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -67,7 +147,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -81,7 +161,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:56](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L56) +[src/types/core-modules.ts:207](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L207) *** @@ -95,7 +175,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -109,7 +189,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -123,7 +203,7 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:58](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L58) +[src/types/core-modules.ts:209](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L209) ## Methods @@ -145,4 +225,4 @@ title: "ExternalEventCommand" #### Source -[src/types/core-modules.ts:59](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L59) +[src/types/core-modules.ts:210](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L210) diff --git a/src/content/docs/v4/api/interfaces/Init.md b/src/content/docs/v4/api/interfaces/Init.md index bbd4da449..65bc1650f 100644 --- a/src/content/docs/v4/api/interfaces/Init.md +++ b/src/content/docs/v4/api/interfaces/Init.md @@ -20,4 +20,4 @@ Let dependencies implement this to initiate some logic. #### Source -[src/core/interfaces.ts:9](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L9) +[src/core/interfaces.ts:9](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L9) diff --git a/src/content/docs/v4/api/interfaces/InitPlugin.md b/src/content/docs/v4/api/interfaces/InitPlugin.md index 29efedd1f..63a1f7638 100644 --- a/src/content/docs/v4/api/interfaces/InitPlugin.md +++ b/src/content/docs/v4/api/interfaces/InitPlugin.md @@ -33,7 +33,7 @@ title: "InitPlugin" #### Source -[src/types/core-plugin.ts:48](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-plugin.ts#L48) +[src/types/core-plugin.ts:49](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-plugin.ts#L49) *** @@ -47,4 +47,4 @@ title: "InitPlugin" #### Source -[src/types/core-plugin.ts:47](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-plugin.ts#L47) +[src/types/core-plugin.ts:48](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-plugin.ts#L48) diff --git a/src/content/docs/v4/api/interfaces/Logging.md b/src/content/docs/v4/api/interfaces/Logging.md index b1227c43a..c2f396335 100644 --- a/src/content/docs/v4/api/interfaces/Logging.md +++ b/src/content/docs/v4/api/interfaces/Logging.md @@ -29,7 +29,7 @@ title: "Logging" #### Source -[src/core/interfaces.ts:52](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L52) +[src/core/interfaces.ts:52](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L52) *** @@ -47,7 +47,7 @@ title: "Logging" #### Source -[src/core/interfaces.ts:49](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L49) +[src/core/interfaces.ts:49](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L49) *** @@ -65,7 +65,7 @@ title: "Logging" #### Source -[src/core/interfaces.ts:51](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L51) +[src/core/interfaces.ts:51](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L51) *** @@ -83,4 +83,4 @@ title: "Logging" #### Source -[src/core/interfaces.ts:50](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L50) +[src/core/interfaces.ts:50](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L50) diff --git a/src/content/docs/v4/api/interfaces/MentionableSelectCommand.md b/src/content/docs/v4/api/interfaces/MentionableSelectCommand.md index 3316567d1..b753bc136 100644 --- a/src/content/docs/v4/api/interfaces/MentionableSelectCommand.md +++ b/src/content/docs/v4/api/interfaces/MentionableSelectCommand.md @@ -21,7 +21,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "MentionableSelectCommand" • **ctx**: `MentionableSelectMenuInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:102](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L102) +[src/types/core-modules.ts:246](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L246) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "MentionableSelectCommand" #### Source -[src/types/core-modules.ts:101](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L101) +[src/types/core-modules.ts:245](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L245) diff --git a/src/content/docs/v4/api/interfaces/ModalSubmitCommand.md b/src/content/docs/v4/api/interfaces/ModalSubmitCommand.md index ca197b8ed..877b11f7f 100644 --- a/src/content/docs/v4/api/interfaces/ModalSubmitCommand.md +++ b/src/content/docs/v4/api/interfaces/ModalSubmitCommand.md @@ -21,7 +21,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "ModalSubmitCommand" • **ctx**: `ModalSubmitInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L112) +[src/types/core-modules.ts:256](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L256) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "ModalSubmitCommand" #### Source -[src/types/core-modules.ts:111](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L111) +[src/types/core-modules.ts:255](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L255) diff --git a/src/content/docs/v4/api/interfaces/Module.md b/src/content/docs/v4/api/interfaces/Module.md index ca898253b..a6593f57e 100644 --- a/src/content/docs/v4/api/interfaces/Module.md +++ b/src/content/docs/v4/api/interfaces/Module.md @@ -31,17 +31,97 @@ title: "Module" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -59,7 +139,7 @@ title: "Module" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -69,7 +149,7 @@ title: "Module" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -79,7 +159,7 @@ title: "Module" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -89,7 +169,7 @@ title: "Module" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -99,7 +179,7 @@ title: "Module" #### Source -[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L35) +[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L118) ## Methods @@ -117,4 +197,4 @@ title: "Module" #### Source -[src/types/core-modules.ts:45](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L45) +[src/types/core-modules.ts:196](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L196) diff --git a/src/content/docs/v4/api/interfaces/Plugin.md b/src/content/docs/v4/api/interfaces/Plugin.md index f73e6d654..d564083ca 100644 --- a/src/content/docs/v4/api/interfaces/Plugin.md +++ b/src/content/docs/v4/api/interfaces/Plugin.md @@ -30,7 +30,7 @@ title: "Plugin" #### Source -[src/types/core-plugin.ts:43](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-plugin.ts#L43) +[src/types/core-plugin.ts:44](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-plugin.ts#L44) *** @@ -40,4 +40,4 @@ title: "Plugin" #### Source -[src/types/core-plugin.ts:42](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-plugin.ts#L42) +[src/types/core-plugin.ts:43](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-plugin.ts#L43) diff --git a/src/content/docs/v4/api/interfaces/PresenceResult.md b/src/content/docs/v4/api/interfaces/PresenceResult.md deleted file mode 100644 index 29bb2ef19..000000000 --- a/src/content/docs/v4/api/interfaces/PresenceResult.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "PresenceResult" ---- - -## Properties - -### activities? - -> `optional` **activities**: `ActivitiesOptions`[] - -#### Source - -[src/core/presences.ts:11](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/presences.ts#L11) - -*** - -### afk? - -> `optional` **afk**: `boolean` - -#### Source - -[src/core/presences.ts:10](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/presences.ts#L10) - -*** - -### onRepeat()? - -> `optional` **onRepeat**: (`previous`) => [`PresenceResult`](/v4/api/interfaces/presenceresult/) - -#### Parameters - -• **previous**: [`PresenceResult`](/v4/api/interfaces/presenceresult/) - -#### Returns - -[`PresenceResult`](/v4/api/interfaces/presenceresult/) - -#### Source - -[src/core/presences.ts:14](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/presences.ts#L14) - -*** - -### repeat? - -> `optional` **repeat**: `number` \| [[`Emitter`](/v4/api/interfaces/emitter/), `string`] - -#### Source - -[src/core/presences.ts:13](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/presences.ts#L13) - -*** - -### shardId? - -> `optional` **shardId**: `number`[] - -#### Source - -[src/core/presences.ts:12](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/presences.ts#L12) - -*** - -### status? - -> `optional` **status**: `Status` - -#### Source - -[src/core/presences.ts:9](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/presences.ts#L9) diff --git a/src/content/docs/v4/api/interfaces/RoleSelectCommand.md b/src/content/docs/v4/api/interfaces/RoleSelectCommand.md index d9a6acee6..05df34922 100644 --- a/src/content/docs/v4/api/interfaces/RoleSelectCommand.md +++ b/src/content/docs/v4/api/interfaces/RoleSelectCommand.md @@ -21,7 +21,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "RoleSelectCommand" • **ctx**: `RoleSelectMenuInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:97](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L97) +[src/types/core-modules.ts:241](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L241) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "RoleSelectCommand" #### Source -[src/types/core-modules.ts:96](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L96) +[src/types/core-modules.ts:240](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L240) diff --git a/src/content/docs/v4/api/interfaces/SDT.md b/src/content/docs/v4/api/interfaces/SDT.md new file mode 100644 index 000000000..95e6b7995 --- /dev/null +++ b/src/content/docs/v4/api/interfaces/SDT.md @@ -0,0 +1,133 @@ +--- +editUrl: false +next: false +prev: false +title: "SDT" +--- + +SDT (State, Dependencies, Type) interface represents the core data structure +passed through the plugin pipeline to command modules. + + SDT + +## Template + +Type parameter for the state object's structure + +## Template + +Type parameter for dependencies interface + +## Example + +```ts +// Example of a plugin using SDT +const loggingPlugin = CommandControlPlugin((ctx, sdt: SDT) => { + console.log(`User ${ctx.user.id} executed command`); + return controller.next({ 'logging/timestamp': Date.now() }); +}); +``` + +## Example + +```ts +// Example of state accumulation through multiple plugins +const plugin1 = CommandControlPlugin((ctx, sdt: SDT) => { + return controller.next({ 'plugin1/data': 'value1' }); +}); + +const plugin2 = CommandControlPlugin((ctx, sdt: SDT) => { + // Access previous state + const prevData = sdt.state['plugin1/data']; + return controller.next({ 'plugin2/data': 'value2' }); +}); +``` + +## Remarks + +- State is immutable and accumulated through the plugin chain +- Keys in state should be namespaced to avoid collisions +- Dependencies are injected and available throughout the pipeline +- Type information helps plugins make type-safe decisions + +## See + + - [CommandControlPlugin](../../../../../../v4/api/functions/commandcontrolplugin) for plugin implementation + - [CommandType](../../../../../../v4/api/enumerations/commandtype) for available command types + - Dependencies for dependency injection interface + +## Properties + +### deps + +> **deps**: `Dependencies` + +Instance of application dependencies + +#### Source + +[src/types/core-modules.ts:87](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L87) + +*** + +### module + +> **module**: `object` + +A copy of the current module that the plugin is running in. + +#### description + +> **description**: `string` + +#### locals + +> **locals**: `Dictionary` + +#### meta + +> **meta**: `Dictionary` + +#### name + +> **name**: `string` + +#### Source + +[src/types/core-modules.ts:109](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L109) + +*** + +### params? + +> `optional` **params**: `string` + +Optional parameters passed to the command + +#### Source + +[src/types/core-modules.ts:104](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L104) + +*** + +### state + +> **state**: `Record`\<`string`, `unknown`\> + +Accumulated state data passed between plugins + +#### Source + +[src/types/core-modules.ts:79](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L79) + +*** + +### type + +> **type**: [`CommandType`](/v4/api/enumerations/commandtype/) + +Command type identifier + +#### Source + +[src/types/core-modules.ts:95](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L95) diff --git a/src/content/docs/v4/api/interfaces/ScheduledTask.md b/src/content/docs/v4/api/interfaces/ScheduledTask.md new file mode 100644 index 000000000..a8bb446c8 --- /dev/null +++ b/src/content/docs/v4/api/interfaces/ScheduledTask.md @@ -0,0 +1,56 @@ +--- +editUrl: false +next: false +prev: false +title: "ScheduledTask" +--- + +## Properties + +### name? + +> `optional` **name**: `string` + +#### Source + +[src/types/core-modules.ts:403](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L403) + +*** + +### timezone? + +> `optional` **timezone**: `string` + +#### Source + +[src/types/core-modules.ts:405](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L405) + +*** + +### trigger + +> **trigger**: `string` \| `Date` + +#### Source + +[src/types/core-modules.ts:404](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L404) + +## Methods + +### execute() + +> **execute**(`tasks`, `sdt`): `Awaitable`\<`void`\> + +#### Parameters + +• **tasks**: `ScheduledTaskContext` + +• **sdt**: `TaskAttrs` + +#### Returns + +`Awaitable`\<`void`\> + +#### Source + +[src/types/core-modules.ts:406](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L406) diff --git a/src/content/docs/v4/api/interfaces/SernAutocompleteData.md b/src/content/docs/v4/api/interfaces/SernAutocompleteData.md index a20d2a5f3..9ecb52d36 100644 --- a/src/content/docs/v4/api/interfaces/SernAutocompleteData.md +++ b/src/content/docs/v4/api/interfaces/SernAutocompleteData.md @@ -17,7 +17,7 @@ title: "SernAutocompleteData" #### Source -[src/types/core-modules.ts:186](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L186) +[src/types/core-modules.ts:329](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L329) *** @@ -27,7 +27,7 @@ title: "SernAutocompleteData" #### Source -[src/types/core-modules.ts:191](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L191) +[src/types/core-modules.ts:334](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L334) *** @@ -41,13 +41,13 @@ title: "SernAutocompleteData" #### Source -node\_modules/discord.js/typings/index.d.ts:4715 +node\_modules/discord.js/typings/index.d.ts:5035 *** ### descriptionLocalizations? -> `optional` **descriptionLocalizations**: `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **descriptionLocalizations**: `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -55,7 +55,7 @@ node\_modules/discord.js/typings/index.d.ts:4715 #### Source -node\_modules/discord.js/typings/index.d.ts:4716 +node\_modules/discord.js/typings/index.d.ts:5036 *** @@ -69,13 +69,13 @@ node\_modules/discord.js/typings/index.d.ts:4716 #### Source -node\_modules/discord.js/typings/index.d.ts:4713 +node\_modules/discord.js/typings/index.d.ts:5033 *** ### nameLocalizations? -> `optional` **nameLocalizations**: `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **nameLocalizations**: `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -83,7 +83,7 @@ node\_modules/discord.js/typings/index.d.ts:4713 #### Source -node\_modules/discord.js/typings/index.d.ts:4714 +node\_modules/discord.js/typings/index.d.ts:5034 *** @@ -97,7 +97,7 @@ node\_modules/discord.js/typings/index.d.ts:4714 #### Source -node\_modules/discord.js/typings/index.d.ts:4717 +node\_modules/discord.js/typings/index.d.ts:5037 *** @@ -107,4 +107,4 @@ node\_modules/discord.js/typings/index.d.ts:4717 #### Source -[src/types/core-modules.ts:187](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L187) +[src/types/core-modules.ts:330](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L330) diff --git a/src/content/docs/v4/api/interfaces/SernEventCommand.md b/src/content/docs/v4/api/interfaces/SernEventCommand.md index 3ab4430b5..726d3c01f 100644 --- a/src/content/docs/v4/api/interfaces/SernEventCommand.md +++ b/src/content/docs/v4/api/interfaces/SernEventCommand.md @@ -25,13 +25,93 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -39,7 +119,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -61,7 +141,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -75,7 +155,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:50](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L50) +[src/types/core-modules.ts:201](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L201) *** @@ -89,7 +169,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -103,7 +183,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -117,7 +197,7 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:51](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L51) +[src/types/core-modules.ts:202](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L202) ## Methods @@ -139,4 +219,4 @@ title: "SernEventCommand" #### Source -[src/types/core-modules.ts:52](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L52) +[src/types/core-modules.ts:203](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L203) diff --git a/src/content/docs/v4/api/interfaces/SernEventsMapping.md b/src/content/docs/v4/api/interfaces/SernEventsMapping.md index 41e6a9e33..6b8bf0aa8 100644 --- a/src/content/docs/v4/api/interfaces/SernEventsMapping.md +++ b/src/content/docs/v4/api/interfaces/SernEventsMapping.md @@ -13,7 +13,7 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:13](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/utility.ts#L13) +[src/types/utility.ts:12](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L12) *** @@ -23,7 +23,7 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:12](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/utility.ts#L12) +[src/types/utility.ts:11](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L11) *** @@ -33,7 +33,7 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:11](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/utility.ts#L11) +[src/types/utility.ts:10](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L10) *** @@ -43,7 +43,7 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:15](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/utility.ts#L15) +[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L14) *** @@ -53,4 +53,4 @@ title: "SernEventsMapping" #### Source -[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/utility.ts#L14) +[src/types/utility.ts:13](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L13) diff --git a/src/content/docs/v4/api/interfaces/SernSubCommandData.md b/src/content/docs/v4/api/interfaces/SernSubCommandData.md index 4ffc304a3..bb30405af 100644 --- a/src/content/docs/v4/api/interfaces/SernSubCommandData.md +++ b/src/content/docs/v4/api/interfaces/SernSubCommandData.md @@ -27,7 +27,7 @@ node\_modules/discord-api-types/payloads/v10/\_interactions/\_applicationCommand ### description\_localizations? -> `optional` **description\_localizations**: `null` \| `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **description\_localizations**: `null` \| `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -55,7 +55,7 @@ node\_modules/discord-api-types/payloads/v10/\_interactions/\_applicationCommand ### name\_localizations? -> `optional` **name\_localizations**: `null` \| `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **name\_localizations**: `null` \| `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -73,7 +73,7 @@ node\_modules/discord-api-types/payloads/v10/\_interactions/\_applicationCommand #### Source -[src/types/core-modules.ts:226](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L226) +[src/types/core-modules.ts:369](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L369) *** @@ -101,4 +101,4 @@ node\_modules/discord-api-types/payloads/v10/\_interactions/\_applicationCommand #### Source -[src/types/core-modules.ts:225](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L225) +[src/types/core-modules.ts:368](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L368) diff --git a/src/content/docs/v4/api/interfaces/SernSubCommandGroupData.md b/src/content/docs/v4/api/interfaces/SernSubCommandGroupData.md index 31b3a1c8e..0d59ac7f4 100644 --- a/src/content/docs/v4/api/interfaces/SernSubCommandGroupData.md +++ b/src/content/docs/v4/api/interfaces/SernSubCommandGroupData.md @@ -21,7 +21,7 @@ title: "SernSubCommandGroupData" #### Source -node\_modules/discord.js/typings/index.d.ts:4718 +node\_modules/discord.js/typings/index.d.ts:5038 *** @@ -35,13 +35,13 @@ node\_modules/discord.js/typings/index.d.ts:4718 #### Source -node\_modules/discord.js/typings/index.d.ts:4715 +node\_modules/discord.js/typings/index.d.ts:5035 *** ### descriptionLocalizations? -> `optional` **descriptionLocalizations**: `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **descriptionLocalizations**: `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -49,7 +49,7 @@ node\_modules/discord.js/typings/index.d.ts:4715 #### Source -node\_modules/discord.js/typings/index.d.ts:4716 +node\_modules/discord.js/typings/index.d.ts:5036 *** @@ -63,13 +63,13 @@ node\_modules/discord.js/typings/index.d.ts:4716 #### Source -node\_modules/discord.js/typings/index.d.ts:4713 +node\_modules/discord.js/typings/index.d.ts:5033 *** ### nameLocalizations? -> `optional` **nameLocalizations**: `Partial`\<`Record`\<`"id"` \| `"en-US"` \| `"en-GB"` \| `"bg"` \| `"zh-CN"` \| `"zh-TW"` \| `"hr"` \| `"cs"` \| `"da"` \| `"nl"` \| `"fi"` \| `"fr"` \| `"de"` \| `"el"` \| `"hi"` \| `"hu"` \| `"it"` \| `"ja"` \| `"ko"` \| `"lt"` \| `"no"` \| `"pl"` \| `"pt-BR"` \| `"ro"` \| `"ru"` \| `"es-ES"` \| `"es-419"` \| `"sv-SE"` \| `"th"` \| `"tr"` \| `"uk"` \| `"vi"`, `null` \| `string`\>\> +> `optional` **nameLocalizations**: `Partial`\<`Record`\<`Locale`, `null` \| `string`\>\> #### Inherited from @@ -77,7 +77,7 @@ node\_modules/discord.js/typings/index.d.ts:4713 #### Source -node\_modules/discord.js/typings/index.d.ts:4714 +node\_modules/discord.js/typings/index.d.ts:5034 *** @@ -87,7 +87,7 @@ node\_modules/discord.js/typings/index.d.ts:4714 #### Source -[src/types/core-modules.ts:231](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L231) +[src/types/core-modules.ts:374](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L374) *** @@ -101,7 +101,7 @@ node\_modules/discord.js/typings/index.d.ts:4714 #### Source -node\_modules/discord.js/typings/index.d.ts:4717 +node\_modules/discord.js/typings/index.d.ts:5037 *** @@ -111,4 +111,4 @@ node\_modules/discord.js/typings/index.d.ts:4717 #### Source -[src/types/core-modules.ts:230](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L230) +[src/types/core-modules.ts:373](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L373) diff --git a/src/content/docs/v4/api/interfaces/SlashCommand.md b/src/content/docs/v4/api/interfaces/SlashCommand.md index 14ad16bf2..ca8bbb3ec 100644 --- a/src/content/docs/v4/api/interfaces/SlashCommand.md +++ b/src/content/docs/v4/api/interfaces/SlashCommand.md @@ -21,7 +21,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:133](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L133) +[src/types/core-modules.ts:277](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L277) *** @@ -33,7 +33,7 @@ title: "SlashCommand" • **ctx**: [`Context`](/v4/api/classes/context/) & `object` -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:135](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L135) +[src/types/core-modules.ts:279](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L279) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -119,7 +199,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:134](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L134) +[src/types/core-modules.ts:278](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L278) *** @@ -133,7 +213,7 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -147,4 +227,4 @@ title: "SlashCommand" #### Source -[src/types/core-modules.ts:132](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L132) +[src/types/core-modules.ts:276](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L276) diff --git a/src/content/docs/v4/api/interfaces/StringSelectCommand.md b/src/content/docs/v4/api/interfaces/StringSelectCommand.md index 15ca89f0c..9f9ead9ad 100644 --- a/src/content/docs/v4/api/interfaces/StringSelectCommand.md +++ b/src/content/docs/v4/api/interfaces/StringSelectCommand.md @@ -21,7 +21,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "StringSelectCommand" • **ctx**: `StringSelectMenuInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:87](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L87) +[src/types/core-modules.ts:231](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L231) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "StringSelectCommand" #### Source -[src/types/core-modules.ts:86](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L86) +[src/types/core-modules.ts:230](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L230) diff --git a/src/content/docs/v4/api/interfaces/TextCommand.md b/src/content/docs/v4/api/interfaces/TextCommand.md index 1276c9f97..a1e7b4d1e 100644 --- a/src/content/docs/v4/api/interfaces/TextCommand.md +++ b/src/content/docs/v4/api/interfaces/TextCommand.md @@ -21,7 +21,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "TextCommand" • **ctx**: [`Context`](/v4/api/classes/context/) & `object` -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:128](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L128) +[src/types/core-modules.ts:272](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L272) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "TextCommand" #### Source -[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L127) +[src/types/core-modules.ts:271](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L271) diff --git a/src/content/docs/v4/api/interfaces/UserSelectCommand.md b/src/content/docs/v4/api/interfaces/UserSelectCommand.md index 62656a6b2..f8fb5dd9a 100644 --- a/src/content/docs/v4/api/interfaces/UserSelectCommand.md +++ b/src/content/docs/v4/api/interfaces/UserSelectCommand.md @@ -21,7 +21,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L39) +[src/types/core-modules.ts:122](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L122) *** @@ -33,7 +33,7 @@ title: "UserSelectCommand" • **ctx**: `UserSelectMenuInteraction`\<`CacheType`\> -• **tbd**: [`SDT`](/v4/api/type-aliases/sdt/) +• **tbd**: [`SDT`](/v4/api/interfaces/sdt/) #### Returns @@ -45,13 +45,93 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L107) +[src/types/core-modules.ts:251](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L251) *** ### locals -> **locals**: `Record`\<`string`, `unknown`\> +> **locals**: `Dictionary` + +Custom data storage object for module-specific information. +Plugins and module code can use this to store and retrieve metadata, +configuration, or any other module-specific information. + +#### Description + +A key-value store that allows plugins and module code to persist +data at the module level. This is especially useful for InitPlugins that need +to attach metadata or configuration to modules. + +#### Example + +```ts +// In a plugin +module.locals.registrationDate = Date.now(); +module.locals.version = "1.0.0"; +module.locals.permissions = ["ADMIN", "MODERATE"]; +``` + +#### Example + +```ts +// In module execution +console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`); +``` + +#### Example + +```ts +// Storing localization data +module.locals.translations = { + en: "Hello", + es: "Hola", + fr: "Bonjour" +}; +``` + +#### Example + +```ts +// Storing command metadata +module.locals.metadata = { + category: "admin", + cooldown: 5000, + requiresPermissions: true +}; +``` + +#### Remarks + +- The locals object is initialized as an empty object ({}) by default +- Keys should be namespaced to avoid collisions between plugins +- Values can be of any type +- Data persists for the lifetime of the module +- Commonly used by InitPlugins during module initialization + +@best-practices +1. Namespace your keys to avoid conflicts: + ```typescript + module.locals['myPlugin:data'] = value; + ``` + +2. Document the data structure you're storing: + ```typescript + interface MyPluginData { + version: string; + timestamp: number; + } + module.locals['myPlugin:data'] = { + version: '1.0.0', + timestamp: Date.now() + } as MyPluginData; + ``` + +3. Use type-safe accessors when possible: + ```typescript + const getPluginData = (module: Module): MyPluginData => + module.locals['myPlugin:data']; + ``` #### Inherited from @@ -59,7 +139,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L44) +[src/types/core-modules.ts:195](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L195) *** @@ -81,7 +161,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:40](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L40) +[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L123) *** @@ -95,7 +175,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L36) +[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L119) *** @@ -109,7 +189,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L37) +[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L120) *** @@ -123,7 +203,7 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:38](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L38) +[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L121) *** @@ -137,4 +217,4 @@ title: "UserSelectCommand" #### Source -[src/types/core-modules.ts:106](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L106) +[src/types/core-modules.ts:250](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L250) diff --git a/src/content/docs/v4/api/interfaces/Wrapper.md b/src/content/docs/v4/api/interfaces/Wrapper.md new file mode 100644 index 000000000..f28ffe100 --- /dev/null +++ b/src/content/docs/v4/api/interfaces/Wrapper.md @@ -0,0 +1,129 @@ +--- +editUrl: false +next: false +prev: false +title: "Wrapper" +--- + +Wrapper + +## Description + +Configuration interface for the sern framework. This interface defines +the structure for configuring essential framework features including command handling, +event management, and task scheduling. + +## Properties + +### commands + +> **commands**: `string` \| `string`[] + +#### Description + +Specifies the directory path where command modules are located. +This is a required property that tells sern where to find and load command files. +The path should be relative to the project root. If given an array, each directory is loaded in order +they were declared. Order of modules in each directory is not guaranteed + +#### Example + +```ts +commands: ["./dist/commands"] +``` + +#### Source + +[src/types/utility.ts:46](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L46) + +*** + +### defaultPrefix? + +> `optional` **defaultPrefix**: `string` + +#### Description + +Optional prefix for text commands. This prefix will be used +to identify text commands in messages. If not specified, text commands [CommandType.Text](../../../../../../v4/api/enumerations/commandtype/#text) +will be disabled. + +#### Example + +```ts +defaultPrefix: "?" +``` + +#### Source + +[src/types/utility.ts:65](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L65) + +*** + +### events? + +> `optional` **events**: `string` \| `string`[] + +#### Description + +Optional directory path where event modules are located. +If provided, Sern will automatically register and handle events from +modules in this directory. The path should be relative to the project root. +If given an array, each directory is loaded in order they were declared. +Order of modules in each directory is not guaranteed. + +#### Example + +```ts +events: ["./dist/events"] +``` + +#### Source + +[src/types/utility.ts:77](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L77) + +*** + +### handleModuleErrors? + +> `optional` **handleModuleErrors**: `boolean` + +#### Description + +Optional flag to enable automatic error handling for modules. +When enabled, sern will automatically catch and handle errors that occur +during module execution, preventing crashes and providing error logging. + +#### Default + +```ts +false +``` + +#### Source + +[src/types/utility.ts:55](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L55) + +*** + +### tasks? + +> `optional` **tasks**: `string` \| `string`[] + +#### Description + +Optional directory path where scheduled task modules are located. +If provided, Sern will automatically register and handle scheduled tasks +from modules in this directory. The path should be relative to the project root. +If given an array, each directory is loaded in order they were declared. +Order of modules in each directory is not guaranteed. + +#### Example + +```ts +tasks: ["./dist/tasks"] +``` + +#### Source + +[src/types/utility.ts:89](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L89) diff --git a/src/content/docs/v4/api/namespaces/Presence/interfaces/Result.md b/src/content/docs/v4/api/namespaces/Presence/interfaces/Result.md new file mode 100644 index 000000000..47cd464ee --- /dev/null +++ b/src/content/docs/v4/api/namespaces/Presence/interfaces/Result.md @@ -0,0 +1,66 @@ +--- +editUrl: false +next: false +prev: false +title: "Result" +--- + +## Properties + +### activities? + +> `optional` **activities**: `ActivitiesOptions`[] + +#### Source + +[src/core/presences.ts:59](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/presences.ts#L59) + +*** + +### afk? + +> `optional` **afk**: `boolean` + +#### Source + +[src/core/presences.ts:58](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/presences.ts#L58) + +*** + +### onRepeat? + +> `optional` **onRepeat**: `PresenceReduce` + +#### Source + +[src/core/presences.ts:62](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/presences.ts#L62) + +*** + +### repeat? + +> `optional` **repeat**: `number` \| [[`Emitter`](/v4/api/interfaces/emitter/), `string`] + +#### Source + +[src/core/presences.ts:61](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/presences.ts#L61) + +*** + +### shardId? + +> `optional` **shardId**: `number`[] + +#### Source + +[src/core/presences.ts:60](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/presences.ts#L60) + +*** + +### status? + +> `optional` **status**: `Status` + +#### Source + +[src/core/presences.ts:57](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/presences.ts#L57) diff --git a/src/content/docs/v4/api/namespaces/Presence/type-aliases/Config.md b/src/content/docs/v4/api/namespaces/Presence/type-aliases/Config.md new file mode 100644 index 000000000..e264313ee --- /dev/null +++ b/src/content/docs/v4/api/namespaces/Presence/type-aliases/Config.md @@ -0,0 +1,34 @@ +--- +editUrl: false +next: false +prev: false +title: "Config" +--- + +> **Config**\<`T`\>: `object` + +## Type parameters + +• **T** *extends* keyof `Dependencies`[] + +## Type declaration + +### execute() + +> **execute**: (...`v`) => `Awaitable`\<[`Result`](/v4/api/namespaces/presence/interfaces/result/)\> + +#### Parameters + +• ...**v**: `IntoDependencies`\<`T`\> + +#### Returns + +`Awaitable`\<[`Result`](/v4/api/namespaces/presence/interfaces/result/)\> + +### inject? + +> `optional` **inject**: [`...T`] + +## Source + +[src/core/presences.ts:50](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/presences.ts#L50) diff --git a/src/content/docs/v4/api/namespaces/Sern/functions/init.md b/src/content/docs/v4/api/namespaces/Sern/functions/init.md index 767c5d8b6..ddf244250 100644 --- a/src/content/docs/v4/api/namespaces/Sern/functions/init.md +++ b/src/content/docs/v4/api/namespaces/Sern/functions/init.md @@ -9,7 +9,10 @@ title: "init" ## Parameters -• **maybeWrapper**: `Wrapper`= `undefined` +• **maybeWrapper**: [`Wrapper`](/v4/api/interfaces/wrapper/)= `undefined` + +Options to pass into sern. +Function to start the handler up ## Returns @@ -30,4 +33,4 @@ Sern.init({ ## Source -[src/sern.ts:34](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/sern.ts#L34) +[src/sern.ts:32](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/sern.ts#L32) diff --git a/src/content/docs/v4/api/type-aliases/AnyPlugin.md b/src/content/docs/v4/api/type-aliases/AnyPlugin.md index 389fc6bc6..9f2689943 100644 --- a/src/content/docs/v4/api/type-aliases/AnyPlugin.md +++ b/src/content/docs/v4/api/type-aliases/AnyPlugin.md @@ -9,4 +9,4 @@ title: "AnyPlugin" ## Source -[src/types/core-plugin.ts:54](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-plugin.ts#L54) +[src/types/core-plugin.ts:55](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-plugin.ts#L55) diff --git a/src/content/docs/v4/api/type-aliases/CommandModule.md b/src/content/docs/v4/api/type-aliases/CommandModule.md index 369742491..e739d8d46 100644 --- a/src/content/docs/v4/api/type-aliases/CommandModule.md +++ b/src/content/docs/v4/api/type-aliases/CommandModule.md @@ -9,4 +9,4 @@ title: "CommandModule" ## Source -[src/types/core-modules.ts:146](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L146) +[src/types/core-modules.ts:290](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L290) diff --git a/src/content/docs/v4/api/type-aliases/Controller.md b/src/content/docs/v4/api/type-aliases/Controller.md index c93d7f455..d7a0ed94a 100644 --- a/src/content/docs/v4/api/type-aliases/Controller.md +++ b/src/content/docs/v4/api/type-aliases/Controller.md @@ -9,4 +9,4 @@ title: "Controller" ## Source -[src/index.ts:52](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/index.ts#L52) +[src/core/plugin.ts:137](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/plugin.ts#L137) diff --git a/src/content/docs/v4/api/type-aliases/EventModule.md b/src/content/docs/v4/api/type-aliases/EventModule.md index f017e455f..294614872 100644 --- a/src/content/docs/v4/api/type-aliases/EventModule.md +++ b/src/content/docs/v4/api/type-aliases/EventModule.md @@ -5,8 +5,8 @@ prev: false title: "EventModule" --- -> **EventModule**: [`DiscordEventCommand`](/v4/api/interfaces/discordeventcommand/) \| [`SernEventCommand`](/v4/api/interfaces/serneventcommand/) \| [`ExternalEventCommand`](/v4/api/interfaces/externaleventcommand/) \| `CronEventCommand` +> **EventModule**: [`DiscordEventCommand`](/v4/api/interfaces/discordeventcommand/) \| [`SernEventCommand`](/v4/api/interfaces/serneventcommand/) \| [`ExternalEventCommand`](/v4/api/interfaces/externaleventcommand/) ## Source -[src/types/core-modules.ts:145](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L145) +[src/types/core-modules.ts:289](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L289) diff --git a/src/content/docs/v4/api/type-aliases/LogPayload.md b/src/content/docs/v4/api/type-aliases/LogPayload.md index be168ad4f..217c3df25 100644 --- a/src/content/docs/v4/api/type-aliases/LogPayload.md +++ b/src/content/docs/v4/api/type-aliases/LogPayload.md @@ -19,4 +19,4 @@ title: "LogPayload" ## Source -[src/core/interfaces.ts:55](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/interfaces.ts#L55) +[src/core/interfaces.ts:55](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/interfaces.ts#L55) diff --git a/src/content/docs/v4/api/type-aliases/Payload.md b/src/content/docs/v4/api/type-aliases/Payload.md index 7dba57ed1..a38af58a1 100644 --- a/src/content/docs/v4/api/type-aliases/Payload.md +++ b/src/content/docs/v4/api/type-aliases/Payload.md @@ -9,4 +9,4 @@ title: "Payload" ## Source -[src/types/utility.ts:18](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/utility.ts#L18) +[src/types/utility.ts:17](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/utility.ts#L17) diff --git a/src/content/docs/v4/api/type-aliases/PluginResult.md b/src/content/docs/v4/api/type-aliases/PluginResult.md index c9124af76..1f387632e 100644 --- a/src/content/docs/v4/api/type-aliases/PluginResult.md +++ b/src/content/docs/v4/api/type-aliases/PluginResult.md @@ -9,4 +9,4 @@ title: "PluginResult" ## Source -[src/types/core-plugin.ts:35](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-plugin.ts#L35) +[src/types/core-plugin.ts:36](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-plugin.ts#L36) diff --git a/src/content/docs/v4/api/type-aliases/PresenceConfig.md b/src/content/docs/v4/api/type-aliases/PresenceConfig.md deleted file mode 100644 index a7291a927..000000000 --- a/src/content/docs/v4/api/type-aliases/PresenceConfig.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "PresenceConfig" ---- - -> **PresenceConfig**\<`T`\>: `object` - -## Type parameters - -• **T** *extends* keyof `Dependencies`[] - -## Type declaration - -### execute() - -> **execute**: (...`v`) => [`PresenceResult`](/v4/api/interfaces/presenceresult/) - -#### Parameters - -• ...**v**: `IntoDependencies`\<`T`\> - -#### Returns - -[`PresenceResult`](/v4/api/interfaces/presenceresult/) - -### inject? - -> `optional` **inject**: [`...T`] - -## Source - -[src/core/presences.ts:60](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/presences.ts#L60) diff --git a/src/content/docs/v4/api/type-aliases/SDT.md b/src/content/docs/v4/api/type-aliases/SDT.md deleted file mode 100644 index 68acaa6e5..000000000 --- a/src/content/docs/v4/api/type-aliases/SDT.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "SDT" ---- - -> **SDT**: `object` - -## Type declaration - -### deps - -> **deps**: `Dependencies` - -### params? - -> `optional` **params**: `string` - -### state - -> **state**: `Record`\<`string`, `unknown`\> - -### type - -> **type**: [`CommandType`](/v4/api/enumerations/commandtype/) - -## Source - -[src/types/core-modules.ts:25](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L25) diff --git a/src/content/docs/v4/api/type-aliases/SernOptionsData.md b/src/content/docs/v4/api/type-aliases/SernOptionsData.md index 40cf00fe3..772e8d8a4 100644 --- a/src/content/docs/v4/api/type-aliases/SernOptionsData.md +++ b/src/content/docs/v4/api/type-aliases/SernOptionsData.md @@ -11,4 +11,4 @@ Type that replaces autocomplete with [SernAutocompleteData](../../../../../../v4 ## Source -[src/types/core-modules.ts:217](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/types/core-modules.ts#L217) +[src/types/core-modules.ts:360](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/types/core-modules.ts#L360) diff --git a/src/content/docs/v4/api/variables/Presence.md b/src/content/docs/v4/api/variables/Presence.md index 37239b8d8..65df2a7c5 100644 --- a/src/content/docs/v4/api/variables/Presence.md +++ b/src/content/docs/v4/api/variables/Presence.md @@ -11,7 +11,7 @@ title: "Presence" ### module() -> **module**: \<`T`\>(`conf`) => [`PresenceConfig`](/v4/api/type-aliases/presenceconfig/)\<`T`\> +> **module**: \<`T`\>(`conf`) => [`Config`](/v4/api/namespaces/presence/type-aliases/config/)\<`T`\> A small wrapper to provide type inference. Create a Presence module which **MUST** be put in a file called presence.(language-extension) @@ -23,11 +23,11 @@ adjacent to the file where **Sern.init** is CALLED. #### Parameters -• **conf**: [`PresenceConfig`](/v4/api/type-aliases/presenceconfig/)\<`T`\> +• **conf**: [`Config`](/v4/api/namespaces/presence/type-aliases/config/)\<`T`\> #### Returns -[`PresenceConfig`](/v4/api/type-aliases/presenceconfig/)\<`T`\> +[`Config`](/v4/api/namespaces/presence/type-aliases/config/)\<`T`\> ### of() @@ -39,7 +39,7 @@ Create a Presence body which can be either: #### Parameters -• **root**: `Omit`\<[`PresenceResult`](/v4/api/interfaces/presenceresult/), `"repeat"` \| `"onRepeat"`\> +• **root**: `Omit`\<[`Result`](/v4/api/namespaces/presence/interfaces/result/), `"repeat"` \| `"onRepeat"`\> #### Returns @@ -47,21 +47,19 @@ Create a Presence body which can be either: ##### once() -> **once**: () => `Omit`\<[`PresenceResult`](/v4/api/interfaces/presenceresult/), `"repeat"` \| `"onRepeat"`\> +> **once**: () => `Omit`\<[`Result`](/v4/api/namespaces/presence/interfaces/result/), `"repeat"` \| `"onRepeat"`\> ###### Example ```ts Presence.of({ - activities: [ - { name: "Chilling out" } - ] - }).once() // Sets the presence once, with what's provided in '.of()' + activities: [{ name: "Chilling out" }] +}).once() // Sets the presence once, with what's provided in '.of()' ``` ###### Returns -`Omit`\<[`PresenceResult`](/v4/api/interfaces/presenceresult/), `"repeat"` \| `"onRepeat"`\> +`Omit`\<[`Result`](/v4/api/namespaces/presence/interfaces/result/), `"repeat"` \| `"onRepeat"`\> ##### repeated() @@ -116,4 +114,4 @@ Presence ## Source -[src/core/presences.ts:17](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/presences.ts#L17) +[src/core/presences.ts:9](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/presences.ts#L9) diff --git a/src/content/docs/v4/api/variables/controller.md b/src/content/docs/v4/api/variables/controller.md index 35577985d..cec7253bd 100644 --- a/src/content/docs/v4/api/variables/controller.md +++ b/src/content/docs/v4/api/variables/controller.md @@ -16,19 +16,27 @@ The object passed into every plugin to control a command's behavior ### next() -> **next**: (`val`?) => `Ok`\<`undefined` \| `Record`\<`string`, `unknown`\>\> +> **next**: (`val`?) => `object` #### Parameters -• **val?**: `Record`\<`string`, `unknown`\> +• **val?**: `Dictionary` #### Returns -`Ok`\<`undefined` \| `Record`\<`string`, `unknown`\>\> +`object` + +##### ok + +> `readonly` **ok**: `true` = `true` + +##### value + +> **value**: `undefined` \| `Dictionary` ### stop() -> **stop**: (`val`?) => `Err`\<`undefined` \| `string`\> +> **stop**: (`val`?) => `object` #### Parameters @@ -36,8 +44,16 @@ The object passed into every plugin to control a command's behavior #### Returns -`Err`\<`undefined` \| `string`\> +`object` + +##### error + +> **error**: `undefined` \| `string` + +##### ok + +> `readonly` **ok**: `false` = `false` ## Source -[src/core/create-plugins.ts:39](https://github.com/sern-handler/handler/blob/7c8e39defbafdd6312a04a2d30750d647a3ab22b/src/core/create-plugins.ts#L39) +[src/core/plugin.ts:131](https://github.com/sern-handler/handler/blob/3f703c17b88b6add7de919772e7b2a7faffd3910/src/core/plugin.ts#L131) diff --git a/src/content/docs/v4/tools/publisher.mdx b/src/content/docs/v4/tools/publisher.mdx index d1cd15b29..2f569af4d 100644 --- a/src/content/docs/v4/tools/publisher.mdx +++ b/src/content/docs/v4/tools/publisher.mdx @@ -4,7 +4,18 @@ description: Publish application commands as a Service sidebar: order: 1 --- +Publish application commands as a service! +## Usage +**Initializing the Publisher** +```ts +import { makeDependencies } from '@sern/handler'; +import { Publisher } from '@sern/publisher'; + +await makeDependencies(({ add }) => { + add('publisher', (deps) => new Publisher(deps['@sern/modules'], deps['@sern/emitter'], deps['@sern/logger'])); +}); +``` ## Implicits - Requires process.env to be populated - A common provider of this is `dotenv` @@ -14,17 +25,6 @@ NODE_ENV= ``` - Calls the discord API with the [PUT route](https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands). Wherever your commands directory is located, publish will override the existing application commands at Discord. -## Usage - -**Initializing the Publisher** -```ts -import { makeDependencies } from '@sern/handler'; -import { Publisher } from '@sern/publisher'; - -await makeDependencies(({ add }) => { - add('publisher', new Publisher()); -}); -``` ## Features - Automatically syncs api with your command base @@ -36,17 +36,24 @@ Each command file can have an extra plugin `publishConfig` that follows `ValidPu ## Config ```ts +enum IntegrationContextType { + GUILD = 0, + BOT_DM = 1, + PRIVATE_CHANNEL = 2 +} + +type Contexts = IntegrationContextType | 0 | 1 | 2; + type ValidMemberPermissions = - | typeof PermissionFlagBits //discord.js enum - | typeof PermissionFlagBits[] //array of discord.js enum - | string //must be a stringified number + | typeof PermissionFlagsBits //discord.js enum + | Array | bigint interface PublishConfig { - guildIds?: string[]; + guildIds?: Array<`${number}`>; defaultMemberPermissions?: ValidMemberPermissions; - integrationTypes?: Array<'Guild'|'User'> - contexts: number[] + integrationTypes?: Array<'Guild'|'User'>; + contexts?: Array; } type ValidPublishOptions = | PublishConfig @@ -96,7 +103,7 @@ export default commandModule( { guildIds: ["889026545715400705"] }) ], - description: `hello worl`, + description: `hello world`, execute: (ctx) => { ctx.reply('pong') } @@ -104,3 +111,27 @@ export default commandModule( { ``` +### Explanation of each property in the plugin + +:::tip +Not everyone likes to look at Discords Docs, so here you go +::: + +- `guildIds`: Commands will be published to guilds specified. + - Can have more than one guild id to publish certain commands in + - These commands cannot be used in dms. + +- `defaultMemberPermissions`: Only members with specified permissions can view the command + - If you specify more than one, all perms are required! + +- `integrationTypes`: able to specify guild install or user install commands + - 'Guild': Command is only able to be used in guilds + - 'User': Command can be installed to a users profile to be used everywhere (with limitations) + - Guilds with less than 200 members, developer can specify if the command should be invisible to others (ephemeral) + - Guild with >= 200 members, commands will be forced to be invisible by the Discord API. + +- `contexts`: specify where the user installed commands can be used. + - 0: Only available to be used by the user in GUILDS. + - 1: Only available in Bot dms. + - 2: Any private channel, such as a group dm outside of bots dms. + - Also able to use IntegrationContextType enum from `@sern/publisher` if you don't want to use numbers.