mirror of
https://github.com/sern-handler/website
synced 2026-06-27 18:22:22 +00:00
Compare commits
1 Commits
feat/clear
...
feat/analy
| Author | SHA1 | Date | |
|---|---|---|---|
| 1a579587ae |
6
.github/workflows/docusaurus.yml
vendored
6
.github/workflows/docusaurus.yml
vendored
@@ -15,12 +15,12 @@ jobs:
|
|||||||
- uses: actions/setup-node@v3
|
- uses: actions/setup-node@v3
|
||||||
with:
|
with:
|
||||||
node-version: 18
|
node-version: 18
|
||||||
cache: yarn
|
cache: npm
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: yarn install --immutable
|
run: npm ci
|
||||||
- name: Build website
|
- name: Build website
|
||||||
run: yarn build
|
run: npm run build
|
||||||
|
|
||||||
# Popular action to deploy to GitHub Pages:
|
# Popular action to deploy to GitHub Pages:
|
||||||
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
|
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
|
||||||
|
|||||||
Binary file not shown.
@@ -1 +0,0 @@
|
|||||||
nodeLinker: node-modules
|
|
||||||
@@ -26,7 +26,7 @@ const config = {
|
|||||||
// to replace "en" with "zh-Hans".
|
// to replace "en" with "zh-Hans".
|
||||||
i18n: {
|
i18n: {
|
||||||
defaultLocale: 'en',
|
defaultLocale: 'en',
|
||||||
locales: ['en']
|
locales: ['en', 'fr', 'tr'],
|
||||||
},
|
},
|
||||||
presets: [
|
presets: [
|
||||||
[
|
[
|
||||||
@@ -175,28 +175,27 @@ const config = {
|
|||||||
darkTheme: darkCodeTheme,
|
darkTheme: darkCodeTheme,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
plugins: [
|
plugins : [
|
||||||
[
|
[
|
||||||
'docusaurus-plugin-typedoc',
|
'docusaurus-plugin-typedoc',
|
||||||
{
|
{
|
||||||
//if you're editing website, please change this to your local branch of sern to generate documentation
|
//if you're editing website, please change this to your local branch of sern to generate documentation
|
||||||
entryPoints: ['../sernHandlerV2/src/index.ts'],
|
entryPoints: ['../sernHandlerV2/src/index.ts'],
|
||||||
tsconfig: '../sernHandlerV2/tsconfig.json',
|
tsconfig: '../sernHandlerV2/tsconfig.json',
|
||||||
},
|
},
|
||||||
],
|
"@dipakparmar/docusaurus-plugin-umami",
|
||||||
[
|
/** @type {import('@dipakparmar/docusaurus-plugin-umami').Options} */
|
||||||
"@dipakparmar/docusaurus-plugin-umami",
|
({
|
||||||
{
|
websiteID: "e82ff65c-b08f-47b5-8e74-5c31cbcec0ad",
|
||||||
websiteID: "e82ff65c-b08f-47b5-8e74-5c31cbcec0ad",
|
analyticsDomain: "analytics.srizan.dev",
|
||||||
analyticsDomain: "analytics.srizan.dev",
|
scriptName: 'ua.js',
|
||||||
scriptName: 'ua.js',
|
dataAutoTrack: true,
|
||||||
dataAutoTrack: true,
|
dataDoNotTrack: true,
|
||||||
dataDoNotTrack: true,
|
dataCache: true,
|
||||||
dataCache: true,
|
dataDomains: "sern.dev",
|
||||||
dataDomains: "sern.dev",
|
}),
|
||||||
},
|
]
|
||||||
]
|
]
|
||||||
]
|
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports = config;
|
module.exports = config;
|
||||||
|
|||||||
@@ -6,9 +6,9 @@ sidebar_position: 0
|
|||||||
custom_edit_url: null
|
custom_edit_url: null
|
||||||
---
|
---
|
||||||
|
|
||||||
**`Deprecated`**
|
**`Experimental`**
|
||||||
|
|
||||||
Will be removed in future
|
Will be refactored / changed in future
|
||||||
|
|
||||||
## Type parameters
|
## Type parameters
|
||||||
|
|
||||||
@@ -20,7 +20,7 @@ Will be removed in future
|
|||||||
|
|
||||||
### constructor
|
### constructor
|
||||||
|
|
||||||
• **new CommandExecutable**<`Type`\>(): [`CommandExecutable`](CommandExecutable.md)<`Type`\>
|
• **new CommandExecutable**<`Type`\>()
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
@@ -28,10 +28,6 @@ Will be removed in future
|
|||||||
| :------ | :------ |
|
| :------ | :------ |
|
||||||
| `Type` | extends [`CommandType`](../enums/CommandType.md) = [`CommandType`](../enums/CommandType.md) |
|
| `Type` | extends [`CommandType`](../enums/CommandType.md) = [`CommandType`](../enums/CommandType.md) |
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`CommandExecutable`](CommandExecutable.md)<`Type`\>
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
### plugins
|
### plugins
|
||||||
@@ -40,7 +36,7 @@ Will be removed in future
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L80)
|
[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L79)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -50,7 +46,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L79)
|
[src/core/modules.ts:78](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L78)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -60,13 +56,13 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:81](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L81)
|
[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L80)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
### execute
|
### execute
|
||||||
|
|
||||||
▸ **execute**(`...args`): `unknown`
|
▸ `Abstract` **execute**(`...args`): `unknown`
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@@ -80,13 +76,13 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:92](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L92)
|
[src/core/modules.ts:91](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L91)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### getInstance
|
### getInstance
|
||||||
|
|
||||||
▸ **getInstance**(): [`CommandModule`](../modules.md#commandmodule)
|
▸ `Static` **getInstance**(): [`CommandModule`](../modules.md#commandmodule)
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@@ -94,4 +90,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:83](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L83)
|
[src/core/modules.ts:82](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L82)
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ Message and ChatInputCommandInteraction
|
|||||||
|
|
||||||
### constructor
|
### constructor
|
||||||
|
|
||||||
• **new Context**(`ctx`): [`Context`](Context.md)
|
• `Protected` **new Context**(`ctx`)
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@@ -30,17 +30,13 @@ Message and ChatInputCommandInteraction
|
|||||||
| :------ | :------ |
|
| :------ | :------ |
|
||||||
| `ctx` | `Result`<`Message`<`boolean`\>, `ChatInputCommandInteraction`<`CacheType`\>\> |
|
| `ctx` | `Result`<`Message`<`boolean`\>, `ChatInputCommandInteraction`<`CacheType`\>\> |
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`Context`](Context.md)
|
|
||||||
|
|
||||||
#### Overrides
|
#### Overrides
|
||||||
|
|
||||||
CoreContext\<Message, ChatInputCommandInteraction\>.constructor
|
CoreContext<Message, ChatInputCommandInteraction\>.constructor
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L29)
|
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L29)
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
@@ -54,7 +50,7 @@ CoreContext.ctx
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L29)
|
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L29)
|
||||||
|
|
||||||
## Accessors
|
## Accessors
|
||||||
|
|
||||||
@@ -68,7 +64,7 @@ CoreContext.ctx
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L39)
|
[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L39)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -82,7 +78,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L45)
|
[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L45)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -96,7 +92,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L91)
|
[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L91)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +106,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L65)
|
[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L65)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -124,7 +120,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L71)
|
[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L71)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -138,7 +134,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L77)
|
[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L77)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -152,7 +148,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L33)
|
[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -166,7 +162,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L97)
|
[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L97)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -184,7 +180,7 @@ CoreContext.interaction
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/core-context.ts#L15)
|
[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L15)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -198,7 +194,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L85)
|
[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L85)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -216,7 +212,7 @@ CoreContext.message
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/core-context.ts#L12)
|
[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L12)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -234,7 +230,7 @@ CoreContext.options
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L26)
|
[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L26)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -251,7 +247,7 @@ else, interaction.user
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L55)
|
[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L55)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -265,7 +261,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L61)
|
[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L61)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -283,7 +279,7 @@ CoreContext.isMessage
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/core-context.ts#L19)
|
[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -301,7 +297,7 @@ CoreContext.isSlash
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/core-context.ts#L23)
|
[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/core-context.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -321,13 +317,13 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L103)
|
[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L103)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### wrap
|
### wrap
|
||||||
|
|
||||||
▸ **wrap**(`wrappable`): [`Context`](Context.md)
|
▸ `Static` **wrap**(`wrappable`): [`Context`](Context.md)
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@@ -345,4 +341,4 @@ CoreContext.wrap
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L113)
|
[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/context.ts#L113)
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ custom_edit_url: null
|
|||||||
**`Since`**
|
**`Since`**
|
||||||
|
|
||||||
2.0.0
|
2.0.0
|
||||||
Version 4.0.0 will internalize this api. Please refrain from using the defaults!
|
Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!
|
||||||
|
|
||||||
## Implements
|
## Implements
|
||||||
|
|
||||||
@@ -19,21 +19,23 @@ Version 4.0.0 will internalize this api. Please refrain from using the defaults!
|
|||||||
|
|
||||||
### constructor
|
### constructor
|
||||||
|
|
||||||
• **new DefaultErrorHandling**(): [`DefaultErrorHandling`](DefaultErrorHandling.md)
|
• **new DefaultErrorHandling**()
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`DefaultErrorHandling`](DefaultErrorHandling.md)
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
### #keepAlive
|
### keepAlive
|
||||||
|
|
||||||
• `Private` **#keepAlive**: `number` = `5`
|
• **keepAlive**: `number` = `5`
|
||||||
|
|
||||||
|
Number of times the process should throw an error until crashing and exiting
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ErrorHandling](../interfaces/ErrorHandling.md).[keepAlive](../interfaces/ErrorHandling.md#keepalive)
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/error-handling.ts:13](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/error-handling.ts#L13)
|
[src/core/structures/services/error-handling.ts:13](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/error-handling.ts#L13)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -41,6 +43,10 @@ Version 4.0.0 will internalize this api. Please refrain from using the defaults!
|
|||||||
|
|
||||||
▸ **crash**(`err`): `never`
|
▸ **crash**(`err`): `never`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Version 4 will remove this method
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -51,17 +57,13 @@ Version 4.0.0 will internalize this api. Please refrain from using the defaults!
|
|||||||
|
|
||||||
`never`
|
`never`
|
||||||
|
|
||||||
**`Deprecated`**
|
|
||||||
|
|
||||||
Version 4 will remove this method
|
|
||||||
|
|
||||||
#### Implementation of
|
#### Implementation of
|
||||||
|
|
||||||
[ErrorHandling](../interfaces/ErrorHandling.md).[crash](../interfaces/ErrorHandling.md#crash)
|
[ErrorHandling](../interfaces/ErrorHandling.md).[crash](../interfaces/ErrorHandling.md#crash)
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/error-handling.ts:9](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/error-handling.ts#L9)
|
[src/core/structures/services/error-handling.ts:9](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/error-handling.ts#L9)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -69,7 +71,8 @@ ___
|
|||||||
|
|
||||||
▸ **updateAlive**(`err`): `void`
|
▸ **updateAlive**(`err`): `void`
|
||||||
|
|
||||||
A function that is called on every throw.
|
A function that is called on every crash. Updates keepAlive.
|
||||||
|
If keepAlive is 0, the process crashes.
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@@ -87,4 +90,4 @@ A function that is called on every throw.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/error-handling.ts#L15)
|
[src/core/structures/services/error-handling.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/error-handling.ts#L15)
|
||||||
|
|||||||
@@ -19,17 +19,13 @@ Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!
|
|||||||
|
|
||||||
### constructor
|
### constructor
|
||||||
|
|
||||||
• **new DefaultLogging**(): [`DefaultLogging`](DefaultLogging.md)
|
• **new DefaultLogging**()
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`DefaultLogging`](DefaultLogging.md)
|
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
### date
|
### date
|
||||||
|
|
||||||
▸ **date**(): `Date`
|
▸ `Private` **date**(): `Date`
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@@ -37,7 +33,7 @@ Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L9)
|
[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/logger.ts#L9)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -61,7 +57,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/logger.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L10)
|
[src/core/structures/services/logger.ts:10](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/logger.ts#L10)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -85,7 +81,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/logger.ts:14](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L14)
|
[src/core/structures/services/logger.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/logger.ts#L14)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -109,7 +105,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/logger.ts:18](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L18)
|
[src/core/structures/services/logger.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/logger.ts#L18)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -133,4 +129,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L22)
|
[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/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
|
### constructor
|
||||||
|
|
||||||
• **new DefaultModuleManager**(`moduleStore`): [`DefaultModuleManager`](DefaultModuleManager.md)
|
• **new DefaultModuleManager**(`moduleStore`)
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@@ -27,13 +27,9 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule
|
|||||||
| :------ | :------ |
|
| :------ | :------ |
|
||||||
| `moduleStore` | [`CoreModuleStore`](../interfaces/CoreModuleStore.md) |
|
| `moduleStore` | [`CoreModuleStore`](../interfaces/CoreModuleStore.md) |
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`DefaultModuleManager`](DefaultModuleManager.md)
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L12)
|
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L12)
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
@@ -43,7 +39,7 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L12)
|
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L12)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -67,7 +63,7 @@ Version 4.0.0 will internalize this api. Please refrain from using DefaultModule
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/module-manager.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L35)
|
[src/core/structures/services/module-manager.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -98,7 +94,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/module-manager.ts:15](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L15)
|
[src/core/structures/services/module-manager.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L14)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -122,7 +118,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/module-manager.ts:27](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L27)
|
[src/core/structures/services/module-manager.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L26)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +136,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/module-manager.ts:42](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L42)
|
[src/core/structures/services/module-manager.ts:41](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L41)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -165,7 +161,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/module-manager.ts:38](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L38)
|
[src/core/structures/services/module-manager.ts:37](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -190,4 +186,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/services/module-manager.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L23)
|
[src/core/structures/services/module-manager.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/services/module-manager.ts#L22)
|
||||||
|
|||||||
@@ -6,9 +6,9 @@ sidebar_position: 0
|
|||||||
custom_edit_url: null
|
custom_edit_url: null
|
||||||
---
|
---
|
||||||
|
|
||||||
**`Deprecated`**
|
**`Experimental`**
|
||||||
|
|
||||||
Will be removed in future
|
Will be refactored in future
|
||||||
|
|
||||||
## Type parameters
|
## Type parameters
|
||||||
|
|
||||||
@@ -20,7 +20,7 @@ Will be removed in future
|
|||||||
|
|
||||||
### constructor
|
### constructor
|
||||||
|
|
||||||
• **new EventExecutable**<`Type`\>(): [`EventExecutable`](EventExecutable.md)<`Type`\>
|
• **new EventExecutable**<`Type`\>()
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
@@ -28,10 +28,6 @@ Will be removed in future
|
|||||||
| :------ | :------ |
|
| :------ | :------ |
|
||||||
| `Type` | extends [`EventType`](../enums/EventType.md) |
|
| `Type` | extends [`EventType`](../enums/EventType.md) |
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`EventExecutable`](EventExecutable.md)<`Type`\>
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
### plugins
|
### plugins
|
||||||
@@ -40,7 +36,7 @@ Will be removed in future
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:101](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L101)
|
[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L100)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -50,7 +46,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L100)
|
[src/core/modules.ts:99](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L99)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -60,13 +56,13 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L103)
|
[src/core/modules.ts:102](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L102)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
### execute
|
### execute
|
||||||
|
|
||||||
▸ **execute**(`...args`): `unknown`
|
▸ `Abstract` **execute**(`...args`): `unknown`
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@@ -80,13 +76,13 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:112](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L112)
|
[src/core/modules.ts:111](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L111)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### getInstance
|
### getInstance
|
||||||
|
|
||||||
▸ **getInstance**(): [`EventModule`](../modules.md#eventmodule)
|
▸ `Static` **getInstance**(): [`EventModule`](../modules.md#eventmodule)
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@@ -94,4 +90,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:104](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L104)
|
[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L103)
|
||||||
|
|||||||
@@ -16,11 +16,7 @@ Represents a core module store that stores IDs mapped to file paths.
|
|||||||
|
|
||||||
### constructor
|
### constructor
|
||||||
|
|
||||||
• **new ModuleStore**(): [`ModuleStore`](ModuleStore.md)
|
• **new ModuleStore**()
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`ModuleStore`](ModuleStore.md)
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
@@ -34,7 +30,7 @@ Represents a core module store that stores IDs mapped to file paths.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/module-store.ts#L11)
|
[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/module-store.ts#L11)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,4 +44,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/module-store.ts#L10)
|
[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/module-store.ts#L10)
|
||||||
|
|||||||
@@ -20,11 +20,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
### constructor
|
### constructor
|
||||||
|
|
||||||
• **new SernEmitter**(): [`SernEmitter`](SernEmitter.md)
|
• **new SernEmitter**()
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
[`SernEmitter`](SernEmitter.md)
|
|
||||||
|
|
||||||
#### Overrides
|
#### Overrides
|
||||||
|
|
||||||
@@ -32,7 +28,7 @@ EventEmitter.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/sern-emitter.ts#L10)
|
[src/core/structures/sern-emitter.ts:10](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L10)
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
@@ -46,7 +42,7 @@ EventEmitter.captureRejectionSymbol
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:357
|
node_modules/@types/node/events.d.ts:328
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -62,7 +58,7 @@ EventEmitter.captureRejections
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:362
|
node_modules/@types/node/events.d.ts:333
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +72,7 @@ EventEmitter.defaultMaxListeners
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:363
|
node_modules/@types/node/events.d.ts:334
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -98,7 +94,7 @@ EventEmitter.errorMonitor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:356
|
node_modules/@types/node/events.d.ts:327
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -108,6 +104,10 @@ node_modules/@types/node/events.d.ts:356
|
|||||||
|
|
||||||
Alias for `emitter.on(eventName, listener)`.
|
Alias for `emitter.on(eventName, listener)`.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v0.1.26
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -119,17 +119,13 @@ Alias for `emitter.on(eventName, listener)`.
|
|||||||
|
|
||||||
[`SernEmitter`](SernEmitter.md)
|
[`SernEmitter`](SernEmitter.md)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v0.1.26
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.addListener
|
EventEmitter.addListener
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:383
|
node_modules/@types/node/events.d.ts:354
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -162,7 +158,7 @@ EventEmitter.emit
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/sern-emitter.ts#L40)
|
[src/core/structures/sern-emitter.ts:40](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L40)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -186,21 +182,21 @@ console.log(myEE.eventNames());
|
|||||||
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
|
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
(`string` \| `symbol`)[]
|
|
||||||
|
|
||||||
**`Since`**
|
**`Since`**
|
||||||
|
|
||||||
v6.0.0
|
v6.0.0
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
(`string` \| `symbol`)[]
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.eventNames
|
EventEmitter.eventNames
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:702
|
node_modules/@types/node/events.d.ts:673
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -211,21 +207,21 @@ ___
|
|||||||
Returns the current max listener value for the `EventEmitter` which is either
|
Returns the current max listener value for the `EventEmitter` which is either
|
||||||
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](SernEmitter.md#defaultmaxlisteners).
|
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](SernEmitter.md#defaultmaxlisteners).
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`number`
|
|
||||||
|
|
||||||
**`Since`**
|
**`Since`**
|
||||||
|
|
||||||
v1.0.0
|
v1.0.0
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`number`
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.getMaxListeners
|
EventEmitter.getMaxListeners
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:555
|
node_modules/@types/node/events.d.ts:526
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -238,6 +234,10 @@ Returns the number of listeners listening to the event named `eventName`.
|
|||||||
If `listener` is provided, it will return how many times the listener
|
If `listener` is provided, it will return how many times the listener
|
||||||
is found in the list of the listeners of the event.
|
is found in the list of the listeners of the event.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v3.2.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
@@ -249,17 +249,13 @@ is found in the list of the listeners of the event.
|
|||||||
|
|
||||||
`number`
|
`number`
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v3.2.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.listenerCount
|
EventEmitter.listenerCount
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:649
|
node_modules/@types/node/events.d.ts:620
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -277,6 +273,10 @@ console.log(util.inspect(server.listeners('connection')));
|
|||||||
// Prints: [ [Function] ]
|
// Prints: [ [Function] ]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v0.1.26
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -287,17 +287,13 @@ console.log(util.inspect(server.listeners('connection')));
|
|||||||
|
|
||||||
`Function`[]
|
`Function`[]
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v0.1.26
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.listeners
|
EventEmitter.listeners
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:568
|
node_modules/@types/node/events.d.ts:539
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -307,6 +303,10 @@ ___
|
|||||||
|
|
||||||
Alias for `emitter.removeListener()`.
|
Alias for `emitter.removeListener()`.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v10.0.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -318,17 +318,13 @@ Alias for `emitter.removeListener()`.
|
|||||||
|
|
||||||
[`SernEmitter`](SernEmitter.md)
|
[`SernEmitter`](SernEmitter.md)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v10.0.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.off
|
EventEmitter.off
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:528
|
node_modules/@types/node/events.d.ts:499
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -361,7 +357,7 @@ EventEmitter.on
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/sern-emitter.ts#L18)
|
[src/core/structures/sern-emitter.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L18)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -394,7 +390,7 @@ EventEmitter.once
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/sern-emitter.ts#L29)
|
[src/core/structures/sern-emitter.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -415,6 +411,10 @@ server.prependListener('connection', (stream) => {
|
|||||||
|
|
||||||
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v6.0.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
@@ -426,17 +426,13 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|||||||
|
|
||||||
[`SernEmitter`](SernEmitter.md)
|
[`SernEmitter`](SernEmitter.md)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v6.0.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.prependListener
|
EventEmitter.prependListener
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:667
|
node_modules/@types/node/events.d.ts:638
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -455,6 +451,10 @@ server.prependOnceListener('connection', (stream) => {
|
|||||||
|
|
||||||
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v6.0.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
@@ -466,17 +466,13 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|||||||
|
|
||||||
[`SernEmitter`](SernEmitter.md)
|
[`SernEmitter`](SernEmitter.md)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v6.0.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.prependOnceListener
|
EventEmitter.prependOnceListener
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:683
|
node_modules/@types/node/events.d.ts:654
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -511,6 +507,10 @@ newListeners[0]();
|
|||||||
emitter.emit('log');
|
emitter.emit('log');
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v9.4.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -521,17 +521,13 @@ emitter.emit('log');
|
|||||||
|
|
||||||
`Function`[]
|
`Function`[]
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v9.4.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.rawListeners
|
EventEmitter.rawListeners
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:598
|
node_modules/@types/node/events.d.ts:569
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -547,6 +543,10 @@ component or module (e.g. sockets or file streams).
|
|||||||
|
|
||||||
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v0.1.26
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -557,17 +557,13 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|||||||
|
|
||||||
[`SernEmitter`](SernEmitter.md)
|
[`SernEmitter`](SernEmitter.md)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v0.1.26
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.removeAllListeners
|
EventEmitter.removeAllListeners
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:539
|
node_modules/@types/node/events.d.ts:510
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -652,6 +648,10 @@ ee.emit('ping');
|
|||||||
|
|
||||||
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v0.1.26
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -663,17 +663,13 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|||||||
|
|
||||||
[`SernEmitter`](SernEmitter.md)
|
[`SernEmitter`](SernEmitter.md)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v0.1.26
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.removeListener
|
EventEmitter.removeListener
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:523
|
node_modules/@types/node/events.d.ts:494
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -688,6 +684,10 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi
|
|||||||
|
|
||||||
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v0.3.5
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -698,23 +698,19 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|||||||
|
|
||||||
[`SernEmitter`](SernEmitter.md)
|
[`SernEmitter`](SernEmitter.md)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v0.3.5
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.setMaxListeners
|
EventEmitter.setMaxListeners
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:549
|
node_modules/@types/node/events.d.ts:520
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### failure
|
### failure
|
||||||
|
|
||||||
▸ **failure**(`module?`, `reason?`): `Object`
|
▸ `Static` **failure**(`module?`, `reason?`): `Object`
|
||||||
|
|
||||||
Creates a compliant SernEmitter failure payload
|
Creates a compliant SernEmitter failure payload
|
||||||
|
|
||||||
@@ -729,21 +725,15 @@ Creates a compliant SernEmitter failure payload
|
|||||||
|
|
||||||
`Object`
|
`Object`
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :------ | :------ |
|
|
||||||
| `module?` | `AnyModule` |
|
|
||||||
| `reason` | `string` \| `Error` |
|
|
||||||
| `type` | [`Failure`](../enums/PayloadType.md#failure) |
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/sern-emitter.ts#L59)
|
[src/core/structures/sern-emitter.ts:59](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L59)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### getEventListeners
|
### getEventListeners
|
||||||
|
|
||||||
▸ **getEventListeners**(`emitter`, `name`): `Function`[]
|
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
|
||||||
|
|
||||||
Returns a copy of the array of listeners for the event named `eventName`.
|
Returns a copy of the array of listeners for the event named `eventName`.
|
||||||
|
|
||||||
@@ -770,6 +760,10 @@ const { getEventListeners, EventEmitter } = require('events');
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v15.2.0, v14.17.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -781,10 +775,6 @@ const { getEventListeners, EventEmitter } = require('events');
|
|||||||
|
|
||||||
`Function`[]
|
`Function`[]
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v15.2.0, v14.17.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.getEventListeners
|
EventEmitter.getEventListeners
|
||||||
@@ -795,63 +785,9 @@ node_modules/@types/node/events.d.ts:299
|
|||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### getMaxListeners
|
|
||||||
|
|
||||||
▸ **getMaxListeners**(`emitter`): `number`
|
|
||||||
|
|
||||||
Returns the currently set max amount of listeners.
|
|
||||||
|
|
||||||
For `EventEmitter`s this behaves exactly the same as calling `.getMaxListeners` on
|
|
||||||
the emitter.
|
|
||||||
|
|
||||||
For `EventTarget`s this is the only way to get the max event listeners for the
|
|
||||||
event target. If the number of event handlers on a single EventTarget exceeds
|
|
||||||
the max set, the EventTarget will print a warning.
|
|
||||||
|
|
||||||
```js
|
|
||||||
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
|
|
||||||
|
|
||||||
{
|
|
||||||
const ee = new EventEmitter();
|
|
||||||
console.log(getMaxListeners(ee)); // 10
|
|
||||||
setMaxListeners(11, ee);
|
|
||||||
console.log(getMaxListeners(ee)); // 11
|
|
||||||
}
|
|
||||||
{
|
|
||||||
const et = new EventTarget();
|
|
||||||
console.log(getMaxListeners(et)); // 10
|
|
||||||
setMaxListeners(11, et);
|
|
||||||
console.log(getMaxListeners(et)); // 11
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :------ | :------ |
|
|
||||||
| `emitter` | `EventEmitter` \| `_DOMEventTarget` |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`number`
|
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v18.17.0
|
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
EventEmitter.getMaxListeners
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:328
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
### listenerCount
|
### listenerCount
|
||||||
|
|
||||||
▸ **listenerCount**(`emitter`, `eventName`): `number`
|
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
|
||||||
|
|
||||||
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
|
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
|
||||||
|
|
||||||
@@ -864,6 +800,14 @@ console.log(listenerCount(myEmitter, 'event'));
|
|||||||
// Prints: 2
|
// Prints: 2
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v0.9.12
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Since v3.2.0 - Use `listenerCount` instead.
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
@@ -875,14 +819,6 @@ console.log(listenerCount(myEmitter, 'event'));
|
|||||||
|
|
||||||
`number`
|
`number`
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v0.9.12
|
|
||||||
|
|
||||||
**`Deprecated`**
|
|
||||||
|
|
||||||
Since v3.2.0 - Use `listenerCount` instead.
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.listenerCount
|
EventEmitter.listenerCount
|
||||||
@@ -895,7 +831,7 @@ ___
|
|||||||
|
|
||||||
### on
|
### on
|
||||||
|
|
||||||
▸ **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`<`any`\>
|
▸ `Static` **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`<`any`\>
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { on, EventEmitter } = require('events');
|
const { on, EventEmitter } = require('events');
|
||||||
@@ -951,6 +887,10 @@ const ac = new AbortController();
|
|||||||
process.nextTick(() => ac.abort());
|
process.nextTick(() => ac.abort());
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v13.6.0, v12.16.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
@@ -965,10 +905,6 @@ process.nextTick(() => ac.abort());
|
|||||||
|
|
||||||
that iterates `eventName` events emitted by the `emitter`
|
that iterates `eventName` events emitted by the `emitter`
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v13.6.0, v12.16.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.on
|
EventEmitter.on
|
||||||
@@ -977,25 +913,25 @@ EventEmitter.on
|
|||||||
|
|
||||||
node_modules/@types/node/events.d.ts:254
|
node_modules/@types/node/events.d.ts:254
|
||||||
|
|
||||||
▸ **on**<`Emitter`, `Events`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Events`] : `any`\>
|
▸ `Static` **on**<`E`, `K`\>(`eventEmitter`, `eventName`): `AsyncIterableIterator`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`\>
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :------ | :------ |
|
| :------ | :------ |
|
||||||
| `Emitter` | extends `__module` |
|
| `E` | extends `__module` |
|
||||||
| `Events` | extends keyof `ClientEvents` |
|
| `K` | extends keyof `ClientEvents` |
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :------ | :------ |
|
| :------ | :------ |
|
||||||
| `eventEmitter` | `Emitter` |
|
| `eventEmitter` | `E` |
|
||||||
| `eventName` | `Emitter` extends `Client`<`boolean`\> ? `Events` : `string` |
|
| `eventName` | `E` extends `Client`<`boolean`\> ? `K` : `string` |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`AsyncIterableIterator`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Events`] : `any`\>
|
`AsyncIterableIterator`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`\>
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
@@ -1003,13 +939,13 @@ EventEmitter.on
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:243
|
node_modules/discord.js/typings/index.d.ts:229
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### once
|
### once
|
||||||
|
|
||||||
▸ **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
||||||
|
|
||||||
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
|
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
|
||||||
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
|
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
|
||||||
@@ -1091,6 +1027,10 @@ ac.abort(); // Abort waiting for the event
|
|||||||
ee.emit('foo'); // Prints: Waiting for the event was canceled!
|
ee.emit('foo'); // Prints: Waiting for the event was canceled!
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v11.13.0, v10.16.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -1103,10 +1043,6 @@ ee.emit('foo'); // Prints: Waiting for the event was canceled!
|
|||||||
|
|
||||||
`Promise`<`any`[]\>
|
`Promise`<`any`[]\>
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v11.13.0, v10.16.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.once
|
EventEmitter.once
|
||||||
@@ -1115,7 +1051,7 @@ EventEmitter.once
|
|||||||
|
|
||||||
node_modules/@types/node/events.d.ts:194
|
node_modules/@types/node/events.d.ts:194
|
||||||
|
|
||||||
▸ **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@@ -1137,25 +1073,25 @@ EventEmitter.once
|
|||||||
|
|
||||||
node_modules/@types/node/events.d.ts:195
|
node_modules/@types/node/events.d.ts:195
|
||||||
|
|
||||||
▸ **once**<`Emitter`, `Event`\>(`eventEmitter`, `eventName`): `Promise`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Event`] : `any`[]\>
|
▸ `Static` **once**<`E`, `K`\>(`eventEmitter`, `eventName`): `Promise`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`[]\>
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :------ | :------ |
|
| :------ | :------ |
|
||||||
| `Emitter` | extends `__module` |
|
| `E` | extends `__module` |
|
||||||
| `Event` | extends keyof `ClientEvents` |
|
| `K` | extends keyof `ClientEvents` |
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
| :------ | :------ |
|
| :------ | :------ |
|
||||||
| `eventEmitter` | `Emitter` |
|
| `eventEmitter` | `E` |
|
||||||
| `eventName` | `Emitter` extends `Client`<`boolean`\> ? `Event` : `string` |
|
| `eventName` | `E` extends `Client`<`boolean`\> ? `K` : `string` |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
`Promise`<`Emitter` extends `Client`<`boolean`\> ? `ClientEvents`[`Event`] : `any`[]\>
|
`Promise`<`E` extends `Client`<`boolean`\> ? `ClientEvents`[`K`] : `any`[]\>
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
@@ -1163,13 +1099,13 @@ EventEmitter.once
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:239
|
node_modules/discord.js/typings/index.d.ts:225
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### payload
|
### payload
|
||||||
|
|
||||||
▸ **payload**<`T`\>(`type`, `module?`, `reason?`): `T`
|
▸ `Static` `Private` **payload**<`T`\>(`type`, `module?`, `reason?`): `T`
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
@@ -1191,13 +1127,13 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/sern-emitter.ts#L46)
|
[src/core/structures/sern-emitter.ts:46](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L46)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### setMaxListeners
|
### setMaxListeners
|
||||||
|
|
||||||
▸ **setMaxListeners**(`n?`, `...eventTargets`): `void`
|
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const {
|
const {
|
||||||
@@ -1211,6 +1147,10 @@ const emitter = new EventEmitter();
|
|||||||
setMaxListeners(5, target, emitter);
|
setMaxListeners(5, target, emitter);
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
v15.4.0
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type | Description |
|
| Name | Type | Description |
|
||||||
@@ -1222,23 +1162,19 @@ setMaxListeners(5, target, emitter);
|
|||||||
|
|
||||||
`void`
|
`void`
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
v15.4.0
|
|
||||||
|
|
||||||
#### Inherited from
|
#### Inherited from
|
||||||
|
|
||||||
EventEmitter.setMaxListeners
|
EventEmitter.setMaxListeners
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/@types/node/events.d.ts:346
|
node_modules/@types/node/events.d.ts:317
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### success
|
### success
|
||||||
|
|
||||||
▸ **success**(`module`): `Object`
|
▸ `Static` **success**(`module`): `Object`
|
||||||
|
|
||||||
Creates a compliant SernEmitter module success payload
|
Creates a compliant SernEmitter module success payload
|
||||||
|
|
||||||
@@ -1252,20 +1188,15 @@ Creates a compliant SernEmitter module success payload
|
|||||||
|
|
||||||
`Object`
|
`Object`
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :------ | :------ |
|
|
||||||
| `module` | `AnyModule` |
|
|
||||||
| `type` | [`Success`](../enums/PayloadType.md#success) |
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/sern-emitter.ts#L72)
|
[src/core/structures/sern-emitter.ts:72](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L72)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### warning
|
### warning
|
||||||
|
|
||||||
▸ **warning**(`reason`): `Object`
|
▸ `Static` **warning**(`reason`): `Object`
|
||||||
|
|
||||||
Creates a compliant SernEmitter module warning payload
|
Creates a compliant SernEmitter module warning payload
|
||||||
|
|
||||||
@@ -1279,11 +1210,6 @@ Creates a compliant SernEmitter module warning payload
|
|||||||
|
|
||||||
`Object`
|
`Object`
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :------ | :------ |
|
|
||||||
| `reason` | `string` |
|
|
||||||
| `type` | [`Warning`](../enums/PayloadType.md#warning) |
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/sern-emitter.ts#L82)
|
[src/core/structures/sern-emitter.ts:82](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/sern-emitter.ts#L82)
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ export default commandModule({
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L20)
|
[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L23)
|
[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L29)
|
[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L22)
|
[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L22)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L21)
|
[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L21)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L28)
|
[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L25)
|
[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L25)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L27)
|
[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L27)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -112,7 +112,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L19)
|
[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -122,7 +122,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L24)
|
[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -132,7 +132,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L18)
|
[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L18)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -142,4 +142,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L26)
|
[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L26)
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ The EventType for handling discord events
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L51)
|
[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L51)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ Could be for example, `process` events, database events
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L60)
|
[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L60)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -56,4 +56,4 @@ The EventType for handling sern events
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L55)
|
[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L55)
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ The PayloadType for a SernEmitter failure event
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L98)
|
[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L98)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ The PayloadType for a SernEmitter success event
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L94)
|
[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L94)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -40,4 +40,4 @@ The PayloadType for a SernEmitter warning event
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L102)
|
[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L102)
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ The PluginType for EventPlugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L85)
|
[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L85)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -42,4 +42,4 @@ The PluginType for InitPlugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L81)
|
[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/e1059f9/src/core/structures/enums.ts#L81)
|
||||||
|
|||||||
@@ -26,17 +26,30 @@ custom_edit_url: null
|
|||||||
- For you. A framework that's tailored to your exact needs.
|
- For you. A framework that's tailored to your exact needs.
|
||||||
- Lightweight. Does a lot while being small.
|
- Lightweight. Does a lot while being small.
|
||||||
- Latest features. Support for discord.js v14 and all of its interactions.
|
- Latest features. Support for discord.js v14 and all of its interactions.
|
||||||
|
- Hybrid, customizable and composable commands. Create them just how you like.
|
||||||
- Start quickly. Plug and play or customize to your liking.
|
- Start quickly. Plug and play or customize to your liking.
|
||||||
- works with [bun](https://bun.sh/) and [node](https://nodejs.org/en) out the box!
|
- Embraces reactive programming. For consistent and reliable backend.
|
||||||
|
- Switch and customize how errors are handled, logging, and more.
|
||||||
- Use it with TypeScript or JavaScript. CommonJS and ESM supported.
|
- Use it with TypeScript or JavaScript. CommonJS and ESM supported.
|
||||||
- Active and growing community, always here to help. [Join us](https://sern.dev/discord)
|
- 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.
|
- Unleash its full potential with a powerful CLI and awesome plugins.
|
||||||
|
|
||||||
## 📜 Installation
|
## 📜 Installation
|
||||||
[Start here!!](https://sern.dev/docs/guide/walkthrough/new-project)
|
|
||||||
|
```sh
|
||||||
|
npm install @sern/handler
|
||||||
|
```
|
||||||
|
|
||||||
|
```sh
|
||||||
|
yarn add @sern/handler
|
||||||
|
```
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pnpm add @sern/handler
|
||||||
|
```
|
||||||
|
|
||||||
## 👶 Basic Usage
|
## 👶 Basic Usage
|
||||||
<details><summary>ping.ts</summary>
|
<details open><summary>ping.ts</summary>
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
export default commandModule({
|
export default commandModule({
|
||||||
@@ -50,7 +63,7 @@ export default commandModule({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
</details>
|
</details>
|
||||||
<details><summary>modal.ts</summary>
|
<details open><summary>modal.ts</summary>
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
export default commandModule({
|
export default commandModule({
|
||||||
@@ -70,6 +83,30 @@ export default commandModule({
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
</details>
|
</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
|
## 🤖 Bots Using sern
|
||||||
- [Community Bot](https://github.com/sern-handler/sern-community), the community bot for our [discord server](https://sern.dev/discord).
|
- [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
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L126)
|
[src/types/core-modules.ts:124](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L124)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L127)
|
[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L125)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -63,7 +63,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:129](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L129)
|
[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L127)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -77,7 +77,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -101,7 +101,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:128](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L128)
|
[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L126)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -115,7 +115,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -129,4 +129,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L125)
|
[src/types/core-modules.ts:123](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L123)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:66](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L66)
|
[src/types/core-modules.ts:64](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L64)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:65](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L65)
|
[src/types/core-modules.ts:63](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L63)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:76](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L76)
|
[src/types/core-modules.ts:74](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L74)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:75](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L75)
|
[src/types/core-modules.ts:73](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L73)
|
||||||
|
|||||||
@@ -1,45 +0,0 @@
|
|||||||
---
|
|
||||||
id: "CommandError.Response"
|
|
||||||
title: "Interface: Response"
|
|
||||||
sidebar_label: "Response"
|
|
||||||
custom_edit_url: null
|
|
||||||
---
|
|
||||||
|
|
||||||
[CommandError](../namespaces/CommandError.md).Response
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### body
|
|
||||||
|
|
||||||
• `Optional` **body**: `ReplyOptions`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
[src/core/structures/command-error.ts:6](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/command-error.ts#L6)
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
### log
|
|
||||||
|
|
||||||
• `Optional` **log**: `Object`
|
|
||||||
|
|
||||||
#### Type declaration
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :------ | :------ |
|
|
||||||
| `message` | `unknown` |
|
|
||||||
| `type` | keyof [`Logging`](Logging.md)<`unknown`\> |
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
[src/core/structures/command-error.ts:7](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/command-error.ts#L7)
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
### type
|
|
||||||
|
|
||||||
• **type**: ``"fail"`` \| ``"continue"``
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
[src/core/structures/command-error.ts:5](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/command-error.ts#L5)
|
|
||||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L151)
|
[src/types/core-modules.ts:149](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L149)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L159)
|
[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L157)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:161](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L161)
|
[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L159)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L156)
|
[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L154)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -54,7 +54,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L152)
|
[src/types/core-modules.ts:150](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L150)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -64,7 +64,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L158)
|
[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L156)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -74,7 +74,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L153)
|
[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L151)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -84,7 +84,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L157)
|
[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L155)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L155)
|
[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L153)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -104,7 +104,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L160)
|
[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L158)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -114,7 +114,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:162](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L162)
|
[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L160)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -124,4 +124,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L154)
|
[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L152)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:61](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L61)
|
[src/types/core-modules.ts:59](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L59)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:60](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L60)
|
[src/types/core-modules.ts:58](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L58)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:56](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L56)
|
[src/types/core-modules.ts:54](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L54)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:55](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L55)
|
[src/types/core-modules.ts:53](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L53)
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L73)
|
[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L73)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,4 +44,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L72)
|
[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L72)
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L59)
|
[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L59)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -40,4 +40,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L60)
|
[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L60)
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L28)
|
[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:30](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L30)
|
[src/types/ioc.ts:30](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L30)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:33](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L33)
|
[src/types/ioc.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L29)
|
[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:32](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L32)
|
[src/types/ioc.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -112,4 +112,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:31](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L31)
|
[src/types/ioc.ts:31](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L31)
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ Represents a core module store that stores IDs mapped to file paths.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-store.ts#L7)
|
[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-store.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -30,4 +30,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-store.ts#L8)
|
[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-store.ts#L8)
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L107)
|
[src/types/core-modules.ts:105](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L105)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:108](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L108)
|
[src/types/core-modules.ts:106](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L106)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -110,4 +110,4 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:109](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L109)
|
[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L107)
|
||||||
|
|||||||
@@ -21,4 +21,4 @@ Let dependencies implement this to dispose and cleanup.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/disposable.ts:8](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/disposable.ts#L8)
|
[src/core/contracts/disposable.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/disposable.ts#L8)
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/emitter.ts:4](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/emitter.ts#L4)
|
[src/core/contracts/emitter.ts:4](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/emitter.ts#L4)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/emitter.ts#L6)
|
[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/emitter.ts#L6)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -67,4 +67,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/emitter.ts:5](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/emitter.ts#L5)
|
[src/core/contracts/emitter.ts:5](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/emitter.ts#L5)
|
||||||
|
|||||||
@@ -14,12 +14,28 @@ custom_edit_url: null
|
|||||||
|
|
||||||
- [`DefaultErrorHandling`](../classes/DefaultErrorHandling.md)
|
- [`DefaultErrorHandling`](../classes/DefaultErrorHandling.md)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### keepAlive
|
||||||
|
|
||||||
|
• **keepAlive**: `number`
|
||||||
|
|
||||||
|
Number of times the process should throw an error until crashing and exiting
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/error-handling.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/error-handling.ts#L8)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
### crash
|
### crash
|
||||||
|
|
||||||
▸ **crash**(`err`): `never`
|
▸ **crash**(`err`): `never`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Version 4 will remove this method
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -30,13 +46,9 @@ custom_edit_url: null
|
|||||||
|
|
||||||
`never`
|
`never`
|
||||||
|
|
||||||
**`Deprecated`**
|
|
||||||
|
|
||||||
Version 4 will remove this method
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/error-handling.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/error-handling.ts#L11)
|
[src/core/contracts/error-handling.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/error-handling.ts#L14)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,7 +56,8 @@ ___
|
|||||||
|
|
||||||
▸ **updateAlive**(`error`): `void`
|
▸ **updateAlive**(`error`): `void`
|
||||||
|
|
||||||
A function that is called on every throw.
|
A function that is called on every crash. Updates keepAlive.
|
||||||
|
If keepAlive is 0, the process crashes.
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
@@ -58,4 +71,4 @@ A function that is called on every throw.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/error-handling.ts:16](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/error-handling.ts#L16)
|
[src/core/contracts/error-handling.ts:20](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/error-handling.ts#L20)
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:167](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L167)
|
[src/types/core-modules.ts:165](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L165)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L166)
|
[src/types/core-modules.ts:164](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L164)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -34,4 +34,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:168](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L168)
|
[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L166)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L49)
|
[src/types/core-modules.ts:47](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L47)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L48)
|
[src/types/core-modules.ts:46](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L46)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:50](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L50)
|
[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L48)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -114,4 +114,4 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:51](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L51)
|
[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L49)
|
||||||
|
|||||||
@@ -21,4 +21,4 @@ Let dependencies implement this to initiate some logic.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/init.ts:8](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/init.ts#L8)
|
[src/core/contracts/init.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/init.ts#L8)
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L69)
|
[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L69)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,4 +44,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L68)
|
[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L68)
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L8)
|
[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L8)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L5)
|
[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L5)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L7)
|
[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -98,4 +98,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L6)
|
[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L6)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:86](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L86)
|
[src/types/core-modules.ts:84](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L84)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:85](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L85)
|
[src/types/core-modules.ts:83](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L83)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:96](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L96)
|
[src/types/core-modules.ts:94](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L94)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:95](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L95)
|
[src/types/core-modules.ts:93](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L93)
|
||||||
|
|||||||
@@ -9,13 +9,6 @@ custom_edit_url: null
|
|||||||
**`Since`**
|
**`Since`**
|
||||||
|
|
||||||
2.0.0
|
2.0.0
|
||||||
- direct access to the module manager will be removed in version 4
|
|
||||||
|
|
||||||
## Hierarchy
|
|
||||||
|
|
||||||
- `MetadataAccess`
|
|
||||||
|
|
||||||
↳ **`ModuleManager`**
|
|
||||||
|
|
||||||
## Implemented by
|
## Implemented by
|
||||||
|
|
||||||
@@ -39,7 +32,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/module-manager.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L19)
|
[src/core/contracts/module-manager.ts:13](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +59,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/module-manager.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L23)
|
[src/core/contracts/module-manager.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L18)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -84,13 +77,9 @@ ___
|
|||||||
|
|
||||||
`undefined` \| `CommandMeta`
|
`undefined` \| `CommandMeta`
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
MetadataAccess.getMetadata
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/module-manager.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L10)
|
[src/core/contracts/module-manager.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L14)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -104,7 +93,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/module-manager.ts:22](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L22)
|
[src/core/contracts/module-manager.ts:17](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L17)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -125,7 +114,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/module-manager.ts:21](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L21)
|
[src/core/contracts/module-manager.ts:16](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -144,10 +133,6 @@ ___
|
|||||||
|
|
||||||
`void`
|
`void`
|
||||||
|
|
||||||
#### Inherited from
|
|
||||||
|
|
||||||
MetadataAccess.setMetadata
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/module-manager.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L11)
|
[src/core/contracts/module-manager.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/module-manager.ts#L15)
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L64)
|
[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L64)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,4 +44,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L63)
|
[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L63)
|
||||||
|
|||||||
@@ -1,82 +0,0 @@
|
|||||||
---
|
|
||||||
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/9d5c6c7/src/core/presences.ts#L11)
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
### afk
|
|
||||||
|
|
||||||
• `Optional` **afk**: `boolean`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
[src/core/presences.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/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/9d5c6c7/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/9d5c6c7/src/core/presences.ts#L13)
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
### shardId
|
|
||||||
|
|
||||||
• `Optional` **shardId**: `number`[]
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
[src/core/presences.ts:12](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/presences.ts#L12)
|
|
||||||
|
|
||||||
___
|
|
||||||
|
|
||||||
### status
|
|
||||||
|
|
||||||
• `Optional` **status**: `Status`
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
[src/core/presences.ts:9](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/presences.ts#L9)
|
|
||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:81](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L81)
|
[src/types/core-modules.ts:79](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L79)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:80](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L80)
|
[src/types/core-modules.ts:78](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L78)
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:173](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L173)
|
[src/types/core-modules.ts:171](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L171)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -30,7 +30,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:178](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L178)
|
[src/types/core-modules.ts:176](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L176)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ Omit.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4493
|
node_modules/discord.js/typings/index.d.ts:4301
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ Omit.descriptionLocalizations
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4494
|
node_modules/discord.js/typings/index.d.ts:4302
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ Omit.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4491
|
node_modules/discord.js/typings/index.d.ts:4299
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ Omit.nameLocalizations
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4492
|
node_modules/discord.js/typings/index.d.ts:4300
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ Omit.required
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4495
|
node_modules/discord.js/typings/index.d.ts:4303
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,4 +110,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:174](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L174)
|
[src/types/core-modules.ts:172](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L172)
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L43)
|
[src/types/core-modules.ts:41](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L41)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L44)
|
[src/types/core-modules.ts:42](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L42)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -110,4 +110,4 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:45](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L45)
|
[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L43)
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L21)
|
[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L21)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L20)
|
[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L19)
|
[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,7 +44,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L23)
|
[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -54,4 +54,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L22)
|
[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L22)
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:210](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L210)
|
[src/types/core-modules.ts:208](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L208)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -104,4 +104,4 @@ APIApplicationCommandOptionBase.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:209](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L209)
|
[src/types/core-modules.ts:207](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L207)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ BaseApplicationCommandOptionsData.autocomplete
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4496
|
node_modules/discord.js/typings/index.d.ts:4304
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ BaseApplicationCommandOptionsData.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4493
|
node_modules/discord.js/typings/index.d.ts:4301
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ BaseApplicationCommandOptionsData.descriptionLocalizations
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4494
|
node_modules/discord.js/typings/index.d.ts:4302
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ BaseApplicationCommandOptionsData.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4491
|
node_modules/discord.js/typings/index.d.ts:4299
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ BaseApplicationCommandOptionsData.nameLocalizations
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4492
|
node_modules/discord.js/typings/index.d.ts:4300
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:215](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L215)
|
[src/types/core-modules.ts:213](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L213)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -104,7 +104,7 @@ BaseApplicationCommandOptionsData.required
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
node_modules/discord.js/typings/index.d.ts:4495
|
node_modules/discord.js/typings/index.d.ts:4303
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -114,4 +114,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:214](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L214)
|
[src/types/core-modules.ts:212](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L212)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L119)
|
[src/types/core-modules.ts:117](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L117)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -53,7 +53,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L121)
|
[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L119)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -67,7 +67,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -81,7 +81,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L120)
|
[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L118)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -105,7 +105,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -119,4 +119,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L118)
|
[src/types/core-modules.ts:116](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L116)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:71](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L71)
|
[src/types/core-modules.ts:69](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L69)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:70](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L70)
|
[src/types/core-modules.ts:68](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L68)
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:113](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L113)
|
[src/types/core-modules.ts:111](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L111)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -63,7 +63,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:114](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L114)
|
[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L112)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -77,7 +77,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -105,7 +105,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -119,4 +119,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L112)
|
[src/types/core-modules.ts:110](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L110)
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ Module.description
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Module.execute
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:91](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L91)
|
[src/types/core-modules.ts:89](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L89)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ Module.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
[src/types/core-modules.ts:32](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ Module.onEvent
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
[src/types/core-modules.ts:33](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Module.plugins
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ Module.type
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:90](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L90)
|
[src/types/core-modules.ts:88](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L88)
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L9)
|
[src/types/core.ts:8](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L8)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -30,7 +30,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core.ts:20](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L20)
|
[src/types/core.ts:19](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L10)
|
[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L9)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L11)
|
[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L10)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,4 +66,4 @@ Overload to enable mode in case developer does not use a .env file.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core.ts:16](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L16)
|
[src/types/core.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core.ts#L15)
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ custom_edit_url: null
|
|||||||
|
|
||||||
## Namespaces
|
## Namespaces
|
||||||
|
|
||||||
- [Presence](namespaces/Presence.md)
|
|
||||||
- [Sern](namespaces/Sern.md)
|
- [Sern](namespaces/Sern.md)
|
||||||
|
|
||||||
## Enumerations
|
## Enumerations
|
||||||
@@ -66,6 +65,12 @@ custom_edit_url: null
|
|||||||
- [UserSelectCommand](interfaces/UserSelectCommand.md)
|
- [UserSelectCommand](interfaces/UserSelectCommand.md)
|
||||||
- [Wrapper](interfaces/Wrapper.md)
|
- [Wrapper](interfaces/Wrapper.md)
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
### controller
|
||||||
|
|
||||||
|
Re-exports [controller](namespaces/Sern.md#controller)
|
||||||
|
|
||||||
## Type Aliases
|
## Type Aliases
|
||||||
|
|
||||||
### AnyCommandPlugin
|
### AnyCommandPlugin
|
||||||
@@ -74,7 +79,7 @@ custom_edit_url: null
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L76)
|
[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L76)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -84,17 +89,17 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L77)
|
[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L77)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### Args
|
### Args
|
||||||
|
|
||||||
Ƭ **Args**: `ParseType`<\{ `slash`: [`SlashOptions`](modules.md#slashoptions) ; `text`: `string`[] }\>
|
Ƭ **Args**: `ParseType`<{ `slash`: [`SlashOptions`](modules.md#slashoptions) ; `text`: `string`[] }\>
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L16)
|
[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -104,7 +109,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:133](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L133)
|
[src/types/core-modules.ts:131](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L131)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -114,7 +119,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:132](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L132)
|
[src/types/core-modules.ts:130](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L130)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -133,7 +138,7 @@ If T has an init method, this will be called.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L17)
|
[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L17)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -155,17 +160,17 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L11)
|
[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/e1059f9/src/core/contracts/logging.ts#L11)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
### Payload
|
### 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
|
#### Defined in
|
||||||
|
|
||||||
[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L26)
|
[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L26)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -175,7 +180,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L51)
|
[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-plugin.ts#L51)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -187,7 +192,7 @@ Type that replaces autocomplete with [SernAutocompleteData](interfaces/SernAutoc
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/core-modules.ts:201](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L201)
|
[src/types/core-modules.ts:199](https://github.com/sern-handler/handler/blob/e1059f9/src/types/core-modules.ts#L199)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -214,7 +219,7 @@ T is created once and lazily.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L7)
|
[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/e1059f9/src/types/ioc.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -224,7 +229,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L14)
|
[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/e1059f9/src/types/utility.ts#L14)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -257,29 +262,7 @@ Every time this is called, a new object is created
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L12)
|
[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/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/9d5c6c7/src/core/create-plugins.ts#L69)
|
|
||||||
|
|
||||||
## Functions
|
## Functions
|
||||||
|
|
||||||
@@ -287,6 +270,11 @@ The object passed into every plugin to control a command's behavior
|
|||||||
|
|
||||||
▸ **CommandControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
▸ **CommandControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -303,14 +291,9 @@ The object passed into every plugin to control a command's behavior
|
|||||||
|
|
||||||
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
2.5.0
|
|
||||||
@__PURE__
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/create-plugins.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L37)
|
[src/core/create-plugins.ts:36](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L36)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -318,6 +301,11 @@ ___
|
|||||||
|
|
||||||
▸ **CommandInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
▸ **CommandInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -334,14 +322,9 @@ ___
|
|||||||
|
|
||||||
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
2.5.0
|
|
||||||
@__PURE__
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/create-plugins.ts:28](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L28)
|
[src/core/create-plugins.ts:27](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L27)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -349,6 +332,15 @@ ___
|
|||||||
|
|
||||||
▸ **DiscordEventControlPlugin**<`T`\>(`name`, `execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
▸ **DiscordEventControlPlugin**<`T`\>(`name`, `execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
|
||||||
|
**`Experimental`**
|
||||||
|
|
||||||
|
A specialized function for creating control plugins with discord.js ClientEvents.
|
||||||
|
Will probably be moved one day!
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -366,18 +358,9 @@ ___
|
|||||||
|
|
||||||
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
2.5.0
|
|
||||||
|
|
||||||
**`Experimental`**
|
|
||||||
|
|
||||||
A specialized function for creating control plugins with discord.js ClientEvents.
|
|
||||||
Will probably be moved one day!
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/create-plugins.ts:58](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L58)
|
[src/core/create-plugins.ts:57](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L57)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -385,6 +368,11 @@ ___
|
|||||||
|
|
||||||
▸ **EventControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
▸ **EventControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -401,14 +389,9 @@ ___
|
|||||||
|
|
||||||
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
2.5.0
|
|
||||||
@__PURE__
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/create-plugins.ts:46](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L46)
|
[src/core/create-plugins.ts:45](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L45)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -416,6 +399,11 @@ ___
|
|||||||
|
|
||||||
▸ **EventInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
▸ **EventInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -432,14 +420,9 @@ ___
|
|||||||
|
|
||||||
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
2.5.0
|
|
||||||
@__PURE__
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/create-plugins.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L19)
|
[src/core/create-plugins.ts:18](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L18)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -451,6 +434,16 @@ The new Service api, a cleaner alternative to useContainer
|
|||||||
To obtain intellisense, ensure a .d.ts file exists in the root of compilation.
|
To obtain intellisense, ensure a .d.ts file exists in the root of compilation.
|
||||||
Usually our scaffolding tool takes care of this.
|
Usually our scaffolding tool takes care of this.
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
3.0.0
|
||||||
|
|
||||||
|
**`Example`**
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const client = Service('@sern/client');
|
||||||
|
```
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -467,19 +460,9 @@ Usually our scaffolding tool takes care of this.
|
|||||||
|
|
||||||
`NonNullable`<`UnpackFunction`<`Partial`<`Dependencies`\>[`T`]\>\>
|
`NonNullable`<`UnpackFunction`<`Partial`<`Dependencies`\>[`T`]\>\>
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
3.0.0
|
|
||||||
|
|
||||||
**`Example`**
|
|
||||||
|
|
||||||
```ts
|
|
||||||
const client = Service('@sern/client');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/ioc/dependency-injection.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/dependency-injection.ts#L36)
|
[src/core/ioc/dependency-injection.ts:37](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/dependency-injection.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -487,6 +470,11 @@ ___
|
|||||||
|
|
||||||
▸ **Services**<`T`\>(`...keys`): `IntoDependencies`<`T`\>
|
▸ **Services**<`T`\>(`...keys`): `IntoDependencies`<`T`\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
3.0.0
|
||||||
|
The plural version of [Service](modules.md#service)
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -505,14 +493,9 @@ ___
|
|||||||
|
|
||||||
array of dependencies, in the same order of keys provided
|
array of dependencies, in the same order of keys provided
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
3.0.0
|
|
||||||
The plural version of [Service](modules.md#service)
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/ioc/dependency-injection.ts:44](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/dependency-injection.ts#L44)
|
[src/core/ioc/dependency-injection.ts:45](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/dependency-injection.ts#L45)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -520,6 +503,10 @@ ___
|
|||||||
|
|
||||||
▸ **commandModule**(`mod`): [`CommandModule`](modules.md#commandmodule)
|
▸ **commandModule**(`mod`): [`CommandModule`](modules.md#commandmodule)
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
1.0.0 The wrapper function to define command modules for sern
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -530,13 +517,9 @@ ___
|
|||||||
|
|
||||||
[`CommandModule`](modules.md#commandmodule)
|
[`CommandModule`](modules.md#commandmodule)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
1.0.0 The wrapper function to define command modules for sern
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:25](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L25)
|
[src/core/modules.ts:25](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L25)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -548,6 +531,8 @@ Create event modules from discord.js client events,
|
|||||||
This is an [eventModule](modules.md#eventmodule-1) for discord events,
|
This is an [eventModule](modules.md#eventmodule-1) for discord events,
|
||||||
where typings can be very bad.
|
where typings can be very bad.
|
||||||
|
|
||||||
|
**`Experimental`**
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -567,11 +552,9 @@ where typings can be very bad.
|
|||||||
|
|
||||||
[`EventModule`](modules.md#eventmodule)
|
[`EventModule`](modules.md#eventmodule)
|
||||||
|
|
||||||
**`Experimental`**
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:53](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L53)
|
[src/core/modules.ts:53](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L53)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -579,6 +562,11 @@ ___
|
|||||||
|
|
||||||
▸ **eventModule**(`mod`): [`EventModule`](modules.md#eventmodule)
|
▸ **eventModule**(`mod`): [`EventModule`](modules.md#eventmodule)
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
1.0.0
|
||||||
|
The wrapper function to define event modules for sern
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -589,14 +577,9 @@ ___
|
|||||||
|
|
||||||
[`EventModule`](modules.md#eventmodule)
|
[`EventModule`](modules.md#eventmodule)
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
1.0.0
|
|
||||||
The wrapper function to define event modules for sern
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/modules.ts:38](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L38)
|
[src/core/modules.ts:38](https://github.com/sern-handler/handler/blob/e1059f9/src/core/modules.ts#L38)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -604,6 +587,10 @@ ___
|
|||||||
|
|
||||||
▸ **makeDependencies**<`T`\>(`conf`): `Promise`<<V\>(...`keys`: [...V[]]) => `IntoDependencies`<`V`\>\>
|
▸ **makeDependencies**<`T`\>(`conf`): `Promise`<<V\>(...`keys`: [...V[]]) => `IntoDependencies`<`V`\>\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type |
|
||||||
@@ -612,9 +599,9 @@ ___
|
|||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
| Name | Type |
|
| Name | Type | Description |
|
||||||
| :------ | :------ |
|
| :------ | :------ | :------ |
|
||||||
| `conf` | `ValidDependencyConfig` |
|
| `conf` | `DependencyConfiguration` | a configuration for creating your project dependencies |
|
||||||
|
|
||||||
#### Returns
|
#### Returns
|
||||||
|
|
||||||
@@ -622,7 +609,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/ioc/base.ts:90](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/base.ts#L90)
|
[src/core/ioc/base.ts:27](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/base.ts#L27)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -649,7 +636,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/create-plugins.ts:6](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L6)
|
[src/core/create-plugins.ts:5](https://github.com/sern-handler/handler/blob/e1059f9/src/core/create-plugins.ts#L5)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -659,6 +646,11 @@ ___
|
|||||||
|
|
||||||
@__PURE__
|
@__PURE__
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0.
|
||||||
|
Creates a singleton object.
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name |
|
| Name |
|
||||||
@@ -681,14 +673,9 @@ ___
|
|||||||
|
|
||||||
`T`
|
`T`
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
2.0.0.
|
|
||||||
Creates a singleton object.
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/ioc/dependency-injection.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/dependency-injection.ts#L11)
|
[src/core/ioc/dependency-injection.ts:12](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/dependency-injection.ts#L12)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -698,6 +685,11 @@ ___
|
|||||||
|
|
||||||
@__PURE__
|
@__PURE__
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
Creates a transient object
|
||||||
|
|
||||||
#### Type parameters
|
#### Type parameters
|
||||||
|
|
||||||
| Name |
|
| Name |
|
||||||
@@ -726,14 +718,9 @@ ___
|
|||||||
|
|
||||||
`T`
|
`T`
|
||||||
|
|
||||||
**`Since`**
|
|
||||||
|
|
||||||
2.0.0
|
|
||||||
Creates a transient object
|
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/ioc/dependency-injection.ts:21](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/dependency-injection.ts#L21)
|
[src/core/ioc/dependency-injection.ts:22](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/dependency-injection.ts#L22)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -741,16 +728,16 @@ ___
|
|||||||
|
|
||||||
▸ **useContainerRaw**(): `CoreContainer`<`Partial`<`Dependencies`\>\>
|
▸ **useContainerRaw**(): `CoreContainer`<`Partial`<`Dependencies`\>\>
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`CoreContainer`<`Partial`<`Dependencies`\>\>
|
|
||||||
|
|
||||||
**`Deprecated`**
|
**`Deprecated`**
|
||||||
|
|
||||||
Returns the underlying data structure holding all dependencies.
|
Returns the underlying data structure holding all dependencies.
|
||||||
Exposes methods from iti
|
Exposes methods from iti
|
||||||
Use the Service API. The container should be readonly
|
Use the Service API. The container should be readonly
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`CoreContainer`<`Partial`<`Dependencies`\>\>
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/core/ioc/base.ts:18](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/base.ts#L18)
|
[src/core/ioc/base.ts:15](https://github.com/sern-handler/handler/blob/e1059f9/src/core/ioc/base.ts#L15)
|
||||||
|
|||||||
@@ -1,31 +0,0 @@
|
|||||||
---
|
|
||||||
id: "CommandError"
|
|
||||||
title: "Namespace: CommandError"
|
|
||||||
sidebar_label: "CommandError"
|
|
||||||
sidebar_position: 0
|
|
||||||
custom_edit_url: null
|
|
||||||
---
|
|
||||||
|
|
||||||
## Interfaces
|
|
||||||
|
|
||||||
- [Response](../interfaces/CommandError.Response.md)
|
|
||||||
|
|
||||||
## Functions
|
|
||||||
|
|
||||||
### of
|
|
||||||
|
|
||||||
▸ **of**(): `Object`
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`Object`
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :------ | :------ |
|
|
||||||
| `log` | <T\>(`type`: keyof [`Logging`](../interfaces/Logging.md)<`unknown`\>, `message`: `T`) => `Record`<`PropertyKey`, `unknown`\> |
|
|
||||||
| `reply` | (`bodyContent`: `ReplyOptions`) => `Record`<`PropertyKey`, `unknown`\> |
|
|
||||||
| `status` | (`p`: ``"fail"`` \| ``"continue"``) => `Record`<`PropertyKey`, `unknown`\> |
|
|
||||||
|
|
||||||
#### Defined in
|
|
||||||
|
|
||||||
[src/core/structures/command-error.ts:10](https://github.com/sern-handler/handler/blob/504cdee/src/core/structures/command-error.ts#L10)
|
|
||||||
@@ -1,93 +0,0 @@
|
|||||||
---
|
|
||||||
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/9d5c6c7/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/9d5c6c7/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/9d5c6c7/src/core/presences.ts#L39)
|
|
||||||
@@ -6,22 +6,34 @@ sidebar_position: 0
|
|||||||
custom_edit_url: null
|
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/e1059f9/src/sern.ts#L63)
|
||||||
|
|
||||||
## Functions
|
## Functions
|
||||||
|
|
||||||
### init
|
### init
|
||||||
|
|
||||||
▸ **init**(`maybeWrapper`): `void`
|
▸ **init**(`maybeWrapper`): `void`
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type |
|
|
||||||
| :------ | :------ |
|
|
||||||
| `maybeWrapper` | [`Wrapper`](../interfaces/Wrapper.md) \| ``"file"`` |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
`void`
|
|
||||||
|
|
||||||
**`Since`**
|
**`Since`**
|
||||||
|
|
||||||
1.0.0
|
1.0.0
|
||||||
@@ -35,6 +47,16 @@ Sern.init({
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `maybeWrapper` | [`Wrapper`](../interfaces/Wrapper.md) \| ``"file"`` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[src/sern.ts:27](https://github.com/sern-handler/handler/blob/9d5c6c7/src/sern.ts#L27)
|
[src/sern.ts:24](https://github.com/sern-handler/handler/blob/e1059f9/src/sern.ts#L24)
|
||||||
|
|||||||
@@ -1,28 +0,0 @@
|
|||||||
```sh
|
|
||||||
Usage: sern commands clear [options]
|
|
||||||
|
|
||||||
Clear and reset commands-data-remote.json and the api
|
|
||||||
|
|
||||||
Options:
|
|
||||||
-y, --yes Say yes to all prompts
|
|
||||||
-e, --env [path] Supply a path to a .env
|
|
||||||
-h, --help display help for command
|
|
||||||
```
|
|
||||||
## Implicits
|
|
||||||
- Automatically reads a .env in the working directory. For seamless integration, your .env file should look like this:
|
|
||||||
```txt title=".env"
|
|
||||||
DISCORD_TOKEN=<YOUR_TOKEN>
|
|
||||||
APPLICATION_ID=<YOUR_APPLICATION_ID>
|
|
||||||
NODE_ENV=<development|production>
|
|
||||||
```
|
|
||||||
- Calls the discord API with the [PUT route](https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands) with an EMPTY array, essentially setting all registered commands to nothing.
|
|
||||||
|
|
||||||
- Optionally override an .env path as a command line argument as well. **CLI arguments take precedence.**
|
|
||||||
If you do not know how to obtain either of these credentials, [click here](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)
|
|
||||||
|
|
||||||
- Automatically confirm with the **-y** flag.
|
|
||||||
|
|
||||||
## Features
|
|
||||||
- Clears all application data and sern-commands-data.json
|
|
||||||
|
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ Options:
|
|||||||
```txt title=".env"
|
```txt title=".env"
|
||||||
DISCORD_TOKEN=<YOUR_TOKEN>
|
DISCORD_TOKEN=<YOUR_TOKEN>
|
||||||
APPLICATION_ID=<YOUR_APPLICATION_ID>
|
APPLICATION_ID=<YOUR_APPLICATION_ID>
|
||||||
NODE_ENV=<production|development>
|
MODE=<DEV|PROD>
|
||||||
```
|
```
|
||||||
- Calls the discord API with the [PUT route](https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands). Wherever your commands directory is located, publish will override the existing application commands at Discord. Existing commands do not count towards the command limit creation daily.
|
- Calls the discord API with the [PUT route](https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands). Wherever your commands directory is located, publish will override the existing application commands at Discord. Existing commands do not count towards the command limit creation daily.
|
||||||
|
|
||||||
|
|||||||
@@ -4,9 +4,21 @@ sidebar_position: 1
|
|||||||
|
|
||||||
# Create a new project
|
# Create a new project
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install -g @sern/cli
|
||||||
|
```
|
||||||
|
Running this will install our CLI. (you'll probably want to download this)
|
||||||
|
- helps manage your applications
|
||||||
|
- plugs you into the sern ecosystem.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Create a new bot
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm create @sern/bot
|
npm create @sern/bot
|
||||||
```
|
```
|
||||||
and follow the interactive prompts.
|
and follow the interactive prompts.
|
||||||
|
|
||||||
if somehow you need help, feel free to ask [here](https://sern.dev.discord)
|
if somehow you need help, feel free to ask [here](https://sern.dev.discord)
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ const config = {
|
|||||||
// to replace "en" with "zh-Hans".
|
// to replace "en" with "zh-Hans".
|
||||||
i18n: {
|
i18n: {
|
||||||
defaultLocale: 'en',
|
defaultLocale: 'en',
|
||||||
locales: ['en']
|
locales: ['en', 'fr', 'tr'],
|
||||||
},
|
},
|
||||||
presets: [
|
presets: [
|
||||||
[
|
[
|
||||||
@@ -177,28 +177,27 @@ const config = {
|
|||||||
darkTheme: darkCodeTheme,
|
darkTheme: darkCodeTheme,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
plugins: [
|
plugins : [
|
||||||
/* [
|
[
|
||||||
'docusaurus-plugin-typedoc',
|
// 'docusaurus-plugin-typedoc',
|
||||||
{
|
// {
|
||||||
//if you're editing website, please change this to your local branch of sern to generate documentation
|
// //if you're editing website, please change this to your local branch of sern to generate documentation
|
||||||
entryPoints: ['../sernHandlerV2/src/index.ts'],
|
// entryPoints: ['../sernHandlerV2/src/index.ts'],
|
||||||
tsconfig: '../sernHandlerV2/tsconfig.json',
|
// tsconfig: '../sernHandlerV2/tsconfig.json',
|
||||||
},
|
// },
|
||||||
], */
|
"@dipakparmar/docusaurus-plugin-umami",
|
||||||
[
|
/** @type {import('@dipakparmar/docusaurus-plugin-umami').Options} */
|
||||||
"@dipakparmar/docusaurus-plugin-umami",
|
({
|
||||||
{
|
websiteID: "e82ff65c-b08f-47b5-8e74-5c31cbcec0ad",
|
||||||
websiteID: "e82ff65c-b08f-47b5-8e74-5c31cbcec0ad",
|
analyticsDomain: "analytics.srizan.dev",
|
||||||
analyticsDomain: "analytics.srizan.dev",
|
scriptName: 'ua.js',
|
||||||
scriptName: 'ua.js',
|
dataAutoTrack: true,
|
||||||
dataAutoTrack: true,
|
dataDoNotTrack: true,
|
||||||
dataDoNotTrack: true,
|
dataCache: true,
|
||||||
dataCache: true,
|
dataDomains: "sern.dev",
|
||||||
dataDomains: "sern.dev",
|
}),
|
||||||
},
|
]
|
||||||
]
|
]
|
||||||
]
|
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports = config;
|
module.exports = config;
|
||||||
|
|||||||
@@ -33,8 +33,7 @@
|
|||||||
"@docusaurus/module-type-aliases": "2.0.0-rc.1",
|
"@docusaurus/module-type-aliases": "2.0.0-rc.1",
|
||||||
"docusaurus-plugin-typedoc": "latest",
|
"docusaurus-plugin-typedoc": "latest",
|
||||||
"typedoc": "latest",
|
"typedoc": "latest",
|
||||||
"typedoc-plugin-markdown": "latest",
|
"typedoc-plugin-markdown": "latest"
|
||||||
"typescript": "latest"
|
|
||||||
},
|
},
|
||||||
"browserslist": {
|
"browserslist": {
|
||||||
"production": [
|
"production": [
|
||||||
|
|||||||
Reference in New Issue
Block a user