From 784d50b8a718e4aa620d8fb1c0dd50d23ffbb6fa Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Tue, 27 Sep 2022 14:33:41 -0500
Subject: [PATCH 1/7] feat: adding blogs
---
.idea/workspace.xml | 90 ++++++++++++++++----
_blog/_2021-08-01-mdx-blog-post.mdx | 15 ----
blog/2021-08-01-mdx-blog-post.mdx | 23 +++++
{_blog => blog}/authors.yml | 0
docs/api/classes/CommandExecutable.md | 65 +++++++++++++++
docs/api/classes/Context.md | 32 +++----
docs/api/classes/EventExecutable.md | 65 +++++++++++++++
docs/api/classes/SernEmitter.md | 20 ++---
docs/api/enums/CommandType.md | 16 ++--
docs/api/enums/EventType.md | 8 +-
docs/api/enums/PayloadType.md | 6 +-
docs/api/enums/PluginType.md | 4 +-
docs/api/index.md | 67 ++++++++++-----
docs/api/interfaces/Controller.md | 4 +-
docs/api/interfaces/Wrapper.md | 10 +--
docs/api/modules.md | 116 +++++++++++---------------
docs/api/namespaces/Sern.md | 26 ++++--
docusaurus.config.js | 30 +++----
18 files changed, 404 insertions(+), 193 deletions(-)
delete mode 100644 _blog/_2021-08-01-mdx-blog-post.mdx
create mode 100644 blog/2021-08-01-mdx-blog-post.mdx
rename {_blog => blog}/authors.yml (100%)
create mode 100644 docs/api/classes/CommandExecutable.md
create mode 100644 docs/api/classes/EventExecutable.md
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 868d76b0b..4e018906b 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -1,8 +1,29 @@
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -21,7 +42,7 @@
@@ -45,24 +66,36 @@
- {
- "keyToString": {
- "ASKED_SHARE_PROJECT_CONFIGURATION_FILES": "true",
- "RunOnceActivity.OpenProjectViewOnStart": "true",
- "RunOnceActivity.ShowReadmeOnStart": "true",
- "WebServerToolWindowFactoryState": "false",
- "nodejs_package_manager_path": "npm",
- "project.structure.last.edited": "Modules",
- "project.structure.proportion": "0.0",
- "project.structure.side.proportion": "0.0"
+
+}]]>
-
+
+
+
+
+
+
+
+
+
+
+
@@ -73,9 +106,21 @@
+
+
+
+
+
+
+
+
+
+
+
+
@@ -91,7 +136,10 @@
-
+
+
+
+
1660418841831
@@ -156,7 +204,14 @@
1661890861168
-
+
+ 1661963793586
+
+
+
+ 1661963793586
+
+
@@ -182,6 +237,7 @@
-
+
+
\ No newline at end of file
diff --git a/_blog/_2021-08-01-mdx-blog-post.mdx b/_blog/_2021-08-01-mdx-blog-post.mdx
deleted file mode 100644
index 5a08c598b..000000000
--- a/_blog/_2021-08-01-mdx-blog-post.mdx
+++ /dev/null
@@ -1,15 +0,0 @@
----
-slug: the-why-in-everything
-title: why
-authors: [jacoobes]
-tags: []
----
-
-Yes, yet another discord.js handler.
-
-
Why?
-
Why??
-
-
-There are so many discord.js handlers out there. So why another one? Here's the thing. Most handlers you see out there are
-poorly made, not maintained, unknown bugs, or who knows what.
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
new file mode 100644
index 000000000..3570072a5
--- /dev/null
+++ b/blog/2021-08-01-mdx-blog-post.mdx
@@ -0,0 +1,23 @@
+---
+slug: 1.2.0
+title: Release 1.2.0
+authors: [jacoobes]
+tags: [release]
+---
+
+## Class-based modules
+
+Today we're announcing the ability to create class based modules!
+To get started, install
+```
+npm install @sern/handler@latest
+```
+
+Quick List of changes!
+- [Class based modules](#class-based-modules)
+- [Deprecation Warnings](#deprecation-warnings)
+- [Dependencies update](#dependencies-update)
+
+
+
+### Class based modules
diff --git a/_blog/authors.yml b/blog/authors.yml
similarity index 100%
rename from _blog/authors.yml
rename to blog/authors.yml
diff --git a/docs/api/classes/CommandExecutable.md b/docs/api/classes/CommandExecutable.md
new file mode 100644
index 000000000..d14c2c8d3
--- /dev/null
+++ b/docs/api/classes/CommandExecutable.md
@@ -0,0 +1,65 @@
+---
+id: "CommandExecutable"
+title: "Class: CommandExecutable"
+sidebar_label: "CommandExecutable"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Type` | extends [`CommandType`](../enums/CommandType.md) |
+
+## Constructors
+
+### constructor
+
+• **new CommandExecutable**<`Type`\>()
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Type` | extends [`CommandType`](../enums/CommandType.md) |
+
+## Properties
+
+### execute
+
+• `Abstract` **execute**: `CommandModuleDefs`[`Type`][``"execute"``]
+
+#### Defined in
+
+[src/handler/sern.ts:132](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L132)
+
+___
+
+### onEvent
+
+• **onEvent**: [`EventPlugin`](../modules.md#eventplugin)<`Type`\>[] = `[]`
+
+#### Defined in
+
+[src/handler/sern.ts:131](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L131)
+
+___
+
+### plugins
+
+• **plugins**: [`CommandPlugin`](../modules.md#commandplugin)<`Type`\>[] = `[]`
+
+#### Defined in
+
+[src/handler/sern.ts:130](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L130)
+
+___
+
+### type
+
+• `Abstract` **type**: `Type`
+
+#### Defined in
+
+[src/handler/sern.ts:129](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L129)
diff --git a/docs/api/classes/Context.md b/docs/api/classes/Context.md
index fa512b004..3da63e88f 100644
--- a/docs/api/classes/Context.md
+++ b/docs/api/classes/Context.md
@@ -24,7 +24,7 @@ Message and ChatInputCommandInteraction
#### Defined in
-[src/handler/structures/context.ts:31](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L31)
+[src/handler/structures/context.ts:31](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L31)
## Accessors
@@ -38,7 +38,7 @@ Message and ChatInputCommandInteraction
#### Defined in
-[src/handler/structures/context.ts:63](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L63)
+[src/handler/structures/context.ts:63](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L63)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:108](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L108)
+[src/handler/structures/context.ts:108](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L108)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:77](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L77)
+[src/handler/structures/context.ts:77](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L77)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:84](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L84)
+[src/handler/structures/context.ts:84](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L84)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:91](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L91)
+[src/handler/structures/context.ts:91](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L91)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L56)
+[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L56)
___
@@ -122,7 +122,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:115](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L115)
+[src/handler/structures/context.ts:115](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L115)
___
@@ -140,7 +140,7 @@ Message
#### Defined in
-[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L52)
+[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L52)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:101](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L101)
+[src/handler/structures/context.ts:101](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L101)
___
@@ -172,7 +172,7 @@ ChatInputCommandInteraction
#### Defined in
-[src/handler/structures/context.ts:44](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L44)
+[src/handler/structures/context.ts:44](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L44)
___
@@ -186,7 +186,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:70](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L70)
+[src/handler/structures/context.ts:70](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L70)
## Methods
@@ -200,7 +200,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:129](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L129)
+[src/handler/structures/context.ts:129](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L129)
___
@@ -212,7 +212,7 @@ ___
| Name | Type |
| :------ | :------ |
-| `content` | `string` \| `Omit`<`InteractionReplyOptions`, ``"fetchReply"``\> \| `ReplyMessageOptions` |
+| `content` | [`ReplyOptions`](../modules.md#replyoptions) |
#### Returns
@@ -220,7 +220,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:133](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L133)
+[src/handler/structures/context.ts:133](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L133)
___
@@ -240,4 +240,4 @@ ___
#### Defined in
-[src/handler/structures/context.ts:122](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L122)
+[src/handler/structures/context.ts:122](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L122)
diff --git a/docs/api/classes/EventExecutable.md b/docs/api/classes/EventExecutable.md
new file mode 100644
index 000000000..03f8a74f9
--- /dev/null
+++ b/docs/api/classes/EventExecutable.md
@@ -0,0 +1,65 @@
+---
+id: "EventExecutable"
+title: "Class: EventExecutable"
+sidebar_label: "EventExecutable"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Type` | extends [`EventType`](../enums/EventType.md) |
+
+## Constructors
+
+### constructor
+
+• **new EventExecutable**<`Type`\>()
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Type` | extends [`EventType`](../enums/EventType.md) |
+
+## Properties
+
+### execute
+
+• `Abstract` **execute**: `EventModuleDefs`[`Type`][``"execute"``]
+
+#### Defined in
+
+[src/handler/sern.ts:139](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L139)
+
+___
+
+### onEvent
+
+• **onEvent**: [`EventModuleEventPluginDefs`](../modules.md#eventmoduleeventplugindefs)[`Type`][] = `[]`
+
+#### Defined in
+
+[src/handler/sern.ts:138](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L138)
+
+___
+
+### plugins
+
+• **plugins**: [`EventModuleCommandPluginDefs`](../modules.md#eventmodulecommandplugindefs)[`Type`][] = `[]`
+
+#### Defined in
+
+[src/handler/sern.ts:137](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L137)
+
+___
+
+### type
+
+• `Abstract` **type**: `Type`
+
+#### Defined in
+
+[src/handler/sern.ts:136](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L136)
diff --git a/docs/api/classes/SernEmitter.md b/docs/api/classes/SernEmitter.md
index e1afd0d27..d26bfa7a3 100644
--- a/docs/api/classes/SernEmitter.md
+++ b/docs/api/classes/SernEmitter.md
@@ -160,7 +160,7 @@ EventEmitter.emit
#### Defined in
-[src/handler/sernEmitter.ts:32](https://github.com/sern-handler/handler/blob/2009593/src/handler/sernEmitter.ts#L32)
+[src/handler/sernEmitter.ts:32](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sernEmitter.ts#L32)
___
@@ -355,7 +355,7 @@ EventEmitter.on
#### Defined in
-[src/handler/sernEmitter.ts:10](https://github.com/sern-handler/handler/blob/2009593/src/handler/sernEmitter.ts#L10)
+[src/handler/sernEmitter.ts:10](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sernEmitter.ts#L10)
___
@@ -388,7 +388,7 @@ EventEmitter.once
#### Defined in
-[src/handler/sernEmitter.ts:21](https://github.com/sern-handler/handler/blob/2009593/src/handler/sernEmitter.ts#L21)
+[src/handler/sernEmitter.ts:21](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sernEmitter.ts#L21)
___
@@ -438,7 +438,7 @@ ___
▸ **prependOnceListener**(`eventName`, `listener`): [`SernEmitter`](SernEmitter.md)
-Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this
+Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
```js
@@ -586,8 +586,8 @@ listener array for the specified `eventName`, then `removeListener()` must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
-time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will
-not remove them from`emit()` in progress. Subsequent events behave as expected.
+time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution
+will not remove them from`emit()` in progress. Subsequent events behave as expected.
```js
const myEmitter = new MyEmitter();
@@ -888,7 +888,7 @@ EventEmitter.on
node_modules/@types/node/events.d.ts:217
-▸ `Static` **on**<`K`\>(`eventEmitter`, `eventName`): `AsyncIterator`<`ClientEvents`[`K`], `any`, `undefined`\>
+▸ `Static` **on**<`K`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`ClientEvents`[`K`]\>
#### Type parameters
@@ -905,7 +905,7 @@ node_modules/@types/node/events.d.ts:217
#### Returns
-`AsyncIterator`<`ClientEvents`[`K`], `any`, `undefined`\>
+`AsyncIterableIterator`<`ClientEvents`[`K`]\>
#### Inherited from
@@ -913,7 +913,7 @@ EventEmitter.on
#### Defined in
-node_modules/discord.js/typings/index.d.ts:195
+node_modules/discord.js/typings/index.d.ts:197
___
@@ -1072,7 +1072,7 @@ EventEmitter.once
#### Defined in
-node_modules/discord.js/typings/index.d.ts:194
+node_modules/discord.js/typings/index.d.ts:196
___
diff --git a/docs/api/enums/CommandType.md b/docs/api/enums/CommandType.md
index ca2a1c8d7..ccc993586 100644
--- a/docs/api/enums/CommandType.md
+++ b/docs/api/enums/CommandType.md
@@ -29,7 +29,7 @@ The CommandType for hybrid commands, text and slash
#### Defined in
-[src/handler/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L27)
+[src/handler/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L27)
___
@@ -41,7 +41,7 @@ The CommandType for ButtonInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:39](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L39)
+[src/handler/structures/enums.ts:39](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L39)
___
@@ -53,7 +53,7 @@ The CommandType for MessageContextMenuInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:35](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L35)
+[src/handler/structures/enums.ts:35](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L35)
___
@@ -65,7 +65,7 @@ The CommandType for SelectMenuInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:43](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L43)
+[src/handler/structures/enums.ts:43](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L43)
___
@@ -77,7 +77,7 @@ The CommandType for UserContextMenuInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:31](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L31)
+[src/handler/structures/enums.ts:31](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L31)
___
@@ -89,7 +89,7 @@ The CommandType for ModalSubmitInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:47](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L47)
+[src/handler/structures/enums.ts:47](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L47)
___
@@ -101,7 +101,7 @@ The CommandType for slash commands
#### Defined in
-[src/handler/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L23)
+[src/handler/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L23)
___
@@ -113,4 +113,4 @@ The CommandType for text commands
#### Defined in
-[src/handler/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L19)
+[src/handler/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L19)
diff --git a/docs/api/enums/EventType.md b/docs/api/enums/EventType.md
index bdd27b006..98bd26a83 100644
--- a/docs/api/enums/EventType.md
+++ b/docs/api/enums/EventType.md
@@ -12,7 +12,7 @@ custom_edit_url: null
export default eventModule({
//highlight-next-line
type : EventType.Discord,
- name : 'guildMemberAdd'
+ name : 'guildMemberAdd',
execute(member : GuildMember) {
console.log(member)
}
@@ -29,7 +29,7 @@ The EventType for handling discord events
#### Defined in
-[src/handler/structures/enums.ts:68](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L68)
+[src/handler/structures/enums.ts:68](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L68)
___
@@ -42,7 +42,7 @@ Could be for example, `process` events, database events
#### Defined in
-[src/handler/structures/enums.ts:77](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L77)
+[src/handler/structures/enums.ts:77](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L77)
___
@@ -54,4 +54,4 @@ The EventType for handling sern events
#### Defined in
-[src/handler/structures/enums.ts:72](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L72)
+[src/handler/structures/enums.ts:72](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L72)
diff --git a/docs/api/enums/PayloadType.md b/docs/api/enums/PayloadType.md
index 5767d5ffc..28a6350a9 100644
--- a/docs/api/enums/PayloadType.md
+++ b/docs/api/enums/PayloadType.md
@@ -16,7 +16,7 @@ The PayloadType for a SernEmitter failure event
#### Defined in
-[src/handler/structures/enums.ts:114](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L114)
+[src/handler/structures/enums.ts:114](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L114)
___
@@ -28,7 +28,7 @@ The PayloadType for a SernEmitter success event
#### Defined in
-[src/handler/structures/enums.ts:110](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L110)
+[src/handler/structures/enums.ts:110](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L110)
___
@@ -40,4 +40,4 @@ The PayloadType for a SernEmitter warning event
#### Defined in
-[src/handler/structures/enums.ts:118](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L118)
+[src/handler/structures/enums.ts:118](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L118)
diff --git a/docs/api/enums/PluginType.md b/docs/api/enums/PluginType.md
index 0e6a6cb2c..53b9c3437 100644
--- a/docs/api/enums/PluginType.md
+++ b/docs/api/enums/PluginType.md
@@ -28,7 +28,7 @@ The PluginType for CommandPlugins
#### Defined in
-[src/handler/structures/enums.ts:97](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L97)
+[src/handler/structures/enums.ts:97](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L97)
___
@@ -40,4 +40,4 @@ The PluginType for EventPlugins
#### Defined in
-[src/handler/structures/enums.ts:101](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L101)
+[src/handler/structures/enums.ts:101](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L101)
diff --git a/docs/api/index.md b/docs/api/index.md
index d3ed3f054..12f3c2d92 100644
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -6,16 +6,23 @@ sidebar_position: 0
custom_edit_url: null
---
-# SernHandler
+
+

+
-
-
-
+Handlers. Redefined.
+A customizable, batteries-included, powerful discord.js framework to streamline bot development.
+
-A customizable, batteries-included, powerful discord.js framework to automate and streamline your bot development.
-
-## Installation
+## 📜 Installation
```sh
npm install @sern/handler
@@ -29,13 +36,26 @@ yarn add @sern/handler
pnpm add @sern/handler
```
-## Basic Usage
+## 👀 Quick Look
+
+* Support for discord.js v14 and all interactions
+* Hybrid commands
+* lightweight and customizable
+* ESM, CommonJS and TypeScript support
+* A powerful cli and awesome community-made plugins
+
+## 👶 Basic Usage
#### ` index.js (CommonJS)`
```js
+// Import the discord.js Client and GatewayIntentBits
const { Client, GatewayIntentBits } = require('discord.js');
+
+// Import Sern namespace
const { Sern } = require('@sern/handler');
+
+// Our configuration file
const { defaultPrefix, token } = require('./config.json');
const client = new Client({
@@ -47,9 +67,9 @@ const client = new Client({
});
Sern.init({
- client,
- defaultPrefix,
- commands : 'src/commands',
+ client,
+ defaultPrefix,
+ commands : 'src/commands',
});
client.login(token);
@@ -58,34 +78,35 @@ client.login(token);
#### ` ping.js (CommonJS)`
```js
-const { Sern, CommandType, commandModule } = require('@sern/handler');
+const { CommandType, commandModule } = require('@sern/handler');
exports.default = commandModule({
- description: 'A ping pong command',
- type: CommandType.Slash,
- execute(ctx) {
- ctx.reply('pong!');
- }
- });
+ name: 'ping',
+ description: 'A ping pong command',
+ type: CommandType.Slash,
+ execute(ctx) {
+ ctx.reply('pong!');
+ }
+});
```
See our [templates](https://github.com/sern-handler/templates) for TypeScript examples and more
-## CLI
+## 💻 CLI
It is **highly encouraged** to use the [command line interface](https://github.com/sern-handler/cli) for your project. Don't forget to view it.
-## Links
+## 🔗 Links
-- [Official Documentation](https://sern-handler.js.org)
+- [Official Documentation and Guide](https://sern-handler.js.org)
- [Support Server](https://discord.com/invite/mmyCTnYtbF)
-## Contribute
+## 👋 Contribute
- Read our contribution [guidelines](https://github.com/sern-handler/handler) carefully
- Pull up on [issues](https://github.com/sern-handler/handler/issues) and report bugs
- All kinds of contributions are welcomed.
-## Roadmap
+## 🚈 Roadmap
You can check our [roadmap](https://github.com/sern-handler/roadmap) to see what's going to be added or patched in the future.
diff --git a/docs/api/interfaces/Controller.md b/docs/api/interfaces/Controller.md
index 751b1e730..26d709705 100644
--- a/docs/api/interfaces/Controller.md
+++ b/docs/api/interfaces/Controller.md
@@ -22,7 +22,7 @@ custom_edit_url: null
#### Defined in
-[src/handler/plugins/plugin.ts:29](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L29)
+[src/handler/plugins/plugin.ts:29](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L29)
___
@@ -40,4 +40,4 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:30](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L30)
+[src/handler/plugins/plugin.ts:30](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L30)
diff --git a/docs/api/interfaces/Wrapper.md b/docs/api/interfaces/Wrapper.md
index b30da2bb7..a3f12a8e0 100644
--- a/docs/api/interfaces/Wrapper.md
+++ b/docs/api/interfaces/Wrapper.md
@@ -16,7 +16,7 @@ An object to be passed into Sern#init() function.
#### Defined in
-[src/handler/structures/wrapper.ts:10](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L10)
+[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L11)
___
@@ -26,7 +26,7 @@ ___
#### Defined in
-[src/handler/structures/wrapper.ts:13](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L13)
+[src/handler/structures/wrapper.ts:15](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L15)
___
@@ -36,7 +36,7 @@ ___
#### Defined in
-[src/handler/structures/wrapper.ts:12](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L12)
+[src/handler/structures/wrapper.ts:14](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L14)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[src/handler/structures/wrapper.ts:14](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L14)
+[src/handler/structures/wrapper.ts:16](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L16)
___
@@ -56,4 +56,4 @@ ___
#### Defined in
-[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L11)
+[src/handler/structures/wrapper.ts:13](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L13)
diff --git a/docs/api/modules.md b/docs/api/modules.md
index 132f88281..503ea2b06 100644
--- a/docs/api/modules.md
+++ b/docs/api/modules.md
@@ -19,7 +19,9 @@ custom_edit_url: null
## Classes
+- [CommandExecutable](classes/CommandExecutable.md)
- [Context](classes/Context.md)
+- [EventExecutable](classes/EventExecutable.md)
- [SernEmitter](classes/SernEmitter.md)
## Interfaces
@@ -35,7 +37,7 @@ custom_edit_url: null
#### Defined in
-[src/types/handler.ts:11](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L11)
+[src/types/handler.ts:12](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L12)
___
@@ -45,7 +47,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:92](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L92)
+[src/handler/plugins/plugin.ts:92](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L92)
___
@@ -57,7 +59,7 @@ Type that replaces autocomplete with [SernAutocompleteData](modules.md#sernautoc
#### Defined in
-[src/handler/structures/module.ts:181](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L181)
+[src/handler/structures/module.ts:181](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L181)
___
@@ -67,7 +69,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:55](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L55)
+[src/handler/structures/module.ts:55](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L55)
___
@@ -77,7 +79,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:145](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L145)
+[src/handler/plugins/plugin.ts:145](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L145)
___
@@ -93,7 +95,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:173](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L173)
+[src/handler/plugins/plugin.ts:173](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L173)
___
@@ -109,7 +111,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:40](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L40)
+[src/handler/plugins/plugin.ts:40](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L40)
___
@@ -119,7 +121,7 @@ ___
#### Defined in
-[src/types/handler.ts:48](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L48)
+[src/types/handler.ts:43](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L43)
___
@@ -129,7 +131,7 @@ ___
#### Defined in
-[src/types/handler.ts:49](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L49)
+[src/types/handler.ts:44](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L44)
___
@@ -142,7 +144,7 @@ are provided to Module. This type represents that transformation
#### Defined in
-[src/types/handler.ts:47](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L47)
+[src/types/handler.ts:42](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L42)
___
@@ -159,7 +161,7 @@ ___
#### Defined in
-[src/types/handler.ts:18](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L18)
+[src/types/handler.ts:19](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L19)
___
@@ -169,7 +171,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:57](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L57)
+[src/handler/plugins/plugin.ts:57](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L57)
___
@@ -185,7 +187,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:136](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L136)
+[src/handler/plugins/plugin.ts:136](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L136)
___
@@ -195,7 +197,7 @@ ___
#### Defined in
-[src/types/handler.ts:24](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L24)
+[src/types/handler.ts:25](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L25)
___
@@ -215,7 +217,7 @@ Event Module Command Plugins
#### Defined in
-[src/handler/plugins/plugin.ts:163](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L163)
+[src/handler/plugins/plugin.ts:163](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L163)
___
@@ -235,7 +237,7 @@ Event Module Event Plugins
#### Defined in
-[src/handler/plugins/plugin.ts:154](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L154)
+[src/handler/plugins/plugin.ts:154](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L154)
___
@@ -251,7 +253,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:169](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L169)
+[src/handler/plugins/plugin.ts:169](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L169)
___
@@ -261,7 +263,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:148](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L148)
+[src/handler/plugins/plugin.ts:148](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L148)
___
@@ -277,7 +279,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:103](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L103)
+[src/handler/plugins/plugin.ts:103](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L103)
___
@@ -293,7 +295,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:68](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L68)
+[src/handler/plugins/plugin.ts:68](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L68)
___
@@ -303,7 +305,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:128](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L128)
+[src/handler/plugins/plugin.ts:128](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L128)
___
@@ -315,7 +317,7 @@ User inputs this type. Sern processes behind the scenes for better usage
#### Defined in
-[src/handler/plugins/plugin.ts:178](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L178)
+[src/handler/plugins/plugin.ts:178](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L178)
___
@@ -325,23 +327,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:182](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L182)
-
-___
-
-### IsOptional
-
-Ƭ **IsOptional**<`T`\>: { [K in keyof T]-?: T[K] extends Required[K] ? false : true }
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-#### Defined in
-
-[src/types/handler.ts:31](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L31)
+[src/handler/plugins/plugin.ts:182](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L182)
___
@@ -351,7 +337,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:141](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L141)
+[src/handler/structures/module.ts:141](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L141)
___
@@ -367,7 +353,7 @@ ___
#### Defined in
-[src/types/handler.ts:4](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L4)
+[src/types/handler.ts:5](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L5)
___
@@ -384,7 +370,7 @@ ___
#### Defined in
-[src/types/handler.ts:16](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L16)
+[src/types/handler.ts:17](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L17)
___
@@ -400,33 +386,27 @@ ___
#### Defined in
-[src/types/handler.ts:7](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L7)
+[src/types/handler.ts:8](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L8)
___
### Payload
-Ƭ **Payload**: { `module`: [`Module`](modules.md#module) ; `type`: [`Success`](enums/PayloadType.md#success) } \| { `module`: [`Module`](modules.md#module) \| `undefined` ; `reason`: `string` \| `Error` ; `type`: [`Failure`](enums/PayloadType.md#failure) }
+Ƭ **Payload**: { `module`: [`Module`](modules.md#module) ; `type`: [`Success`](enums/PayloadType.md#success) } \| { `module?`: [`Module`](modules.md#module) ; `reason`: `string` \| `Error` ; `type`: [`Failure`](enums/PayloadType.md#failure) }
#### Defined in
-[src/types/handler.ts:50](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L50)
+[src/types/handler.ts:45](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L45)
___
-### Reconstruct
+### ReplyOptions
-Ƭ **Reconstruct**<`T`\>: `T` extends `Omit` ? `O` & [`Reconstruct`](modules.md#reconstruct)<`O`\> : `T`
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
+Ƭ **ReplyOptions**: `string` \| `Omit`<`InteractionReplyOptions`, ``"fetchReply"``\> \| `MessageReplyOptions`
#### Defined in
-[src/types/handler.ts:29](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L29)
+[src/types/handler.ts:55](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L55)
___
@@ -436,7 +416,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:166](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L166)
+[src/handler/structures/module.ts:166](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L166)
___
@@ -446,7 +426,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:80](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L80)
+[src/handler/plugins/plugin.ts:80](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L80)
___
@@ -462,7 +442,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:116](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L116)
+[src/handler/plugins/plugin.ts:116](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L116)
___
@@ -474,14 +454,14 @@ ___
| Name | Type |
| :------ | :------ |
-| `error` | [`Error` \| `string`] |
+| `error` | [[`Payload`](modules.md#payload)] |
| `module.activate` | [[`Payload`](modules.md#payload)] |
| `module.register` | [[`Payload`](modules.md#payload)] |
| `warning` | [`string`] |
#### Defined in
-[src/types/handler.ts:53](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L53)
+[src/types/handler.ts:48](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L48)
___
@@ -497,7 +477,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:205](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L205)
+[src/handler/structures/module.ts:205](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L205)
___
@@ -507,7 +487,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:189](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L189)
+[src/handler/structures/module.ts:189](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L189)
___
@@ -517,7 +497,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:197](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L197)
+[src/handler/structures/module.ts:197](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L197)
___
@@ -527,7 +507,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:44](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L44)
+[src/handler/structures/module.ts:44](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L44)
___
@@ -537,7 +517,7 @@ ___
#### Defined in
-[src/types/handler.ts:13](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L13)
+[src/types/handler.ts:14](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L14)
___
@@ -570,7 +550,7 @@ Turns a function with a union of array of args into a single union
#### Defined in
-[src/types/handler.ts:39](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L39)
+[src/types/handler.ts:34](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L34)
___
@@ -580,7 +560,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:33](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L33)
+[src/handler/structures/module.ts:33](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L33)
## Functions
@@ -602,7 +582,7 @@ The wrapper function to define command modules for sern
#### Defined in
-[src/handler/sern.ts:86](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L86)
+[src/handler/sern.ts:91](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L91)
___
@@ -624,4 +604,4 @@ The wrapper function to define event modules for sern
#### Defined in
-[src/handler/sern.ts:107](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L107)
+[src/handler/sern.ts:112](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L112)
diff --git a/docs/api/namespaces/Sern.md b/docs/api/namespaces/Sern.md
index 256c67726..acb07660b 100644
--- a/docs/api/namespaces/Sern.md
+++ b/docs/api/namespaces/Sern.md
@@ -8,6 +8,18 @@ custom_edit_url: null
## References
+### CommandExecutable
+
+Re-exports [CommandExecutable](../classes/CommandExecutable.md)
+
+___
+
+### EventExecutable
+
+Re-exports [EventExecutable](../classes/EventExecutable.md)
+
+___
+
### commandModule
Re-exports [commandModule](../modules.md#commandmodule)
@@ -35,7 +47,7 @@ The object passed into every plugin to control a command's behavior
#### Defined in
-[src/handler/sern.ts:77](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L77)
+[src/handler/sern.ts:82](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L82)
## Functions
@@ -43,6 +55,10 @@ The object passed into every plugin to control a command's behavior
▸ **addExternal**<`T`\>(`emitter`): `void`
+**`Deprecated`**
+
+- use Sern#makeDependencies instead
+
**`Example`**
```ts title="src/index.ts"
@@ -73,7 +89,7 @@ Sern.addExternal(new Level())
| Name | Type | Description |
| :------ | :------ | :------ |
-| `emitter` | `T` | Any external event emitter. The object will be stored in a map, and then fetched by the name of the instance's class. As there are infinite possibilities to adding external event emitters, Most types aren't provided and are as narrow as possibly can. |
+| `emitter` | `T` | Any external event emitter. The object will be stored in a map, and then fetched by the name of the instance's class. As there are infinite possibilities to adding external event emitters, Most types aren't provided and are as narrow as possibly can. |
#### Returns
@@ -81,7 +97,7 @@ Sern.addExternal(new Level())
#### Defined in
-[src/handler/sern.ts:67](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L67)
+[src/handler/sern.ts:72](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L72)
___
@@ -103,7 +119,7 @@ Sern.init({
| Name | Type | Description |
| :------ | :------ | :------ |
-| `wrapper` | [`Wrapper`](../interfaces/Wrapper.md) | Options to pass into sern. Function to start the handler up |
+| `wrapper` | [`Wrapper`](../interfaces/Wrapper.md) | Options to pass into sern. Function to start the handler up |
#### Returns
@@ -111,4 +127,4 @@ Sern.init({
#### Defined in
-[src/handler/sern.ts:34](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L34)
+[src/handler/sern.ts:39](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L39)
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 0be3bc37b..5711e5900 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -82,7 +82,7 @@ const config = {
position: 'left',
label: 'docs & guide',
},
- //{to: '/blog', label: 'blog', position: 'left'},
+ {to: '/blog', label: 'blog', position: 'left'},
{
href: 'https://github.com/sern-handler',
label: 'GitHub',
@@ -127,10 +127,10 @@ const config = {
{
title: 'More',
items: [
- // { //this was causing the build err
- // label: 'blog',
- // to: '/blog',
- // },
+ {
+ label: 'blog',
+ to: '/blog',
+ },
{
label: 'GitHub',
href: 'https://github.com/sern-handler',
@@ -159,16 +159,16 @@ const config = {
darkTheme: darkCodeTheme,
},
}),
- // plugins : [
- // [
- // 'docusaurus-plugin-typedoc',
- // {
- // //if you're editing website, please change this to your local branch of sern to generate documentation
- // entryPoints: ['../sernHandlerV2/src/index.ts'],
- // tsconfig: '../sernHandlerV2/tsconfig-base.json',
- // },
- // ]
- // ]
+ plugins : [
+ [
+ 'docusaurus-plugin-typedoc',
+ {
+ //if you're editing website, please change this to your local branch of sern to generate documentation
+ entryPoints: ['../sernHandlerV2/src/index.ts'],
+ tsconfig: '../sernHandlerV2/tsconfig-esm.json',
+ },
+ ]
+ ]
};
module.exports = config;
From 62e0d6a61ecfd66bdcac310ad8ee3fadc8d89a10 Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Wed, 28 Sep 2022 00:20:58 -0500
Subject: [PATCH 2/7] feat: blogwork
---
.idea/workspace.xml | 57 +++++++++---------
blog/2021-08-01-mdx-blog-post.md | 80 +++++++++++++++++++++++++
blog/2021-08-01-mdx-blog-post.mdx | 23 --------
docs/api/classes/CommandExecutable.md | 8 +--
docs/api/classes/Context.md | 30 +++++-----
docs/api/classes/EventExecutable.md | 8 +--
docs/api/classes/SernEmitter.md | 6 +-
docs/api/enums/CommandType.md | 16 ++---
docs/api/enums/EventType.md | 8 +--
docs/api/enums/PayloadType.md | 6 +-
docs/api/enums/PluginType.md | 4 +-
docs/api/interfaces/Controller.md | 4 +-
docs/api/interfaces/Wrapper.md | 10 ++--
docs/api/modules.md | 84 +++++++++++++--------------
docs/api/namespaces/Sern.md | 6 +-
15 files changed, 206 insertions(+), 144 deletions(-)
create mode 100644 blog/2021-08-01-mdx-blog-post.md
delete mode 100644 blog/2021-08-01-mdx-blog-post.mdx
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 4e018906b..73bccdd01 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,26 +4,22 @@
-
+
+
-
-
+
+
+
-
-
-
-
-
-
@@ -42,7 +38,7 @@
@@ -66,20 +62,20 @@
- {
+ "keyToString": {
+ "ASKED_SHARE_PROJECT_CONFIGURATION_FILES": "true",
+ "Git.Branch.Popup.ShowAllRemotes": "true",
+ "RunOnceActivity.OpenProjectViewOnStart": "true",
+ "RunOnceActivity.ShowReadmeOnStart": "true",
+ "WebServerToolWindowFactoryState": "false",
+ "last_opened_file_path": "C:/Users/jacob/OneDrive/Desktop/Projects/sern/website",
+ "nodejs_package_manager_path": "npm",
+ "project.structure.last.edited": "Modules",
+ "project.structure.proportion": "0.0",
+ "project.structure.side.proportion": "0.0"
}
-}]]>
+}
@@ -139,7 +135,8 @@
-
+
+
1660418841831
@@ -211,7 +208,14 @@
1661963793586
-
+
+ 1664307221790
+
+
+
+ 1664307221790
+
+
@@ -238,6 +242,7 @@
-
+
+
\ No newline at end of file
diff --git a/blog/2021-08-01-mdx-blog-post.md b/blog/2021-08-01-mdx-blog-post.md
new file mode 100644
index 000000000..9722294d3
--- /dev/null
+++ b/blog/2021-08-01-mdx-blog-post.md
@@ -0,0 +1,80 @@
+---
+slug: 1.2.0
+title: Release 1.2.0
+authors: [jacoobes]
+tags: [release]
+---
+
+## Class-based modules
+
+Today we're announcing the ability to create class based modules!
+To get started, install
+```
+npm install @sern/handler@latest
+```
+
+Quick List of changes!
+- [Class based modules](#class-based-modules)
+- [Deprecation Warnings](#deprecation-warnings)
+- [Dependencies update](#dependencies-update)
+
+
+
+### Class based modules
+Incorporate class based modules into your project instead of the traditional `commandModule` or `eventModule`
+Extend the new [CommandExecutable](../docs/api/classes/CommandExecutable) or [EventExecutable](../docs/api/classes/EventExecutable)
+```ts title="commands/meaning-of-life.ts"
+import { CommandType, CommandExecutable, type Args, type Context } from "@sern/handler";
+import { publish } from "../plugins/publish.js";
+import { serendipityOnly } from "../plugins/serendipityOnly.js";
+
+export default class extends CommandExecutable {
+
+ type = CommandType.Both as const;
+ description = 'What is the meaning of life?'
+ override onEvent = [
+ serendipityOnly()
+ ];
+ override plugins = [
+ publish(),
+ ];
+ // highlight-next-line
+ execute = async (ctx: Context, args: Args) => {
+ await ctx.reply('42')
+ };
+}
+```
+:::caution
+
+execute must be a member function. It should be as above, a property on the class!
+
+:::
+
+```ts title="commands/guildMemberAdd.ts"
+import { CommandType, EventExecutable, type EventType } from "@sern/handler";
+import type { GuildMember } from 'discord.js'
+export default class extends EventExecutable {
+
+ type = EventType.Discord as const;
+ // highlight-next-line
+ execute = (member: GuildMember) => {
+ console.log(member)
+ };
+}
+```
+Now, you might ask **why** this feature was added.
Simply put, to give flexibility to the developers.
+In addition, **decorators now unofficially work with modules!**
+Feel free to use TypeScript experimental decorators to augment and customize your classes.
+
+### Deprecation Warnings
+The next update will bring sern v2 with some important features. Here are some things to watch out for.
+
+- [Wrapper#client](../docs/api/interfaces/Wrapper) will be deprecated
+- [Wrapper#sernEmitter](../docs/api/interfaces/Wrapper) will be deprecated
+ - a SernEmitter will be automatically created once Sern#init is called
+- The option to pass in a function or array for [Wrapper#events](../docs/api/interfaces/Wrapper) will be deprecated. Only strings are accepted.
+- [Sern#addExternal](../docs/api/classes/SernEmitter) will be deprecated in favor of a better way.
+
+### Dependencies Update
+- TypeScript has been updated to 4.8.3
+- Discord.js has been upgraded to 14.5
\ No newline at end of file
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
deleted file mode 100644
index 3570072a5..000000000
--- a/blog/2021-08-01-mdx-blog-post.mdx
+++ /dev/null
@@ -1,23 +0,0 @@
----
-slug: 1.2.0
-title: Release 1.2.0
-authors: [jacoobes]
-tags: [release]
----
-
-## Class-based modules
-
-Today we're announcing the ability to create class based modules!
-To get started, install
-```
-npm install @sern/handler@latest
-```
-
-Quick List of changes!
-- [Class based modules](#class-based-modules)
-- [Deprecation Warnings](#deprecation-warnings)
-- [Dependencies update](#dependencies-update)
-
-
-
-### Class based modules
diff --git a/docs/api/classes/CommandExecutable.md b/docs/api/classes/CommandExecutable.md
index d14c2c8d3..7d85d55db 100644
--- a/docs/api/classes/CommandExecutable.md
+++ b/docs/api/classes/CommandExecutable.md
@@ -32,7 +32,7 @@ custom_edit_url: null
#### Defined in
-[src/handler/sern.ts:132](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L132)
+[src/handler/sern.ts:132](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L132)
___
@@ -42,7 +42,7 @@ ___
#### Defined in
-[src/handler/sern.ts:131](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L131)
+[src/handler/sern.ts:131](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L131)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
-[src/handler/sern.ts:130](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L130)
+[src/handler/sern.ts:130](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L130)
___
@@ -62,4 +62,4 @@ ___
#### Defined in
-[src/handler/sern.ts:129](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L129)
+[src/handler/sern.ts:129](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L129)
diff --git a/docs/api/classes/Context.md b/docs/api/classes/Context.md
index 3da63e88f..9b6a4b024 100644
--- a/docs/api/classes/Context.md
+++ b/docs/api/classes/Context.md
@@ -24,7 +24,7 @@ Message and ChatInputCommandInteraction
#### Defined in
-[src/handler/structures/context.ts:31](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L31)
+[src/handler/structures/context.ts:31](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L31)
## Accessors
@@ -38,7 +38,7 @@ Message and ChatInputCommandInteraction
#### Defined in
-[src/handler/structures/context.ts:63](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L63)
+[src/handler/structures/context.ts:63](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L63)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:108](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L108)
+[src/handler/structures/context.ts:108](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L108)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:77](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L77)
+[src/handler/structures/context.ts:77](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L77)
___
@@ -80,7 +80,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:84](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L84)
+[src/handler/structures/context.ts:84](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L84)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:91](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L91)
+[src/handler/structures/context.ts:91](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L91)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L56)
+[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L56)
___
@@ -122,7 +122,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:115](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L115)
+[src/handler/structures/context.ts:115](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L115)
___
@@ -140,7 +140,7 @@ Message
#### Defined in
-[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L52)
+[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L52)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:101](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L101)
+[src/handler/structures/context.ts:101](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L101)
___
@@ -172,7 +172,7 @@ ChatInputCommandInteraction
#### Defined in
-[src/handler/structures/context.ts:44](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L44)
+[src/handler/structures/context.ts:44](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L44)
___
@@ -186,7 +186,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:70](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L70)
+[src/handler/structures/context.ts:70](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L70)
## Methods
@@ -200,7 +200,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:129](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L129)
+[src/handler/structures/context.ts:129](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L129)
___
@@ -220,7 +220,7 @@ ___
#### Defined in
-[src/handler/structures/context.ts:133](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L133)
+[src/handler/structures/context.ts:133](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L133)
___
@@ -240,4 +240,4 @@ ___
#### Defined in
-[src/handler/structures/context.ts:122](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/context.ts#L122)
+[src/handler/structures/context.ts:122](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L122)
diff --git a/docs/api/classes/EventExecutable.md b/docs/api/classes/EventExecutable.md
index 03f8a74f9..f03c1aaed 100644
--- a/docs/api/classes/EventExecutable.md
+++ b/docs/api/classes/EventExecutable.md
@@ -32,7 +32,7 @@ custom_edit_url: null
#### Defined in
-[src/handler/sern.ts:139](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L139)
+[src/handler/sern.ts:139](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L139)
___
@@ -42,7 +42,7 @@ ___
#### Defined in
-[src/handler/sern.ts:138](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L138)
+[src/handler/sern.ts:138](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L138)
___
@@ -52,7 +52,7 @@ ___
#### Defined in
-[src/handler/sern.ts:137](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L137)
+[src/handler/sern.ts:137](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L137)
___
@@ -62,4 +62,4 @@ ___
#### Defined in
-[src/handler/sern.ts:136](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L136)
+[src/handler/sern.ts:136](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L136)
diff --git a/docs/api/classes/SernEmitter.md b/docs/api/classes/SernEmitter.md
index d26bfa7a3..ed4898018 100644
--- a/docs/api/classes/SernEmitter.md
+++ b/docs/api/classes/SernEmitter.md
@@ -160,7 +160,7 @@ EventEmitter.emit
#### Defined in
-[src/handler/sernEmitter.ts:32](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sernEmitter.ts#L32)
+[src/handler/sernEmitter.ts:32](https://github.com/sern-handler/handler/blob/4074274/src/handler/sernEmitter.ts#L32)
___
@@ -355,7 +355,7 @@ EventEmitter.on
#### Defined in
-[src/handler/sernEmitter.ts:10](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sernEmitter.ts#L10)
+[src/handler/sernEmitter.ts:10](https://github.com/sern-handler/handler/blob/4074274/src/handler/sernEmitter.ts#L10)
___
@@ -388,7 +388,7 @@ EventEmitter.once
#### Defined in
-[src/handler/sernEmitter.ts:21](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sernEmitter.ts#L21)
+[src/handler/sernEmitter.ts:21](https://github.com/sern-handler/handler/blob/4074274/src/handler/sernEmitter.ts#L21)
___
diff --git a/docs/api/enums/CommandType.md b/docs/api/enums/CommandType.md
index ccc993586..44a6e9994 100644
--- a/docs/api/enums/CommandType.md
+++ b/docs/api/enums/CommandType.md
@@ -29,7 +29,7 @@ The CommandType for hybrid commands, text and slash
#### Defined in
-[src/handler/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L27)
+[src/handler/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L27)
___
@@ -41,7 +41,7 @@ The CommandType for ButtonInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:39](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L39)
+[src/handler/structures/enums.ts:39](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L39)
___
@@ -53,7 +53,7 @@ The CommandType for MessageContextMenuInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:35](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L35)
+[src/handler/structures/enums.ts:35](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L35)
___
@@ -65,7 +65,7 @@ The CommandType for SelectMenuInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:43](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L43)
+[src/handler/structures/enums.ts:43](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L43)
___
@@ -77,7 +77,7 @@ The CommandType for UserContextMenuInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:31](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L31)
+[src/handler/structures/enums.ts:31](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L31)
___
@@ -89,7 +89,7 @@ The CommandType for ModalSubmitInteraction commands
#### Defined in
-[src/handler/structures/enums.ts:47](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L47)
+[src/handler/structures/enums.ts:47](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L47)
___
@@ -101,7 +101,7 @@ The CommandType for slash commands
#### Defined in
-[src/handler/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L23)
+[src/handler/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L23)
___
@@ -113,4 +113,4 @@ The CommandType for text commands
#### Defined in
-[src/handler/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L19)
+[src/handler/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L19)
diff --git a/docs/api/enums/EventType.md b/docs/api/enums/EventType.md
index 98bd26a83..483c0f1c8 100644
--- a/docs/api/enums/EventType.md
+++ b/docs/api/enums/EventType.md
@@ -12,7 +12,7 @@ custom_edit_url: null
export default eventModule({
//highlight-next-line
type : EventType.Discord,
- name : 'guildMemberAdd',
+ name : 'guildMemberAdd'
execute(member : GuildMember) {
console.log(member)
}
@@ -29,7 +29,7 @@ The EventType for handling discord events
#### Defined in
-[src/handler/structures/enums.ts:68](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L68)
+[src/handler/structures/enums.ts:68](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L68)
___
@@ -42,7 +42,7 @@ Could be for example, `process` events, database events
#### Defined in
-[src/handler/structures/enums.ts:77](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L77)
+[src/handler/structures/enums.ts:77](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L77)
___
@@ -54,4 +54,4 @@ The EventType for handling sern events
#### Defined in
-[src/handler/structures/enums.ts:72](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L72)
+[src/handler/structures/enums.ts:72](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L72)
diff --git a/docs/api/enums/PayloadType.md b/docs/api/enums/PayloadType.md
index 28a6350a9..3da33a32a 100644
--- a/docs/api/enums/PayloadType.md
+++ b/docs/api/enums/PayloadType.md
@@ -16,7 +16,7 @@ The PayloadType for a SernEmitter failure event
#### Defined in
-[src/handler/structures/enums.ts:114](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L114)
+[src/handler/structures/enums.ts:114](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L114)
___
@@ -28,7 +28,7 @@ The PayloadType for a SernEmitter success event
#### Defined in
-[src/handler/structures/enums.ts:110](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L110)
+[src/handler/structures/enums.ts:110](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L110)
___
@@ -40,4 +40,4 @@ The PayloadType for a SernEmitter warning event
#### Defined in
-[src/handler/structures/enums.ts:118](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L118)
+[src/handler/structures/enums.ts:118](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L118)
diff --git a/docs/api/enums/PluginType.md b/docs/api/enums/PluginType.md
index 53b9c3437..89ad9da3d 100644
--- a/docs/api/enums/PluginType.md
+++ b/docs/api/enums/PluginType.md
@@ -28,7 +28,7 @@ The PluginType for CommandPlugins
#### Defined in
-[src/handler/structures/enums.ts:97](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L97)
+[src/handler/structures/enums.ts:97](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L97)
___
@@ -40,4 +40,4 @@ The PluginType for EventPlugins
#### Defined in
-[src/handler/structures/enums.ts:101](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/enums.ts#L101)
+[src/handler/structures/enums.ts:101](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L101)
diff --git a/docs/api/interfaces/Controller.md b/docs/api/interfaces/Controller.md
index 26d709705..1c39c190e 100644
--- a/docs/api/interfaces/Controller.md
+++ b/docs/api/interfaces/Controller.md
@@ -22,7 +22,7 @@ custom_edit_url: null
#### Defined in
-[src/handler/plugins/plugin.ts:29](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L29)
+[src/handler/plugins/plugin.ts:29](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L29)
___
@@ -40,4 +40,4 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:30](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L30)
+[src/handler/plugins/plugin.ts:30](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L30)
diff --git a/docs/api/interfaces/Wrapper.md b/docs/api/interfaces/Wrapper.md
index a3f12a8e0..25e0e53e4 100644
--- a/docs/api/interfaces/Wrapper.md
+++ b/docs/api/interfaces/Wrapper.md
@@ -16,7 +16,7 @@ An object to be passed into Sern#init() function.
#### Defined in
-[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L11)
+[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L11)
___
@@ -26,7 +26,7 @@ ___
#### Defined in
-[src/handler/structures/wrapper.ts:15](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L15)
+[src/handler/structures/wrapper.ts:15](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L15)
___
@@ -36,7 +36,7 @@ ___
#### Defined in
-[src/handler/structures/wrapper.ts:14](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L14)
+[src/handler/structures/wrapper.ts:14](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L14)
___
@@ -46,7 +46,7 @@ ___
#### Defined in
-[src/handler/structures/wrapper.ts:16](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L16)
+[src/handler/structures/wrapper.ts:16](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L16)
___
@@ -56,4 +56,4 @@ ___
#### Defined in
-[src/handler/structures/wrapper.ts:13](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/wrapper.ts#L13)
+[src/handler/structures/wrapper.ts:13](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L13)
diff --git a/docs/api/modules.md b/docs/api/modules.md
index 503ea2b06..96c7cf1bb 100644
--- a/docs/api/modules.md
+++ b/docs/api/modules.md
@@ -37,7 +37,7 @@ custom_edit_url: null
#### Defined in
-[src/types/handler.ts:12](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L12)
+[src/types/handler.ts:12](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L12)
___
@@ -47,7 +47,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:92](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L92)
+[src/handler/plugins/plugin.ts:92](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L92)
___
@@ -59,7 +59,7 @@ Type that replaces autocomplete with [SernAutocompleteData](modules.md#sernautoc
#### Defined in
-[src/handler/structures/module.ts:181](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L181)
+[src/handler/structures/module.ts:181](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L181)
___
@@ -69,7 +69,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:55](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L55)
+[src/handler/structures/module.ts:55](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L55)
___
@@ -79,7 +79,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:145](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L145)
+[src/handler/plugins/plugin.ts:145](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L145)
___
@@ -95,7 +95,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:173](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L173)
+[src/handler/plugins/plugin.ts:173](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L173)
___
@@ -111,7 +111,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:40](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L40)
+[src/handler/plugins/plugin.ts:40](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L40)
___
@@ -121,7 +121,7 @@ ___
#### Defined in
-[src/types/handler.ts:43](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L43)
+[src/types/handler.ts:43](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L43)
___
@@ -131,7 +131,7 @@ ___
#### Defined in
-[src/types/handler.ts:44](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L44)
+[src/types/handler.ts:44](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L44)
___
@@ -144,7 +144,7 @@ are provided to Module. This type represents that transformation
#### Defined in
-[src/types/handler.ts:42](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L42)
+[src/types/handler.ts:42](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L42)
___
@@ -161,7 +161,7 @@ ___
#### Defined in
-[src/types/handler.ts:19](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L19)
+[src/types/handler.ts:19](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L19)
___
@@ -171,7 +171,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:57](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L57)
+[src/handler/plugins/plugin.ts:57](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L57)
___
@@ -187,7 +187,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:136](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L136)
+[src/handler/plugins/plugin.ts:136](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L136)
___
@@ -197,7 +197,7 @@ ___
#### Defined in
-[src/types/handler.ts:25](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L25)
+[src/types/handler.ts:25](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L25)
___
@@ -217,7 +217,7 @@ Event Module Command Plugins
#### Defined in
-[src/handler/plugins/plugin.ts:163](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L163)
+[src/handler/plugins/plugin.ts:163](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L163)
___
@@ -237,7 +237,7 @@ Event Module Event Plugins
#### Defined in
-[src/handler/plugins/plugin.ts:154](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L154)
+[src/handler/plugins/plugin.ts:154](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L154)
___
@@ -253,7 +253,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:169](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L169)
+[src/handler/plugins/plugin.ts:169](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L169)
___
@@ -263,7 +263,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:148](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L148)
+[src/handler/plugins/plugin.ts:148](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L148)
___
@@ -279,7 +279,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:103](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L103)
+[src/handler/plugins/plugin.ts:103](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L103)
___
@@ -295,7 +295,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:68](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L68)
+[src/handler/plugins/plugin.ts:68](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L68)
___
@@ -305,7 +305,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:128](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L128)
+[src/handler/plugins/plugin.ts:128](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L128)
___
@@ -317,7 +317,7 @@ User inputs this type. Sern processes behind the scenes for better usage
#### Defined in
-[src/handler/plugins/plugin.ts:178](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L178)
+[src/handler/plugins/plugin.ts:178](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L178)
___
@@ -327,7 +327,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:182](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L182)
+[src/handler/plugins/plugin.ts:182](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L182)
___
@@ -337,7 +337,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:141](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L141)
+[src/handler/structures/module.ts:141](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L141)
___
@@ -353,7 +353,7 @@ ___
#### Defined in
-[src/types/handler.ts:5](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L5)
+[src/types/handler.ts:5](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L5)
___
@@ -370,7 +370,7 @@ ___
#### Defined in
-[src/types/handler.ts:17](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L17)
+[src/types/handler.ts:17](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L17)
___
@@ -386,7 +386,7 @@ ___
#### Defined in
-[src/types/handler.ts:8](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L8)
+[src/types/handler.ts:8](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L8)
___
@@ -396,7 +396,7 @@ ___
#### Defined in
-[src/types/handler.ts:45](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L45)
+[src/types/handler.ts:45](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L45)
___
@@ -406,7 +406,7 @@ ___
#### Defined in
-[src/types/handler.ts:55](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L55)
+[src/types/handler.ts:55](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L55)
___
@@ -416,7 +416,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:166](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L166)
+[src/handler/structures/module.ts:166](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L166)
___
@@ -426,7 +426,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:80](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L80)
+[src/handler/plugins/plugin.ts:80](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L80)
___
@@ -442,7 +442,7 @@ ___
#### Defined in
-[src/handler/plugins/plugin.ts:116](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/plugins/plugin.ts#L116)
+[src/handler/plugins/plugin.ts:116](https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L116)
___
@@ -461,7 +461,7 @@ ___
#### Defined in
-[src/types/handler.ts:48](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L48)
+[src/types/handler.ts:48](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L48)
___
@@ -477,7 +477,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:205](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L205)
+[src/handler/structures/module.ts:205](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L205)
___
@@ -487,7 +487,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:189](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L189)
+[src/handler/structures/module.ts:189](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L189)
___
@@ -497,7 +497,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:197](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L197)
+[src/handler/structures/module.ts:197](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L197)
___
@@ -507,7 +507,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:44](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L44)
+[src/handler/structures/module.ts:44](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L44)
___
@@ -517,7 +517,7 @@ ___
#### Defined in
-[src/types/handler.ts:14](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L14)
+[src/types/handler.ts:14](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L14)
___
@@ -550,7 +550,7 @@ Turns a function with a union of array of args into a single union
#### Defined in
-[src/types/handler.ts:34](https://github.com/sern-handler/handler/blob/9b7ad2c/src/types/handler.ts#L34)
+[src/types/handler.ts:34](https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L34)
___
@@ -560,7 +560,7 @@ ___
#### Defined in
-[src/handler/structures/module.ts:33](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/structures/module.ts#L33)
+[src/handler/structures/module.ts:33](https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L33)
## Functions
@@ -582,7 +582,7 @@ The wrapper function to define command modules for sern
#### Defined in
-[src/handler/sern.ts:91](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L91)
+[src/handler/sern.ts:91](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L91)
___
@@ -604,4 +604,4 @@ The wrapper function to define event modules for sern
#### Defined in
-[src/handler/sern.ts:112](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L112)
+[src/handler/sern.ts:112](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L112)
diff --git a/docs/api/namespaces/Sern.md b/docs/api/namespaces/Sern.md
index acb07660b..8292d2a5e 100644
--- a/docs/api/namespaces/Sern.md
+++ b/docs/api/namespaces/Sern.md
@@ -47,7 +47,7 @@ The object passed into every plugin to control a command's behavior
#### Defined in
-[src/handler/sern.ts:82](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L82)
+[src/handler/sern.ts:82](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L82)
## Functions
@@ -97,7 +97,7 @@ Sern.addExternal(new Level())
#### Defined in
-[src/handler/sern.ts:72](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L72)
+[src/handler/sern.ts:72](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L72)
___
@@ -127,4 +127,4 @@ Sern.init({
#### Defined in
-[src/handler/sern.ts:39](https://github.com/sern-handler/handler/blob/9b7ad2c/src/handler/sern.ts#L39)
+[src/handler/sern.ts:39](https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L39)
From 0c5cc4401737eb4fe23e8a8b50811176f1f71309 Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Wed, 28 Sep 2022 01:24:32 -0500
Subject: [PATCH 3/7] fix: links
---
.idea/workspace.xml | 37 ++++++++++++++++----------------
blog/2021-08-01-mdx-blog-post.md | 10 ++++-----
2 files changed, 23 insertions(+), 24 deletions(-)
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 73bccdd01..d2a718616 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,22 +4,9 @@
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -81,7 +68,7 @@
-
+
@@ -114,8 +101,8 @@
-
+
@@ -137,6 +124,9 @@
+
+
+
1660418841831
@@ -215,7 +205,14 @@
1664307221790
-
+
+ 1664342459061
+
+
+
+ 1664342459061
+
+
@@ -243,6 +240,8 @@
-
+
+
+
\ No newline at end of file
diff --git a/blog/2021-08-01-mdx-blog-post.md b/blog/2021-08-01-mdx-blog-post.md
index 9722294d3..88e45aa6c 100644
--- a/blog/2021-08-01-mdx-blog-post.md
+++ b/blog/2021-08-01-mdx-blog-post.md
@@ -22,7 +22,7 @@ Quick List of changes!
### Class based modules
Incorporate class based modules into your project instead of the traditional `commandModule` or `eventModule`
-Extend the new [CommandExecutable](../docs/api/classes/CommandExecutable) or [EventExecutable](../docs/api/classes/EventExecutable)
+Extend the new [CommandExecutable](docs/api/classes/CommandExecutable) or [EventExecutable](docs/api/classes/EventExecutable)
```ts title="commands/meaning-of-life.ts"
import { CommandType, CommandExecutable, type Args, type Context } from "@sern/handler";
import { publish } from "../plugins/publish.js";
@@ -69,11 +69,11 @@ Feel free to use TypeScript experimental decorators to augment and customize you
### Deprecation Warnings
The next update will bring sern v2 with some important features. Here are some things to watch out for.
-- [Wrapper#client](../docs/api/interfaces/Wrapper) will be deprecated
-- [Wrapper#sernEmitter](../docs/api/interfaces/Wrapper) will be deprecated
+- [Wrapper#client](docs/api/interfaces/Wrapper) will be deprecated
+- [Wrapper#sernEmitter](docs/api/interfaces/Wrapper) will be deprecated
- a SernEmitter will be automatically created once Sern#init is called
-- The option to pass in a function or array for [Wrapper#events](../docs/api/interfaces/Wrapper) will be deprecated. Only strings are accepted.
-- [Sern#addExternal](../docs/api/classes/SernEmitter) will be deprecated in favor of a better way.
+- The option to pass in a function or array for [Wrapper#events](docs/api/interfaces/Wrapper) will be deprecated. Only strings are accepted.
+- [Sern#addExternal](docs/api/classes/SernEmitter) will be deprecated in favor of a better way.
### Dependencies Update
- TypeScript has been updated to 4.8.3
From 61bef454dace8e8d88b2d1c68c22430dfbc93e3d Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Wed, 28 Sep 2022 01:31:45 -0500
Subject: [PATCH 4/7] fix: try fiux
---
.idea/workspace.xml | 16 ++++++++++------
docusaurus.config.js | 20 ++++++++++----------
2 files changed, 20 insertions(+), 16 deletions(-)
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index d2a718616..cb1158bb6 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,10 +4,7 @@
-
-
-
-
+
@@ -126,7 +123,7 @@
-
+
1660418841831
@@ -212,7 +209,14 @@
1664342459061
-
+
+ 1664346272428
+
+
+
+ 1664346272428
+
+
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 5711e5900..816416b9e 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -159,16 +159,16 @@ const config = {
darkTheme: darkCodeTheme,
},
}),
- plugins : [
- [
- 'docusaurus-plugin-typedoc',
- {
- //if you're editing website, please change this to your local branch of sern to generate documentation
- entryPoints: ['../sernHandlerV2/src/index.ts'],
- tsconfig: '../sernHandlerV2/tsconfig-esm.json',
- },
- ]
- ]
+ // plugins : [
+ // [
+ // 'docusaurus-plugin-typedoc',
+ // {
+ // //if you're editing website, please change this to your local branch of sern to generate documentation
+ // entryPoints: ['../sernHandlerV2/src/index.ts'],
+ // tsconfig: '../sernHandlerV2/tsconfig-esm.json',
+ // },
+ // ]
+ // ]
};
module.exports = config;
From 068ee4c7f3606237e8c25bb4ec582ee3113c2a5c Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Wed, 28 Sep 2022 01:39:01 -0500
Subject: [PATCH 5/7] feat: change date of blog
---
.idea/workspace.xml | 20 +++++++++++++------
...og-post.md => 2022-09-28-mdx-blog-post.md} | 0
2 files changed, 14 insertions(+), 6 deletions(-)
rename blog/{2021-08-01-mdx-blog-post.md => 2022-09-28-mdx-blog-post.md} (100%)
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index cb1158bb6..1ea560392 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,7 +4,7 @@
-
+
@@ -65,7 +65,7 @@
-
+
@@ -98,8 +98,8 @@
-
+
@@ -123,7 +123,7 @@
-
+
1660418841831
@@ -216,7 +216,14 @@
1664346272428
-
+
+ 1664346705175
+
+
+
+ 1664346705175
+
+
@@ -246,6 +253,7 @@
-
+
+
\ No newline at end of file
diff --git a/blog/2021-08-01-mdx-blog-post.md b/blog/2022-09-28-mdx-blog-post.md
similarity index 100%
rename from blog/2021-08-01-mdx-blog-post.md
rename to blog/2022-09-28-mdx-blog-post.md
From 9a686c27f0d69b7c3952579054595b0cd6bd5b76 Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Wed, 28 Sep 2022 01:45:14 -0500
Subject: [PATCH 6/7] fix: admonition
---
.idea/workspace.xml | 16 ++++++++++++----
blog/2022-09-28-mdx-blog-post.md | 2 +-
2 files changed, 13 insertions(+), 5 deletions(-)
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 1ea560392..4f9948a0c 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,7 +4,7 @@
-
+
@@ -123,7 +123,7 @@
-
+
1660418841831
@@ -223,7 +223,14 @@
1664346705175
-
+
+ 1664347141696
+
+
+
+ 1664347141696
+
+
@@ -254,6 +261,7 @@
-
+
+
\ No newline at end of file
diff --git a/blog/2022-09-28-mdx-blog-post.md b/blog/2022-09-28-mdx-blog-post.md
index 88e45aa6c..7df991dd8 100644
--- a/blog/2022-09-28-mdx-blog-post.md
+++ b/blog/2022-09-28-mdx-blog-post.md
@@ -46,7 +46,7 @@ export default class extends CommandExecutable {
```
:::caution
-execute must be a member function. It should be as above, a property on the class!
+execute must not be a method of the class. It should be as above, a property on the class!
:::
From b588f64dd5120e8c4812614d63681ccbec0b9473 Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Wed, 28 Sep 2022 01:47:54 -0500
Subject: [PATCH 7/7] fix: admonition
---
blog/2022-09-28-mdx-blog-post.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/blog/2022-09-28-mdx-blog-post.md b/blog/2022-09-28-mdx-blog-post.md
index 7df991dd8..17432f802 100644
--- a/blog/2022-09-28-mdx-blog-post.md
+++ b/blog/2022-09-28-mdx-blog-post.md
@@ -63,6 +63,7 @@ export default class extends EventExecutable {
}
```
Now, you might ask **why** this feature was added.
Simply put, to give flexibility to the developers.
+I believe that you should build your own structures however you might like and customize to your liking.
In addition, **decorators now unofficially work with modules!**
Feel free to use TypeScript experimental decorators to augment and customize your classes.