mirror of
https://github.com/sern-handler/website
synced 2026-06-28 02:32:23 +00:00
feat: update documentation and clarify documentation
This commit is contained in:
25
.idea/workspace.xml
generated
25
.idea/workspace.xml
generated
@@ -4,9 +4,9 @@
|
||||
<option name="autoReloadType" value="SELECTIVE" />
|
||||
</component>
|
||||
<component name="ChangeListManager">
|
||||
<list default="true" id="53dd69d3-e01a-4656-b414-c727f5aa549a" name="Changes" comment="feat: add image">
|
||||
<change afterPath="$PROJECT_DIR$/blog/2023-01-12-mdx-blog-post.md" afterDir="false" />
|
||||
<list default="true" id="53dd69d3-e01a-4656-b414-c727f5aa549a" name="Changes" comment="feat: update docs and some blog progress">
|
||||
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/blog/2023-01-12-mdx-blog-post.md" beforeDir="false" afterPath="$PROJECT_DIR$/blog/2023-01-12-mdx-blog-post.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/classes/CommandExecutable.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/classes/CommandExecutable.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/classes/Context.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/classes/Context.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/classes/DefaultErrorHandling.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/classes/DefaultErrorHandling.md" afterDir="false" />
|
||||
@@ -15,21 +15,22 @@
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/classes/EventExecutable.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/classes/EventExecutable.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/classes/ModuleStore.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/classes/ModuleStore.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/classes/SernEmitter.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/classes/SernEmitter.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/classes/_category_.yml" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/classes/_category_.yml" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/enums/CommandType.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/enums/CommandType.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/enums/EventType.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/enums/EventType.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/enums/PayloadType.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/enums/PayloadType.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/enums/PluginType.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/enums/PluginType.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/enums/_category_.yml" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/enums/_category_.yml" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/index.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/index.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/AutocompleteCommand.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/AutocompleteCommand.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/BothCommand.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/BothCommand.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/ButtonCommand.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/ButtonCommand.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/ChannelSelectCommand.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/ChannelSelectCommand.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/CommandPlugin.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/CommandPlugin.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/ContextMenuMsg.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/ContextMenuMsg.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/ContextMenuUser.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/ContextMenuUser.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/Controller.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/Controller.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/Dependencies.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/Dependencies.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/ErrorHandling.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/ErrorHandling.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/EventPlugin.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/EventPlugin.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/Logging.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/Logging.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/MentionableSelectCommand.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/MentionableSelectCommand.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/ModalSubmitCommand.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/ModalSubmitCommand.md" afterDir="false" />
|
||||
@@ -45,11 +46,8 @@
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/TextCommand.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/TextCommand.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/UserSelectCommand.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/UserSelectCommand.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/Wrapper.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/Wrapper.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/interfaces/_category_.yml" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/interfaces/_category_.yml" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/modules.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/modules.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/namespaces/Sern.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/namespaces/Sern.md" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docs/api/namespaces/_category_.yml" beforeDir="false" afterPath="$PROJECT_DIR$/docs/api/namespaces/_category_.yml" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/docusaurus.config.js" beforeDir="false" afterPath="$PROJECT_DIR$/docusaurus.config.js" afterDir="false" />
|
||||
</list>
|
||||
<option name="SHOW_DIALOG" value="false" />
|
||||
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
||||
@@ -176,6 +174,7 @@
|
||||
<workItem from="1671030002725" duration="5842000" />
|
||||
<workItem from="1671047161316" duration="3576000" />
|
||||
<workItem from="1671119393024" duration="3889000" />
|
||||
<workItem from="1673974979200" duration="983000" />
|
||||
</task>
|
||||
<task id="LOCAL-00001" summary="feat: remove old index.html in static/">
|
||||
<created>1660418841831</created>
|
||||
@@ -338,7 +337,14 @@
|
||||
<option name="project" value="LOCAL" />
|
||||
<updated>1671123452807</updated>
|
||||
</task>
|
||||
<option name="localTasksCounter" value="24" />
|
||||
<task id="LOCAL-00024" summary="feat: update docs and some blog progress">
|
||||
<created>1673582791487</created>
|
||||
<option name="number" value="00024" />
|
||||
<option name="presentableId" value="LOCAL-00024" />
|
||||
<option name="project" value="LOCAL" />
|
||||
<updated>1673582791487</updated>
|
||||
</task>
|
||||
<option name="localTasksCounter" value="25" />
|
||||
<servers />
|
||||
</component>
|
||||
<component name="TypeScriptGeneratedFilesManager">
|
||||
@@ -378,6 +384,7 @@
|
||||
<MESSAGE value="feat: update typedoc" />
|
||||
<MESSAGE value="feat: try again" />
|
||||
<MESSAGE value="feat: add image" />
|
||||
<option name="LAST_COMMIT_MESSAGE" value="feat: add image" />
|
||||
<MESSAGE value="feat: update docs and some blog progress" />
|
||||
<option name="LAST_COMMIT_MESSAGE" value="feat: update docs and some blog progress" />
|
||||
</component>
|
||||
</project>
|
||||
@@ -13,15 +13,18 @@ Wow! We're increasing our semantic versioning by +0.3.9 <br />
|
||||
What does this mean?
|
||||
|
||||
### Breaking changes
|
||||
- CommandPlugin and EventPlugin have been named [InitPlugin](docs/api/interfaces/InitPlugin) and [ControlPlugin](docs/api/interfaces/ControlPlugin), respectively
|
||||
- The naming of plugins was getting too complex. For example, CommandModuleCommandPlugin, CommandModuleEventPlugin was part of the big mess
|
||||
- The old names still exist in the codebase but will be removed in the next minor.
|
||||
- [controller](docs/api/modules#controller) parameter for plugins has been removed
|
||||
- You'll need to import it instead
|
||||
- This **breaks** old [CommandPlugin](docs/api/interfaces/CommandPlugin), but not old [EventPlugin](docs/api/interfaces/EventPlugin)
|
||||
### Deprecations
|
||||
- [CommandPlugin](docs/api/interfaces/CommandPlugin) and [EventPlugin](docs/api/interfaces/EventPlugin) have been renamed [InitPlugin](docs/api/interfaces/InitPlugin) and [ControlPlugin](docs/api/interfaces/ControlPlugin)
|
||||
|
||||
### Reason
|
||||
- The naming of plugins was getting too complex. For example, plugin naming evolved into CommandModuleCommandPlugin, CommandModuleEventPlugin and more.
|
||||
- I realize that this affects all plugins. I have updated all [plugins](https://github.com/sern-handler/awesome-plugins/pull/68) to match these changes
|
||||
- The old way of declaring plugins has been deprecated in favor of newer functions that facilitate and ease typings
|
||||
- [CommandControlPlugin](docs/api/modules#commandcontrolplugin)
|
||||
- [CommandInitPlugin](docs/api/modules#commandinitplugin)
|
||||
- [EventControlPlugin](docs/api/modules#eventcontrolplugin)
|
||||
- [EventInitPlugin](docs/api/modules#eventinitplugin)
|
||||
- Long are the days of confusing plugin names and types!
|
||||
- [controller](docs/api/modules#controller) parameter for plugins has been removed
|
||||
- You'll need to import it instead
|
||||
- [DiscordEventControlPlugin](docs/api/modules#discordeventcontrolplugin)
|
||||
@@ -36,7 +36,7 @@ Will be refactored / changed in future
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:126](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L126)
|
||||
[src/handler/sern.ts:121](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:125](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L125)
|
||||
[src/handler/sern.ts:120](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L120)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:124](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L124)
|
||||
[src/handler/sern.ts:119](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,4 +66,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:123](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L123)
|
||||
[src/handler/sern.ts:118](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L118)
|
||||
|
||||
@@ -23,7 +23,7 @@ Message and ChatInputCommandInteraction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:22](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L22)
|
||||
[src/handler/structures/context.ts:22](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L22)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -37,7 +37,7 @@ Message and ChatInputCommandInteraction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:45](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L45)
|
||||
[src/handler/structures/context.ts:45](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -51,7 +51,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:75](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L75)
|
||||
[src/handler/structures/context.ts:75](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
@@ -65,7 +65,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L56)
|
||||
[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -79,7 +79,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:60](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L60)
|
||||
[src/handler/structures/context.ts:60](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -93,7 +93,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:64](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L64)
|
||||
[src/handler/structures/context.ts:64](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -107,7 +107,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:41](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L41)
|
||||
[src/handler/structures/context.ts:41](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -121,7 +121,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:79](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L79)
|
||||
[src/handler/structures/context.ts:79](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
@@ -139,7 +139,7 @@ Message
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L37)
|
||||
[src/handler/structures/context.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -153,7 +153,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:71](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L71)
|
||||
[src/handler/structures/context.ts:71](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -171,7 +171,7 @@ ChatInputCommandInteraction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:29](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L29)
|
||||
[src/handler/structures/context.ts:29](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -188,7 +188,7 @@ else, interaction.user
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L52)
|
||||
[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L52)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -202,7 +202,7 @@ else, interaction.user
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:82](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L82)
|
||||
[src/handler/structures/context.ts:82](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
@@ -216,7 +216,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:86](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L86)
|
||||
[src/handler/structures/context.ts:86](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -236,7 +236,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:97](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L97)
|
||||
[src/handler/structures/context.ts:97](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -256,4 +256,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/context.ts:90](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/context.ts#L90)
|
||||
[src/handler/structures/context.ts:90](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/context.ts#L90)
|
||||
|
||||
@@ -30,7 +30,7 @@ Number of times the process should throw an error until crashing and exiting
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/errorHandling.ts:25](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/errorHandling.ts#L25)
|
||||
[src/handler/contracts/errorHandling.ts:24](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/errorHandling.ts#L24)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -56,7 +56,7 @@ Utility function to crash
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/errorHandling.ts:26](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/errorHandling.ts#L26)
|
||||
[src/handler/contracts/errorHandling.ts:25](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/errorHandling.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,4 +82,4 @@ A function that is called on every crash. Updates keepAlive
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/errorHandling.ts:29](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/errorHandling.ts#L29)
|
||||
[src/handler/contracts/errorHandling.ts:28](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/errorHandling.ts#L28)
|
||||
|
||||
@@ -28,7 +28,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L11)
|
||||
[src/handler/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:12](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L12)
|
||||
[src/handler/contracts/logging.ts:12](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:16](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L16)
|
||||
[src/handler/contracts/logging.ts:16](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +100,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:20](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L20)
|
||||
[src/handler/contracts/logging.ts:20](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -124,4 +124,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:24](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L24)
|
||||
[src/handler/contracts/logging.ts:24](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L24)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/moduleManager.ts:14](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/moduleManager.ts#L14)
|
||||
[src/handler/contracts/moduleManager.ts:13](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/moduleManager.ts#L13)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -54,7 +54,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/moduleManager.ts:15](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/moduleManager.ts#L15)
|
||||
[src/handler/contracts/moduleManager.ts:14](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/moduleManager.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,4 +78,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/moduleManager.ts:21](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/moduleManager.ts#L21)
|
||||
[src/handler/contracts/moduleManager.ts:20](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/moduleManager.ts#L20)
|
||||
|
||||
@@ -36,7 +36,7 @@ Will be refactored in future
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:135](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L135)
|
||||
[src/handler/sern.ts:130](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:134](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L134)
|
||||
[src/handler/sern.ts:129](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L129)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:133](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L133)
|
||||
[src/handler/sern.ts:128](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L128)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,4 +66,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:132](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L132)
|
||||
[src/handler/sern.ts:127](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L127)
|
||||
|
||||
@@ -31,7 +31,7 @@ This dependency is usually injected into ModuleManager
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/moduleStore.ts:11](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/moduleStore.ts#L11)
|
||||
[src/handler/structures/moduleStore.ts:11](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/moduleStore.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -41,7 +41,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/moduleStore.ts:10](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/moduleStore.ts#L10)
|
||||
[src/handler/structures/moduleStore.ts:10](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/moduleStore.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/moduleStore.ts:18](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/moduleStore.ts#L18)
|
||||
[src/handler/structures/moduleStore.ts:18](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/moduleStore.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/moduleStore.ts:16](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/moduleStore.ts#L16)
|
||||
[src/handler/structures/moduleStore.ts:16](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/moduleStore.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,4 +82,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/moduleStore.ts:17](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/moduleStore.ts#L17)
|
||||
[src/handler/structures/moduleStore.ts:17](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/moduleStore.ts#L17)
|
||||
|
||||
@@ -160,7 +160,7 @@ EventEmitter.emit
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sernEmitter.ts:34](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sernEmitter.ts#L34)
|
||||
[src/handler/sernEmitter.ts:34](https://github.com/sern-handler/handler/blob/b641472/src/handler/sernEmitter.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -355,7 +355,7 @@ EventEmitter.on
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sernEmitter.ts:12](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sernEmitter.ts#L12)
|
||||
[src/handler/sernEmitter.ts:12](https://github.com/sern-handler/handler/blob/b641472/src/handler/sernEmitter.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
@@ -388,7 +388,7 @@ EventEmitter.once
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sernEmitter.ts:23](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sernEmitter.ts#L23)
|
||||
[src/handler/sernEmitter.ts:23](https://github.com/sern-handler/handler/blob/b641472/src/handler/sernEmitter.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -710,6 +710,8 @@ ___
|
||||
|
||||
▸ `Static` **failure**(`module?`, `reason?`): `never` & { `module?`: [`AnyModule`](../modules.md#anymodule) ; `reason`: `string` \| `Error` ; `type`: [`Failure`](../enums/PayloadType.md#failure) } & { `type`: [`Failure`](../enums/PayloadType.md#failure) } & `never`
|
||||
|
||||
Creates a compliant SernEmitter failure payload
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
@@ -723,7 +725,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sernEmitter.ts:47](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sernEmitter.ts#L47)
|
||||
[src/handler/sernEmitter.ts:53](https://github.com/sern-handler/handler/blob/b641472/src/handler/sernEmitter.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -1123,7 +1125,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sernEmitter.ts:40](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sernEmitter.ts#L40)
|
||||
[src/handler/sernEmitter.ts:40](https://github.com/sern-handler/handler/blob/b641472/src/handler/sernEmitter.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -1172,6 +1174,8 @@ ___
|
||||
|
||||
▸ `Static` **success**(`module`): { `module`: [`AnyModule`](../modules.md#anymodule) ; `type`: [`Success`](../enums/PayloadType.md#success) } & { `type`: [`Success`](../enums/PayloadType.md#success) } & `never` & `never`
|
||||
|
||||
Creates a compliant SernEmitter module success payload
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
@@ -1184,7 +1188,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sernEmitter.ts:56](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sernEmitter.ts#L56)
|
||||
[src/handler/sernEmitter.ts:66](https://github.com/sern-handler/handler/blob/b641472/src/handler/sernEmitter.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -1192,6 +1196,8 @@ ___
|
||||
|
||||
▸ `Static` **warning**(`reason`): `never` & `never` & { `reason`: `string` ; `type`: [`Warning`](../enums/PayloadType.md#warning) } & { `type`: [`Warning`](../enums/PayloadType.md#warning) }
|
||||
|
||||
Creates a compliant SernEmitter module warning payload
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
@@ -1204,4 +1210,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sernEmitter.ts:62](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sernEmitter.ts#L62)
|
||||
[src/handler/sernEmitter.ts:76](https://github.com/sern-handler/handler/blob/b641472/src/handler/sernEmitter.ts#L76)
|
||||
|
||||
@@ -31,7 +31,7 @@ The CommandType for hybrid commands, text and slash
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L28)
|
||||
[src/handler/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -43,7 +43,7 @@ The CommandType for ButtonInteraction commands
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:40](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L40)
|
||||
[src/handler/structures/enums.ts:40](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -55,7 +55,7 @@ The CommandType for the other SelectMenuInteractions
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:52](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L52)
|
||||
[src/handler/structures/enums.ts:52](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -67,7 +67,7 @@ The CommandType for MessageContextMenuInteraction commands
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L36)
|
||||
[src/handler/structures/enums.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -79,7 +79,7 @@ The CommandType for UserContextMenuInteraction commands
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:32](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L32)
|
||||
[src/handler/structures/enums.ts:32](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -89,7 +89,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:53](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L53)
|
||||
[src/handler/structures/enums.ts:53](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -101,7 +101,7 @@ The CommandType for ModalSubmitInteraction commands
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:48](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L48)
|
||||
[src/handler/structures/enums.ts:48](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -111,7 +111,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:54](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L54)
|
||||
[src/handler/structures/enums.ts:54](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -123,7 +123,7 @@ The CommandType for slash commands
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L24)
|
||||
[src/handler/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
@@ -135,7 +135,7 @@ The CommandType for StringSelectMenuInteraction commands
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:44](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L44)
|
||||
[src/handler/structures/enums.ts:44](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -147,7 +147,7 @@ The CommandType for text commands
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L20)
|
||||
[src/handler/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -157,4 +157,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L55)
|
||||
[src/handler/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L55)
|
||||
|
||||
@@ -31,7 +31,7 @@ The EventType for handling discord events
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:77](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L77)
|
||||
[src/handler/structures/enums.ts:77](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ Could be for example, `process` events, database events
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:86](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L86)
|
||||
[src/handler/structures/enums.ts:86](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,4 +56,4 @@ The EventType for handling sern events
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L81)
|
||||
[src/handler/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L81)
|
||||
|
||||
@@ -16,7 +16,7 @@ The PayloadType for a SernEmitter failure event
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:124](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L124)
|
||||
[src/handler/structures/enums.ts:134](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L134)
|
||||
|
||||
___
|
||||
|
||||
@@ -28,7 +28,7 @@ The PayloadType for a SernEmitter success event
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:120](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L120)
|
||||
[src/handler/structures/enums.ts:130](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
@@ -40,4 +40,4 @@ The PayloadType for a SernEmitter warning event
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:128](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L128)
|
||||
[src/handler/structures/enums.ts:138](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L138)
|
||||
|
||||
@@ -22,6 +22,20 @@ export default function myPlugin() : EventPlugin<CommandType.Text> {
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### Command
|
||||
|
||||
• **Command** = ``1``
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
Use PluginType.Init instead
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:112](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
### Control
|
||||
|
||||
• **Control** = ``2``
|
||||
@@ -30,7 +44,21 @@ The PluginType for EventPlugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:111](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L111)
|
||||
[src/handler/structures/enums.ts:121](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
### Event
|
||||
|
||||
• **Event** = ``2``
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
Use PluginType.Control instead
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:117](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L117)
|
||||
|
||||
___
|
||||
|
||||
@@ -42,4 +70,4 @@ The PluginType for InitPlugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/enums.ts:107](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/enums.ts#L107)
|
||||
[src/handler/structures/enums.ts:107](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/enums.ts#L107)
|
||||
|
||||
@@ -35,7 +35,13 @@ yarn add @sern/handler
|
||||
```sh
|
||||
pnpm add @sern/handler
|
||||
```
|
||||
|
||||
## Why?
|
||||
- Most handlers don't support discord.js 14.7+
|
||||
- Customizable commands
|
||||
- Plug and play or customize to your liking
|
||||
- Embraces reactive programming for consistent and reliable backend
|
||||
- Customizable logger, error handling, and more
|
||||
- Active development and growing [community](https://sern.dev/discord)
|
||||
## 👀 Quick Look
|
||||
|
||||
* Support for discord.js v14 and all interactions
|
||||
|
||||
@@ -38,7 +38,7 @@ Omit.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:111](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L111)
|
||||
[src/types/module.ts:111](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L111)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,4 +52,4 @@ Omit.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:110](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L110)
|
||||
[src/types/module.ts:110](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L110)
|
||||
|
||||
@@ -20,7 +20,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:57](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L57)
|
||||
[src/types/module.ts:57](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:58](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L58)
|
||||
[src/types/module.ts:58](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -63,7 +63,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:60](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L60)
|
||||
[src/types/module.ts:60](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -77,7 +77,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -101,7 +101,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:59](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L59)
|
||||
[src/types/module.ts:59](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -115,7 +115,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -129,4 +129,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:56](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L56)
|
||||
[src/types/module.ts:56](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L56)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:75](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L75)
|
||||
[src/types/module.ts:75](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:74](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L74)
|
||||
[src/types/module.ts:74](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L74)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:85](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L85)
|
||||
[src/types/module.ts:85](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:84](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L84)
|
||||
[src/types/module.ts:84](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L84)
|
||||
|
||||
@@ -6,17 +6,15 @@ sidebar_position: 0
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
Use the newer helper functions and import { controller } from '@sern/handler'
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends keyof [`CommandModuleDefs`](../modules.md#commandmoduledefs) = keyof [`CommandModuleDefs`](../modules.md#commandmoduledefs) |
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`Plugin`](Plugin.md)
|
||||
|
||||
↳ **`CommandPlugin`**
|
||||
| `T` | extends [`CommandType`](../enums/CommandType.md) = [`CommandType`](../enums/CommandType.md) |
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -24,44 +22,34 @@ custom_edit_url: null
|
||||
|
||||
• `Optional` **description**: `string`
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
will be removed in the next update
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||
[src/types/plugin.ts:51](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### execute
|
||||
|
||||
• **execute**: (`payload`: { `absPath`: `string` ; `mod`: [`CommandModuleDefs`](../modules.md#commandmoduledefs)[`T`] & { `description`: `string` ; `name`: `string` } }, `controller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||
• **execute**: (`m`: [`InitArgs`](InitArgs.md)<[`Processed`](../modules.md#processed)<[`CommandModule`](../modules.md#commandmodule)\>\>, `controller?`: [`Deprecated`](../modules.md#deprecated)<``"Please import controller instead"``\>) => [`PluginResult`](../modules.md#pluginresult)
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`payload`, `controller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||
▸ (`m`, `controller?`): [`PluginResult`](../modules.md#pluginresult)
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | `Object` |
|
||||
| `payload.absPath` | `string` |
|
||||
| `payload.mod` | [`CommandModuleDefs`](../modules.md#commandmoduledefs)[`T`] & { `description`: `string` ; `name`: `string` } |
|
||||
| `controller` | [`Controller`](Controller.md) |
|
||||
| `m` | [`InitArgs`](InitArgs.md)<[`Processed`](../modules.md#processed)<[`CommandModule`](../modules.md#commandmodule)\>\> |
|
||||
| `controller?` | [`Deprecated`](../modules.md#deprecated)<``"Please import controller instead"``\> |
|
||||
|
||||
##### Returns
|
||||
|
||||
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||
[`PluginResult`](../modules.md#pluginresult)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:39](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L39)
|
||||
[src/types/plugin.ts:53](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -69,28 +57,16 @@ ___
|
||||
|
||||
• `Optional` **name**: `string`
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
will be removed in the next update
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:31](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31)
|
||||
[src/types/plugin.ts:50](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`Command`](../enums/PluginType.md#command)
|
||||
|
||||
#### Overrides
|
||||
|
||||
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||
• **type**: [`Init`](../enums/PluginType.md#init)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:38](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L38)
|
||||
[src/types/plugin.ts:52](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L52)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:70](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L70)
|
||||
[src/types/module.ts:70](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:69](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L69)
|
||||
[src/types/module.ts:69](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L69)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:65](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L65)
|
||||
[src/types/module.ts:65](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:64](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L64)
|
||||
[src/types/module.ts:64](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L64)
|
||||
|
||||
@@ -22,7 +22,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:26](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L26)
|
||||
[src/types/plugin.ts:25](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -40,4 +40,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:27](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L27)
|
||||
[src/types/plugin.ts:26](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L26)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:39](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L39)
|
||||
[src/types/handler.ts:40](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:41](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L41)
|
||||
[src/types/handler.ts:42](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:44](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L44)
|
||||
[src/types/handler.ts:45](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:40](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L40)
|
||||
[src/types/handler.ts:41](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:43](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L43)
|
||||
[src/types/handler.ts:44](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,4 +64,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:42](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L42)
|
||||
[src/types/handler.ts:43](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L43)
|
||||
|
||||
@@ -20,7 +20,7 @@ Number of times the process should throw an error until crashing and exiting
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/errorHandling.ts:9](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/errorHandling.ts#L9)
|
||||
[src/handler/contracts/errorHandling.ts:8](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/errorHandling.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -42,7 +42,7 @@ Utility function to crash
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/errorHandling.ts:15](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/errorHandling.ts#L15)
|
||||
[src/handler/contracts/errorHandling.ts:14](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/errorHandling.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,4 +64,4 @@ A function that is called on every crash. Updates keepAlive
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/errorHandling.ts:21](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/errorHandling.ts#L21)
|
||||
[src/handler/contracts/errorHandling.ts:20](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/errorHandling.ts#L20)
|
||||
|
||||
@@ -1,22 +1,20 @@
|
||||
---
|
||||
id: "EventPlugin"
|
||||
title: "Interface: EventPlugin<K>"
|
||||
title: "Interface: EventPlugin<T>"
|
||||
sidebar_label: "EventPlugin"
|
||||
sidebar_position: 0
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
Use the newer helper functions
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `K` | extends keyof [`CommandModuleDefs`](../modules.md#commandmoduledefs) = keyof [`CommandModuleDefs`](../modules.md#commandmoduledefs) |
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`Plugin`](Plugin.md)
|
||||
|
||||
↳ **`EventPlugin`**
|
||||
| `T` | extends [`CommandType`](../enums/CommandType.md) |
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -24,42 +22,34 @@ custom_edit_url: null
|
||||
|
||||
• `Optional` **description**: `string`
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
will be removed in the next update
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||
[src/types/plugin.ts:61](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
### execute
|
||||
|
||||
• **execute**: (`event`: `Parameters`<[`CommandModuleDefs`](../modules.md#commandmoduledefs)[`K`][``"execute"``]\>, `controller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||
• **execute**: (`args`: [`CommandArgs`](../modules.md#commandargs)<`T`, [`Event`](../enums/PluginType.md#event)\>, `controller?`: [`Controller`](Controller.md)) => [`PluginResult`](../modules.md#pluginresult)
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`event`, `controller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||
▸ (`args`, `controller?`): [`PluginResult`](../modules.md#pluginresult)
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `event` | `Parameters`<[`CommandModuleDefs`](../modules.md#commandmoduledefs)[`K`][``"execute"``]\> |
|
||||
| `controller` | [`Controller`](Controller.md) |
|
||||
| `args` | [`CommandArgs`](../modules.md#commandargs)<`T`, [`Event`](../enums/PluginType.md#event)\> |
|
||||
| `controller?` | [`Controller`](Controller.md) |
|
||||
|
||||
##### Returns
|
||||
|
||||
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||
[`PluginResult`](../modules.md#pluginresult)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:82](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L82)
|
||||
[src/types/plugin.ts:63](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
@@ -67,17 +57,9 @@ ___
|
||||
|
||||
• `Optional` **name**: `string`
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
will be removed in the next update
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:31](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31)
|
||||
[src/types/plugin.ts:60](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -85,10 +67,6 @@ ___
|
||||
|
||||
• **type**: [`Event`](../enums/PluginType.md#event)
|
||||
|
||||
#### Overrides
|
||||
|
||||
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/plugin.ts:81](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L81)
|
||||
[src/types/plugin.ts:62](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L62)
|
||||
|
||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L7)
|
||||
[src/handler/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:4](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L4)
|
||||
[src/handler/contracts/logging.ts:4](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L4)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L6)
|
||||
[src/handler/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,4 +94,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/logging.ts#L5)
|
||||
[src/handler/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/logging.ts#L5)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:95](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L95)
|
||||
[src/types/module.ts:95](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L95)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:94](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L94)
|
||||
[src/types/module.ts:94](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L94)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:105](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L105)
|
||||
[src/types/module.ts:105](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L105)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:104](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L104)
|
||||
[src/types/module.ts:104](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L104)
|
||||
|
||||
@@ -48,7 +48,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:39](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L39)
|
||||
[src/types/module.ts:39](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +92,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,4 +112,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:34](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L34)
|
||||
[src/types/module.ts:34](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L34)
|
||||
|
||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/moduleManager.ts:7](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/moduleManager.ts#L7)
|
||||
[src/handler/contracts/moduleManager.ts:6](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/moduleManager.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,4 +54,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/contracts/moduleManager.ts:10](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/contracts/moduleManager.ts#L10)
|
||||
[src/handler/contracts/moduleManager.ts:9](https://github.com/sern-handler/handler/blob/b641472/src/handler/contracts/moduleManager.ts#L9)
|
||||
|
||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:26](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L26)
|
||||
[src/types/plugin.ts:30](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:25](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L25)
|
||||
[src/types/plugin.ts:29](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L29)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:90](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L90)
|
||||
[src/types/module.ts:90](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:89](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L89)
|
||||
[src/types/module.ts:89](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L89)
|
||||
|
||||
@@ -20,7 +20,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:177](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L177)
|
||||
[src/types/module.ts:177](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L177)
|
||||
|
||||
___
|
||||
|
||||
@@ -30,7 +30,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:182](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L182)
|
||||
[src/types/module.ts:182](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L182)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,4 +110,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:178](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L178)
|
||||
[src/types/module.ts:178](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L178)
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:214](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L214)
|
||||
[src/types/module.ts:214](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L214)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,7 +104,7 @@ BaseApplicationCommandOptionsData.required
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:213](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L213)
|
||||
[src/types/module.ts:213](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L213)
|
||||
|
||||
___
|
||||
|
||||
@@ -114,4 +114,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:212](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L212)
|
||||
[src/types/module.ts:212](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L212)
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:220](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L220)
|
||||
[src/types/module.ts:220](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L220)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,7 +104,7 @@ BaseApplicationCommandOptionsData.required
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:219](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L219)
|
||||
[src/types/module.ts:219](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L219)
|
||||
|
||||
___
|
||||
|
||||
@@ -114,4 +114,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:218](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L218)
|
||||
[src/types/module.ts:218](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L218)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:50](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L50)
|
||||
[src/types/module.ts:50](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -53,7 +53,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:52](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L52)
|
||||
[src/types/module.ts:52](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -67,7 +67,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -81,7 +81,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:51](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L51)
|
||||
[src/types/module.ts:51](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -105,7 +105,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -119,4 +119,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:49](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L49)
|
||||
[src/types/module.ts:49](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L49)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:80](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L80)
|
||||
[src/types/module.ts:80](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:79](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L79)
|
||||
[src/types/module.ts:79](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L79)
|
||||
|
||||
@@ -20,7 +20,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:44](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L44)
|
||||
[src/types/module.ts:44](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -63,7 +63,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:45](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L45)
|
||||
[src/types/module.ts:45](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -77,7 +77,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -105,7 +105,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -119,4 +119,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:43](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L43)
|
||||
[src/types/module.ts:43](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L43)
|
||||
|
||||
@@ -24,7 +24,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L38)
|
||||
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:100](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L100)
|
||||
[src/types/module.ts:100](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L35)
|
||||
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L36)
|
||||
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L37)
|
||||
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:99](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L99)
|
||||
[src/types/module.ts:99](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L99)
|
||||
|
||||
@@ -16,7 +16,7 @@ An object to be passed into Sern#init() function.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/wrapper.ts:9](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/wrapper.ts#L9)
|
||||
[src/handler/structures/wrapper.ts:9](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/wrapper.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -32,7 +32,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/wrapper.ts#L11)
|
||||
[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/wrapper.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -42,7 +42,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/wrapper.ts:8](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/wrapper.ts#L8)
|
||||
[src/handler/structures/wrapper.ts:8](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/wrapper.ts#L8)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,4 +52,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/structures/wrapper.ts:10](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/structures/wrapper.ts#L10)
|
||||
[src/handler/structures/wrapper.ts:10](https://github.com/sern-handler/handler/blob/b641472/src/handler/structures/wrapper.ts#L10)
|
||||
|
||||
@@ -16,6 +16,7 @@ custom_edit_url: null
|
||||
- [EventType](enums/EventType.md)
|
||||
- [PayloadType](enums/PayloadType.md)
|
||||
- [PluginType](enums/PluginType.md)
|
||||
- [SernError](enums/SernError.md)
|
||||
|
||||
## Classes
|
||||
|
||||
@@ -34,12 +35,16 @@ custom_edit_url: null
|
||||
- [BothCommand](interfaces/BothCommand.md)
|
||||
- [ButtonCommand](interfaces/ButtonCommand.md)
|
||||
- [ChannelSelectCommand](interfaces/ChannelSelectCommand.md)
|
||||
- [CommandPlugin](interfaces/CommandPlugin.md)
|
||||
- [ContextMenuMsg](interfaces/ContextMenuMsg.md)
|
||||
- [ContextMenuUser](interfaces/ContextMenuUser.md)
|
||||
- [ControlPlugin](interfaces/ControlPlugin.md)
|
||||
- [Controller](interfaces/Controller.md)
|
||||
- [Dependencies](interfaces/Dependencies.md)
|
||||
- [DependencyConfiguration](interfaces/DependencyConfiguration.md)
|
||||
- [DiscordEventCommand](interfaces/DiscordEventCommand.md)
|
||||
- [ErrorHandling](interfaces/ErrorHandling.md)
|
||||
- [EventPlugin](interfaces/EventPlugin.md)
|
||||
- [ExternalEventCommand](interfaces/ExternalEventCommand.md)
|
||||
- [InitArgs](interfaces/InitArgs.md)
|
||||
- [InitPlugin](interfaces/InitPlugin.md)
|
||||
@@ -68,7 +73,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:38](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L38)
|
||||
[src/types/plugin.ts:42](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -81,7 +86,7 @@ are provided to Module. This type represents that transformation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:23](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L23)
|
||||
[src/types/handler.ts:24](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:39](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L39)
|
||||
[src/types/plugin.ts:43](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -101,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:150](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L150)
|
||||
[src/types/module.ts:150](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L150)
|
||||
|
||||
___
|
||||
|
||||
@@ -111,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:15](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L15)
|
||||
[src/types/handler.ts:16](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
@@ -121,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:46](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L46)
|
||||
[src/types/plugin.ts:68](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
@@ -133,7 +138,7 @@ Type that replaces autocomplete with [SernAutocompleteData](interfaces/SernAutoc
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:203](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L203)
|
||||
[src/types/module.ts:203](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L203)
|
||||
|
||||
___
|
||||
|
||||
@@ -150,7 +155,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/args.ts:109](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/plugins/args.ts#L109)
|
||||
[src/handler/plugins/args.ts:109](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/args.ts#L109)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +165,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:136](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L136)
|
||||
[src/types/module.ts:136](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L136)
|
||||
|
||||
___
|
||||
|
||||
@@ -187,7 +192,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:154](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L154)
|
||||
[src/types/module.ts:154](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L154)
|
||||
|
||||
___
|
||||
|
||||
@@ -197,23 +202,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:185](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L185)
|
||||
|
||||
___
|
||||
|
||||
### CommandPlugin
|
||||
|
||||
Ƭ **CommandPlugin**<`T`\>: [`Deprecated`](modules.md#deprecated)<``"Please use InitPlugin instead: "``\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends keyof [`CommandModuleDefs`](modules.md#commandmoduledefs) = keyof [`CommandModuleDefs`](modules.md#commandmoduledefs) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:41](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L41)
|
||||
[src/types/module.ts:185](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L185)
|
||||
|
||||
___
|
||||
|
||||
@@ -229,7 +218,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:64](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L64)
|
||||
[src/types/handler.ts:65](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -239,7 +228,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:43](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L43)
|
||||
[src/types/plugin.ts:65](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -249,7 +238,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:50](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L50)
|
||||
[src/types/plugin.ts:71](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -266,7 +255,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/args.ts:113](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/plugins/args.ts#L113)
|
||||
[src/handler/plugins/args.ts:113](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/args.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -276,7 +265,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:135](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L135)
|
||||
[src/types/module.ts:135](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L135)
|
||||
|
||||
___
|
||||
|
||||
@@ -294,7 +283,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:169](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L169)
|
||||
[src/types/module.ts:169](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L169)
|
||||
|
||||
___
|
||||
|
||||
@@ -304,17 +293,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:188](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L188)
|
||||
|
||||
___
|
||||
|
||||
### EventPlugin
|
||||
|
||||
Ƭ **EventPlugin**: [`Deprecated`](modules.md#deprecated)<``"Please view alternatives: "``\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:47](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L47)
|
||||
[src/types/module.ts:188](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L188)
|
||||
|
||||
___
|
||||
|
||||
@@ -324,7 +303,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:44](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L44)
|
||||
[src/types/plugin.ts:66](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -334,7 +313,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:49](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L49)
|
||||
[src/types/plugin.ts:70](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
@@ -344,7 +323,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:196](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L196)
|
||||
[src/types/module.ts:196](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L196)
|
||||
|
||||
___
|
||||
|
||||
@@ -354,7 +333,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:192](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L192)
|
||||
[src/types/module.ts:192](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L192)
|
||||
|
||||
___
|
||||
|
||||
@@ -376,7 +355,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:34](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L34)
|
||||
[src/types/handler.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -393,7 +372,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:52](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L52)
|
||||
[src/types/handler.ts:53](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -403,7 +382,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:62](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L62)
|
||||
[src/types/handler.ts:63](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
@@ -419,7 +398,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:11](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L11)
|
||||
[src/types/handler.ts:12](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
@@ -429,7 +408,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:24](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L24)
|
||||
[src/types/handler.ts:25](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -439,7 +418,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:21](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L21)
|
||||
[src/types/plugin.ts:21](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -449,13 +428,13 @@ ___
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends [`Module`](interfaces/Module.md) |
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:63](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L63)
|
||||
[src/types/handler.ts:64](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -465,7 +444,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:47](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L47)
|
||||
[src/types/handler.ts:48](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -475,7 +454,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:45](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L45)
|
||||
[src/types/plugin.ts:67](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
@@ -485,7 +464,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:48](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L48)
|
||||
[src/types/plugin.ts:69](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
@@ -504,7 +483,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:28](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L28)
|
||||
[src/types/handler.ts:29](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -520,7 +499,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/module.ts:223](https://github.com/sern-handler/handler/blob/404a8c7/src/types/module.ts#L223)
|
||||
[src/types/module.ts:223](https://github.com/sern-handler/handler/blob/b641472/src/types/module.ts#L223)
|
||||
|
||||
___
|
||||
|
||||
@@ -544,7 +523,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:35](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L35)
|
||||
[src/types/handler.ts:36](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -554,7 +533,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:17](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L17)
|
||||
[src/types/handler.ts:18](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
@@ -584,7 +563,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/handler.ts:36](https://github.com/sern-handler/handler/blob/404a8c7/src/types/handler.ts#L36)
|
||||
[src/types/handler.ts:37](https://github.com/sern-handler/handler/blob/b641472/src/types/handler.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -594,7 +573,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/plugin.ts:22](https://github.com/sern-handler/handler/blob/404a8c7/src/types/plugin.ts#L22)
|
||||
[src/types/plugin.ts:22](https://github.com/sern-handler/handler/blob/b641472/src/types/plugin.ts#L22)
|
||||
|
||||
## Variables
|
||||
|
||||
@@ -613,7 +592,17 @@ The object passed into every plugin to control a command's behavior
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:56](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L56)
|
||||
[src/handler/sern.ts:55](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### guayin
|
||||
|
||||
• `Const` **guayin**: typeof [`guayin`](modules.md#guayin)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/createPlugin.ts:5](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/createPlugin.ts#L5)
|
||||
|
||||
## Functions
|
||||
|
||||
@@ -631,7 +620,7 @@ The object passed into every plugin to control a command's behavior
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `execute` | (...`args`: [`CommandArgs`](modules.md#commandargs)<`I`, [`Control`](enums/PluginType.md#control)\>) => [`PluginResult`](modules.md#pluginresult) |
|
||||
| `execute` | (...`args`: [`CommandArgs`](modules.md#commandargs)<`I`, [`Event`](enums/PluginType.md#event)\>) => [`PluginResult`](modules.md#pluginresult) |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -639,7 +628,7 @@ The object passed into every plugin to control a command's behavior
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/createPlugin.ts:28](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/plugins/createPlugin.ts#L28)
|
||||
[src/handler/plugins/createPlugin.ts:29](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/createPlugin.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -665,7 +654,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/createPlugin.ts:22](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/plugins/createPlugin.ts#L22)
|
||||
[src/handler/plugins/createPlugin.ts:23](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/createPlugin.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -697,7 +686,7 @@ Will probably be moved one day!
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/createPlugin.ts:45](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/plugins/createPlugin.ts#L45)
|
||||
[src/handler/plugins/createPlugin.ts:46](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/createPlugin.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -715,7 +704,7 @@ ___
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `execute` | (...`args`: [`EventArgs`](modules.md#eventargs)<`I`, [`Control`](enums/PluginType.md#control)\>) => [`PluginResult`](modules.md#pluginresult) |
|
||||
| `execute` | (...`args`: [`EventArgs`](modules.md#eventargs)<`I`, [`Event`](enums/PluginType.md#event)\>) => [`PluginResult`](modules.md#pluginresult) |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -723,7 +712,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/createPlugin.ts:34](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/plugins/createPlugin.ts#L34)
|
||||
[src/handler/plugins/createPlugin.ts:35](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/createPlugin.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -749,7 +738,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/createPlugin.ts:16](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/plugins/createPlugin.ts#L16)
|
||||
[src/handler/plugins/createPlugin.ts:17](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/createPlugin.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
@@ -771,7 +760,7 @@ The wrapper function to define command modules for sern
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:65](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L65)
|
||||
[src/handler/sern.ts:64](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -804,7 +793,7 @@ where typings can be very bad.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:98](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L98)
|
||||
[src/handler/sern.ts:97](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -826,7 +815,7 @@ The wrapper function to define event modules for sern
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:80](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L80)
|
||||
[src/handler/sern.ts:79](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
@@ -853,7 +842,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/plugins/createPlugin.ts:6](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/plugins/createPlugin.ts#L6)
|
||||
[src/handler/plugins/createPlugin.ts:6](https://github.com/sern-handler/handler/blob/b641472/src/handler/plugins/createPlugin.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -861,8 +850,7 @@ ___
|
||||
|
||||
▸ **many**<`T`\>(`value`): () => () => `T`
|
||||
|
||||
A function that returns another function
|
||||
Used for transient in iti
|
||||
**`Deprecated`**
|
||||
|
||||
#### Type parameters
|
||||
|
||||
@@ -872,9 +860,9 @@ Used for transient in iti
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `value` | `T` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `value` | `T` | Please use the transient function instead |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -894,28 +882,27 @@ Used for transient in iti
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/utilities/functions.ts:17](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/utilities/functions.ts#L17)
|
||||
[src/handler/dependencies/lifetimeFunctions.ts:50](https://github.com/sern-handler/handler/blob/b641472/src/handler/dependencies/lifetimeFunctions.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### single
|
||||
|
||||
▸ **single**<`T`\>(`value`): () => `T`
|
||||
▸ **single**<`T`\>(`cb`): () => `T`
|
||||
|
||||
A function that returns whatever value is provided.
|
||||
Used for singleton in iti
|
||||
**`Deprecated`**
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends `NotFunction` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `value` | `T` |
|
||||
| `cb` | `T` |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -929,21 +916,117 @@ Used for singleton in iti
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/utilities/functions.ts:10](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/utilities/functions.ts#L10)
|
||||
[src/handler/dependencies/lifetimeFunctions.ts:11](https://github.com/sern-handler/handler/blob/b641472/src/handler/dependencies/lifetimeFunctions.ts#L11)
|
||||
|
||||
▸ **single**<`T`\>(`cb`): `T`
|
||||
|
||||
New signature
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends () => `unknown` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `cb` | `T` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`T`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/dependencies/lifetimeFunctions.ts:16](https://github.com/sern-handler/handler/blob/b641472/src/handler/dependencies/lifetimeFunctions.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### transient
|
||||
|
||||
▸ **transient**<`T`\>(`cb`): () => () => `T`
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends `NotFunction` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cb` | `T` | Deprecated signature |
|
||||
|
||||
#### Returns
|
||||
|
||||
`fn`
|
||||
|
||||
▸ (): () => `T`
|
||||
|
||||
##### Returns
|
||||
|
||||
`fn`
|
||||
|
||||
▸ (): `T`
|
||||
|
||||
##### Returns
|
||||
|
||||
`T`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/dependencies/lifetimeFunctions.ts:32](https://github.com/sern-handler/handler/blob/b641472/src/handler/dependencies/lifetimeFunctions.ts#L32)
|
||||
|
||||
▸ **transient**<`T`\>(`cb`): `T`
|
||||
|
||||
Following iti's singleton and transient implementation,
|
||||
use transient if you want a new dependency every time your container getter is called
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends () => () => `unknown` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `cb` | `T` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`T`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/dependencies/lifetimeFunctions.ts:33](https://github.com/sern-handler/handler/blob/b641472/src/handler/dependencies/lifetimeFunctions.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### useContainerRaw
|
||||
|
||||
▸ **useContainerRaw**(): ``null`` \| `Container`<[`Dependencies`](interfaces/Dependencies.md), `Partial`<[`Dependencies`](interfaces/Dependencies.md)\>\>
|
||||
▸ **useContainerRaw**<`T`\>(): `Container`<`T`, {}\>
|
||||
|
||||
Returns the underlying data structure holding all dependencies.
|
||||
Please be careful as this only gets the client's current state.
|
||||
Exposes some methods from iti
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends [`Dependencies`](interfaces/Dependencies.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `Container`<[`Dependencies`](interfaces/Dependencies.md), `Partial`<[`Dependencies`](interfaces/Dependencies.md)\>\>
|
||||
`Container`<`T`, {}\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/dependencies/provider.ts:87](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/dependencies/provider.ts#L87)
|
||||
[src/handler/dependencies/provider.ts:54](https://github.com/sern-handler/handler/blob/b641472/src/handler/dependencies/provider.ts#L54)
|
||||
|
||||
@@ -73,7 +73,7 @@ Sern.init({
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:39](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L39)
|
||||
[src/handler/sern.ts:38](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,9 +91,7 @@ ___
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `conf` | `Object` | a configuration for creating your project dependencies |
|
||||
| `conf.build` | (`root`: `Container`<`Record`<`string`, `any`\>, {}\>) => `Container`<`Partial`<`T`\>, `T`\> | - |
|
||||
| `conf.exclude?` | `Set`<``"@sern/logger"``\> | - |
|
||||
| `conf` | [`DependencyConfiguration`](../interfaces/DependencyConfiguration.md)<`T`\> | a configuration for creating your project dependencies |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -119,4 +117,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/handler/sern.ts:108](https://github.com/sern-handler/handler/blob/404a8c7/src/handler/sern.ts#L108)
|
||||
[src/handler/sern.ts:107](https://github.com/sern-handler/handler/blob/b641472/src/handler/sern.ts#L107)
|
||||
|
||||
Reference in New Issue
Block a user