mirror of
https://github.com/sern-handler/website
synced 2026-06-06 01:16:47 +00:00
chore: update api documentation
This commit is contained in:
@@ -6,9 +6,9 @@ sidebar_position: 0
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
**`Experimental`**
|
||||
**`Deprecated`**
|
||||
|
||||
Will be refactored / changed in future
|
||||
Will be removed in future
|
||||
|
||||
## Type parameters
|
||||
|
||||
@@ -20,7 +20,7 @@ Will be refactored / changed in future
|
||||
|
||||
### constructor
|
||||
|
||||
• **new CommandExecutable**<`Type`\>()
|
||||
• **new CommandExecutable**<`Type`\>(): [`CommandExecutable`](CommandExecutable.md)<`Type`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
@@ -28,6 +28,10 @@ Will be refactored / changed in future
|
||||
| :------ | :------ |
|
||||
| `Type` | extends [`CommandType`](../enums/CommandType.md) = [`CommandType`](../enums/CommandType.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`CommandExecutable`](CommandExecutable.md)<`Type`\>
|
||||
|
||||
## Properties
|
||||
|
||||
### plugins
|
||||
@@ -36,7 +40,7 @@ Will be refactored / changed in future
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L79)
|
||||
[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +50,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:78](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L78)
|
||||
[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,13 +60,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L80)
|
||||
[src/core/modules.ts:81](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L81)
|
||||
|
||||
## Methods
|
||||
|
||||
### execute
|
||||
|
||||
▸ `Abstract` **execute**(`...args`): `unknown`
|
||||
▸ **execute**(`...args`): `unknown`
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -76,13 +80,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:91](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L91)
|
||||
[src/core/modules.ts:92](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L92)
|
||||
|
||||
___
|
||||
|
||||
### getInstance
|
||||
|
||||
▸ `Static` **getInstance**(): [`CommandModule`](../modules.md#commandmodule)
|
||||
▸ **getInstance**(): [`CommandModule`](../modules.md#commandmodule)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -90,4 +94,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:82](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L82)
|
||||
[src/core/modules.ts:83](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L83)
|
||||
|
||||
@@ -22,7 +22,7 @@ Message and ChatInputCommandInteraction
|
||||
|
||||
### constructor
|
||||
|
||||
• `Protected` **new Context**(`ctx`)
|
||||
• **new Context**(`ctx`): [`Context`](Context.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -30,13 +30,17 @@ Message and ChatInputCommandInteraction
|
||||
| :------ | :------ |
|
||||
| `ctx` | `Result`<`Message`<`boolean`\>, `ChatInputCommandInteraction`<`CacheType`\>\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Context`](Context.md)
|
||||
|
||||
#### Overrides
|
||||
|
||||
CoreContext<Message, ChatInputCommandInteraction\>.constructor
|
||||
CoreContext\<Message, ChatInputCommandInteraction\>.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L29)
|
||||
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L29)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -50,7 +54,7 @@ CoreContext.ctx
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L29)
|
||||
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L29)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -64,7 +68,7 @@ CoreContext.ctx
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L39)
|
||||
[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L45)
|
||||
[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L91)
|
||||
[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L91)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +110,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L65)
|
||||
[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +124,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L71)
|
||||
[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -134,7 +138,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L77)
|
||||
[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
@@ -148,7 +152,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L33)
|
||||
[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
@@ -162,7 +166,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L97)
|
||||
[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -180,7 +184,7 @@ CoreContext.interaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/core-context.ts#L15)
|
||||
[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/core-context.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -194,7 +198,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L85)
|
||||
[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -212,7 +216,7 @@ CoreContext.message
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/core-context.ts#L12)
|
||||
[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/core-context.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
@@ -230,7 +234,7 @@ CoreContext.options
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L26)
|
||||
[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -247,7 +251,7 @@ else, interaction.user
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L55)
|
||||
[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -261,7 +265,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L61)
|
||||
[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L61)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -279,7 +283,7 @@ CoreContext.isMessage
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/core-context.ts#L19)
|
||||
[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/core-context.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -297,7 +301,7 @@ CoreContext.isSlash
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/core-context.ts#L23)
|
||||
[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/core-context.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -317,13 +321,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L103)
|
||||
[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L103)
|
||||
|
||||
___
|
||||
|
||||
### wrap
|
||||
|
||||
▸ `Static` **wrap**(`wrappable`): [`Context`](Context.md)
|
||||
▸ **wrap**(`wrappable`): [`Context`](Context.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -341,4 +345,4 @@ CoreContext.wrap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/context.ts#L113)
|
||||
[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/context.ts#L113)
|
||||
|
||||
@@ -19,7 +19,11 @@ Version 4.0.0 will internalize this api. Please refrain from using the defaults!
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DefaultErrorHandling**()
|
||||
• **new DefaultErrorHandling**(): [`DefaultErrorHandling`](DefaultErrorHandling.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`DefaultErrorHandling`](DefaultErrorHandling.md)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -29,7 +33,7 @@ Version 4.0.0 will internalize this api. Please refrain from using the defaults!
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/error-handling.ts:13](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/error-handling.ts#L13)
|
||||
[src/core/structures/services/error-handling.ts:13](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/error-handling.ts#L13)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -57,7 +61,7 @@ Version 4 will remove this method
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/error-handling.ts:9](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/error-handling.ts#L9)
|
||||
[src/core/structures/services/error-handling.ts:9](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/error-handling.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -83,4 +87,4 @@ A function that is called on every throw.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/error-handling.ts#L15)
|
||||
[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/error-handling.ts#L15)
|
||||
|
||||
@@ -19,13 +19,17 @@ Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DefaultLogging**()
|
||||
• **new DefaultLogging**(): [`DefaultLogging`](DefaultLogging.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`DefaultLogging`](DefaultLogging.md)
|
||||
|
||||
## Methods
|
||||
|
||||
### date
|
||||
|
||||
▸ `Private` **date**(): `Date`
|
||||
▸ **date**(): `Date`
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -33,7 +37,7 @@ Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L9)
|
||||
[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -57,7 +61,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/logger.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L10)
|
||||
[src/core/structures/services/logger.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -81,7 +85,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/logger.ts:14](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L14)
|
||||
[src/core/structures/services/logger.ts:14](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -105,7 +109,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/logger.ts:18](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L18)
|
||||
[src/core/structures/services/logger.ts:18](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
@@ -129,4 +133,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/logger.ts#L22)
|
||||
[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/logger.ts#L22)
|
||||
|
||||
@@ -19,7 +19,7 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DefaultModuleManager**(`moduleStore`)
|
||||
• **new DefaultModuleManager**(`moduleStore`): [`DefaultModuleManager`](DefaultModuleManager.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -27,9 +27,13 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule
|
||||
| :------ | :------ |
|
||||
| `moduleStore` | [`CoreModuleStore`](../interfaces/CoreModuleStore.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`DefaultModuleManager`](DefaultModuleManager.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L12)
|
||||
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L12)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -39,7 +43,7 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L12)
|
||||
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L12)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -63,7 +67,7 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/module-manager.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L35)
|
||||
[src/core/structures/services/module-manager.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/module-manager.ts:15](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L15)
|
||||
[src/core/structures/services/module-manager.ts:15](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +122,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/module-manager.ts:27](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L27)
|
||||
[src/core/structures/services/module-manager.ts:27](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +140,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/module-manager.ts:42](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L42)
|
||||
[src/core/structures/services/module-manager.ts:42](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -161,7 +165,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/module-manager.ts:38](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L38)
|
||||
[src/core/structures/services/module-manager.ts:38](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -186,4 +190,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/services/module-manager.ts:23](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/services/module-manager.ts#L23)
|
||||
[src/core/structures/services/module-manager.ts:23](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/services/module-manager.ts#L23)
|
||||
|
||||
@@ -6,9 +6,9 @@ sidebar_position: 0
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
**`Experimental`**
|
||||
**`Deprecated`**
|
||||
|
||||
Will be refactored in future
|
||||
Will be removed in future
|
||||
|
||||
## Type parameters
|
||||
|
||||
@@ -20,7 +20,7 @@ Will be refactored in future
|
||||
|
||||
### constructor
|
||||
|
||||
• **new EventExecutable**<`Type`\>()
|
||||
• **new EventExecutable**<`Type`\>(): [`EventExecutable`](EventExecutable.md)<`Type`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
@@ -28,6 +28,10 @@ Will be refactored in future
|
||||
| :------ | :------ |
|
||||
| `Type` | extends [`EventType`](../enums/EventType.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`EventExecutable`](EventExecutable.md)<`Type`\>
|
||||
|
||||
## Properties
|
||||
|
||||
### plugins
|
||||
@@ -36,7 +40,7 @@ Will be refactored in future
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L100)
|
||||
[src/core/modules.ts:101](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +50,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:99](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L99)
|
||||
[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,13 +60,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:102](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L102)
|
||||
[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L103)
|
||||
|
||||
## Methods
|
||||
|
||||
### execute
|
||||
|
||||
▸ `Abstract` **execute**(`...args`): `unknown`
|
||||
▸ **execute**(`...args`): `unknown`
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -76,13 +80,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:111](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L111)
|
||||
[src/core/modules.ts:112](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
### getInstance
|
||||
|
||||
▸ `Static` **getInstance**(): [`EventModule`](../modules.md#eventmodule)
|
||||
▸ **getInstance**(): [`EventModule`](../modules.md#eventmodule)
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -90,4 +94,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L103)
|
||||
[src/core/modules.ts:104](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L104)
|
||||
|
||||
@@ -16,7 +16,11 @@ Represents a core module store that stores IDs mapped to file paths.
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ModuleStore**()
|
||||
• **new ModuleStore**(): [`ModuleStore`](ModuleStore.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ModuleStore`](ModuleStore.md)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -30,7 +34,7 @@ Represents a core module store that stores IDs mapped to file paths.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/module-store.ts#L11)
|
||||
[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/module-store.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +48,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/module-store.ts#L10)
|
||||
[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/module-store.ts#L10)
|
||||
|
||||
@@ -20,7 +20,11 @@ custom_edit_url: null
|
||||
|
||||
### constructor
|
||||
|
||||
• **new SernEmitter**()
|
||||
• **new SernEmitter**(): [`SernEmitter`](SernEmitter.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`SernEmitter`](SernEmitter.md)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -28,7 +32,7 @@ EventEmitter.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L10)
|
||||
[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L10)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -158,7 +162,7 @@ EventEmitter.emit
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L40)
|
||||
[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -357,7 +361,7 @@ EventEmitter.on
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L18)
|
||||
[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
@@ -390,7 +394,7 @@ EventEmitter.once
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L29)
|
||||
[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -710,7 +714,7 @@ ___
|
||||
|
||||
### failure
|
||||
|
||||
▸ `Static` **failure**(`module?`, `reason?`): `Object`
|
||||
▸ **failure**(`module?`, `reason?`): `Object`
|
||||
|
||||
Creates a compliant SernEmitter failure payload
|
||||
|
||||
@@ -725,15 +729,21 @@ Creates a compliant SernEmitter failure payload
|
||||
|
||||
`Object`
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `module?` | `AnyModule` |
|
||||
| `reason` | `string` \| `Error` |
|
||||
| `type` | [`Failure`](../enums/PayloadType.md#failure) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L59)
|
||||
[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### getEventListeners
|
||||
|
||||
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
|
||||
▸ **getEventListeners**(`emitter`, `name`): `Function`[]
|
||||
|
||||
Returns a copy of the array of listeners for the event named `eventName`.
|
||||
|
||||
@@ -787,7 +797,7 @@ ___
|
||||
|
||||
### getMaxListeners
|
||||
|
||||
▸ `Static` **getMaxListeners**(`emitter`): `number`
|
||||
▸ **getMaxListeners**(`emitter`): `number`
|
||||
|
||||
Returns the currently set max amount of listeners.
|
||||
|
||||
@@ -841,7 +851,7 @@ ___
|
||||
|
||||
### listenerCount
|
||||
|
||||
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
|
||||
▸ **listenerCount**(`emitter`, `eventName`): `number`
|
||||
|
||||
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
|
||||
|
||||
@@ -885,7 +895,7 @@ ___
|
||||
|
||||
### on
|
||||
|
||||
▸ `Static` **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`<`any`\>
|
||||
▸ **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`<`any`\>
|
||||
|
||||
```js
|
||||
const { on, EventEmitter } = require('events');
|
||||
@@ -967,7 +977,7 @@ EventEmitter.on
|
||||
|
||||
node_modules/@types/node/events.d.ts:254
|
||||
|
||||
▸ `Static` **on**<`Emitter`, `Events`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Events`] : `any`\>
|
||||
▸ **on**<`Emitter`, `Events`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Events`] : `any`\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
@@ -999,7 +1009,7 @@ ___
|
||||
|
||||
### once
|
||||
|
||||
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
||||
▸ **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
||||
|
||||
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
|
||||
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
|
||||
@@ -1105,7 +1115,7 @@ EventEmitter.once
|
||||
|
||||
node_modules/@types/node/events.d.ts:194
|
||||
|
||||
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
||||
▸ **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -1127,7 +1137,7 @@ EventEmitter.once
|
||||
|
||||
node_modules/@types/node/events.d.ts:195
|
||||
|
||||
▸ `Static` **once**<`Emitter`, `Event`\>(`eventEmitter`, `eventName`): `Promise`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Event`] : `any`[]\>
|
||||
▸ **once**<`Emitter`, `Event`\>(`eventEmitter`, `eventName`): `Promise`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Event`] : `any`[]\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
@@ -1159,7 +1169,7 @@ ___
|
||||
|
||||
### payload
|
||||
|
||||
▸ `Static` `Private` **payload**<`T`\>(`type`, `module?`, `reason?`): `T`
|
||||
▸ **payload**<`T`\>(`type`, `module?`, `reason?`): `T`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
@@ -1181,13 +1191,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L46)
|
||||
[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### setMaxListeners
|
||||
|
||||
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
|
||||
▸ **setMaxListeners**(`n?`, `...eventTargets`): `void`
|
||||
|
||||
```js
|
||||
const {
|
||||
@@ -1228,7 +1238,7 @@ ___
|
||||
|
||||
### success
|
||||
|
||||
▸ `Static` **success**(`module`): `Object`
|
||||
▸ **success**(`module`): `Object`
|
||||
|
||||
Creates a compliant SernEmitter module success payload
|
||||
|
||||
@@ -1242,15 +1252,20 @@ Creates a compliant SernEmitter module success payload
|
||||
|
||||
`Object`
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `module` | `AnyModule` |
|
||||
| `type` | [`Success`](../enums/PayloadType.md#success) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L72)
|
||||
[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
### warning
|
||||
|
||||
▸ `Static` **warning**(`reason`): `Object`
|
||||
▸ **warning**(`reason`): `Object`
|
||||
|
||||
Creates a compliant SernEmitter module warning payload
|
||||
|
||||
@@ -1264,6 +1279,11 @@ Creates a compliant SernEmitter module warning payload
|
||||
|
||||
`Object`
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `reason` | `string` |
|
||||
| `type` | [`Warning`](../enums/PayloadType.md#warning) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/sern-emitter.ts#L82)
|
||||
[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/sern-emitter.ts#L82)
|
||||
|
||||
@@ -32,7 +32,7 @@ export default commandModule({
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L20)
|
||||
[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -42,7 +42,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L23)
|
||||
[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L29)
|
||||
[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L22)
|
||||
[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L21)
|
||||
[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L28)
|
||||
[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +92,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L25)
|
||||
[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L27)
|
||||
[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L19)
|
||||
[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -122,7 +122,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L24)
|
||||
[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
@@ -132,7 +132,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L18)
|
||||
[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
@@ -142,4 +142,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L26)
|
||||
[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L26)
|
||||
|
||||
@@ -31,7 +31,7 @@ The EventType for handling discord events
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L51)
|
||||
[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ Could be for example, `process` events, database events
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L60)
|
||||
[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,4 +56,4 @@ The EventType for handling sern events
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L55)
|
||||
[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L55)
|
||||
|
||||
@@ -16,7 +16,7 @@ The PayloadType for a SernEmitter failure event
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L98)
|
||||
[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
@@ -28,7 +28,7 @@ The PayloadType for a SernEmitter success event
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L94)
|
||||
[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
@@ -40,4 +40,4 @@ The PayloadType for a SernEmitter warning event
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L102)
|
||||
[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L102)
|
||||
|
||||
@@ -30,7 +30,7 @@ The PluginType for EventPlugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L85)
|
||||
[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -42,4 +42,4 @@ The PluginType for InitPlugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/enums.ts#L81)
|
||||
[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/b0399f9/src/core/structures/enums.ts#L81)
|
||||
|
||||
@@ -27,28 +27,16 @@ custom_edit_url: null
|
||||
- Lightweight. Does a lot while being small.
|
||||
- Latest features. Support for discord.js v14 and all of its interactions.
|
||||
- Start quickly. Plug and play or customize to your liking.
|
||||
- Switch and customize how errors are handled, logging, and more.
|
||||
- works with [bun](https://bun.sh/) and [node](https://nodejs.org/en) out the box!
|
||||
- Use it with TypeScript or JavaScript. CommonJS and ESM supported.
|
||||
- Active and growing community, always here to help. [Join us](https://sern.dev/discord)
|
||||
- Unleash its full potential with a powerful CLI and awesome plugins.
|
||||
|
||||
## 📜 Installation
|
||||
|
||||
```sh
|
||||
npm install @sern/handler
|
||||
```
|
||||
|
||||
```sh
|
||||
yarn add @sern/handler
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm add @sern/handler
|
||||
```
|
||||
[Start here!!](https://sern.dev/docs/guide/walkthrough/new-project)
|
||||
|
||||
## 👶 Basic Usage
|
||||
<details open><summary>ping.ts</summary>
|
||||
<details><summary>ping.ts</summary>
|
||||
|
||||
```ts
|
||||
export default commandModule({
|
||||
@@ -62,7 +50,7 @@ export default commandModule({
|
||||
});
|
||||
```
|
||||
</details>
|
||||
<details open><summary>modal.ts</summary>
|
||||
<details><summary>modal.ts</summary>
|
||||
|
||||
```ts
|
||||
export default commandModule({
|
||||
@@ -82,30 +70,6 @@ export default commandModule({
|
||||
})
|
||||
```
|
||||
</details>
|
||||
<details open><summary>index.ts</summary>
|
||||
|
||||
|
||||
```ts
|
||||
import { Client, GatewayIntentBits } from 'discord.js';
|
||||
import { Sern, single } from '@sern/handler';
|
||||
|
||||
//client has been declared previously
|
||||
//Version 3
|
||||
await makeDependencies({
|
||||
build: root => root
|
||||
.add({ '@sern/client': single(() => client) })
|
||||
});
|
||||
|
||||
//View docs for all options
|
||||
Sern.init({
|
||||
defaultPrefix: '!', // removing defaultPrefix will shut down text commands
|
||||
commands: 'src/commands',
|
||||
// events: 'src/events' (optional),
|
||||
});
|
||||
|
||||
client.login("YOUR_BOT_TOKEN_HERE");
|
||||
```
|
||||
</details>
|
||||
|
||||
## 🤖 Bots Using sern
|
||||
- [Community Bot](https://github.com/sern-handler/sern-community), the community bot for our [discord server](https://sern.dev/discord).
|
||||
|
||||
@@ -20,7 +20,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L126)
|
||||
[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L126)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L127)
|
||||
[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L127)
|
||||
|
||||
___
|
||||
|
||||
@@ -63,7 +63,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:129](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L129)
|
||||
[src/types/core-modules.ts:129](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L129)
|
||||
|
||||
___
|
||||
|
||||
@@ -77,7 +77,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -101,7 +101,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:128](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L128)
|
||||
[src/types/core-modules.ts:128](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L128)
|
||||
|
||||
___
|
||||
|
||||
@@ -115,7 +115,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -129,4 +129,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L125)
|
||||
[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L125)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:66](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L66)
|
||||
[src/types/core-modules.ts:66](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:65](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L65)
|
||||
[src/types/core-modules.ts:65](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L65)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:76](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L76)
|
||||
[src/types/core-modules.ts:76](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:75](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L75)
|
||||
[src/types/core-modules.ts:75](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L75)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L151)
|
||||
[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L151)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L159)
|
||||
[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L159)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:161](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L161)
|
||||
[src/types/core-modules.ts:161](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L161)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L156)
|
||||
[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L156)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L152)
|
||||
[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L152)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L158)
|
||||
[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L158)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L153)
|
||||
[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L157)
|
||||
[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L157)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L155)
|
||||
[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L155)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,7 +104,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L160)
|
||||
[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L160)
|
||||
|
||||
___
|
||||
|
||||
@@ -114,7 +114,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:162](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L162)
|
||||
[src/types/core-modules.ts:162](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L162)
|
||||
|
||||
___
|
||||
|
||||
@@ -124,4 +124,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L154)
|
||||
[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L154)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:61](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L61)
|
||||
[src/types/core-modules.ts:61](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:60](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L60)
|
||||
[src/types/core-modules.ts:60](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L60)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:56](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L56)
|
||||
[src/types/core-modules.ts:56](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:55](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L55)
|
||||
[src/types/core-modules.ts:55](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L55)
|
||||
|
||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L73)
|
||||
[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L72)
|
||||
[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L72)
|
||||
|
||||
@@ -22,7 +22,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L59)
|
||||
[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -40,4 +40,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L60)
|
||||
[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L60)
|
||||
|
||||
@@ -22,7 +22,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L28)
|
||||
[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:30](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L30)
|
||||
[src/types/ioc.ts:30](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -58,7 +58,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:33](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L33)
|
||||
[src/types/ioc.ts:33](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L29)
|
||||
[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:32](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L32)
|
||||
[src/types/ioc.ts:32](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,4 +112,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:31](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L31)
|
||||
[src/types/ioc.ts:31](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L31)
|
||||
|
||||
@@ -20,7 +20,7 @@ Represents a core module store that stores IDs mapped to file paths.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/module-store.ts#L7)
|
||||
[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/module-store.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
@@ -30,4 +30,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/module-store.ts#L8)
|
||||
[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/module-store.ts#L8)
|
||||
|
||||
@@ -30,7 +30,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L107)
|
||||
[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -58,7 +58,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:108](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L108)
|
||||
[src/types/core-modules.ts:108](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L108)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -110,4 +110,4 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:109](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L109)
|
||||
[src/types/core-modules.ts:109](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L109)
|
||||
|
||||
@@ -21,4 +21,4 @@ Let dependencies implement this to dispose and cleanup.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/disposable.ts:8](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/disposable.ts#L8)
|
||||
[src/core/contracts/disposable.ts:8](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/disposable.ts#L8)
|
||||
|
||||
@@ -25,7 +25,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/emitter.ts:4](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/emitter.ts#L4)
|
||||
[src/core/contracts/emitter.ts:4](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/emitter.ts#L4)
|
||||
|
||||
___
|
||||
|
||||
@@ -46,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/emitter.ts#L6)
|
||||
[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/emitter.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -67,4 +67,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/emitter.ts:5](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/emitter.ts#L5)
|
||||
[src/core/contracts/emitter.ts:5](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/emitter.ts#L5)
|
||||
|
||||
@@ -36,7 +36,7 @@ Version 4 will remove this method
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/error-handling.ts:11](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/error-handling.ts#L11)
|
||||
[src/core/contracts/error-handling.ts:11](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/error-handling.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -58,4 +58,4 @@ A function that is called on every throw.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/error-handling.ts:16](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/error-handling.ts#L16)
|
||||
[src/core/contracts/error-handling.ts:16](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/error-handling.ts#L16)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:167](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L167)
|
||||
[src/types/core-modules.ts:167](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L166)
|
||||
[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L166)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,4 +34,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:168](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L168)
|
||||
[src/types/core-modules.ts:168](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L168)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L49)
|
||||
[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -48,7 +48,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L48)
|
||||
[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +90,7 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:50](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L50)
|
||||
[src/types/core-modules.ts:50](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -114,4 +114,4 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:51](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L51)
|
||||
[src/types/core-modules.ts:51](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L51)
|
||||
|
||||
@@ -21,4 +21,4 @@ Let dependencies implement this to initiate some logic.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/init.ts:8](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/init.ts#L8)
|
||||
[src/core/contracts/init.ts:8](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/init.ts#L8)
|
||||
|
||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L69)
|
||||
[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L68)
|
||||
[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L68)
|
||||
|
||||
@@ -38,7 +38,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/logging.ts#L8)
|
||||
[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/logging.ts#L8)
|
||||
|
||||
___
|
||||
|
||||
@@ -58,7 +58,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/logging.ts#L5)
|
||||
[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/logging.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/logging.ts#L7)
|
||||
[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/logging.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,4 +98,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/logging.ts#L6)
|
||||
[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/logging.ts#L6)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:86](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L86)
|
||||
[src/types/core-modules.ts:86](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:85](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L85)
|
||||
[src/types/core-modules.ts:85](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L85)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:96](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L96)
|
||||
[src/types/core-modules.ts:96](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L96)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:95](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L95)
|
||||
[src/types/core-modules.ts:95](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L95)
|
||||
|
||||
@@ -39,7 +39,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/module-manager.ts:19](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/module-manager.ts#L19)
|
||||
[src/core/contracts/module-manager.ts:19](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/module-manager.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/module-manager.ts:23](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/module-manager.ts#L23)
|
||||
[src/core/contracts/module-manager.ts:23](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/module-manager.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +90,7 @@ MetadataAccess.getMetadata
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/module-manager.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/module-manager.ts#L10)
|
||||
[src/core/contracts/module-manager.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/module-manager.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,7 +104,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/module-manager.ts:22](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/module-manager.ts#L22)
|
||||
[src/core/contracts/module-manager.ts:22](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/module-manager.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
@@ -125,7 +125,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/module-manager.ts:21](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/module-manager.ts#L21)
|
||||
[src/core/contracts/module-manager.ts:21](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/module-manager.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -150,4 +150,4 @@ MetadataAccess.setMetadata
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/module-manager.ts:11](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/module-manager.ts#L11)
|
||||
[src/core/contracts/module-manager.ts:11](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/module-manager.ts#L11)
|
||||
|
||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L64)
|
||||
[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +44,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L63)
|
||||
[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L63)
|
||||
|
||||
82
docs/api/interfaces/Presence.Result.md
Normal file
82
docs/api/interfaces/Presence.Result.md
Normal file
@@ -0,0 +1,82 @@
|
||||
---
|
||||
id: "Presence.Result"
|
||||
title: "Interface: Result"
|
||||
sidebar_label: "Result"
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
[Presence](../namespaces/Presence.md).Result
|
||||
|
||||
## Properties
|
||||
|
||||
### activities
|
||||
|
||||
• `Optional` **activities**: `ActivitiesOptions`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:11](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
### afk
|
||||
|
||||
• `Optional` **afk**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
### onRepeat
|
||||
|
||||
• `Optional` **onRepeat**: (`previous`: [`Result`](Presence.Result.md)) => [`Result`](Presence.Result.md)
|
||||
|
||||
#### Type declaration
|
||||
|
||||
▸ (`previous`): [`Result`](Presence.Result.md)
|
||||
|
||||
##### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `previous` | [`Result`](Presence.Result.md) |
|
||||
|
||||
##### Returns
|
||||
|
||||
[`Result`](Presence.Result.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:14](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
### repeat
|
||||
|
||||
• `Optional` **repeat**: `number` \| [[`Emitter`](Emitter.md), `string`]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:13](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### shardId
|
||||
|
||||
• `Optional` **shardId**: `number`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:12](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• `Optional` **status**: `Status`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:9](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L9)
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:81](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L81)
|
||||
[src/types/core-modules.ts:81](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:80](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L80)
|
||||
[src/types/core-modules.ts:80](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L80)
|
||||
|
||||
@@ -20,7 +20,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:173](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L173)
|
||||
[src/types/core-modules.ts:173](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L173)
|
||||
|
||||
___
|
||||
|
||||
@@ -30,7 +30,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:178](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L178)
|
||||
[src/types/core-modules.ts:178](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L178)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,4 +110,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:174](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L174)
|
||||
[src/types/core-modules.ts:174](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L174)
|
||||
|
||||
@@ -30,7 +30,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L43)
|
||||
[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -58,7 +58,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L44)
|
||||
[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L44)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -110,4 +110,4 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:45](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L45)
|
||||
[src/types/core-modules.ts:45](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L45)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/504cdee/src/types/utility.ts#L21)
|
||||
[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/b0399f9/src/types/utility.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/504cdee/src/types/utility.ts#L20)
|
||||
[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/b0399f9/src/types/utility.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/504cdee/src/types/utility.ts#L19)
|
||||
[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/b0399f9/src/types/utility.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/504cdee/src/types/utility.ts#L23)
|
||||
[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/b0399f9/src/types/utility.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,4 +54,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/504cdee/src/types/utility.ts#L22)
|
||||
[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/b0399f9/src/types/utility.ts#L22)
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:210](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L210)
|
||||
[src/types/core-modules.ts:210](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L210)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,4 +104,4 @@ APIApplicationCommandOptionBase.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:209](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L209)
|
||||
[src/types/core-modules.ts:209](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L209)
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:215](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L215)
|
||||
[src/types/core-modules.ts:215](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L215)
|
||||
|
||||
___
|
||||
|
||||
@@ -114,4 +114,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:214](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L214)
|
||||
[src/types/core-modules.ts:214](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L214)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L119)
|
||||
[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
@@ -53,7 +53,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L121)
|
||||
[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
@@ -67,7 +67,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -81,7 +81,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L120)
|
||||
[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L120)
|
||||
|
||||
___
|
||||
|
||||
@@ -105,7 +105,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -119,4 +119,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L118)
|
||||
[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L118)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:71](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L71)
|
||||
[src/types/core-modules.ts:71](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:70](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L70)
|
||||
[src/types/core-modules.ts:70](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L70)
|
||||
|
||||
@@ -20,7 +20,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:113](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L113)
|
||||
[src/types/core-modules.ts:113](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +34,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -63,7 +63,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:114](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L114)
|
||||
[src/types/core-modules.ts:114](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L114)
|
||||
|
||||
___
|
||||
|
||||
@@ -77,7 +77,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -91,7 +91,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -105,7 +105,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -119,4 +119,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L112)
|
||||
[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L112)
|
||||
|
||||
@@ -24,7 +24,7 @@ Module.description
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L37)
|
||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ Module.execute
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:91](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L91)
|
||||
[src/types/core-modules.ts:91](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L91)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Module.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L34)
|
||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ Module.onEvent
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L35)
|
||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ Module.plugins
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L36)
|
||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,4 +108,4 @@ Module.type
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:90](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L90)
|
||||
[src/types/core-modules.ts:90](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L90)
|
||||
|
||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/504cdee/src/types/core.ts#L9)
|
||||
[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -30,7 +30,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core.ts:20](https://github.com/sern-handler/handler/blob/504cdee/src/types/core.ts#L20)
|
||||
[src/types/core.ts:20](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -40,7 +40,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/types/core.ts#L10)
|
||||
[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -50,7 +50,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core.ts:11](https://github.com/sern-handler/handler/blob/504cdee/src/types/core.ts#L11)
|
||||
[src/types/core.ts:11](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,4 +66,4 @@ Overload to enable mode in case developer does not use a .env file.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core.ts:16](https://github.com/sern-handler/handler/blob/504cdee/src/types/core.ts#L16)
|
||||
[src/types/core.ts:16](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core.ts#L16)
|
||||
|
||||
@@ -8,7 +8,7 @@ custom_edit_url: null
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [CommandError](namespaces/CommandError.md)
|
||||
- [Presence](namespaces/Presence.md)
|
||||
- [Sern](namespaces/Sern.md)
|
||||
|
||||
## Enumerations
|
||||
@@ -66,12 +66,6 @@ custom_edit_url: null
|
||||
- [UserSelectCommand](interfaces/UserSelectCommand.md)
|
||||
- [Wrapper](interfaces/Wrapper.md)
|
||||
|
||||
## References
|
||||
|
||||
### controller
|
||||
|
||||
Re-exports [controller](namespaces/Sern.md#controller)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AnyCommandPlugin
|
||||
@@ -80,7 +74,7 @@ Re-exports [controller](namespaces/Sern.md#controller)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L76)
|
||||
[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,17 +84,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L77)
|
||||
[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
### Args
|
||||
|
||||
Ƭ **Args**: `ParseType`<{ `slash`: [`SlashOptions`](modules.md#slashoptions) ; `text`: `string`[] }\>
|
||||
Ƭ **Args**: `ParseType`<\{ `slash`: [`SlashOptions`](modules.md#slashoptions) ; `text`: `string`[] }\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/504cdee/src/types/utility.ts#L16)
|
||||
[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/b0399f9/src/types/utility.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,7 +104,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:133](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L133)
|
||||
[src/types/core-modules.ts:133](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L133)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +114,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:132](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L132)
|
||||
[src/types/core-modules.ts:132](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L132)
|
||||
|
||||
___
|
||||
|
||||
@@ -139,7 +133,7 @@ If T has an init method, this will be called.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L17)
|
||||
[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
@@ -161,17 +155,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/504cdee/src/core/contracts/logging.ts#L11)
|
||||
[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/b0399f9/src/core/contracts/logging.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
### Payload
|
||||
|
||||
Ƭ **Payload**: { `module`: `AnyModule` ; `type`: [`Success`](enums/PayloadType.md#success) } \| { `module?`: `AnyModule` ; `reason`: `string` \| `Error` ; `type`: [`Failure`](enums/PayloadType.md#failure) } \| { `reason`: `string` ; `type`: [`Warning`](enums/PayloadType.md#warning) }
|
||||
Ƭ **Payload**: \{ `module`: `AnyModule` ; `type`: [`Success`](enums/PayloadType.md#success) } \| \{ `module?`: `AnyModule` ; `reason`: `string` \| `Error` ; `type`: [`Failure`](enums/PayloadType.md#failure) } \| \{ `reason`: `string` ; `type`: [`Warning`](enums/PayloadType.md#warning) }
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/504cdee/src/types/utility.ts#L26)
|
||||
[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/b0399f9/src/types/utility.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -181,7 +175,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-plugin.ts#L51)
|
||||
[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-plugin.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -193,7 +187,7 @@ Type that replaces autocomplete with [SernAutocompleteData](interfaces/SernAutoc
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/core-modules.ts:201](https://github.com/sern-handler/handler/blob/504cdee/src/types/core-modules.ts#L201)
|
||||
[src/types/core-modules.ts:201](https://github.com/sern-handler/handler/blob/b0399f9/src/types/core-modules.ts#L201)
|
||||
|
||||
___
|
||||
|
||||
@@ -220,7 +214,7 @@ T is created once and lazily.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L7)
|
||||
[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
@@ -230,7 +224,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/504cdee/src/types/utility.ts#L14)
|
||||
[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/b0399f9/src/types/utility.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -263,7 +257,29 @@ Every time this is called, a new object is created
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/504cdee/src/types/ioc.ts#L12)
|
||||
[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/b0399f9/src/types/ioc.ts#L12)
|
||||
|
||||
## Variables
|
||||
|
||||
### controller
|
||||
|
||||
• `Const` **controller**: `Object`
|
||||
|
||||
**`Since`**
|
||||
|
||||
1.0.0
|
||||
The object passed into every plugin to control a command's behavior
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `next` | () => `OkImpl`<`void`\> |
|
||||
| `stop` | () => `ErrImpl`<`void`\> |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/create-plugins.ts:69](https://github.com/sern-handler/handler/blob/b0399f9/src/core/create-plugins.ts#L69)
|
||||
|
||||
## Functions
|
||||
|
||||
@@ -294,7 +310,7 @@ Every time this is called, a new object is created
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/create-plugins.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/core/create-plugins.ts#L36)
|
||||
[src/core/create-plugins.ts:37](https://github.com/sern-handler/handler/blob/b0399f9/src/core/create-plugins.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -325,7 +341,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/create-plugins.ts:27](https://github.com/sern-handler/handler/blob/504cdee/src/core/create-plugins.ts#L27)
|
||||
[src/core/create-plugins.ts:28](https://github.com/sern-handler/handler/blob/b0399f9/src/core/create-plugins.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -361,7 +377,7 @@ Will probably be moved one day!
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/create-plugins.ts:57](https://github.com/sern-handler/handler/blob/504cdee/src/core/create-plugins.ts#L57)
|
||||
[src/core/create-plugins.ts:58](https://github.com/sern-handler/handler/blob/b0399f9/src/core/create-plugins.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -392,7 +408,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/create-plugins.ts:45](https://github.com/sern-handler/handler/blob/504cdee/src/core/create-plugins.ts#L45)
|
||||
[src/core/create-plugins.ts:46](https://github.com/sern-handler/handler/blob/b0399f9/src/core/create-plugins.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -423,7 +439,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/create-plugins.ts:18](https://github.com/sern-handler/handler/blob/504cdee/src/core/create-plugins.ts#L18)
|
||||
[src/core/create-plugins.ts:19](https://github.com/sern-handler/handler/blob/b0399f9/src/core/create-plugins.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -463,7 +479,7 @@ const client = Service('@sern/client');
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/ioc/dependency-injection.ts:36](https://github.com/sern-handler/handler/blob/504cdee/src/core/ioc/dependency-injection.ts#L36)
|
||||
[src/core/ioc/dependency-injection.ts:36](https://github.com/sern-handler/handler/blob/b0399f9/src/core/ioc/dependency-injection.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -496,7 +512,7 @@ The plural version of [Service](modules.md#service)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/ioc/dependency-injection.ts:44](https://github.com/sern-handler/handler/blob/504cdee/src/core/ioc/dependency-injection.ts#L44)
|
||||
[src/core/ioc/dependency-injection.ts:44](https://github.com/sern-handler/handler/blob/b0399f9/src/core/ioc/dependency-injection.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -520,7 +536,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:25](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L25)
|
||||
[src/core/modules.ts:25](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -555,7 +571,7 @@ where typings can be very bad.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:53](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L53)
|
||||
[src/core/modules.ts:53](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -580,7 +596,7 @@ The wrapper function to define event modules for sern
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/modules.ts:38](https://github.com/sern-handler/handler/blob/504cdee/src/core/modules.ts#L38)
|
||||
[src/core/modules.ts:38](https://github.com/sern-handler/handler/blob/b0399f9/src/core/modules.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -606,7 +622,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/ioc/base.ts:83](https://github.com/sern-handler/handler/blob/504cdee/src/core/ioc/base.ts#L83)
|
||||
[src/core/ioc/base.ts:90](https://github.com/sern-handler/handler/blob/b0399f9/src/core/ioc/base.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
@@ -633,7 +649,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/create-plugins.ts:5](https://github.com/sern-handler/handler/blob/504cdee/src/core/create-plugins.ts#L5)
|
||||
[src/core/create-plugins.ts:6](https://github.com/sern-handler/handler/blob/b0399f9/src/core/create-plugins.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -672,7 +688,7 @@ Creates a singleton object.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/ioc/dependency-injection.ts:11](https://github.com/sern-handler/handler/blob/504cdee/src/core/ioc/dependency-injection.ts#L11)
|
||||
[src/core/ioc/dependency-injection.ts:11](https://github.com/sern-handler/handler/blob/b0399f9/src/core/ioc/dependency-injection.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -717,7 +733,7 @@ Creates a transient object
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/ioc/dependency-injection.ts:21](https://github.com/sern-handler/handler/blob/504cdee/src/core/ioc/dependency-injection.ts#L21)
|
||||
[src/core/ioc/dependency-injection.ts:21](https://github.com/sern-handler/handler/blob/b0399f9/src/core/ioc/dependency-injection.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -737,4 +753,4 @@ Use the Service API. The container should be readonly
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/ioc/base.ts:17](https://github.com/sern-handler/handler/blob/504cdee/src/core/ioc/base.ts#L17)
|
||||
[src/core/ioc/base.ts:18](https://github.com/sern-handler/handler/blob/b0399f9/src/core/ioc/base.ts#L18)
|
||||
|
||||
93
docs/api/namespaces/Presence.md
Normal file
93
docs/api/namespaces/Presence.md
Normal file
@@ -0,0 +1,93 @@
|
||||
---
|
||||
id: "Presence"
|
||||
title: "Namespace: Presence"
|
||||
sidebar_label: "Presence"
|
||||
sidebar_position: 0
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [Result](../interfaces/Presence.Result.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### Config
|
||||
|
||||
Ƭ **Config**<`T`\>: `Object`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends keyof `Dependencies`[] |
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `execute` | (...`v`: `IntoDependencies`<`T`\>) => [`Result`](../interfaces/Presence.Result.md) |
|
||||
| `inject?` | [...T] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:17](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L17)
|
||||
|
||||
## Functions
|
||||
|
||||
### module
|
||||
|
||||
▸ **module**<`T`\>(`conf`): [`Config`](Presence.md#config)<`T`\>
|
||||
|
||||
A small wrapper to provide type inference.
|
||||
Create a Presence module which **MUST** be put in a file called presence.<language-extension>
|
||||
adjacent to the file where **Sern.init** is CALLED.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends keyof `Dependencies`[] |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `conf` | [`Config`](Presence.md#config)<`T`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Config`](Presence.md#config)<`T`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:28](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### of
|
||||
|
||||
▸ **of**(`root`): `Object`
|
||||
|
||||
Create a Presence body which can be either:
|
||||
- once, the presence is activated only once.
|
||||
- repeated, per cycle or event, the presence can be changed.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `root` | `Omit`<[`Result`](../interfaces/Presence.Result.md), ``"repeat"`` \| ``"onRepeat"``\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Object`
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `once` | () => `Omit`<[`Result`](../interfaces/Presence.Result.md), ``"repeat"`` \| ``"onRepeat"``\> |
|
||||
| `repeated` | (`onRepeat`: `PresenceReduce`, `repeat`: `number` \| [[`Emitter`](../interfaces/Emitter.md), `string`]) => \{ `activities?`: `ActivitiesOptions`[] ; `afk?`: `boolean` ; `onRepeat`: `PresenceReduce` ; `repeat`: `number` \| [[`Emitter`](../interfaces/Emitter.md), `string`] ; `shardId?`: `number`[] ; `status?`: `Status` } |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/presences.ts:39](https://github.com/sern-handler/handler/blob/b0399f9/src/core/presences.ts#L39)
|
||||
@@ -6,28 +6,6 @@ sidebar_position: 0
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
## Variables
|
||||
|
||||
### controller
|
||||
|
||||
• `Const` **controller**: `Object`
|
||||
|
||||
**`Since`**
|
||||
|
||||
1.0.0
|
||||
The object passed into every plugin to control a command's behavior
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `next` | () => `OkImpl`<`void`\> |
|
||||
| `stop` | () => `ErrImpl`<`void`\> |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/sern.ts:63](https://github.com/sern-handler/handler/blob/504cdee/src/sern.ts#L63)
|
||||
|
||||
## Functions
|
||||
|
||||
### init
|
||||
@@ -59,4 +37,4 @@ Sern.init({
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/sern.ts:24](https://github.com/sern-handler/handler/blob/504cdee/src/sern.ts#L24)
|
||||
[src/sern.ts:27](https://github.com/sern-handler/handler/blob/b0399f9/src/sern.ts#L27)
|
||||
|
||||
Reference in New Issue
Block a user