mirror of
https://github.com/sern-handler/website
synced 2026-06-15 20:32:19 +00:00
Compare commits
263 Commits
1.0.0
...
feat/tutor
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
53e3c59bcb | ||
|
|
0d07c18759 | ||
|
|
289dbff4e3 | ||
| f2554174ce | |||
| 2c5b77a919 | |||
| d08874b844 | |||
| 8454208413 | |||
| a928d730c0 | |||
|
|
8b72bfd07e | ||
|
|
1e14ce2a76 | ||
|
|
6907748dbf | ||
|
|
e9cf39984d | ||
|
|
6b366501f2 | ||
|
|
90b22074df | ||
|
|
ae72c3eedc | ||
|
|
a69e19503c | ||
|
|
edd1d1492d | ||
|
|
92959c3319 | ||
|
|
b14a033c86 | ||
|
|
55a691e787 | ||
|
|
0bd5ab15cb | ||
| 4cd89d146f | |||
| a37d077848 | |||
| cec0ac0912 | |||
| 7e444894c7 | |||
| c0b5631bc7 | |||
|
|
5f521dfa34 | ||
|
|
6242c85b3f | ||
|
|
c047c3b1cc | ||
|
|
828471eba7 | ||
|
|
1b49dc80b5 | ||
|
|
82605f326b | ||
|
|
3b5795c0e6 | ||
|
|
319571df5e | ||
| f56a99dd70 | |||
|
|
dba7c42055 | ||
|
|
f19b46917f | ||
|
|
ebd6de8205 | ||
| f8c0fca0e2 | |||
| 48e87b5bf0 | |||
| c4f59cc4a7 | |||
| 3e1ad95f1c | |||
| ed2029440b | |||
|
|
f07eecc0dd | ||
|
|
677152f47a | ||
| 2fe692f44a | |||
| 6e82a507f3 | |||
| 2d9e5839f2 | |||
| 2da761787d | |||
|
|
fa7bd13c12 | ||
| ca3f108525 | |||
| 2c5837951c | |||
| 93201cc42d | |||
|
|
927de87426 | ||
|
|
09a451f6c4 | ||
|
|
473427db87 | ||
|
|
f2388eb23d | ||
|
|
948b3bb8cf | ||
| ce43790214 | |||
|
|
3eb3690232 | ||
|
|
74b259e1b6 | ||
|
|
76eb15c793 | ||
|
|
2689b95e85 | ||
|
|
e64667b31c | ||
|
|
749b706a02 | ||
|
|
2f757710e1 | ||
|
|
d77ee3f7f5 | ||
|
|
1d142db329 | ||
|
|
71f100d079 | ||
|
|
0b8de88344 | ||
|
|
bfc4d6ac8e | ||
|
|
b06251f499 | ||
|
|
19db611a9b | ||
|
|
ef452e678a | ||
|
|
c7a8611476 | ||
|
|
9802586bf7 | ||
|
|
d59674eca2 | ||
|
|
9168f61c09 | ||
|
|
c1d64d1172 | ||
|
|
2b3cdc2374 | ||
|
|
530a622c36 | ||
|
|
c46f074926 | ||
|
|
3cc8b38390 | ||
|
|
ef6420a669 | ||
|
|
e10e6cbd2f | ||
|
|
d531eb7340 | ||
|
|
332399bb43 | ||
|
|
b97bc9dde7 | ||
|
|
d447a40f98 | ||
|
|
eca35e1309 | ||
|
|
44645d89de | ||
|
|
66bdaf7f9f | ||
|
|
d9a69a4b6b | ||
|
|
70ff70a1bf | ||
|
|
59b6096423 | ||
|
|
ee11018d48 | ||
|
|
e547c0f485 | ||
| 75140b3d38 | |||
|
|
f1917da3e6 | ||
|
|
7a80638a1b | ||
|
|
4c6b6f9177 | ||
|
|
49a910f90a | ||
|
|
05e470b99b | ||
|
|
ebe5c84ba3 | ||
|
|
a4d12af7f2 | ||
|
|
b8377ec5a4 | ||
|
|
b8be42b1d7 | ||
|
|
9eebee836a | ||
|
|
64adb7b0ca | ||
|
|
51a9774b58 | ||
|
|
4feb242b61 | ||
| 24a2098402 | |||
|
|
6ab8f09271 | ||
|
|
04a7824983 | ||
|
|
994f0ca0e8 | ||
|
|
a60c20545e | ||
|
|
9923ad226d | ||
|
|
a418273592 | ||
|
|
cefbc62823 | ||
|
|
437b8759cb | ||
|
|
7e0c9c012f | ||
|
|
9087c085c4 | ||
|
|
adfbe3b8a4 | ||
|
|
39ff89aa00 | ||
|
|
486b4eced9 | ||
|
|
ccc5466b9c | ||
|
|
ffc3e5419a | ||
|
|
c965f6fca2 | ||
| ba9b7605a6 | |||
|
|
3842e2dc35 | ||
|
|
dd0a61d71a | ||
|
|
b588f64dd5 | ||
|
|
9a686c27f0 | ||
|
|
068ee4c7f3 | ||
|
|
61bef454da | ||
|
|
0c5cc44017 | ||
|
|
62e0d6a61e | ||
|
|
784d50b8a7 | ||
|
|
6857d86848 | ||
| 0936b2db77 | |||
|
|
db4c4adfa8 | ||
| 92a99887eb | |||
| ae3a02b066 | |||
| a745ed65f1 | |||
| f4377c8689 | |||
|
|
d253d3845a | ||
| d6378cf861 | |||
| b36464273e | |||
| 7648247f38 | |||
| 0efe03d88a | |||
|
|
7c8008625d | ||
|
|
98254a7391 | ||
|
|
85b6bbb1cf | ||
|
|
24569595f9 | ||
| 647c89755c | |||
| 0e6caf5c8a | |||
|
|
9a7e98bede | ||
|
|
43f6e227ca | ||
|
|
427fa8cdc9 | ||
|
|
ce68afeeaf | ||
|
|
0f01b5863e | ||
|
|
0fafea8539 | ||
|
|
96283b2d45 | ||
|
|
5f28408e05 | ||
|
|
6214328309 | ||
|
|
5244a9d020 | ||
|
|
95f07e7bfa | ||
|
|
428e975fee | ||
|
|
178a49dcc5 | ||
|
|
57b2a3ec73 | ||
|
|
40e4fe60ad | ||
|
|
2051a692be | ||
|
|
4e66d27350 | ||
|
|
e19b5e345e | ||
|
|
8845e3827d | ||
|
|
d30eb72469 | ||
|
|
73478e6d29 | ||
|
|
b9227a70e2 | ||
|
|
07b83f76fe | ||
|
|
3956759f06 | ||
|
|
88b4ffae11 | ||
|
|
2bce9458bf | ||
|
|
cd601bdefe | ||
|
|
ae9c40ee50 | ||
|
|
d4abf4bc9d | ||
|
|
e4eaf9dda2 | ||
|
|
5178605264 | ||
|
|
62982d91e4 | ||
|
|
e8acece51a | ||
|
|
463f0f61e0 | ||
|
|
d23c54dd2c | ||
|
|
e627b8bb55 | ||
|
|
add28784d2 | ||
|
|
0eccac926f | ||
|
|
f18d4ded88 | ||
|
|
a128e8dee6 | ||
|
|
211aeaefbd | ||
|
|
33301874f9 | ||
|
|
cc7bd61542 | ||
|
|
48912ed979 | ||
|
|
cd964af129 | ||
|
|
4e604a0449 | ||
|
|
6f4ab8ef9c | ||
|
|
e43eec5f20 | ||
|
|
fe27ff5a0c | ||
|
|
eb3b049a19 | ||
|
|
974b909946 | ||
|
|
f607b95346 | ||
|
|
ed91cceabc | ||
|
|
83320e49f6 | ||
|
|
fc3dde72f9 | ||
|
|
e0444a9998 | ||
|
|
8e4f5299df | ||
|
|
70010ffe57 | ||
|
|
97309dba62 | ||
|
|
31651e1963 | ||
|
|
05e188439d | ||
|
|
5bfe0f825c | ||
|
|
da0eefdf3b | ||
|
|
2ee09a6e7a | ||
|
|
fc134c0c9c | ||
|
|
24765af575 | ||
|
|
243c020628 | ||
|
|
cff7bd7e09 | ||
|
|
0eec925422 | ||
|
|
b08f1ff29f | ||
|
|
674184badb | ||
|
|
9cfb202014 | ||
|
|
c2e1028bc8 | ||
|
|
99a3ed27f7 | ||
|
|
0e83cb99ec | ||
|
|
23ab9d36f5 | ||
|
|
3fbfdeff76 | ||
|
|
3d05c4873f | ||
|
|
d34b97dfa8 | ||
|
|
e37640b6b2 | ||
|
|
0e363ad491 | ||
|
|
7ff79a4576 | ||
|
|
7771807657 | ||
|
|
8f33ee8e60 | ||
|
|
ed3a4a53e3 | ||
|
|
f84e2e686a | ||
|
|
93e3aeccd8 | ||
|
|
7140a7aef8 | ||
|
|
3abba07c89 | ||
|
|
28395413ae | ||
|
|
70e20f6030 | ||
|
|
2542851e2e | ||
|
|
c129a4e032 | ||
|
|
d8cab0782e | ||
|
|
bf0611bd79 | ||
|
|
3d0cf23c53 | ||
|
|
9a0f5a5dbc | ||
|
|
384e09541b | ||
|
|
97722573fa | ||
|
|
bc6f9048c2 | ||
|
|
c1d5931ccd | ||
|
|
81c7250f63 | ||
|
|
f1db5ff361 | ||
|
|
6aa53edc22 | ||
|
|
2f46becc47 | ||
|
|
54b58d944f | ||
|
|
f90b05bf92 |
39
.github/workflows/docusaurus.yml
vendored
Normal file
39
.github/workflows/docusaurus.yml
vendored
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
name: Deploy to GitHub Pages
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ main ]
|
||||||
|
# Review gh actions docs if you want to further define triggers, paths, etc
|
||||||
|
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
name: Deploy to GitHub Pages
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: 18
|
||||||
|
cache: yarn
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: yarn install --immutable
|
||||||
|
- name: Build website
|
||||||
|
run: yarn build
|
||||||
|
|
||||||
|
# Popular action to deploy to GitHub Pages:
|
||||||
|
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
|
||||||
|
- name: Deploy to GitHub Pages
|
||||||
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
# Build output to publish to the `gh-pages` branch:
|
||||||
|
publish_dir: ./build
|
||||||
|
# The following lines assign commit authorship to the official
|
||||||
|
# GH-Actions bot for deploys to `gh-pages` branch:
|
||||||
|
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
|
||||||
|
# The GH actions bot is used by default if you didn't specify the two fields.
|
||||||
|
# You can swap them out with your own user credentials.
|
||||||
|
user_name: github-actions[bot]
|
||||||
|
user_email: 41898282+github-actions[bot]@users.noreply.github.com
|
||||||
20
.gitignore
vendored
Normal file
20
.gitignore
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Dependencies
|
||||||
|
/node_modules
|
||||||
|
|
||||||
|
# Production
|
||||||
|
/build
|
||||||
|
|
||||||
|
# Generated files
|
||||||
|
.docusaurus
|
||||||
|
.cache-loader
|
||||||
|
|
||||||
|
# Misc
|
||||||
|
.DS_Store
|
||||||
|
.env.local
|
||||||
|
.env.development.local
|
||||||
|
.env.test.local
|
||||||
|
.env.production.local
|
||||||
|
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
8
.idea/.gitignore
generated
vendored
Normal file
8
.idea/.gitignore
generated
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Default ignored files
|
||||||
|
/shelf/
|
||||||
|
/workspace.xml
|
||||||
|
# Editor-based HTTP Client requests
|
||||||
|
/httpRequests/
|
||||||
|
# Datasource local storage ignored files
|
||||||
|
/dataSources/
|
||||||
|
/dataSources.local.xml
|
||||||
7
.idea/discord.xml
generated
Normal file
7
.idea/discord.xml
generated
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="DiscordProjectSettings">
|
||||||
|
<option name="show" value="PROJECT_FILES" />
|
||||||
|
<option name="description" value="" />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
22
.idea/inspectionProfiles/Project_Default.xml
generated
Normal file
22
.idea/inspectionProfiles/Project_Default.xml
generated
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
<component name="InspectionProjectProfileManager">
|
||||||
|
<profile version="1.0">
|
||||||
|
<option name="myName" value="Project Default" />
|
||||||
|
<inspection_tool class="HtmlUnknownTag" enabled="true" level="WARNING" enabled_by_default="true">
|
||||||
|
<option name="myValues">
|
||||||
|
<value>
|
||||||
|
<list size="7">
|
||||||
|
<item index="0" class="java.lang.String" itemvalue="nobr" />
|
||||||
|
<item index="1" class="java.lang.String" itemvalue="noembed" />
|
||||||
|
<item index="2" class="java.lang.String" itemvalue="comment" />
|
||||||
|
<item index="3" class="java.lang.String" itemvalue="noscript" />
|
||||||
|
<item index="4" class="java.lang.String" itemvalue="embed" />
|
||||||
|
<item index="5" class="java.lang.String" itemvalue="script" />
|
||||||
|
<item index="6" class="java.lang.String" itemvalue="herotitle_font" />
|
||||||
|
</list>
|
||||||
|
</value>
|
||||||
|
</option>
|
||||||
|
<option name="myCustomValuesEnabled" value="true" />
|
||||||
|
</inspection_tool>
|
||||||
|
<inspection_tool class="HtmlUnknownTarget" enabled="false" level="WARNING" enabled_by_default="false" />
|
||||||
|
</profile>
|
||||||
|
</component>
|
||||||
6
.idea/misc.xml
generated
Normal file
6
.idea/misc.xml
generated
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="ProjectRootManager">
|
||||||
|
<output url="file://$PROJECT_DIR$/out" />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
8
.idea/modules.xml
generated
Normal file
8
.idea/modules.xml
generated
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="ProjectModuleManager">
|
||||||
|
<modules>
|
||||||
|
<module fileurl="file://$PROJECT_DIR$/.idea/website.iml" filepath="$PROJECT_DIR$/.idea/website.iml" />
|
||||||
|
</modules>
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
6
.idea/vcs.xml
generated
Normal file
6
.idea/vcs.xml
generated
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="VcsDirectoryMappings">
|
||||||
|
<mapping directory="" vcs="Git" />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
9
.idea/website.iml
generated
Normal file
9
.idea/website.iml
generated
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<module type="JAVA_MODULE" version="4">
|
||||||
|
<component name="NewModuleRootManager" inherit-compiler-output="true">
|
||||||
|
<exclude-output />
|
||||||
|
<content url="file://$MODULE_DIR$" />
|
||||||
|
<orderEntry type="inheritedJdk" />
|
||||||
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
</component>
|
||||||
|
</module>
|
||||||
480
.idea/workspace.xml
generated
Normal file
480
.idea/workspace.xml
generated
Normal file
@@ -0,0 +1,480 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="AutoImportSettings">
|
||||||
|
<option name="autoReloadType" value="SELECTIVE" />
|
||||||
|
</component>
|
||||||
|
<component name="ChangeListManager">
|
||||||
|
<list default="true" id="53dd69d3-e01a-4656-b414-c727f5aa549a" name="Changes" comment="two dirs back" />
|
||||||
|
<option name="SHOW_DIALOG" value="false" />
|
||||||
|
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
||||||
|
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
|
||||||
|
<option name="LAST_RESOLUTION" value="IGNORE" />
|
||||||
|
</component>
|
||||||
|
<component name="ComposerSettings">
|
||||||
|
<execution />
|
||||||
|
</component>
|
||||||
|
<component name="FileTemplateManagerImpl">
|
||||||
|
<option name="RECENT_TEMPLATES">
|
||||||
|
<list>
|
||||||
|
<option value="CSS File" />
|
||||||
|
<option value="JavaScript File" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
</component>
|
||||||
|
<component name="Git.Merge.Settings">
|
||||||
|
<option name="BRANCH" value="master" />
|
||||||
|
</component>
|
||||||
|
<component name="Git.Rebase.Settings">
|
||||||
|
<option name="NEW_BASE" value="jacoobes" />
|
||||||
|
</component>
|
||||||
|
<component name="Git.Settings">
|
||||||
|
<option name="RECENT_BRANCH_BY_REPOSITORY">
|
||||||
|
<map>
|
||||||
|
<entry key="$PROJECT_DIR$" value="main" />
|
||||||
|
</map>
|
||||||
|
</option>
|
||||||
|
<option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
|
||||||
|
</component>
|
||||||
|
<component name="GitHubPullRequestSearchHistory">{
|
||||||
|
"lastFilter": {
|
||||||
|
"state": "OPEN",
|
||||||
|
"assignee": "SrIzan10"
|
||||||
|
}
|
||||||
|
}</component>
|
||||||
|
<component name="GithubPullRequestsUISettings">
|
||||||
|
<option name="selectedUrlAndAccountId">
|
||||||
|
<UrlAndAccount>
|
||||||
|
<option name="accountId" value="338eb51f-f02f-4dc6-997b-a87ba611c308" />
|
||||||
|
<option name="url" value="https://github.com/sern-handler/website.git" />
|
||||||
|
</UrlAndAccount>
|
||||||
|
</option>
|
||||||
|
</component>
|
||||||
|
<component name="MacroExpansionManager">
|
||||||
|
<option name="directoryName" value="d62oj9rg" />
|
||||||
|
</component>
|
||||||
|
<component name="MarkdownSettingsMigration">
|
||||||
|
<option name="stateVersion" value="1" />
|
||||||
|
</component>
|
||||||
|
<component name="ProjectColorInfo">{
|
||||||
|
"associatedIndex": 7
|
||||||
|
}</component>
|
||||||
|
<component name="ProjectId" id="2DJXFY4dwukGLOzXi05b6lHCkuk" />
|
||||||
|
<component name="ProjectViewState">
|
||||||
|
<option name="hideEmptyMiddlePackages" value="true" />
|
||||||
|
<option name="showLibraryContents" value="true" />
|
||||||
|
</component>
|
||||||
|
<component name="PropertiesComponent">{
|
||||||
|
"keyToString": {
|
||||||
|
"ASKED_SHARE_PROJECT_CONFIGURATION_FILES": "true",
|
||||||
|
"Git.Branch.Popup.ShowAllRemotes": "true",
|
||||||
|
"RunOnceActivity.OpenProjectViewOnStart": "true",
|
||||||
|
"RunOnceActivity.ShowReadmeOnStart": "true",
|
||||||
|
"SHARE_PROJECT_CONFIGURATION_FILES": "true",
|
||||||
|
"WebServerToolWindowFactoryState": "false",
|
||||||
|
"git-widget-placeholder": "feat/tutorial",
|
||||||
|
"ignore.virus.scanning.warn.message": "true",
|
||||||
|
"last_opened_file_path": "C:/Users/USER/Desktop/Development/mainwebsite",
|
||||||
|
"list.type.of.created.stylesheet": "CSS",
|
||||||
|
"node.js.detected.package.eslint": "true",
|
||||||
|
"node.js.selected.package.eslint": "(autodetect)",
|
||||||
|
"node.js.selected.package.tslint": "(autodetect)",
|
||||||
|
"nodejs_package_manager_path": "npm",
|
||||||
|
"project.structure.last.edited": "Modules",
|
||||||
|
"project.structure.proportion": "0.0",
|
||||||
|
"project.structure.side.proportion": "0.0",
|
||||||
|
"settings.editor.selected.configurable": "preferences.pluginManager",
|
||||||
|
"ts.external.directory.path": "E:\\IntelliJ IDEA 2022.1.1\\plugins\\JavaScriptLanguage\\jsLanguageServicesImpl\\external",
|
||||||
|
"vue.rearranger.settings.migration": "true"
|
||||||
|
}
|
||||||
|
}</component>
|
||||||
|
<component name="ReactDesignerToolWindowState">
|
||||||
|
<option name="myId2Visible">
|
||||||
|
<map>
|
||||||
|
<entry key="com.haulmont.rcb.reactComponents" value="false" />
|
||||||
|
<entry key="com.haulmont.rcb.reactInspector" value="false" />
|
||||||
|
<entry key="com.haulmont.rcb.storybook" value="false" />
|
||||||
|
</map>
|
||||||
|
</option>
|
||||||
|
</component>
|
||||||
|
<component name="RecentsManager">
|
||||||
|
<key name="MoveFile.RECENT_KEYS">
|
||||||
|
<recent name="C:\Users\USER\Desktop\Development\sern-website\docs\tutorial\en\intro" />
|
||||||
|
<recent name="C:\Users\USER\Desktop\Development\sern-website\docs\tutorial\en" />
|
||||||
|
<recent name="C:\Users\jacob\IdeaProjects\website\static\img" />
|
||||||
|
</key>
|
||||||
|
</component>
|
||||||
|
<component name="RunManager" selected="npm.start">
|
||||||
|
<configuration name="build" type="js.build_tools.npm" temporary="true" nameIsGenerated="true">
|
||||||
|
<package-json value="$PROJECT_DIR$/package.json" />
|
||||||
|
<command value="run" />
|
||||||
|
<scripts>
|
||||||
|
<script value="build" />
|
||||||
|
</scripts>
|
||||||
|
<node-interpreter value="project" />
|
||||||
|
<envs />
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="start" type="js.build_tools.npm" temporary="true" nameIsGenerated="true">
|
||||||
|
<package-json value="$PROJECT_DIR$/package.json" />
|
||||||
|
<command value="run" />
|
||||||
|
<scripts>
|
||||||
|
<script value="start" />
|
||||||
|
</scripts>
|
||||||
|
<node-interpreter value="project" />
|
||||||
|
<envs />
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<configuration name="typedoc-json" type="js.build_tools.npm" temporary="true" nameIsGenerated="true">
|
||||||
|
<package-json value="$PROJECT_DIR$/package.json" />
|
||||||
|
<command value="run" />
|
||||||
|
<scripts>
|
||||||
|
<script value="typedoc-json" />
|
||||||
|
</scripts>
|
||||||
|
<node-interpreter value="project" />
|
||||||
|
<envs />
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
<recent_temporary>
|
||||||
|
<list>
|
||||||
|
<item itemvalue="npm.start" />
|
||||||
|
<item itemvalue="npm.build" />
|
||||||
|
<item itemvalue="npm.typedoc-json" />
|
||||||
|
</list>
|
||||||
|
</recent_temporary>
|
||||||
|
</component>
|
||||||
|
<component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
|
||||||
|
<component name="TaskManager">
|
||||||
|
<task active="true" id="Default" summary="Default task">
|
||||||
|
<changelist id="53dd69d3-e01a-4656-b414-c727f5aa549a" name="Changes" comment="chore: edit link so no new windows" />
|
||||||
|
<created>1660418057765</created>
|
||||||
|
<option name="number" value="Default" />
|
||||||
|
<option name="presentableId" value="Default" />
|
||||||
|
<updated>1660418057765</updated>
|
||||||
|
<workItem from="1660418059202" duration="1120000" />
|
||||||
|
<workItem from="1660419190329" duration="211000" />
|
||||||
|
<workItem from="1660703091089" duration="348000" />
|
||||||
|
<workItem from="1661890199928" duration="3164000" />
|
||||||
|
<workItem from="1661963277269" duration="666000" />
|
||||||
|
<workItem from="1661966300011" duration="124000" />
|
||||||
|
<workItem from="1664254948139" duration="391000" />
|
||||||
|
<workItem from="1664301972139" duration="4356000" />
|
||||||
|
<workItem from="1664322335828" duration="5088000" />
|
||||||
|
<workItem from="1664342243187" duration="510000" />
|
||||||
|
<workItem from="1664342844947" duration="41000" />
|
||||||
|
<workItem from="1664345686862" duration="1690000" />
|
||||||
|
<workItem from="1670994246639" duration="17000" />
|
||||||
|
<workItem from="1670994294247" duration="1058000" />
|
||||||
|
<workItem from="1671030002725" duration="5842000" />
|
||||||
|
<workItem from="1671047161316" duration="3576000" />
|
||||||
|
<workItem from="1671119393024" duration="3889000" />
|
||||||
|
<workItem from="1673974979200" duration="2385000" />
|
||||||
|
<workItem from="1674757791435" duration="925000" />
|
||||||
|
<workItem from="1693943174979" duration="3494000" />
|
||||||
|
<workItem from="1693998900601" duration="4854000" />
|
||||||
|
<workItem from="1694013887941" duration="680000" />
|
||||||
|
<workItem from="1694014634755" duration="3452000" />
|
||||||
|
<workItem from="1694086921138" duration="3532000" />
|
||||||
|
<workItem from="1694095607446" duration="2640000" />
|
||||||
|
<workItem from="1694170854677" duration="225000" />
|
||||||
|
<workItem from="1694463335421" duration="56000" />
|
||||||
|
<workItem from="1694533500197" duration="2188000" />
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00001" summary="feat: remove old index.html in static/">
|
||||||
|
<created>1660418841831</created>
|
||||||
|
<option name="number" value="00001" />
|
||||||
|
<option name="presentableId" value="LOCAL-00001" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1660418841831</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00002" summary="feat: remove old index.html in static/">
|
||||||
|
<created>1660419375631</created>
|
||||||
|
<option name="number" value="00002" />
|
||||||
|
<option name="presentableId" value="LOCAL-00002" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1660419375631</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00003" summary="feat: edit action">
|
||||||
|
<created>1660421982013</created>
|
||||||
|
<option name="number" value="00003" />
|
||||||
|
<option name="presentableId" value="LOCAL-00003" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1660421982013</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00004" summary="feat: delete needless assets/dir">
|
||||||
|
<created>1660425803740</created>
|
||||||
|
<option name="number" value="00004" />
|
||||||
|
<option name="presentableId" value="LOCAL-00004" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1660425803740</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00005" summary="feat: action changes and edit link">
|
||||||
|
<created>1660426493480</created>
|
||||||
|
<option name="number" value="00005" />
|
||||||
|
<option name="presentableId" value="LOCAL-00005" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1660426493480</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00006" summary="feat: add favicon">
|
||||||
|
<created>1660427131558</created>
|
||||||
|
<option name="number" value="00006" />
|
||||||
|
<option name="presentableId" value="LOCAL-00006" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1660427131558</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00007" summary="fix: broken link">
|
||||||
|
<created>1660427309873</created>
|
||||||
|
<option name="number" value="00007" />
|
||||||
|
<option name="presentableId" value="LOCAL-00007" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1660427309873</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00008" summary="chore: edit link so no new windows">
|
||||||
|
<created>1660427590730</created>
|
||||||
|
<option name="number" value="00008" />
|
||||||
|
<option name="presentableId" value="LOCAL-00008" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1660427590730</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00009" summary="chore: fix typo">
|
||||||
|
<created>1661890861168</created>
|
||||||
|
<option name="number" value="00009" />
|
||||||
|
<option name="presentableId" value="LOCAL-00009" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1661890861168</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00010" summary="feat: adding width attr">
|
||||||
|
<created>1661963793586</created>
|
||||||
|
<option name="number" value="00010" />
|
||||||
|
<option name="presentableId" value="LOCAL-00010" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1661963793586</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00011" summary="feat: adding blogs">
|
||||||
|
<created>1664307221790</created>
|
||||||
|
<option name="number" value="00011" />
|
||||||
|
<option name="presentableId" value="LOCAL-00011" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1664307221790</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00012" summary="feat: blogwork">
|
||||||
|
<created>1664342459061</created>
|
||||||
|
<option name="number" value="00012" />
|
||||||
|
<option name="presentableId" value="LOCAL-00012" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1664342459061</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00013" summary="fix: links">
|
||||||
|
<created>1664346272428</created>
|
||||||
|
<option name="number" value="00013" />
|
||||||
|
<option name="presentableId" value="LOCAL-00013" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1664346272428</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00014" summary="fix: try fiux">
|
||||||
|
<created>1664346705175</created>
|
||||||
|
<option name="number" value="00014" />
|
||||||
|
<option name="presentableId" value="LOCAL-00014" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1664346705175</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00015" summary="feat: change date of blog">
|
||||||
|
<created>1664347141696</created>
|
||||||
|
<option name="number" value="00015" />
|
||||||
|
<option name="presentableId" value="LOCAL-00015" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1664347141696</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00016" summary="feat: starting writing 2.0 release blog">
|
||||||
|
<created>1670995351643</created>
|
||||||
|
<option name="number" value="00016" />
|
||||||
|
<option name="presentableId" value="LOCAL-00016" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1670995351643</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00017" summary="feat: adding more to blog">
|
||||||
|
<created>1671035904313</created>
|
||||||
|
<option name="number" value="00017" />
|
||||||
|
<option name="presentableId" value="LOCAL-00017" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1671035904313</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00018" summary="feat: update docs and links">
|
||||||
|
<created>1671049168115</created>
|
||||||
|
<option name="number" value="00018" />
|
||||||
|
<option name="presentableId" value="LOCAL-00018" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1671049168115</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00019" summary="feat: update docs and links">
|
||||||
|
<created>1671049335597</created>
|
||||||
|
<option name="number" value="00019" />
|
||||||
|
<option name="presentableId" value="LOCAL-00019" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1671049335597</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00020" summary="feat: fix blog links">
|
||||||
|
<created>1671050397033</created>
|
||||||
|
<option name="number" value="00020" />
|
||||||
|
<option name="presentableId" value="LOCAL-00020" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1671050397033</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00021" summary="feat: update blog">
|
||||||
|
<created>1671121547701</created>
|
||||||
|
<option name="number" value="00021" />
|
||||||
|
<option name="presentableId" value="LOCAL-00021" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1671121547701</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00022" summary="feat: update typedoc">
|
||||||
|
<created>1671121807771</created>
|
||||||
|
<option name="number" value="00022" />
|
||||||
|
<option name="presentableId" value="LOCAL-00022" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1671121807771</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00023" summary="feat: try again">
|
||||||
|
<created>1671123452807</created>
|
||||||
|
<option name="number" value="00023" />
|
||||||
|
<option name="presentableId" value="LOCAL-00023" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1671123452807</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00024" summary="feat: update docs and some blog progress">
|
||||||
|
<created>1673582791487</created>
|
||||||
|
<option name="number" value="00024" />
|
||||||
|
<option name="presentableId" value="LOCAL-00024" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1673582791487</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00025" summary="feat: update documentation and clarify documentation">
|
||||||
|
<created>1673976226325</created>
|
||||||
|
<option name="number" value="00025" />
|
||||||
|
<option name="presentableId" value="LOCAL-00025" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1673976226325</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00026" summary="fix: links">
|
||||||
|
<created>1673976805332</created>
|
||||||
|
<option name="number" value="00026" />
|
||||||
|
<option name="presentableId" value="LOCAL-00026" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1673976805332</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00027" summary="docs: add new plugins docs">
|
||||||
|
<created>1673976828238</created>
|
||||||
|
<option name="number" value="00027" />
|
||||||
|
<option name="presentableId" value="LOCAL-00027" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1673976828238</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00028" summary="fix: some grammar errors and dir structure">
|
||||||
|
<option name="closed" value="true" />
|
||||||
|
<created>1693943258104</created>
|
||||||
|
<option name="number" value="00028" />
|
||||||
|
<option name="presentableId" value="LOCAL-00028" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1693943258104</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00029" summary="chore: move file structure">
|
||||||
|
<option name="closed" value="true" />
|
||||||
|
<created>1693943441448</created>
|
||||||
|
<option name="number" value="00029" />
|
||||||
|
<option name="presentableId" value="LOCAL-00029" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1693943441448</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00030" summary="rephrasing a bit and ropox introduction invasion">
|
||||||
|
<option name="closed" value="true" />
|
||||||
|
<created>1693944545011</created>
|
||||||
|
<option name="number" value="00030" />
|
||||||
|
<option name="presentableId" value="LOCAL-00030" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1693944545011</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00031" summary="add introduction for me (im egoist)">
|
||||||
|
<option name="closed" value="true" />
|
||||||
|
<created>1693999127245</created>
|
||||||
|
<option name="number" value="00031" />
|
||||||
|
<option name="presentableId" value="LOCAL-00031" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1693999127245</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00032" summary="move to mdx">
|
||||||
|
<option name="closed" value="true" />
|
||||||
|
<created>1693999615376</created>
|
||||||
|
<option name="number" value="00032" />
|
||||||
|
<option name="presentableId" value="LOCAL-00032" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1693999615376</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00033" summary="add title">
|
||||||
|
<option name="closed" value="true" />
|
||||||
|
<created>1693999895960</created>
|
||||||
|
<option name="number" value="00033" />
|
||||||
|
<option name="presentableId" value="LOCAL-00033" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1693999895960</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00034" summary="feedback system">
|
||||||
|
<option name="closed" value="true" />
|
||||||
|
<created>1694534513180</created>
|
||||||
|
<option name="number" value="00034" />
|
||||||
|
<option name="presentableId" value="LOCAL-00034" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1694534513180</updated>
|
||||||
|
</task>
|
||||||
|
<task id="LOCAL-00035" summary="two dirs back">
|
||||||
|
<option name="closed" value="true" />
|
||||||
|
<created>1694535688773</created>
|
||||||
|
<option name="number" value="00035" />
|
||||||
|
<option name="presentableId" value="LOCAL-00035" />
|
||||||
|
<option name="project" value="LOCAL" />
|
||||||
|
<updated>1694535688773</updated>
|
||||||
|
</task>
|
||||||
|
<option name="localTasksCounter" value="36" />
|
||||||
|
<servers />
|
||||||
|
</component>
|
||||||
|
<component name="TypeScriptGeneratedFilesManager">
|
||||||
|
<option name="version" value="3" />
|
||||||
|
</component>
|
||||||
|
<component name="Vcs.Log.Tabs.Properties">
|
||||||
|
<option name="TAB_STATES">
|
||||||
|
<map>
|
||||||
|
<entry key="MAIN">
|
||||||
|
<value>
|
||||||
|
<State />
|
||||||
|
</value>
|
||||||
|
</entry>
|
||||||
|
</map>
|
||||||
|
</option>
|
||||||
|
</component>
|
||||||
|
<component name="VcsManagerConfiguration">
|
||||||
|
<MESSAGE value="feat: adding width attr" />
|
||||||
|
<MESSAGE value="feat: adding blogs" />
|
||||||
|
<MESSAGE value="feat: blogwork" />
|
||||||
|
<MESSAGE value="fix: try fiux" />
|
||||||
|
<MESSAGE value="feat: change date of blog" />
|
||||||
|
<MESSAGE value="feat: starting writing 2.0 release blog" />
|
||||||
|
<MESSAGE value="feat: adding more to blog" />
|
||||||
|
<MESSAGE value="feat: update docs and links" />
|
||||||
|
<MESSAGE value="feat: fix blog links" />
|
||||||
|
<MESSAGE value="feat: update blog" />
|
||||||
|
<MESSAGE value="feat: update typedoc" />
|
||||||
|
<MESSAGE value="feat: try again" />
|
||||||
|
<MESSAGE value="feat: add image" />
|
||||||
|
<MESSAGE value="feat: update docs and some blog progress" />
|
||||||
|
<MESSAGE value="feat: update documentation and clarify documentation" />
|
||||||
|
<MESSAGE value="fix: links" />
|
||||||
|
<MESSAGE value="docs: add new plugins docs" />
|
||||||
|
<MESSAGE value="fix: some grammar errors and dir structure" />
|
||||||
|
<MESSAGE value="chore: move file structure" />
|
||||||
|
<MESSAGE value="rephrasing a bit and ropox introduction invasion" />
|
||||||
|
<MESSAGE value="add introduction for me (im egoist)" />
|
||||||
|
<MESSAGE value="move to mdx" />
|
||||||
|
<MESSAGE value="add title" />
|
||||||
|
<MESSAGE value="feedback system" />
|
||||||
|
<MESSAGE value="two dirs back" />
|
||||||
|
<option name="LAST_COMMIT_MESSAGE" value="two dirs back" />
|
||||||
|
</component>
|
||||||
|
</project>
|
||||||
12
.vscode/settings.json
vendored
Normal file
12
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"files.exclude": {
|
||||||
|
"**/.git": true,
|
||||||
|
"**/.svn": true,
|
||||||
|
"**/.hg": true,
|
||||||
|
"**/CVS": true,
|
||||||
|
"**/.DS_Store": true,
|
||||||
|
"**/Thumbs.db": true,
|
||||||
|
".idea": true,
|
||||||
|
".vscode": true
|
||||||
|
}
|
||||||
|
}
|
||||||
1
.yarnrc.yml
Normal file
1
.yarnrc.yml
Normal file
@@ -0,0 +1 @@
|
|||||||
|
nodeLinker: node-modules
|
||||||
30
404.html
Normal file
30
404.html
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html style="height:100%">
|
||||||
|
<head>
|
||||||
|
<meta name="viewport" charset="utf-8" content="width=device-width, initial-scale=1, shrink-to-fit=no" >
|
||||||
|
<link rel="icon" href="./assets/images/favicon.ico">
|
||||||
|
<meta name="theme-color" content="#fff">
|
||||||
|
<meta name="twitter:card" content="summary">
|
||||||
|
|
||||||
|
<meta property="og:title" content="sern">
|
||||||
|
<meta property="og:description" content="sern’s clean, modern and web interface.">
|
||||||
|
<meta property="og:type" content="website">
|
||||||
|
<meta property="og:url" content="https://sern-handler.js.org/">
|
||||||
|
<meta property="og:locale" content="en_US">
|
||||||
|
<meta name="description" content="sern’s clean, modern and user-friendly web interface.">
|
||||||
|
|
||||||
|
<title>sern - Page Not Found</title>
|
||||||
|
</head>
|
||||||
|
<body style="color: #444; margin:0;font: normal 14px/20px Arial, Helvetica, sans-serif; height:100%; background-color: #fff;">
|
||||||
|
<div style="height:auto; min-height:100%; "> <div style="text-align: center; width:800px; margin-left: -400px; position:absolute; top: 30%; left:50%;">
|
||||||
|
<h1 style="margin:0; font-size:150px; line-height:150px; font-weight:bold;">404</h1>
|
||||||
|
<h2 style="margin-top:20px;font-size: 30px;">Not Found
|
||||||
|
</h2>
|
||||||
|
<p>The link you visited may be broken or invalid.</p>
|
||||||
|
<div class="button">
|
||||||
|
<h2>
|
||||||
|
<a href="http://sern-handler.js.org" title="Back to home" style="color: #444;">Back to homepage</a>
|
||||||
|
</h2>
|
||||||
|
</div>
|
||||||
|
</div></div></body></html>
|
||||||
|
|
||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2022 Sern
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -1 +1,3 @@
|
|||||||
# docs
|
# Website
|
||||||
|
|
||||||
|
sern's clean, modern and user-friendly web interface.
|
||||||
|
|||||||
11625
assets/css/style.css
11625
assets/css/style.css
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
@@ -1,2 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
|
|
||||||
3
babel.config.js
Normal file
3
babel.config.js
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
module.exports = {
|
||||||
|
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
|
||||||
|
};
|
||||||
79
blog/2022-09-28-mdx-blog-post.md
Normal file
79
blog/2022-09-28-mdx-blog-post.md
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
---
|
||||||
|
slug: 1.2.0
|
||||||
|
title: Release 1.2.0
|
||||||
|
authors: [jacoobes]
|
||||||
|
tags: [release]
|
||||||
|
---
|
||||||
|
|
||||||
|
## Class-based modules
|
||||||
|
|
||||||
|
Today we're announcing the ability to create class based modules!
|
||||||
|
To get started, install
|
||||||
|
```
|
||||||
|
npm install @sern/handler@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Quick List of changes!
|
||||||
|
- [Class based modules](#class-based-modules)
|
||||||
|
- [Deprecation Warnings](#deprecation-warnings)
|
||||||
|
- [Dependencies update](#dependencies-update)
|
||||||
|
|
||||||
|
|
||||||
|
### Class based modules
|
||||||
|
Incorporate class based modules into your project instead of the traditional `commandModule` or `eventModule`
|
||||||
|
Extend the new [CommandExecutable](docs/api/classes/CommandExecutable) or [EventExecutable](docs/api/classes/EventExecutable)
|
||||||
|
```ts title="commands/meaning-of-life.ts"
|
||||||
|
import { CommandType, CommandExecutable, type Args, type Context } from '@sern/handler';
|
||||||
|
import { publish } from '../plugins/publish.js';
|
||||||
|
import { serendipityOnly } from '../plugins/serendipityOnly.js';
|
||||||
|
|
||||||
|
export default class extends CommandExecutable<CommandType.Both> {
|
||||||
|
type = CommandType.Both as const;
|
||||||
|
description = 'What is the meaning of life?'
|
||||||
|
override onEvent = [
|
||||||
|
serendipityOnly()
|
||||||
|
];
|
||||||
|
override plugins = [
|
||||||
|
publish(),
|
||||||
|
];
|
||||||
|
// highlight-next-line
|
||||||
|
execute = async (ctx: Context, args: Args) => {
|
||||||
|
await ctx.reply('42')
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
:::caution
|
||||||
|
|
||||||
|
execute must not be a method of the class. It should be as above, a property on the class!
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
```ts title="events/guildMemberAdd.ts"
|
||||||
|
import { CommandType, EventExecutable, type EventType } from '@sern/handler';
|
||||||
|
import type { GuildMember } from 'discord.js'
|
||||||
|
|
||||||
|
export default class extends EventExecutable<EventType.Discord> {
|
||||||
|
type = EventType.Discord as const;
|
||||||
|
// highlight-next-line
|
||||||
|
execute = (member: GuildMember) => {
|
||||||
|
console.log(member)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Now, you might ask **why** this feature was added. <br /> Simply put, to give flexibility to the developers.
|
||||||
|
I believe that you should build your own structures however you might like and customize to your liking.
|
||||||
|
In addition, **decorators now unofficially work with modules!**
|
||||||
|
Feel free to use TypeScript experimental decorators to augment and customize your classes.
|
||||||
|
|
||||||
|
### Deprecation Warnings
|
||||||
|
The next update will bring sern v2 with some important features. Here are some things to watch out for.
|
||||||
|
|
||||||
|
- [Wrapper#client](docs/api/interfaces/Wrapper) will be deprecated
|
||||||
|
- [Wrapper#sernEmitter](docs/api/interfaces/Wrapper) will be deprecated
|
||||||
|
- a SernEmitter will be automatically created once Sern#init is called
|
||||||
|
- The option to pass in a function or array for [Wrapper#events](docs/api/interfaces/Wrapper) will be deprecated. Only strings are accepted.
|
||||||
|
- [Sern#addExternal](docs/api/classes/SernEmitter) will be deprecated in favor of a better way.
|
||||||
|
|
||||||
|
### Dependencies Update
|
||||||
|
- TypeScript has been updated to 4.8.3
|
||||||
|
- Discord.js has been upgraded to 14.5
|
||||||
62
blog/2022-09-30-mdx-blog-post.md
Normal file
62
blog/2022-09-30-mdx-blog-post.md
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
---
|
||||||
|
slug: getting-started
|
||||||
|
title: How to get started with sern!
|
||||||
|
authors: [Sr Izan]
|
||||||
|
tags: [guides]
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hello everyone!
|
||||||
|
|
||||||
|
I'm Sr Izan, your fellow user and contributor.
|
||||||
|
|
||||||
|
Today I'm going to show you how to get started with sern and all its cool features.
|
||||||
|
|
||||||
|
### Step 1: Install the CLI.
|
||||||
|
|
||||||
|
Install the CLI:
|
||||||
|
```
|
||||||
|
npm i -g @sern/cli
|
||||||
|
```
|
||||||
|
and then run
|
||||||
|
```
|
||||||
|
sern init
|
||||||
|
```
|
||||||
|
:::tip
|
||||||
|
You can also run `sern init -y` if you want to use the default options.
|
||||||
|
:::
|
||||||
|
|
||||||
|
The CLI is written in Typescript and open-sourced on [Github](https://github.com/sern-handler/cli). (thanks [evo](https://github.com/EvolutionX-10)!)
|
||||||
|
|
||||||
|
### Step 2: Have some way to store secrets.
|
||||||
|
|
||||||
|
Normally you'd need a way to store secrets, and the best way to do that is by installing another package: `dotenv`
|
||||||
|
|
||||||
|
just `npm i dotenv` in the project folder and add `require('dotenv').config()` to your import section. Then, when you login, `process.env.TOKEN` (or however you have it named on your `.env` file) should do the trick.
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
If you're using ESM, configure dotenv with `import 'dotenv/config'` instead of `require('dotenv').config()`.
|
||||||
|
:::
|
||||||
|
|
||||||
|
### And... that's it?
|
||||||
|
|
||||||
|
Yes, that's it. Here's a little FAQ to get you started. You can also join the [Discord](https://sern.dev/discord) for any problems.
|
||||||
|
|
||||||
|
### Extra: Video tutorial!
|
||||||
|
|
||||||
|
<video width="400" controls>
|
||||||
|
<source src="https://srizan.s-ul.eu/wtJBVsZU" type="video/mp4" />
|
||||||
|
</video>
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
**Q**: How do I publish a slash command?
|
||||||
|
**A**: Install the publish extension. Little video:
|
||||||
|
<video width="400" controls>
|
||||||
|
<source src="https://srizan.s-ul.eu/uHzPhfcS" type="video/mp4" />
|
||||||
|
</video>
|
||||||
|
|
||||||
|
**Q**: Any snippet VSCode extension?
|
||||||
|
**A**: Yeah, just search `sern Snippets` made by a verified publisher called Sr Izan (haha yeah me funny!)
|
||||||
|
|
||||||
|
**Q**: HEEEELLLPPPP!!!!
|
||||||
|
**A**: Hey, don't panic! We're here to help so, join the [Discord](https://sern.dev/discord). We're trying to get to 100 members!
|
||||||
191
blog/2022-12-13-mdx-blog-post.md
Normal file
191
blog/2022-12-13-mdx-blog-post.md
Normal file
@@ -0,0 +1,191 @@
|
|||||||
|
---
|
||||||
|
slug: 2.0.0
|
||||||
|
title: Release 2.0.0
|
||||||
|
authors: [jacoobes]
|
||||||
|
tags: [release]
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2.0 Release
|
||||||
|
Join our [discord](https://sern.dev/discord)! <br />
|
||||||
|
Wow! We're finally increasing our semantic versioning by +`1.7.9.` <br />
|
||||||
|
What does this mean?
|
||||||
|
|
||||||
|
### Plugin Support for Event Modules
|
||||||
|
You can now use plugins for event modules. Previous version would throw an error if the
|
||||||
|
`plugins` field was populated.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
export function commandPlTest() : SernEmitterPlugin {
|
||||||
|
return {
|
||||||
|
type: PluginType.Command,
|
||||||
|
execute: ({ mod}, controller) => {
|
||||||
|
if(mod.name === 'module.register') {
|
||||||
|
console.log('Event Module created correctly')
|
||||||
|
return controller.next()
|
||||||
|
}
|
||||||
|
console.log('event name is wrong')
|
||||||
|
return controller.stop()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Applying this plugin to some `eventModule`:
|
||||||
|
```typescript
|
||||||
|
export default eventModule({
|
||||||
|
name: 'error',
|
||||||
|
type: EventType.Sern,
|
||||||
|
plugins: [commandPlTest()],
|
||||||
|
execute(m) {
|
||||||
|
console.log(m)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
## Dependency Injection and Decoupling
|
||||||
|
|
||||||
|
The powerful npm package `iti` decouples sern even more.
|
||||||
|
Decoupling data structures with the Inversion of Control pattern separates data from logic, which will help speed production
|
||||||
|
and make sern even more customizable than before.
|
||||||
|
|
||||||
|
### How do I start?
|
||||||
|
```typescript title="src/index.ts"
|
||||||
|
//With typescript, you can customize / augment your typings.
|
||||||
|
interface MyDependencies extends Dependencies {
|
||||||
|
'@sern/client' : Singleton<Client>;
|
||||||
|
'@sern/logger' : Singleton<DefaultLogging>
|
||||||
|
}
|
||||||
|
|
||||||
|
export const useContainer = Sern.makeDependencies<MyDependencies>({
|
||||||
|
// exclude: new Set(['@sern/logger']), don't autofill optional dependencies
|
||||||
|
build: root => root
|
||||||
|
.add({ '@sern/client': single(client) })
|
||||||
|
.add({ '@sern/logger': single(new DefaultLogging()) })
|
||||||
|
});
|
||||||
|
|
||||||
|
Sern.init({
|
||||||
|
defaultPrefix: '!', // removing defaultPrefix will shut down text commands
|
||||||
|
commands: 'src/commands',
|
||||||
|
// events: 'src/events' (optional),
|
||||||
|
containerConfig : {
|
||||||
|
get: useContainer //pass in your dependency getter here
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
```
|
||||||
|
Using the `Sern#makeDependencies` function, inject your dependencies.
|
||||||
|
We'll use specific dependencies that are created with the `@sern/keyword`
|
||||||
|
key.
|
||||||
|
Using typescript to display all `keywords` and what they represent:
|
||||||
|
```typescript
|
||||||
|
export interface Dependencies {
|
||||||
|
'@sern/client': Singleton<EventEmitter>; //Discord Client
|
||||||
|
'@sern/logger'?: Singleton<Logging>; //Logger
|
||||||
|
'@sern/emitter': Singleton<SernEmitter>; //SernEmitter
|
||||||
|
'@sern/store' : Singleton<ModuleStore>; //Stores all Command Modules
|
||||||
|
'@sern/modules' : Singleton<ModuleManager>; //Manages Modules
|
||||||
|
'@sern/errors': Singleton<ErrorHandling>; //A Lifetime / Crash Handler
|
||||||
|
}
|
||||||
|
```
|
||||||
|
:::danger
|
||||||
|
Sern#addExternal has been deprecated and removed in favor of Sern#makeDependencies
|
||||||
|
:::
|
||||||
|
At the moment, one optional dependency, `@sern/logger`, exists. If not added explicitly,
|
||||||
|
we'll **autofill** with a [DefaultLogger](https://sern.dev/docs/api/classes/defaultlogging).
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
If you don't want a logger, add it to the
|
||||||
|
`exclude` field while composing dependencies.
|
||||||
|
:::
|
||||||
|
|
||||||
|
Use your generated dependency getter `useContainer` (use whatever name you want), access them
|
||||||
|
from anywhere.
|
||||||
|
:::note
|
||||||
|
the function [useContainerRaw](https://sern.dev/docs/api/modules#usecontainerraw) is provided for direct access to dependencies and the internal
|
||||||
|
data structure. Use this wisely as no guarantees are made and crashes can happen.
|
||||||
|
:::
|
||||||
|
|
||||||
|
The `build` field follows [createContainer](https://itijs.org/docs/quick-start#usage) function call.
|
||||||
|
|
||||||
|
## New CommandTypes
|
||||||
|
2.0 includes all the new role select menus. `CommandType.MenuSelect` has been renamed into
|
||||||
|
`CommandType.StringSelect`. The remaining SelectMenus are
|
||||||
|
`CommandType.RoleSelect`, `CommandType.ChannelSelect`, `CommandType.UserSelect`, `CommandType.MentionableSelect`
|
||||||
|
```typescript title="commands/roleselect.ts"
|
||||||
|
export default commandModule({
|
||||||
|
type: CommandType.RoleSelect,
|
||||||
|
execute(ctx) {
|
||||||
|
ctx.reply('role select')
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
In addition, commandModules with ContextMenus have been renamed.
|
||||||
|
```diff
|
||||||
|
- CommandType.MenuUser, CommandType.MenuMsg
|
||||||
|
+ CommandType.CtxUser, CommandType.CtxMsg
|
||||||
|
```
|
||||||
|
## Typings Simplification
|
||||||
|
Pre 2.0:
|
||||||
|
<img src="https://cdn.discordapp.com/attachments/820348341358952550/1038577974829666386/image.png" />
|
||||||
|
<br/> <br/> <br/>
|
||||||
|
Post 2.0:
|
||||||
|
<br/>
|
||||||
|
<img src="https://cdn.discordapp.com/attachments/820348341358952550/1052623728489550015/image.png" />
|
||||||
|
|
||||||
|
CommandPlugin<T\> and EventPlugin<T\> typings have also been static'ified, transformed from types to interfaces
|
||||||
|
## Breaking Changes
|
||||||
|
<img src="https://img.srizan.dev/Discord_z8Sn1UBfEe.png" />
|
||||||
|
<br />
|
||||||
|
All deprecation warnings from previous versions have taken effect, and are removed in 2.0.
|
||||||
|
|
||||||
|
```diff
|
||||||
|
- type Module = EventModule | CommandModule
|
||||||
|
+ type AnyModule = EventModule | CommandModule
|
||||||
|
|
||||||
|
-export type SpreadParams<T extends (...args: never) => unknown> = (
|
||||||
|
- args: Parameters<T>[number],
|
||||||
|
- ) => unknown;
|
||||||
|
```
|
||||||
|
Override type has been removed due to redundancy
|
||||||
|
```diff
|
||||||
|
- discord.js : 14.5
|
||||||
|
+ discord.js : 14.7
|
||||||
|
|
||||||
|
-typescript: 4.7
|
||||||
|
+ typescript: 4.9
|
||||||
|
```
|
||||||
|
```diff
|
||||||
|
+ interface Wrapper {
|
||||||
|
+ readonly defaultPrefix?: string;
|
||||||
|
+ readonly commands: string;
|
||||||
|
+ readonly events?: string;
|
||||||
|
+ readonly containerConfig : {
|
||||||
|
+ get: (...keys: (keyof Dependencies)[]) => unknown[];
|
||||||
|
+ }
|
||||||
|
+}
|
||||||
|
|
||||||
|
- interface Wrapper {
|
||||||
|
- readonly client: Client;
|
||||||
|
- readonly sernEmitter?: SernEmitter;
|
||||||
|
- readonly defaultPrefix?: string;
|
||||||
|
- readonly commands: string;
|
||||||
|
- readonly events?:
|
||||||
|
- | string
|
||||||
|
- | { mod: EventModule; absPath: string }[]
|
||||||
|
- | (() => { mod: EventModule; absPath: string }[]);
|
||||||
|
-}
|
||||||
|
```
|
||||||
|
```diff
|
||||||
|
+ DefaultLogger
|
||||||
|
+ DefaultModuleManager
|
||||||
|
+ SernEmitter
|
||||||
|
+ DefaultErrorHandling
|
||||||
|
+ type Singleton<T> = () => T
|
||||||
|
+ type Transient<T> = () => () => T;
|
||||||
|
+ type LogPayload<T = unknown> = { message: T }
|
||||||
|
+ export const single = <T>() => T
|
||||||
|
+ export const many = <T>() => () => T
|
||||||
|
```
|
||||||
|
Including the previous section, some names to symbols and data structures were altered to
|
||||||
|
be better represented. view [changelog](/404.html)
|
||||||
|
|
||||||
|
## Context refactoring
|
||||||
|
The context data structure has been internally altered to represent its dynamics better.
|
||||||
31
blog/2023-01-12-mdx-blog-post.md
Normal file
31
blog/2023-01-12-mdx-blog-post.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
slug: 2.5.0
|
||||||
|
title: Release 2.5.0
|
||||||
|
authors: [jacoobes]
|
||||||
|
tags: [release]
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2.5 Release
|
||||||
|
|
||||||
|
### Join our [discord](https://sern.dev/discord) <br />
|
||||||
|
- Thank you for using sern in your projects. It's only going to get better!
|
||||||
|
- I apologize for the sudden small breaking change. After this update, there won't be any for a while.
|
||||||
|
Wow! We're increasing our semantic versioning by `+0.3.9` <br />
|
||||||
|
What does this mean?
|
||||||
|
### Breaking changes
|
||||||
|
- [controller](../docs/api/modules#controller) parameter for plugins has been removed
|
||||||
|
- You'll need to import it instead
|
||||||
|
- This **breaks** old [CommandPlugin](../docs/api/interfaces/CommandPlugin), but **not** old [EventPlugin](../docs/api/interfaces/EventPlugin)
|
||||||
|
### Deprecations
|
||||||
|
- [CommandPlugin](../docs/api/interfaces/CommandPlugin) and [EventPlugin](../docs/api/interfaces/EventPlugin) have been renamed [InitPlugin](../docs/api/interfaces/InitPlugin) and [ControlPlugin](../docs/api/interfaces/ControlPlugin)
|
||||||
|
|
||||||
|
### Reason
|
||||||
|
- The naming of plugins was getting too complex. For example, plugin naming evolved into CommandModuleCommandPlugin, CommandModuleEventPlugin and more.
|
||||||
|
- I realize that this affects all plugins. I have updated all [plugins](https://github.com/sern-handler/awesome-plugins/pull/68) to match these changes
|
||||||
|
- The old way of declaring plugins has been deprecated in favor of newer functions that facilitate and ease typings
|
||||||
|
- [CommandControlPlugin](../docs/api/modules#commandcontrolplugin)
|
||||||
|
- [CommandInitPlugin](../docs/api/modules#commandinitplugin)
|
||||||
|
- [EventControlPlugin](../docs/api/modules#eventcontrolplugin)
|
||||||
|
- [EventInitPlugin](../docs/api/modules#eventinitplugin)
|
||||||
|
- [DiscordEventControlPlugin](../docs/api/modules#discordeventcontrolplugin)
|
||||||
|
This will probably be the last breaking change in a while. Thanks for using sern!
|
||||||
102
blog/2023-06-18-mdx-blog-post.md
Normal file
102
blog/2023-06-18-mdx-blog-post.md
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
---
|
||||||
|
slug: 3.0.0
|
||||||
|
title: Release 3.0.0
|
||||||
|
authors: [jacoobes]
|
||||||
|
tags: [release]
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3.0 Release
|
||||||
|
|
||||||
|
### Join our [discord](https://sern.dev/discord) <br />
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
#### Dependency Management
|
||||||
|
- `Service` API (recommended to use this over useContainer hooks)
|
||||||
|
- Dependencies type must be globally augmented in order for Services api to function properly
|
||||||
|
- new methods on ModuleManager
|
||||||
|
- getPublishableCommands()
|
||||||
|
- Init Hooks
|
||||||
|
- implement starting behavior for dependencies
|
||||||
|
- To enforce and type check this, use the `Initializable` type when making your Dependencies type!
|
||||||
|
- Emitter interface
|
||||||
|
- More generic interface to define any event emitter
|
||||||
|
- You can now swap out the SernEmitter with whatever emitter now.
|
||||||
|
```ts
|
||||||
|
class DatabaseService implements Init {
|
||||||
|
//some hypothetical database
|
||||||
|
_pgsql : database()
|
||||||
|
|
||||||
|
async init() {
|
||||||
|
await _pgsql.load()
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
await makeDependencies({
|
||||||
|
build: root => root.add({
|
||||||
|
db: new DatabaseService() //will be init'ed automatically
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
```
|
||||||
|
- new SernEmitter event `modulesLoaded` , which allows users to customize behavior after all modules are loaded!
|
||||||
|
```ts
|
||||||
|
|
||||||
|
export default eventModule({
|
||||||
|
name: 'modulesLoaded',
|
||||||
|
type: EventType.Sern,
|
||||||
|
execute: () => {
|
||||||
|
console.log('All modules loaded')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Quality of Life
|
||||||
|
- faster module loading
|
||||||
|
- I utilize async generators for reading files now. A lot faster than the first iteration.
|
||||||
|
- better error handling
|
||||||
|
- Less boilerplate
|
||||||
|
- Services api cleans up v2 boilerplate
|
||||||
|
- class modules devex got upgraded and work better than before
|
||||||
|
- automatically ignore any files not ending in (mts, cts, mjs, cjs, ts, js)
|
||||||
|
- ignore commands and events with `!` prefix on filename or directory (ie: `!filename.ts` or `!directory` will be ignored by sern)
|
||||||
|
|
||||||
|
- `Service` API (recommended to use this over useContainer hooks)
|
||||||
|
- Dependencies type must be globally augmented in order for Services api to function properly
|
||||||
|
- Less boilerplate
|
||||||
|
- new methods on ModuleManager
|
||||||
|
- automatically ignore any files not ending in (mts, cts, mjs, cjs, ts, js)
|
||||||
|
- ignore commands / events with `!` prefix on filename or directory (ie: `!filename.ts` or `!directory`)
|
||||||
|
- new SernEmitter event `modulesLoaded` , which allows users to customize behavior after all modules are loaded!
|
||||||
|
- Init Hooks
|
||||||
|
- implement starting behavior for dependencies
|
||||||
|
|
||||||
|
### Experimental
|
||||||
|
- Experimental things may be subject to removal, need feedback and are not guaranteed stable
|
||||||
|
- dev / prod mode
|
||||||
|
- sern will behave differently depending on mode set
|
||||||
|
- init sern from `file` option
|
||||||
|
- reads from local sern.config.json
|
||||||
|
|
||||||
|
```js
|
||||||
|
Sern.init('file');
|
||||||
|
```
|
||||||
|
### Breaking changes
|
||||||
|
- Sern.makeDependencies -> makeDependencies
|
||||||
|
- it is asynchronous and top level function now. Make sure to await it before initing for proper synchronization.
|
||||||
|
- module store and manager internally changed, so those using them may recieve breaking changes
|
||||||
|
- BaseOptions type removed
|
||||||
|
|
||||||
|
```diff
|
||||||
|
- Sern.makeDependencies({ build: () => {} })
|
||||||
|
+ await makeDependencies({ build: () => {} })
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deprecations
|
||||||
|
- Removed all previous marked deprecations in v3
|
||||||
|
- ModuleStore will be removed as a dependency in v4. The only way to access modules should be through ModuleManager
|
||||||
|
- Default Dependencies will be made internal in the v4. Users should only have access to its interface / contract
|
||||||
|
|
||||||
34
blog/2023-7-4-mdx-blog-post.md
Normal file
34
blog/2023-7-4-mdx-blog-post.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
slug: newlogo
|
||||||
|
title: New logo!
|
||||||
|
authors: [sern]
|
||||||
|
tags: [branding]
|
||||||
|
---
|
||||||
|
|
||||||
|
Hey everyone! Today we have very special news for you all: We're changing our logo!
|
||||||
|
|
||||||
|
# Why?
|
||||||
|
|
||||||
|
You see, on today's standards, having a simple logo is essential. Our logo aligns perfectly with these design principles but it can always be improved.
|
||||||
|
We were chilling, you know, cooking sern handler v3, sern gui, `npm create @sern/bot` and serncord when we thought about changing the logo to a sleek design with less colors.
|
||||||
|
And here we are!
|
||||||
|
|
||||||
|
# Who did our new branding? {#ropox-thing}
|
||||||
|
|
||||||
|
[Ropox](https://github.com/Murtatrxx)!
|
||||||
|
Bro's the GOAT. This website is maintained by him, the domain costs are funded by him and also he started brainstorming how the logo would be on paper:
|
||||||
|

|
||||||
|
And there it all clicked:
|
||||||
|

|
||||||
|
seren tried by the way!
|
||||||
|

|
||||||
|
|
||||||
|
# Anyways, here it is:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Pretty nice!
|
||||||
|
|
||||||
|
By the way, we have animations and variations on the way, so make sure to stay updated in the [discord server](https://sern.dev/discord)!
|
||||||
|
|
||||||
|
# Finally, from the entire sern team, thank you for sticking around ❤️
|
||||||
19
blog/authors.yml
Normal file
19
blog/authors.yml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
jacoobes:
|
||||||
|
name: jacoobes
|
||||||
|
title: Head Dev
|
||||||
|
url: https://github.com/jacoobes
|
||||||
|
image_url: https://github.com/jacoobes.png
|
||||||
|
Sr Izan:
|
||||||
|
name: Sr Izan
|
||||||
|
title: Developer
|
||||||
|
url: https://github.com/SrIzan10
|
||||||
|
image_url: https://github.com/SrIzan10.png
|
||||||
|
sern:
|
||||||
|
name: sern Team
|
||||||
|
url: https://github.com/sern-handler
|
||||||
|
image_url: https://github.com/sernbot.png
|
||||||
|
Murtatrxx:
|
||||||
|
name: Murtatrxx
|
||||||
|
title: Developer
|
||||||
|
url: https://github.com/Murtatrxx
|
||||||
|
image_url: https://github.com/Murtatrxx.png
|
||||||
202
docgen.docusaurus.config.js
Normal file
202
docgen.docusaurus.config.js
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
// @ts-check
|
||||||
|
// Note: type annotations allow type checking and IDEs autocompletion
|
||||||
|
|
||||||
|
const lightCodeTheme = require('prism-react-renderer/themes/nightOwlLight');
|
||||||
|
const darkCodeTheme = require('prism-react-renderer/themes/oceanicNext');
|
||||||
|
|
||||||
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
|
const config = {
|
||||||
|
title: 'sern - Handlers. Redefined.',
|
||||||
|
tagline: 'With the support of the community made plugins and a powerful CLI, it\'s more than just a handler.',
|
||||||
|
url: 'https://sern.dev',
|
||||||
|
baseUrl: '/',
|
||||||
|
onBrokenLinks: 'ignore',
|
||||||
|
onBrokenMarkdownLinks: 'warn',
|
||||||
|
favicon: '/img/favicon.ico', // this currently not working
|
||||||
|
|
||||||
|
// GitHub pages deployment config.
|
||||||
|
// If you aren't using GitHub pages, you don't need these.
|
||||||
|
organizationName: 'sern-handler', // Usually your GitHub org/user name.
|
||||||
|
projectName: 'website', // Usually your repo name.
|
||||||
|
deploymentBranch: 'main',
|
||||||
|
trailingSlash: false,
|
||||||
|
|
||||||
|
// Even if you don't use internalization, you can use this field to set useful
|
||||||
|
// metadata like html lang. For example, if your site is Chinese, you may want
|
||||||
|
// to replace "en" with "zh-Hans".
|
||||||
|
i18n: {
|
||||||
|
defaultLocale: 'en',
|
||||||
|
locales: ['en']
|
||||||
|
},
|
||||||
|
presets: [
|
||||||
|
[
|
||||||
|
'classic',
|
||||||
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||||
|
({
|
||||||
|
docs: {
|
||||||
|
sidebarPath: require.resolve('./sidebars.js'),
|
||||||
|
editUrl:
|
||||||
|
'https://github.com/sern-handler/website/edit/main/',
|
||||||
|
},
|
||||||
|
blog: {
|
||||||
|
showReadingTime: true,
|
||||||
|
// Please change this to your repo.
|
||||||
|
// Remove this to remove the "edit this page" links.
|
||||||
|
editUrl:
|
||||||
|
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
|
||||||
|
},
|
||||||
|
pages : {
|
||||||
|
path: 'src/pages',
|
||||||
|
routeBasePath: '/',
|
||||||
|
include: ['**/*.{js,jsx,ts,tsx,md,mdx}'],
|
||||||
|
exclude: [
|
||||||
|
'**/_*.{js,jsx,ts,tsx,md,mdx}',
|
||||||
|
'**/_*/**',
|
||||||
|
'**/*.test.{js,jsx,ts,tsx}',
|
||||||
|
'**/__tests__/**',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
theme: {
|
||||||
|
customCss: require.resolve('./src/css/custom.css'),
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
],
|
||||||
|
|
||||||
|
themeConfig:
|
||||||
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||||
|
({
|
||||||
|
image: 'https://sern.dev/img/logo.png',
|
||||||
|
algolia: {
|
||||||
|
appId: 'AA9S5J9NYT',
|
||||||
|
apiKey: 'ccfe6abc4d12ac6f882565a9d0caafb1',
|
||||||
|
indexName: 'sern',
|
||||||
|
insights: true,
|
||||||
|
container: 'div',
|
||||||
|
debug: false,
|
||||||
|
contextualSearch: true,
|
||||||
|
externalUrlRegex: 'external\\.com|domain\\.com',
|
||||||
|
replaceSearchResultPathname: {
|
||||||
|
from: '/docs/api',
|
||||||
|
to: '/docs/api',
|
||||||
|
},
|
||||||
|
searchParameters: {},
|
||||||
|
searchPagePath: 'search',
|
||||||
|
},
|
||||||
|
navbar: {
|
||||||
|
title: 'Home',
|
||||||
|
logo: {
|
||||||
|
alt: 'logo logo',
|
||||||
|
src: 'img/favicon.ico',
|
||||||
|
},
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
type: 'doc',
|
||||||
|
docId: 'intro',
|
||||||
|
position: 'left',
|
||||||
|
label: 'Docs & Guide',
|
||||||
|
},
|
||||||
|
{to: '/blog', label: 'Blog', position: 'left'},
|
||||||
|
{
|
||||||
|
href: 'https://github.com/sern-handler',
|
||||||
|
label: 'GitHub',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
to: '/plugins',
|
||||||
|
label: 'Plugins',
|
||||||
|
position: 'left'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
},
|
||||||
|
footer: {
|
||||||
|
style: 'dark',
|
||||||
|
links: [
|
||||||
|
{
|
||||||
|
title: 'Information',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'Docs & Guide',
|
||||||
|
to: '/docs/intro',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Community',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'Stack Overflow',
|
||||||
|
href: 'https://stackoverflow.com/questions/tagged/sern-handler',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Discord',
|
||||||
|
href: 'https://discord.gg/DwbF5H5JgQ',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label : 'Open Collective',
|
||||||
|
href: 'https://opencollective.com/sern'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'More',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'Blog',
|
||||||
|
to: '/blog',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'GitHub',
|
||||||
|
href: 'https://github.com/sern-handler',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
copyright: `Built with ❤️ by the sern Handler team and its contributors`,
|
||||||
|
},
|
||||||
|
metadata : [
|
||||||
|
{ name: 'og:title', content: 'sern - Handlers. Redefined.' },
|
||||||
|
{ name: 'og:description', content: 'A modular, customizable, fast Discord.js framework to streamline bot development' },
|
||||||
|
{ name: 'og:url', content: 'https://sern.dev' },
|
||||||
|
{ name: 'og:type', content: 'website' },
|
||||||
|
{ name: 'twitter:site', content: '@sern-handler' },
|
||||||
|
{ property: 'og:image:alt', content: 'sernlogo' },
|
||||||
|
{ name: 'twitter:title', content: 'sern - Handlers. Redefined.' },
|
||||||
|
{ name: 'twitter:description', content: 'A modular, customizable, fast Discord.js framework to streamline bot development' },
|
||||||
|
{ name: 'keywords', content: 'discord, bot, handler, framework, documentation, sern'},
|
||||||
|
{ name: 'twitter:image', content: 'https://sern.dev/img/logo.png' },
|
||||||
|
{ name: 'twitter:url', content: 'https://sern.dev' },
|
||||||
|
{ property: 'og:image:height', content: '512' },
|
||||||
|
{ property: 'og:image:width', content: '1024' },
|
||||||
|
{ name: 'theme-color', content: '#F25186' }
|
||||||
|
],
|
||||||
|
prism: {
|
||||||
|
theme: lightCodeTheme,
|
||||||
|
darkTheme: darkCodeTheme,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
plugins: [
|
||||||
|
[
|
||||||
|
'docusaurus-plugin-typedoc',
|
||||||
|
{
|
||||||
|
//if you're editing website, please change this to your local branch of sern to generate documentation
|
||||||
|
entryPoints: ['../sernHandlerV2/src/index.ts'],
|
||||||
|
tsconfig: '../sernHandlerV2/tsconfig.json',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"@dipakparmar/docusaurus-plugin-umami",
|
||||||
|
{
|
||||||
|
websiteID: "e82ff65c-b08f-47b5-8e74-5c31cbcec0ad",
|
||||||
|
analyticsDomain: "analytics.srizan.dev",
|
||||||
|
scriptName: 'ua.js',
|
||||||
|
dataAutoTrack: true,
|
||||||
|
dataDoNotTrack: true,
|
||||||
|
dataCache: true,
|
||||||
|
dataDomains: "sern.dev",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
]
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = config;
|
||||||
1
docs/api/_category_.yml
Normal file
1
docs/api/_category_.yml
Normal file
@@ -0,0 +1 @@
|
|||||||
|
label: "API"
|
||||||
97
docs/api/classes/CommandExecutable.md
Normal file
97
docs/api/classes/CommandExecutable.md
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
---
|
||||||
|
id: "CommandExecutable"
|
||||||
|
title: "Class: CommandExecutable<Type>"
|
||||||
|
sidebar_label: "CommandExecutable"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Will be removed in future
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `Type` | extends [`CommandType`](../enums/CommandType.md) = [`CommandType`](../enums/CommandType.md) |
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### constructor
|
||||||
|
|
||||||
|
• **new CommandExecutable**<`Type`\>(): [`CommandExecutable`](CommandExecutable.md)<`Type`\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `Type` | extends [`CommandType`](../enums/CommandType.md) = [`CommandType`](../enums/CommandType.md) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`CommandExecutable`](CommandExecutable.md)<`Type`\>
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`AnyCommandPlugin`](../modules.md#anycommandplugin)[] = `[]`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:80](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L80)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• `Abstract` **type**: `Type`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:79](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L79)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### \_instance
|
||||||
|
|
||||||
|
▪ `Static` `Private` **\_instance**: [`CommandModule`](../modules.md#commandmodule)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:81](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L81)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
▸ **execute**(`...args`): `unknown`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | `CommandArgs`<`Type`, [`Control`](../enums/PluginType.md#control)\> |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:92](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L92)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### getInstance
|
||||||
|
|
||||||
|
▸ **getInstance**(): [`CommandModule`](../modules.md#commandmodule)
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`CommandModule`](../modules.md#commandmodule)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:83](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L83)
|
||||||
348
docs/api/classes/Context.md
Normal file
348
docs/api/classes/Context.md
Normal file
@@ -0,0 +1,348 @@
|
|||||||
|
---
|
||||||
|
id: "Context"
|
||||||
|
title: "Class: Context"
|
||||||
|
sidebar_label: "Context"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
1.0.0
|
||||||
|
Provides values shared between
|
||||||
|
Message and ChatInputCommandInteraction
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `CoreContext`<`Message`, `ChatInputCommandInteraction`\>
|
||||||
|
|
||||||
|
↳ **`Context`**
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### constructor
|
||||||
|
|
||||||
|
• **new Context**(`ctx`): [`Context`](Context.md)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `Result`<`Message`<`boolean`\>, `ChatInputCommandInteraction`<`CacheType`\>\> |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Context`](Context.md)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
CoreContext\<Message, ChatInputCommandInteraction\>.constructor
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L29)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### ctx
|
||||||
|
|
||||||
|
• `Protected` **ctx**: `Result`<`Message`<`boolean`\>, `ChatInputCommandInteraction`<`CacheType`\>\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
CoreContext.ctx
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L29)
|
||||||
|
|
||||||
|
## Accessors
|
||||||
|
|
||||||
|
### channel
|
||||||
|
|
||||||
|
• `get` **channel**(): ``null`` \| `TextBasedChannel`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
``null`` \| `TextBasedChannel`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:39](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L39)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### channelId
|
||||||
|
|
||||||
|
• `get` **channelId**(): `string`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:45](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L45)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### client
|
||||||
|
|
||||||
|
• `get` **client**(): `Client`<`boolean`\>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`Client`<`boolean`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:91](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L91)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### createdTimestamp
|
||||||
|
|
||||||
|
• `get` **createdTimestamp**(): `number`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`number`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:65](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L65)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### guild
|
||||||
|
|
||||||
|
• `get` **guild**(): ``null`` \| `Guild`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
``null`` \| `Guild`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:71](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L71)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### guildId
|
||||||
|
|
||||||
|
• `get` **guildId**(): ``null`` \| `string`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
``null`` \| `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:77](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L77)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### id
|
||||||
|
|
||||||
|
• `get` **id**(): `string`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:33](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### inGuild
|
||||||
|
|
||||||
|
• `get` **inGuild**(): `boolean`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`boolean`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:97](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L97)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### interaction
|
||||||
|
|
||||||
|
• `get` **interaction**(): `I`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`I`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
CoreContext.interaction
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/core-context.ts:15](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/core-context.ts#L15)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### member
|
||||||
|
|
||||||
|
• `get` **member**(): ``null`` \| `GuildMember` \| `APIInteractionGuildMember`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
``null`` \| `GuildMember` \| `APIInteractionGuildMember`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:85](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L85)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### message
|
||||||
|
|
||||||
|
• `get` **message**(): `M`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`M`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
CoreContext.message
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/core-context.ts:12](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/core-context.ts#L12)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### options
|
||||||
|
|
||||||
|
• `get` **options**(): `Omit`<`CommandInteractionOptionResolver`<`CacheType`\>, ``"getMessage"`` \| ``"getFocused"``\>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`Omit`<`CommandInteractionOptionResolver`<`CacheType`\>, ``"getMessage"`` \| ``"getFocused"``\>
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
CoreContext.options
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:26](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L26)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### user
|
||||||
|
|
||||||
|
• `get` **user**(): `User`
|
||||||
|
|
||||||
|
If context is holding a message, message.author
|
||||||
|
else, interaction.user
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`User`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:55](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L55)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### userId
|
||||||
|
|
||||||
|
• `get` **userId**(): `string`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:61](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L61)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### isMessage
|
||||||
|
|
||||||
|
▸ **isMessage**(): this is CoreContext<Message<boolean\>, never\>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
this is CoreContext<Message<boolean\>, never\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
CoreContext.isMessage
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/core-context.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/core-context.ts#L19)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### isSlash
|
||||||
|
|
||||||
|
▸ **isSlash**(): this is CoreContext<never, ChatInputCommandInteraction<CacheType\>\>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
this is CoreContext<never, ChatInputCommandInteraction<CacheType\>\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
CoreContext.isSlash
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/core-context.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/core-context.ts#L23)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### reply
|
||||||
|
|
||||||
|
▸ **reply**(`content`): `Promise`<`Message`<`boolean`\>\>
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `content` | `ReplyOptions` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`Promise`<`Message`<`boolean`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:103](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L103)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### wrap
|
||||||
|
|
||||||
|
▸ **wrap**(`wrappable`): [`Context`](Context.md)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `wrappable` | `Message`<`boolean`\> \| `BaseInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Context`](Context.md)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
CoreContext.wrap
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/context.ts:113](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/context.ts#L113)
|
||||||
90
docs/api/classes/DefaultErrorHandling.md
Normal file
90
docs/api/classes/DefaultErrorHandling.md
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
---
|
||||||
|
id: "DefaultErrorHandling"
|
||||||
|
title: "Class: DefaultErrorHandling"
|
||||||
|
sidebar_label: "DefaultErrorHandling"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
Version 4.0.0 will internalize this api. Please refrain from using the defaults!
|
||||||
|
|
||||||
|
## Implements
|
||||||
|
|
||||||
|
- [`ErrorHandling`](../interfaces/ErrorHandling.md)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### constructor
|
||||||
|
|
||||||
|
• **new DefaultErrorHandling**(): [`DefaultErrorHandling`](DefaultErrorHandling.md)
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`DefaultErrorHandling`](DefaultErrorHandling.md)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### #keepAlive
|
||||||
|
|
||||||
|
• `Private` **#keepAlive**: `number` = `5`
|
||||||
|
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### crash
|
||||||
|
|
||||||
|
▸ **crash**(`err`): `never`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `err` | `Error` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`never`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Version 4 will remove this method
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ErrorHandling](../interfaces/ErrorHandling.md).[crash](../interfaces/ErrorHandling.md#crash)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### updateAlive
|
||||||
|
|
||||||
|
▸ **updateAlive**(`err`): `void`
|
||||||
|
|
||||||
|
A function that is called on every throw.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `err` | `Error` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ErrorHandling](../interfaces/ErrorHandling.md).[updateAlive](../interfaces/ErrorHandling.md#updatealive)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
136
docs/api/classes/DefaultLogging.md
Normal file
136
docs/api/classes/DefaultLogging.md
Normal file
@@ -0,0 +1,136 @@
|
|||||||
|
---
|
||||||
|
id: "DefaultLogging"
|
||||||
|
title: "Class: DefaultLogging"
|
||||||
|
sidebar_label: "DefaultLogging"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!
|
||||||
|
|
||||||
|
## Implements
|
||||||
|
|
||||||
|
- [`Logging`](../interfaces/Logging.md)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### constructor
|
||||||
|
|
||||||
|
• **new DefaultLogging**(): [`DefaultLogging`](DefaultLogging.md)
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`DefaultLogging`](DefaultLogging.md)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### date
|
||||||
|
|
||||||
|
▸ **date**(): `Date`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`Date`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/services/logger.ts:9](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L9)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### debug
|
||||||
|
|
||||||
|
▸ **debug**(`payload`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | [`LogPayload`](../modules.md#logpayload) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[Logging](../interfaces/Logging.md).[debug](../interfaces/Logging.md#debug)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/services/logger.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L10)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### error
|
||||||
|
|
||||||
|
▸ **error**(`payload`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | [`LogPayload`](../modules.md#logpayload) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[Logging](../interfaces/Logging.md).[error](../interfaces/Logging.md#error)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/services/logger.ts:14](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L14)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### info
|
||||||
|
|
||||||
|
▸ **info**(`payload`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | [`LogPayload`](../modules.md#logpayload) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[Logging](../interfaces/Logging.md).[info](../interfaces/Logging.md#info)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/services/logger.ts:18](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L18)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### warning
|
||||||
|
|
||||||
|
▸ **warning**(`payload`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | [`LogPayload`](../modules.md#logpayload) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[Logging](../interfaces/Logging.md).[warning](../interfaces/Logging.md#warning)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/services/logger.ts:22](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/logger.ts#L22)
|
||||||
193
docs/api/classes/DefaultModuleManager.md
Normal file
193
docs/api/classes/DefaultModuleManager.md
Normal file
@@ -0,0 +1,193 @@
|
|||||||
|
---
|
||||||
|
id: "DefaultModuleManager"
|
||||||
|
title: "Class: DefaultModuleManager"
|
||||||
|
sidebar_label: "DefaultModuleManager"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
Version 4.0.0 will internalize this api. Please refrain from using DefaultModuleManager!
|
||||||
|
|
||||||
|
## Implements
|
||||||
|
|
||||||
|
- [`ModuleManager`](../interfaces/ModuleManager.md)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### constructor
|
||||||
|
|
||||||
|
• **new DefaultModuleManager**(`moduleStore`): [`DefaultModuleManager`](DefaultModuleManager.md)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `moduleStore` | [`CoreModuleStore`](../interfaces/CoreModuleStore.md) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`DefaultModuleManager`](DefaultModuleManager.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/services/module-manager.ts:12](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/services/module-manager.ts#L12)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### moduleStore
|
||||||
|
|
||||||
|
• `Private` **moduleStore**: [`CoreModuleStore`](../interfaces/CoreModuleStore.md)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### get
|
||||||
|
|
||||||
|
▸ **get**(`id`): `undefined` \| `string`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `id` | `string` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`undefined` \| `string`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ModuleManager](../interfaces/ModuleManager.md).[get](../interfaces/ModuleManager.md#get)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### getByNameCommandType
|
||||||
|
|
||||||
|
▸ **getByNameCommandType**<`T`\>(`name`, `commandType`): `undefined` \| `Promise`<[`CommandModuleDefs`](../interfaces/CommandModuleDefs.md)[`T`]\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends [`CommandType`](../enums/CommandType.md) |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `name` | `string` |
|
||||||
|
| `commandType` | `T` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`undefined` \| `Promise`<[`CommandModuleDefs`](../interfaces/CommandModuleDefs.md)[`T`]\>
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ModuleManager](../interfaces/ModuleManager.md).[getByNameCommandType](../interfaces/ModuleManager.md#getbynamecommandtype)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### getMetadata
|
||||||
|
|
||||||
|
▸ **getMetadata**(`m`): `CommandMeta`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `m` | `Module` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`CommandMeta`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ModuleManager](../interfaces/ModuleManager.md).[getMetadata](../interfaces/ModuleManager.md#getmetadata)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### getPublishableCommands
|
||||||
|
|
||||||
|
▸ **getPublishableCommands**(): `Promise`<[`CommandModule`](../modules.md#commandmodule)[]\>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`Promise`<[`CommandModule`](../modules.md#commandmodule)[]\>
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ModuleManager](../interfaces/ModuleManager.md).[getPublishableCommands](../interfaces/ModuleManager.md#getpublishablecommands)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### set
|
||||||
|
|
||||||
|
▸ **set**(`id`, `path`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `id` | `string` |
|
||||||
|
| `path` | `string` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ModuleManager](../interfaces/ModuleManager.md).[set](../interfaces/ModuleManager.md#set)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### setMetadata
|
||||||
|
|
||||||
|
▸ **setMetadata**(`m`, `c`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `m` | `Module` |
|
||||||
|
| `c` | `CommandMeta` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[ModuleManager](../interfaces/ModuleManager.md).[setMetadata](../interfaces/ModuleManager.md#setmetadata)
|
||||||
|
|
||||||
|
#### 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)
|
||||||
97
docs/api/classes/EventExecutable.md
Normal file
97
docs/api/classes/EventExecutable.md
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
---
|
||||||
|
id: "EventExecutable"
|
||||||
|
title: "Class: EventExecutable<Type>"
|
||||||
|
sidebar_label: "EventExecutable"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Will be removed in future
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `Type` | extends [`EventType`](../enums/EventType.md) |
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### constructor
|
||||||
|
|
||||||
|
• **new EventExecutable**<`Type`\>(): [`EventExecutable`](EventExecutable.md)<`Type`\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `Type` | extends [`EventType`](../enums/EventType.md) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`EventExecutable`](EventExecutable.md)<`Type`\>
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`AnyEventPlugin`](../modules.md#anyeventplugin)[] = `[]`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:101](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L101)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• `Abstract` **type**: `Type`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:100](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L100)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### \_instance
|
||||||
|
|
||||||
|
▪ `Static` `Private` **\_instance**: [`EventModule`](../modules.md#eventmodule)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:103](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L103)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
▸ **execute**(`...args`): `unknown`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | `EventArgs`<`Type`, [`Control`](../enums/PluginType.md#control)\> |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:112](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L112)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### getInstance
|
||||||
|
|
||||||
|
▸ **getInstance**(): [`EventModule`](../modules.md#eventmodule)
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`EventModule`](../modules.md#eventmodule)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:104](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L104)
|
||||||
51
docs/api/classes/ModuleStore.md
Normal file
51
docs/api/classes/ModuleStore.md
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
---
|
||||||
|
id: "ModuleStore"
|
||||||
|
title: "Class: ModuleStore"
|
||||||
|
sidebar_label: "ModuleStore"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
Represents a core module store that stores IDs mapped to file paths.
|
||||||
|
|
||||||
|
## Implements
|
||||||
|
|
||||||
|
- [`CoreModuleStore`](../interfaces/CoreModuleStore.md)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### constructor
|
||||||
|
|
||||||
|
• **new ModuleStore**(): [`ModuleStore`](ModuleStore.md)
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`ModuleStore`](ModuleStore.md)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### commands
|
||||||
|
|
||||||
|
• **commands**: `Map`<`string`, `string`\>
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[CoreModuleStore](../interfaces/CoreModuleStore.md).[commands](../interfaces/CoreModuleStore.md#commands)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/module-store.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/module-store.ts#L11)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### metadata
|
||||||
|
|
||||||
|
• **metadata**: `WeakMap`<`Module`, `CommandMeta`\>
|
||||||
|
|
||||||
|
#### Implementation of
|
||||||
|
|
||||||
|
[CoreModuleStore](../interfaces/CoreModuleStore.md).[metadata](../interfaces/CoreModuleStore.md#metadata)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/module-store.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/module-store.ts#L10)
|
||||||
1289
docs/api/classes/SernEmitter.md
Normal file
1289
docs/api/classes/SernEmitter.md
Normal file
File diff suppressed because it is too large
Load Diff
2
docs/api/classes/_category_.yml
Normal file
2
docs/api/classes/_category_.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
label: "Classes"
|
||||||
|
position: 3
|
||||||
145
docs/api/enums/CommandType.md
Normal file
145
docs/api/enums/CommandType.md
Normal file
@@ -0,0 +1,145 @@
|
|||||||
|
---
|
||||||
|
id: "CommandType"
|
||||||
|
title: "Enumeration: CommandType"
|
||||||
|
sidebar_label: "CommandType"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
1.0.0
|
||||||
|
A bitfield that discriminates command modules
|
||||||
|
|
||||||
|
**`Example`**
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export default commandModule({
|
||||||
|
// highlight-next-line
|
||||||
|
type : CommandType.Text,
|
||||||
|
name : 'a text command'
|
||||||
|
execute(message) {
|
||||||
|
console.log(message.content)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Enumeration Members
|
||||||
|
|
||||||
|
### Both
|
||||||
|
|
||||||
|
• **Both** = ``3``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:20](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L20)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Button
|
||||||
|
|
||||||
|
• **Button** = ``16``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L23)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### ChannelSelect
|
||||||
|
|
||||||
|
• **ChannelSelect** = ``1024``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L29)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### CtxMsg
|
||||||
|
|
||||||
|
• **CtxMsg** = ``8``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:22](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L22)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### CtxUser
|
||||||
|
|
||||||
|
• **CtxUser** = ``4``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:21](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L21)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### MentionableSelect
|
||||||
|
|
||||||
|
• **MentionableSelect** = ``512``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:28](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L28)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Modal
|
||||||
|
|
||||||
|
• **Modal** = ``64``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:25](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L25)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### RoleSelect
|
||||||
|
|
||||||
|
• **RoleSelect** = ``256``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L27)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Slash
|
||||||
|
|
||||||
|
• **Slash** = ``2``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L19)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### StringSelect
|
||||||
|
|
||||||
|
• **StringSelect** = ``32``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:24](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L24)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Text
|
||||||
|
|
||||||
|
• **Text** = ``1``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:18](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L18)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### UserSelect
|
||||||
|
|
||||||
|
• **UserSelect** = ``128``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:26](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L26)
|
||||||
59
docs/api/enums/EventType.md
Normal file
59
docs/api/enums/EventType.md
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
---
|
||||||
|
id: "EventType"
|
||||||
|
title: "Enumeration: EventType"
|
||||||
|
sidebar_label: "EventType"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
A bitfield that discriminates event modules
|
||||||
|
|
||||||
|
**`Example`**
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export default eventModule({
|
||||||
|
//highlight-next-line
|
||||||
|
type : EventType.Discord,
|
||||||
|
name : 'guildMemberAdd'
|
||||||
|
execute(member : GuildMember) {
|
||||||
|
console.log(member)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Enumeration Members
|
||||||
|
|
||||||
|
### Discord
|
||||||
|
|
||||||
|
• **Discord** = ``1``
|
||||||
|
|
||||||
|
The EventType for handling discord events
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:51](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L51)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### External
|
||||||
|
|
||||||
|
• **External** = ``3``
|
||||||
|
|
||||||
|
The EventType for handling external events.
|
||||||
|
Could be for example, `process` events, database events
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:60](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L60)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Sern
|
||||||
|
|
||||||
|
• **Sern** = ``2``
|
||||||
|
|
||||||
|
The EventType for handling sern events
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:55](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L55)
|
||||||
43
docs/api/enums/PayloadType.md
Normal file
43
docs/api/enums/PayloadType.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
id: "PayloadType"
|
||||||
|
title: "Enumeration: PayloadType"
|
||||||
|
sidebar_label: "PayloadType"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Enumeration Members
|
||||||
|
|
||||||
|
### Failure
|
||||||
|
|
||||||
|
• **Failure** = ``"failure"``
|
||||||
|
|
||||||
|
The PayloadType for a SernEmitter failure event
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:98](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L98)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Success
|
||||||
|
|
||||||
|
• **Success** = ``"success"``
|
||||||
|
|
||||||
|
The PayloadType for a SernEmitter success event
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:94](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L94)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Warning
|
||||||
|
|
||||||
|
• **Warning** = ``"warning"``
|
||||||
|
|
||||||
|
The PayloadType for a SernEmitter warning event
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:102](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L102)
|
||||||
45
docs/api/enums/PluginType.md
Normal file
45
docs/api/enums/PluginType.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
---
|
||||||
|
id: "PluginType"
|
||||||
|
title: "Enumeration: PluginType"
|
||||||
|
sidebar_label: "PluginType"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
A bitfield that discriminates plugins
|
||||||
|
|
||||||
|
**`Example`**
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export default function myPlugin() : EventPlugin<CommandType.Text> {
|
||||||
|
//highlight-next-line
|
||||||
|
type : PluginType.Event,
|
||||||
|
execute([ctx, args], controller) {
|
||||||
|
return controller.next();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Enumeration Members
|
||||||
|
|
||||||
|
### Control
|
||||||
|
|
||||||
|
• **Control** = ``2``
|
||||||
|
|
||||||
|
The PluginType for EventPlugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:85](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L85)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Init
|
||||||
|
|
||||||
|
• **Init** = ``1``
|
||||||
|
|
||||||
|
The PluginType for InitPlugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/structures/enums.ts:81](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/structures/enums.ts#L81)
|
||||||
104
docs/api/enums/SernError.md
Normal file
104
docs/api/enums/SernError.md
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
---
|
||||||
|
id: "SernError"
|
||||||
|
title: "Enumeration: SernError"
|
||||||
|
sidebar_label: "SernError"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Enumeration Members
|
||||||
|
|
||||||
|
### InvalidModuleType
|
||||||
|
|
||||||
|
• **InvalidModuleType** = ``"Detected an unknown module type"``
|
||||||
|
|
||||||
|
Throws when registering an invalid module.
|
||||||
|
This means it is undefined or an invalid command type was provided
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/structures/errors.ts:9](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L9)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### MismatchEvent
|
||||||
|
|
||||||
|
• **MismatchEvent** = ``"You cannot use message when an interaction fired or vice versa"``
|
||||||
|
|
||||||
|
A crash that occurs when accessing an invalid property of Context
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/structures/errors.ts:29](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L29)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### MismatchModule
|
||||||
|
|
||||||
|
• **MismatchModule** = ``"A module type mismatched with event emitted!"``
|
||||||
|
|
||||||
|
Attempted to lookup module in command module store. Nothing was found!
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/structures/errors.ts:17](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L17)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### MissingRequired
|
||||||
|
|
||||||
|
• **MissingRequired** = ``"@sern/client is required but was not found"``
|
||||||
|
|
||||||
|
Required Dependency not found
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/structures/errors.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### NotSupportedInteraction
|
||||||
|
|
||||||
|
• **NotSupportedInteraction** = ``"This interaction is not supported."``
|
||||||
|
|
||||||
|
Unsupported interaction at this moment.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/structures/errors.ts:21](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L21)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### NotSupportedYet
|
||||||
|
|
||||||
|
• **NotSupportedYet** = ``"This feature is not supported yet"``
|
||||||
|
|
||||||
|
Unsupported feature attempted to access at this time
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/structures/errors.ts:33](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### PluginFailure
|
||||||
|
|
||||||
|
• **PluginFailure** = ``"A plugin failed to call controller.next()"``
|
||||||
|
|
||||||
|
One plugin called `controller.stop()` (end command execution / loading)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/structures/errors.ts:25](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L25)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### UndefinedModule
|
||||||
|
|
||||||
|
• **UndefinedModule** = ``"A module could not be detected"``
|
||||||
|
|
||||||
|
Attempted to lookup module in command module store. Nothing was found!
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/structures/errors.ts:13](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/structures/errors.ts#L13)
|
||||||
2
docs/api/enums/_category_.yml
Normal file
2
docs/api/enums/_category_.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
label: "Enumerations"
|
||||||
|
position: 2
|
||||||
95
docs/api/index.md
Normal file
95
docs/api/index.md
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
---
|
||||||
|
id: "index"
|
||||||
|
title: "@sern/handler"
|
||||||
|
sidebar_label: "Readme"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="https://raw.githubusercontent.com/sern-handler/.github/main/banner.png" width="900px" />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<h1 align="center">Handlers. Redefined.</h1>
|
||||||
|
<h4 align="center">A complete, customizable, typesafe, & reactive framework for discord bots</h4>
|
||||||
|
|
||||||
|
<div align="center" styles="margin-top: 10px">
|
||||||
|
<img src="https://img.shields.io/badge/open-source-brightgreen" />
|
||||||
|
<a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/v/@sern/handler?maxAge=3600" alt="NPM version" /></a>
|
||||||
|
<a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/dt/@sern/handler?maxAge=3600" alt="NPM downloads" /></a>
|
||||||
|
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="License MIT" /></a>
|
||||||
|
<a href="https://sern.dev"><img alt="docs.rs" src="https://img.shields.io/docsrs/docs" /></a>
|
||||||
|
<img alt="Lines of code" src="https://img.shields.io/badge/total%20lines-2k-blue" />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## Why?
|
||||||
|
- For you. A framework that's tailored to your exact needs.
|
||||||
|
- Lightweight. Does a lot while being small.
|
||||||
|
- Latest features. Support for discord.js v14 and all of its interactions.
|
||||||
|
- Start quickly. Plug and play or customize to your liking.
|
||||||
|
- works with [bun](https://bun.sh/) and [node](https://nodejs.org/en) out the box!
|
||||||
|
- Use it with TypeScript or JavaScript. CommonJS and ESM supported.
|
||||||
|
- Active and growing community, always here to help. [Join us](https://sern.dev/discord)
|
||||||
|
- Unleash its full potential with a powerful CLI and awesome plugins.
|
||||||
|
|
||||||
|
## 📜 Installation
|
||||||
|
[Start here!!](https://sern.dev/docs/guide/walkthrough/new-project)
|
||||||
|
|
||||||
|
## 👶 Basic Usage
|
||||||
|
<details><summary>ping.ts</summary>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export default commandModule({
|
||||||
|
type: CommandType.Slash,
|
||||||
|
//Installed plugin to publish to discord api and allow access to owners only.
|
||||||
|
plugins: [publish(), ownerOnly()],
|
||||||
|
description: 'A ping pong command',
|
||||||
|
execute(ctx) {
|
||||||
|
ctx.reply('Hello owner of the bot');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
</details>
|
||||||
|
<details><summary>modal.ts</summary>
|
||||||
|
|
||||||
|
```ts
|
||||||
|
export default commandModule({
|
||||||
|
type: CommandType.Modal,
|
||||||
|
//Installed a plugin to make sure modal fields pass a validation.
|
||||||
|
plugins : [
|
||||||
|
assertFields({
|
||||||
|
fields: {
|
||||||
|
name: /^([^0-9]*)$/
|
||||||
|
},
|
||||||
|
failure: (errors, modal) => modal.reply('your submission did not pass the validations')
|
||||||
|
})
|
||||||
|
],
|
||||||
|
execute : (modal) => {
|
||||||
|
modal.reply('thanks for the submission!');
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## 🤖 Bots Using sern
|
||||||
|
- [Community Bot](https://github.com/sern-handler/sern-community), the community bot for our [discord server](https://sern.dev/discord).
|
||||||
|
- [Vinci](https://github.com/SrIzan10/vinci), the bot for Mara Turing.
|
||||||
|
- [Bask](https://github.com/baskbotml/bask), Listen your favorite artists on Discord.
|
||||||
|
- [ava](https://github.com/SrIzan10/ava), A discord bot that plays KNGI and Gensokyo Radio.
|
||||||
|
- [Murayama](https://github.com/murayamabot/murayama), :pepega:
|
||||||
|
- [Protector (WIP)](https://github.com/needhamgary/Protector), Just a simple bot to help enhance a private minecraft server.
|
||||||
|
- [SmokinWeed 💨](https://github.com/Peter-MJ-Parker/sern-bud), A fun bot for a small - but growing - server.
|
||||||
|
|
||||||
|
## 💻 CLI
|
||||||
|
|
||||||
|
It is **highly encouraged** to use the [command line interface](https://github.com/sern-handler/cli) for your project. Don't forget to view it.
|
||||||
|
|
||||||
|
## 🔗 Links
|
||||||
|
|
||||||
|
- [Official Documentation and Guide](https://sern.dev)
|
||||||
|
- [Support Server](https://sern.dev/discord)
|
||||||
|
|
||||||
|
## 👋 Contribute
|
||||||
|
- Read our contribution [guidelines](https://github.com/sern-handler/handler/blob/main/.github/CONTRIBUTING.md) carefully
|
||||||
|
- Pull up on [issues](https://github.com/sern-handler/handler/issues) and report bugs
|
||||||
|
- All kinds of contributions are welcomed.
|
||||||
55
docs/api/interfaces/AutocompleteCommand.md
Normal file
55
docs/api/interfaces/AutocompleteCommand.md
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
---
|
||||||
|
id: "AutocompleteCommand"
|
||||||
|
title: "Interface: AutocompleteCommand"
|
||||||
|
sidebar_label: "AutocompleteCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Omit`<[`Module`](Module.md), ``"name"`` \| ``"type"`` \| ``"plugins"`` \| ``"description"``\>
|
||||||
|
|
||||||
|
↳ **`AutocompleteCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `AutocompleteInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `AutocompleteInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Omit.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/module.ts:111](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L111)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Omit.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/module.ts:110](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L110)
|
||||||
88
docs/api/interfaces/AutocompletePlugin.md
Normal file
88
docs/api/interfaces/AutocompletePlugin.md
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
---
|
||||||
|
id: "AutocompletePlugin"
|
||||||
|
title: "Interface: AutocompletePlugin"
|
||||||
|
sidebar_label: "AutocompletePlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- [`Plugin`](Plugin.md)
|
||||||
|
|
||||||
|
↳ **`AutocompletePlugin`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`autocmp`: `AutocompleteInteraction`<`CacheType`\>, `controlller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`autocmp`, `controlller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `autocmp` | `AutocompleteInteraction`<`CacheType`\> |
|
||||||
|
| `controlller` | [`Controller`](Controller.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:73](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L73)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:31](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Event`](../enums/PluginType.md#event)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:72](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L72)
|
||||||
132
docs/api/interfaces/BothCommand.md
Normal file
132
docs/api/interfaces/BothCommand.md
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
---
|
||||||
|
id: "BothCommand"
|
||||||
|
title: "Interface: BothCommand"
|
||||||
|
sidebar_label: "BothCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`BothCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### alias
|
||||||
|
|
||||||
|
• `Optional` **alias**: `string`[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:126](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L126)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• **description**: `string`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:127](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L127)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: [`Context`](../classes/Context.md), `args`: [`Args`](../modules.md#args)) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`, `args`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | [`Context`](../classes/Context.md) |
|
||||||
|
| `args` | [`Args`](../modules.md#args) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:129](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L129)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### options
|
||||||
|
|
||||||
|
• `Optional` **options**: [`SernOptionsData`](../modules.md#sernoptionsdata)[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:128](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L128)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Both`](../enums/CommandType.md#both)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:125](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L125)
|
||||||
111
docs/api/interfaces/ButtonCommand.md
Normal file
111
docs/api/interfaces/ButtonCommand.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "ButtonCommand"
|
||||||
|
title: "Interface: ButtonCommand"
|
||||||
|
sidebar_label: "ButtonCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`ButtonCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `ButtonInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `ButtonInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:66](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L66)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Button`](../enums/CommandType.md#button)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:65](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L65)
|
||||||
111
docs/api/interfaces/ChannelSelectCommand.md
Normal file
111
docs/api/interfaces/ChannelSelectCommand.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "ChannelSelectCommand"
|
||||||
|
title: "Interface: ChannelSelectCommand"
|
||||||
|
sidebar_label: "ChannelSelectCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`ChannelSelectCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `ChannelSelectMenuInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `ChannelSelectMenuInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:76](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L76)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`ChannelSelect`](../enums/CommandType.md#channelselect)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:75](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L75)
|
||||||
45
docs/api/interfaces/CommandError.Response.md
Normal file
45
docs/api/interfaces/CommandError.Response.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
---
|
||||||
|
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)
|
||||||
127
docs/api/interfaces/CommandModuleDefs.md
Normal file
127
docs/api/interfaces/CommandModuleDefs.md
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
---
|
||||||
|
id: "CommandModuleDefs"
|
||||||
|
title: "Interface: CommandModuleDefs"
|
||||||
|
sidebar_label: "CommandModuleDefs"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### 1
|
||||||
|
|
||||||
|
• **1**: [`TextCommand`](TextCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:151](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L151)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 1024
|
||||||
|
|
||||||
|
• **1024**: [`ChannelSelectCommand`](ChannelSelectCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:159](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L159)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 128
|
||||||
|
|
||||||
|
• **128**: [`UserSelectCommand`](UserSelectCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:161](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L161)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 16
|
||||||
|
|
||||||
|
• **16**: [`ButtonCommand`](ButtonCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:156](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L156)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 2
|
||||||
|
|
||||||
|
• **2**: [`SlashCommand`](SlashCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:152](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L152)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 256
|
||||||
|
|
||||||
|
• **256**: [`RoleSelectCommand`](RoleSelectCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:158](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L158)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 3
|
||||||
|
|
||||||
|
• **3**: [`BothCommand`](BothCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:153](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L153)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 32
|
||||||
|
|
||||||
|
• **32**: [`StringSelectCommand`](StringSelectCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:157](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L157)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 4
|
||||||
|
|
||||||
|
• **4**: [`ContextMenuUser`](ContextMenuUser.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:155](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L155)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 512
|
||||||
|
|
||||||
|
• **512**: [`MentionableSelectCommand`](MentionableSelectCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:160](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L160)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 64
|
||||||
|
|
||||||
|
• **64**: [`ModalSubmitCommand`](ModalSubmitCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:162](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L162)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 8
|
||||||
|
|
||||||
|
• **8**: [`ContextMenuMsg`](ContextMenuMsg.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:154](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L154)
|
||||||
72
docs/api/interfaces/CommandPlugin.md
Normal file
72
docs/api/interfaces/CommandPlugin.md
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
---
|
||||||
|
id: "CommandPlugin"
|
||||||
|
title: "Interface: CommandPlugin<T>"
|
||||||
|
sidebar_label: "CommandPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Use the newer helper functions and import { controller } from '@sern/handler'
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends [`CommandType`](../enums/CommandType.md) = [`CommandType`](../enums/CommandType.md) |
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/plugin.ts:51](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L51)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`m`: [`InitArgs`](InitArgs.md)<[`Processed`](../modules.md#processed)<[`CommandModule`](../modules.md#commandmodule)\>\>, `controller?`: [`Deprecated`](../modules.md#deprecated)<``"Please import controller instead"``\>) => [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`m`, `controller?`): [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `m` | [`InitArgs`](InitArgs.md)<[`Processed`](../modules.md#processed)<[`CommandModule`](../modules.md#commandmodule)\>\> |
|
||||||
|
| `controller?` | [`Deprecated`](../modules.md#deprecated)<``"Please import controller instead"``\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/plugin.ts:53](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L53)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/plugin.ts:50](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L50)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Init`](../enums/PluginType.md#init)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/plugin.ts:52](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L52)
|
||||||
111
docs/api/interfaces/ContextMenuMsg.md
Normal file
111
docs/api/interfaces/ContextMenuMsg.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "ContextMenuMsg"
|
||||||
|
title: "Interface: ContextMenuMsg"
|
||||||
|
sidebar_label: "ContextMenuMsg"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`ContextMenuMsg`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `MessageContextMenuCommandInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `MessageContextMenuCommandInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:61](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L61)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`CtxMsg`](../enums/CommandType.md#ctxmsg)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:60](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L60)
|
||||||
111
docs/api/interfaces/ContextMenuUser.md
Normal file
111
docs/api/interfaces/ContextMenuUser.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "ContextMenuUser"
|
||||||
|
title: "Interface: ContextMenuUser"
|
||||||
|
sidebar_label: "ContextMenuUser"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`ContextMenuUser`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `UserContextMenuCommandInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `UserContextMenuCommandInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:56](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L56)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`CtxUser`](../enums/CommandType.md#ctxuser)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:55](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L55)
|
||||||
47
docs/api/interfaces/ControlPlugin.md
Normal file
47
docs/api/interfaces/ControlPlugin.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
---
|
||||||
|
id: "ControlPlugin"
|
||||||
|
title: "Interface: ControlPlugin<Args>"
|
||||||
|
sidebar_label: "ControlPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `Args` | extends `any`[] = `any`[] |
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (...`args`: `Args`) => [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`...args`): [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | `Args` |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:73](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L73)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Control`](../enums/PluginType.md#control)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:72](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L72)
|
||||||
43
docs/api/interfaces/Controller.md
Normal file
43
docs/api/interfaces/Controller.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
id: "Controller"
|
||||||
|
title: "Interface: Controller"
|
||||||
|
sidebar_label: "Controller"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### next
|
||||||
|
|
||||||
|
• **next**: () => `Ok`<`void`\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): `Ok`<`void`\>
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Ok`<`void`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:59](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L59)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### stop
|
||||||
|
|
||||||
|
• **stop**: () => `Err`<`void`\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): `Err`<`void`\>
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Err`<`void`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:60](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L60)
|
||||||
115
docs/api/interfaces/CoreDependencies.md
Normal file
115
docs/api/interfaces/CoreDependencies.md
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
---
|
||||||
|
id: "CoreDependencies"
|
||||||
|
title: "Interface: CoreDependencies"
|
||||||
|
sidebar_label: "CoreDependencies"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### @sern/client
|
||||||
|
|
||||||
|
• **@sern/client**: () => [`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): [`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:28](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L28)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/emitter
|
||||||
|
|
||||||
|
• **@sern/emitter**: () => [`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): [`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:30](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L30)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/errors
|
||||||
|
|
||||||
|
• **@sern/errors**: () => [`ErrorHandling`](ErrorHandling.md)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): [`ErrorHandling`](ErrorHandling.md)
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`ErrorHandling`](ErrorHandling.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:33](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/logger
|
||||||
|
|
||||||
|
• `Optional` **@sern/logger**: () => [`Logging`](Logging.md)<`unknown`\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): [`Logging`](Logging.md)<`unknown`\>
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`Logging`](Logging.md)<`unknown`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:29](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L29)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/modules
|
||||||
|
|
||||||
|
• **@sern/modules**: () => [`ModuleManager`](ModuleManager.md)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): [`ModuleManager`](ModuleManager.md)
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`ModuleManager`](ModuleManager.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:32](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L32)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/store
|
||||||
|
|
||||||
|
• **@sern/store**: () => [`CoreModuleStore`](CoreModuleStore.md)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): [`CoreModuleStore`](CoreModuleStore.md)
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`CoreModuleStore`](CoreModuleStore.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:31](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L31)
|
||||||
33
docs/api/interfaces/CoreModuleStore.md
Normal file
33
docs/api/interfaces/CoreModuleStore.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
---
|
||||||
|
id: "CoreModuleStore"
|
||||||
|
title: "Interface: CoreModuleStore"
|
||||||
|
sidebar_label: "CoreModuleStore"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
Represents a core module store that stores IDs mapped to file paths.
|
||||||
|
|
||||||
|
## Implemented by
|
||||||
|
|
||||||
|
- [`ModuleStore`](../classes/ModuleStore.md)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### commands
|
||||||
|
|
||||||
|
• **commands**: `Map`<`string`, `string`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/module-store.ts:7](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-store.ts#L7)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### metadata
|
||||||
|
|
||||||
|
• **metadata**: `WeakMap`<`Module`, `CommandMeta`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/module-store.ts:8](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-store.ts#L8)
|
||||||
67
docs/api/interfaces/Dependencies.md
Normal file
67
docs/api/interfaces/Dependencies.md
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
---
|
||||||
|
id: "Dependencies"
|
||||||
|
title: "Interface: Dependencies"
|
||||||
|
sidebar_label: "Dependencies"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### @sern/client
|
||||||
|
|
||||||
|
• **@sern/client**: [`Singleton`](../modules.md#singleton)<`__module`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/handler.ts:40](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L40)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/emitter
|
||||||
|
|
||||||
|
• **@sern/emitter**: [`Singleton`](../modules.md#singleton)<[`SernEmitter`](../classes/SernEmitter.md)\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/handler.ts:42](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L42)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/errors
|
||||||
|
|
||||||
|
• **@sern/errors**: [`Singleton`](../modules.md#singleton)<[`ErrorHandling`](ErrorHandling.md)\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/handler.ts:45](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L45)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/logger
|
||||||
|
|
||||||
|
• `Optional` **@sern/logger**: [`Singleton`](../modules.md#singleton)<[`Logging`](Logging.md)<`unknown`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/handler.ts:41](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L41)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/modules
|
||||||
|
|
||||||
|
• **@sern/modules**: [`Singleton`](../modules.md#singleton)<[`ModuleManager`](ModuleManager.md)\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/handler.ts:44](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L44)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### @sern/store
|
||||||
|
|
||||||
|
• **@sern/store**: [`Singleton`](../modules.md#singleton)<[`ModuleStore`](../classes/ModuleStore.md)\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/handler.ts:43](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L43)
|
||||||
47
docs/api/interfaces/DependencyConfiguration.md
Normal file
47
docs/api/interfaces/DependencyConfiguration.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
---
|
||||||
|
id: "DependencyConfiguration"
|
||||||
|
title: "Interface: DependencyConfiguration<T>"
|
||||||
|
sidebar_label: "DependencyConfiguration"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends [`Dependencies`](Dependencies.md) |
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### build
|
||||||
|
|
||||||
|
• **build**: (`root`: `Container`<`Omit`<[`Dependencies`](Dependencies.md), ``"@sern/client"``\>, {}\>) => `Container`<`T`, {}\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`root`): `Container`<`T`, {}\>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `root` | `Container`<`Omit`<[`Dependencies`](Dependencies.md), ``"@sern/client"``\>, {}\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Container`<`T`, {}\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/handler.ts:68](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L68)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### exclude
|
||||||
|
|
||||||
|
• `Optional` **exclude**: `Set`<``"@sern/logger"``\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/handler.ts:67](https://github.com/sern-handler/handler/blob/c1f6906/src/types/handler.ts#L67)
|
||||||
90
docs/api/interfaces/DiscordEmitterPlugin.md
Normal file
90
docs/api/interfaces/DiscordEmitterPlugin.md
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
---
|
||||||
|
id: "DiscordEmitterPlugin"
|
||||||
|
title: "Interface: DiscordEmitterPlugin"
|
||||||
|
sidebar_label: "DiscordEmitterPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- [`Plugin`](Plugin.md)
|
||||||
|
|
||||||
|
↳ **`DiscordEmitterPlugin`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`payload`: { `absPath`: `string` ; `mod`: `DiscordEventCommand`<keyof `ClientEvents`\> & { `name`: `string` } }, `controller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`payload`, `controller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | `Object` |
|
||||||
|
| `payload.absPath` | `string` |
|
||||||
|
| `payload.mod` | `DiscordEventCommand`<keyof `ClientEvents`\> & { `name`: `string` } |
|
||||||
|
| `controller` | [`Controller`](Controller.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:49](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L49)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:31](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Command`](../enums/PluginType.md#command)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:48](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L48)
|
||||||
113
docs/api/interfaces/DiscordEventCommand.md
Normal file
113
docs/api/interfaces/DiscordEventCommand.md
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
---
|
||||||
|
id: "DiscordEventCommand"
|
||||||
|
title: "Interface: DiscordEventCommand<T>"
|
||||||
|
sidebar_label: "DiscordEventCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends keyof `ClientEvents` = keyof `ClientEvents` |
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`DiscordEventCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `T`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:107](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L107)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Discord`](../enums/EventType.md#discord)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:108](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L108)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
▸ **execute**(`...args`): `unknown`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | `ClientEvents`[`T`] |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:109](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L109)
|
||||||
94
docs/api/interfaces/DiscordEventPlugin.md
Normal file
94
docs/api/interfaces/DiscordEventPlugin.md
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
---
|
||||||
|
id: "DiscordEventPlugin"
|
||||||
|
title: "Interface: DiscordEventPlugin<T>"
|
||||||
|
sidebar_label: "DiscordEventPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends keyof `ClientEvents` = keyof `ClientEvents` |
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- [`Plugin`](Plugin.md)
|
||||||
|
|
||||||
|
↳ **`DiscordEventPlugin`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`args`: `ClientEvents`[`T`], `controller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`args`, `controller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `args` | `ClientEvents`[`T`] |
|
||||||
|
| `controller` | [`Controller`](Controller.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:105](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L105)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `T`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:103](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L103)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Event`](../enums/PluginType.md#event)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:104](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L104)
|
||||||
24
docs/api/interfaces/Disposable.md
Normal file
24
docs/api/interfaces/Disposable.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
id: "Disposable"
|
||||||
|
title: "Interface: Disposable"
|
||||||
|
sidebar_label: "Disposable"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
Represents a Disposable contract.
|
||||||
|
Let dependencies implement this to dispose and cleanup.
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### dispose
|
||||||
|
|
||||||
|
▸ **dispose**(): `unknown`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/disposable.ts:8](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/disposable.ts#L8)
|
||||||
70
docs/api/interfaces/Emitter.md
Normal file
70
docs/api/interfaces/Emitter.md
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
---
|
||||||
|
id: "Emitter"
|
||||||
|
title: "Interface: Emitter"
|
||||||
|
sidebar_label: "Emitter"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### addListener
|
||||||
|
|
||||||
|
▸ **addListener**(`eventName`, `listener`): [`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `eventName` | `string` \| `symbol` |
|
||||||
|
| `listener` | `AnyFunction` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/emitter.ts:4](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/emitter.ts#L4)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### emit
|
||||||
|
|
||||||
|
▸ **emit**(`eventName`, `...payload`): `boolean`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `eventName` | `string` \| `symbol` |
|
||||||
|
| `...payload` | `any`[] |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`boolean`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/emitter.ts:6](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/emitter.ts#L6)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### removeListener
|
||||||
|
|
||||||
|
▸ **removeListener**(`eventName`, `listener`): [`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `eventName` | `string` \| `symbol` |
|
||||||
|
| `listener` | `AnyFunction` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Emitter`](Emitter.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/emitter.ts:5](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/emitter.ts#L5)
|
||||||
61
docs/api/interfaces/ErrorHandling.md
Normal file
61
docs/api/interfaces/ErrorHandling.md
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
---
|
||||||
|
id: "ErrorHandling"
|
||||||
|
title: "Interface: ErrorHandling"
|
||||||
|
sidebar_label: "ErrorHandling"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
|
||||||
|
## Implemented by
|
||||||
|
|
||||||
|
- [`DefaultErrorHandling`](../classes/DefaultErrorHandling.md)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### crash
|
||||||
|
|
||||||
|
▸ **crash**(`err`): `never`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `err` | `Error` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`never`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Version 4 will remove this method
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/error-handling.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/error-handling.ts#L11)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### updateAlive
|
||||||
|
|
||||||
|
▸ **updateAlive**(`error`): `void`
|
||||||
|
|
||||||
|
A function that is called on every throw.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `error` | `Error` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/error-handling.ts:16](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/error-handling.ts#L16)
|
||||||
37
docs/api/interfaces/EventModuleDefs.md
Normal file
37
docs/api/interfaces/EventModuleDefs.md
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
---
|
||||||
|
id: "EventModuleDefs"
|
||||||
|
title: "Interface: EventModuleDefs"
|
||||||
|
sidebar_label: "EventModuleDefs"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### 1
|
||||||
|
|
||||||
|
• **1**: [`DiscordEventCommand`](DiscordEventCommand.md)<keyof `ClientEvents`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:167](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L167)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 2
|
||||||
|
|
||||||
|
• **2**: [`SernEventCommand`](SernEventCommand.md)<keyof [`SernEventsMapping`](SernEventsMapping.md)\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:166](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L166)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### 3
|
||||||
|
|
||||||
|
• **3**: [`ExternalEventCommand`](ExternalEventCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:168](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L168)
|
||||||
72
docs/api/interfaces/EventPlugin.md
Normal file
72
docs/api/interfaces/EventPlugin.md
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
---
|
||||||
|
id: "EventPlugin"
|
||||||
|
title: "Interface: EventPlugin<T>"
|
||||||
|
sidebar_label: "EventPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Use the newer helper functions
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends [`CommandType`](../enums/CommandType.md) |
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/plugin.ts:64](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L64)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`args`: [`CommandArgs`](../modules.md#commandargs)<`T`, [`Event`](../enums/PluginType.md#event)\>, `controller?`: [`Controller`](Controller.md)) => [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`args`, `controller?`): [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `args` | [`CommandArgs`](../modules.md#commandargs)<`T`, [`Event`](../enums/PluginType.md#event)\> |
|
||||||
|
| `controller?` | [`Controller`](Controller.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/plugin.ts:66](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L66)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/plugin.ts:63](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L63)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Event`](../enums/PluginType.md#event)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/plugin.ts:65](https://github.com/sern-handler/handler/blob/c1f6906/src/types/plugin.ts#L65)
|
||||||
90
docs/api/interfaces/ExternalEmitterPlugin.md
Normal file
90
docs/api/interfaces/ExternalEmitterPlugin.md
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
---
|
||||||
|
id: "ExternalEmitterPlugin"
|
||||||
|
title: "Interface: ExternalEmitterPlugin"
|
||||||
|
sidebar_label: "ExternalEmitterPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- [`Plugin`](Plugin.md)
|
||||||
|
|
||||||
|
↳ **`ExternalEmitterPlugin`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`payload`: { `absPath`: `string` ; `mod`: `ExternalEventCommand` & { `name`: `string` } }, `controller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`payload`, `controller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | `Object` |
|
||||||
|
| `payload.absPath` | `string` |
|
||||||
|
| `payload.mod` | `ExternalEventCommand` & { `name`: `string` } |
|
||||||
|
| `controller` | [`Controller`](Controller.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:57](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L57)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:31](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Command`](../enums/PluginType.md#command)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:56](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L56)
|
||||||
117
docs/api/interfaces/ExternalEventCommand.md
Normal file
117
docs/api/interfaces/ExternalEventCommand.md
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
---
|
||||||
|
id: "ExternalEventCommand"
|
||||||
|
title: "Interface: ExternalEventCommand"
|
||||||
|
sidebar_label: "ExternalEventCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`ExternalEventCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### emitter
|
||||||
|
|
||||||
|
• **emitter**: keyof `Dependencies`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:49](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L49)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:48](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L48)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`External`](../enums/EventType.md#external)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:50](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L50)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
▸ **execute**(`...args`): `unknown`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | `unknown`[] |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:51](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L51)
|
||||||
88
docs/api/interfaces/ExternalEventPlugin.md
Normal file
88
docs/api/interfaces/ExternalEventPlugin.md
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
---
|
||||||
|
id: "ExternalEventPlugin"
|
||||||
|
title: "Interface: ExternalEventPlugin"
|
||||||
|
sidebar_label: "ExternalEventPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- [`Plugin`](Plugin.md)
|
||||||
|
|
||||||
|
↳ **`ExternalEventPlugin`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`args`: `unknown`[], `controller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`args`, `controller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `args` | `unknown`[] |
|
||||||
|
| `controller` | [`Controller`](Controller.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:99](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L99)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:31](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Event`](../enums/PluginType.md#event)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:98](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L98)
|
||||||
24
docs/api/interfaces/Init.md
Normal file
24
docs/api/interfaces/Init.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
id: "Init"
|
||||||
|
title: "Interface: Init"
|
||||||
|
sidebar_label: "Init"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
Represents an initialization contract.
|
||||||
|
Let dependencies implement this to initiate some logic.
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### init
|
||||||
|
|
||||||
|
▸ **init**(): `unknown`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/init.ts:8](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/init.ts#L8)
|
||||||
33
docs/api/interfaces/InitArgs.md
Normal file
33
docs/api/interfaces/InitArgs.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
---
|
||||||
|
id: "InitArgs"
|
||||||
|
title: "Interface: InitArgs<T>"
|
||||||
|
sidebar_label: "InitArgs"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends [`Processed`](../modules.md#processed)<[`Module`](Module.md)\> |
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### absPath
|
||||||
|
|
||||||
|
• **absPath**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/args.ts:107](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/args.ts#L107)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### module
|
||||||
|
|
||||||
|
• **module**: `T`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/args.ts:106](https://github.com/sern-handler/handler/blob/c1f6906/src/handler/plugins/args.ts#L106)
|
||||||
47
docs/api/interfaces/InitPlugin.md
Normal file
47
docs/api/interfaces/InitPlugin.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
---
|
||||||
|
id: "InitPlugin"
|
||||||
|
title: "Interface: InitPlugin<Args>"
|
||||||
|
sidebar_label: "InitPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `Args` | extends `any`[] = `any`[] |
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (...`args`: `Args`) => [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`...args`): [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | `Args` |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:69](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L69)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Init`](../enums/PluginType.md#init)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:68](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L68)
|
||||||
101
docs/api/interfaces/Logging.md
Normal file
101
docs/api/interfaces/Logging.md
Normal file
@@ -0,0 +1,101 @@
|
|||||||
|
---
|
||||||
|
id: "Logging"
|
||||||
|
title: "Interface: Logging<T>"
|
||||||
|
sidebar_label: "Logging"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | `unknown` |
|
||||||
|
|
||||||
|
## Implemented by
|
||||||
|
|
||||||
|
- [`DefaultLogging`](../classes/DefaultLogging.md)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### debug
|
||||||
|
|
||||||
|
▸ **debug**(`payload`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | [`LogPayload`](../modules.md#logpayload)<`T`\> |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/logging.ts:8](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L8)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### error
|
||||||
|
|
||||||
|
▸ **error**(`payload`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | [`LogPayload`](../modules.md#logpayload)<`T`\> |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/logging.ts:5](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L5)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### info
|
||||||
|
|
||||||
|
▸ **info**(`payload`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | [`LogPayload`](../modules.md#logpayload)<`T`\> |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/logging.ts:7](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L7)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### warning
|
||||||
|
|
||||||
|
▸ **warning**(`payload`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | [`LogPayload`](../modules.md#logpayload)<`T`\> |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/logging.ts:6](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L6)
|
||||||
111
docs/api/interfaces/MentionableSelectCommand.md
Normal file
111
docs/api/interfaces/MentionableSelectCommand.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "MentionableSelectCommand"
|
||||||
|
title: "Interface: MentionableSelectCommand"
|
||||||
|
sidebar_label: "MentionableSelectCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`MentionableSelectCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `MentionableSelectMenuInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `MentionableSelectMenuInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:86](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L86)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`MentionableSelect`](../enums/CommandType.md#mentionableselect)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:85](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L85)
|
||||||
111
docs/api/interfaces/ModalSubmitCommand.md
Normal file
111
docs/api/interfaces/ModalSubmitCommand.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "ModalSubmitCommand"
|
||||||
|
title: "Interface: ModalSubmitCommand"
|
||||||
|
sidebar_label: "ModalSubmitCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`ModalSubmitCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `ModalSubmitInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `ModalSubmitInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:96](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L96)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Modal`](../enums/CommandType.md#modal)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:95](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L95)
|
||||||
115
docs/api/interfaces/Module.md
Normal file
115
docs/api/interfaces/Module.md
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
---
|
||||||
|
id: "Module"
|
||||||
|
title: "Interface: Module"
|
||||||
|
sidebar_label: "Module"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- **`Module`**
|
||||||
|
|
||||||
|
↳ [`TextCommand`](TextCommand.md)
|
||||||
|
|
||||||
|
↳ [`SlashCommand`](SlashCommand.md)
|
||||||
|
|
||||||
|
↳ [`BothCommand`](BothCommand.md)
|
||||||
|
|
||||||
|
↳ [`ContextMenuUser`](ContextMenuUser.md)
|
||||||
|
|
||||||
|
↳ [`ContextMenuMsg`](ContextMenuMsg.md)
|
||||||
|
|
||||||
|
↳ [`ButtonCommand`](ButtonCommand.md)
|
||||||
|
|
||||||
|
↳ [`StringSelectCommand`](StringSelectCommand.md)
|
||||||
|
|
||||||
|
↳ [`ChannelSelectCommand`](ChannelSelectCommand.md)
|
||||||
|
|
||||||
|
↳ [`RoleSelectCommand`](RoleSelectCommand.md)
|
||||||
|
|
||||||
|
↳ [`MentionableSelectCommand`](MentionableSelectCommand.md)
|
||||||
|
|
||||||
|
↳ [`UserSelectCommand`](UserSelectCommand.md)
|
||||||
|
|
||||||
|
↳ [`ModalSubmitCommand`](ModalSubmitCommand.md)
|
||||||
|
|
||||||
|
↳ [`SernEventCommand`](SernEventCommand.md)
|
||||||
|
|
||||||
|
↳ [`DiscordEventCommand`](DiscordEventCommand.md)
|
||||||
|
|
||||||
|
↳ [`ExternalEventCommand`](ExternalEventCommand.md)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/module.ts:38](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L38)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (...`args`: `any`[]) => `any`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (...`args`): `any`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | `any`[] |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`any`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/module.ts:39](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L39)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/module.ts:35](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/module.ts:36](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/module.ts:37](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`CommandType`](../enums/CommandType.md) \| [`EventType`](../enums/EventType.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/module.ts:34](https://github.com/sern-handler/handler/blob/c1f6906/src/types/module.ts#L34)
|
||||||
153
docs/api/interfaces/ModuleManager.md
Normal file
153
docs/api/interfaces/ModuleManager.md
Normal file
@@ -0,0 +1,153 @@
|
|||||||
|
---
|
||||||
|
id: "ModuleManager"
|
||||||
|
title: "Interface: ModuleManager"
|
||||||
|
sidebar_label: "ModuleManager"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
- direct access to the module manager will be removed in version 4
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `MetadataAccess`
|
||||||
|
|
||||||
|
↳ **`ModuleManager`**
|
||||||
|
|
||||||
|
## Implemented by
|
||||||
|
|
||||||
|
- [`DefaultModuleManager`](../classes/DefaultModuleManager.md)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### get
|
||||||
|
|
||||||
|
▸ **get**(`id`): `undefined` \| `string`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `id` | `string` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`undefined` \| `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/module-manager.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L19)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### getByNameCommandType
|
||||||
|
|
||||||
|
▸ **getByNameCommandType**<`T`\>(`name`, `commandType`): `undefined` \| `Promise`<[`CommandModuleDefs`](CommandModuleDefs.md)[`T`]\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends [`CommandType`](../enums/CommandType.md) |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `name` | `string` |
|
||||||
|
| `commandType` | `T` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`undefined` \| `Promise`<[`CommandModuleDefs`](CommandModuleDefs.md)[`T`]\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/module-manager.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L23)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### getMetadata
|
||||||
|
|
||||||
|
▸ **getMetadata**(`m`): `undefined` \| `CommandMeta`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `m` | `Module` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`undefined` \| `CommandMeta`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
MetadataAccess.getMetadata
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/module-manager.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L10)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### getPublishableCommands
|
||||||
|
|
||||||
|
▸ **getPublishableCommands**(): `Promise`<[`CommandModule`](../modules.md#commandmodule)[]\>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`Promise`<[`CommandModule`](../modules.md#commandmodule)[]\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/module-manager.ts:22](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L22)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### set
|
||||||
|
|
||||||
|
▸ **set**(`id`, `path`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `id` | `string` |
|
||||||
|
| `path` | `string` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/module-manager.ts:21](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L21)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### setMetadata
|
||||||
|
|
||||||
|
▸ **setMetadata**(`m`, `c`): `void`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `m` | `Module` |
|
||||||
|
| `c` | `CommandMeta` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`void`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
MetadataAccess.setMetadata
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/module-manager.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/module-manager.ts#L11)
|
||||||
47
docs/api/interfaces/Plugin.md
Normal file
47
docs/api/interfaces/Plugin.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
---
|
||||||
|
id: "Plugin"
|
||||||
|
title: "Interface: Plugin<Args>"
|
||||||
|
sidebar_label: "Plugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `Args` | extends `any`[] = `any`[] |
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (...`args`: `Args`) => [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`...args`): [`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | `Args` |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
[`PluginResult`](../modules.md#pluginresult)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:64](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L64)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`PluginType`](../enums/PluginType.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:63](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L63)
|
||||||
82
docs/api/interfaces/Presence.Result.md
Normal file
82
docs/api/interfaces/Presence.Result.md
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
---
|
||||||
|
id: "Presence.Result"
|
||||||
|
title: "Interface: Result"
|
||||||
|
sidebar_label: "Result"
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
[Presence](../namespaces/Presence.md).Result
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### activities
|
||||||
|
|
||||||
|
• `Optional` **activities**: `ActivitiesOptions`[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/presences.ts:11](https://github.com/sern-handler/handler/blob/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)
|
||||||
111
docs/api/interfaces/RoleSelectCommand.md
Normal file
111
docs/api/interfaces/RoleSelectCommand.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "RoleSelectCommand"
|
||||||
|
title: "Interface: RoleSelectCommand"
|
||||||
|
sidebar_label: "RoleSelectCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`RoleSelectCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `RoleSelectMenuInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `RoleSelectMenuInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:81](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L81)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`RoleSelect`](../enums/CommandType.md#roleselect)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:80](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L80)
|
||||||
113
docs/api/interfaces/SernAutocompleteData.md
Normal file
113
docs/api/interfaces/SernAutocompleteData.md
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
---
|
||||||
|
id: "SernAutocompleteData"
|
||||||
|
title: "Interface: SernAutocompleteData"
|
||||||
|
sidebar_label: "SernAutocompleteData"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Omit`<`BaseApplicationCommandOptionsData`, ``"autocomplete"``\>
|
||||||
|
|
||||||
|
↳ **`SernAutocompleteData`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### autocomplete
|
||||||
|
|
||||||
|
• **autocomplete**: ``true``
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:173](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L173)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### command
|
||||||
|
|
||||||
|
• **command**: `AutocompleteCommand`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:178](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L178)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Omit.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4493
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### descriptionLocalizations
|
||||||
|
|
||||||
|
• `Optional` **descriptionLocalizations**: `Partial`<`Record`<``"id"`` \| ``"en-US"`` \| ``"en-GB"`` \| ``"bg"`` \| ``"zh-CN"`` \| ``"zh-TW"`` \| ``"hr"`` \| ``"cs"`` \| ``"da"`` \| ``"nl"`` \| ``"fi"`` \| ``"fr"`` \| ``"de"`` \| ``"el"`` \| ``"hi"`` \| ``"hu"`` \| ``"it"`` \| ``"ja"`` \| ``"ko"`` \| ``"lt"`` \| ``"no"`` \| ``"pl"`` \| ``"pt-BR"`` \| ``"ro"`` \| ``"ru"`` \| ``"es-ES"`` \| ``"sv-SE"`` \| ``"th"`` \| ``"tr"`` \| ``"uk"`` \| ``"vi"``, ``null`` \| `string`\>\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Omit.descriptionLocalizations
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4494
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Omit.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4491
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### nameLocalizations
|
||||||
|
|
||||||
|
• `Optional` **nameLocalizations**: `Partial`<`Record`<``"id"`` \| ``"en-US"`` \| ``"en-GB"`` \| ``"bg"`` \| ``"zh-CN"`` \| ``"zh-TW"`` \| ``"hr"`` \| ``"cs"`` \| ``"da"`` \| ``"nl"`` \| ``"fi"`` \| ``"fr"`` \| ``"de"`` \| ``"el"`` \| ``"hi"`` \| ``"hu"`` \| ``"it"`` \| ``"ja"`` \| ``"ko"`` \| ``"lt"`` \| ``"no"`` \| ``"pl"`` \| ``"pt-BR"`` \| ``"ro"`` \| ``"ru"`` \| ``"es-ES"`` \| ``"sv-SE"`` \| ``"th"`` \| ``"tr"`` \| ``"uk"`` \| ``"vi"``, ``null`` \| `string`\>\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Omit.nameLocalizations
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4492
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### required
|
||||||
|
|
||||||
|
• `Optional` **required**: `boolean`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Omit.required
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4495
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: `String` \| `Integer` \| `Number`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:174](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L174)
|
||||||
90
docs/api/interfaces/SernEmitterPlugin.md
Normal file
90
docs/api/interfaces/SernEmitterPlugin.md
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
---
|
||||||
|
id: "SernEmitterPlugin"
|
||||||
|
title: "Interface: SernEmitterPlugin"
|
||||||
|
sidebar_label: "SernEmitterPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- [`Plugin`](Plugin.md)
|
||||||
|
|
||||||
|
↳ **`SernEmitterPlugin`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`payload`: { `absPath`: `string` ; `mod`: `SernEventCommand`<keyof [`SernEventsMapping`](../modules.md#serneventsmapping)\> & { `name`: `string` } }, `controller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`payload`, `controller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `payload` | `Object` |
|
||||||
|
| `payload.absPath` | `string` |
|
||||||
|
| `payload.mod` | `SernEventCommand`<keyof [`SernEventsMapping`](../modules.md#serneventsmapping)\> & { `name`: `string` } |
|
||||||
|
| `controller` | [`Controller`](Controller.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:65](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L65)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:31](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Command`](../enums/PluginType.md#command)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:64](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L64)
|
||||||
113
docs/api/interfaces/SernEventCommand.md
Normal file
113
docs/api/interfaces/SernEventCommand.md
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
---
|
||||||
|
id: "SernEventCommand"
|
||||||
|
title: "Interface: SernEventCommand<T>"
|
||||||
|
sidebar_label: "SernEventCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends keyof [`SernEventsMapping`](SernEventsMapping.md) = keyof [`SernEventsMapping`](SernEventsMapping.md) |
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`SernEventCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `T`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:43](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L43)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Sern`](../enums/EventType.md#sern)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:44](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L44)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
▸ **execute**(`...args`): `unknown`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...args` | [`SernEventsMapping`](SernEventsMapping.md)[`T`] |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:45](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L45)
|
||||||
94
docs/api/interfaces/SernEventPlugin.md
Normal file
94
docs/api/interfaces/SernEventPlugin.md
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
---
|
||||||
|
id: "SernEventPlugin"
|
||||||
|
title: "Interface: SernEventPlugin<T>"
|
||||||
|
sidebar_label: "SernEventPlugin"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends keyof [`SernEventsMapping`](../modules.md#serneventsmapping) = keyof [`SernEventsMapping`](../modules.md#serneventsmapping) |
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- [`Plugin`](Plugin.md)
|
||||||
|
|
||||||
|
↳ **`SernEventPlugin`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[description](Plugin.md#description)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:33](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`args`: [`SernEventsMapping`](../modules.md#serneventsmapping)[`T`], `controller`: [`Controller`](Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`args`, `controller`): `Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `args` | [`SernEventsMapping`](../modules.md#serneventsmapping)[`T`] |
|
||||||
|
| `controller` | [`Controller`](Controller.md) |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`Awaitable`<`Result`<`void`, `void`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:91](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L91)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `T`
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
will be removed in the next update
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[name](Plugin.md#name)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:89](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L89)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Event`](../enums/PluginType.md#event)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
[Plugin](Plugin.md).[type](Plugin.md#type)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/handler/plugins/plugin.ts:90](https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L90)
|
||||||
57
docs/api/interfaces/SernEventsMapping.md
Normal file
57
docs/api/interfaces/SernEventsMapping.md
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
---
|
||||||
|
id: "SernEventsMapping"
|
||||||
|
title: "Interface: SernEventsMapping"
|
||||||
|
sidebar_label: "SernEventsMapping"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### error
|
||||||
|
|
||||||
|
• **error**: [[`Payload`](../modules.md#payload)]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/utility.ts:21](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L21)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### module.activate
|
||||||
|
|
||||||
|
• **module.activate**: [[`Payload`](../modules.md#payload)]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/utility.ts:20](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L20)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### module.register
|
||||||
|
|
||||||
|
• **module.register**: [[`Payload`](../modules.md#payload)]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/utility.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L19)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### modulesLoaded
|
||||||
|
|
||||||
|
• **modulesLoaded**: [undefined?]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/utility.ts:23](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L23)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### warning
|
||||||
|
|
||||||
|
• **warning**: [[`Payload`](../modules.md#payload)]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/utility.ts:22](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L22)
|
||||||
107
docs/api/interfaces/SernSubCommandData.md
Normal file
107
docs/api/interfaces/SernSubCommandData.md
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
---
|
||||||
|
id: "SernSubCommandData"
|
||||||
|
title: "Interface: SernSubCommandData"
|
||||||
|
sidebar_label: "SernSubCommandData"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `APIApplicationCommandOptionBase`<`ApplicationCommandOptionType.Subcommand`\>
|
||||||
|
|
||||||
|
↳ **`SernSubCommandData`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
APIApplicationCommandOptionBase.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord-api-types/payloads/v10/_interactions/_applicationCommands/_chatInput/base.d.ts:7
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### description\_localizations
|
||||||
|
|
||||||
|
• `Optional` **description\_localizations**: ``null`` \| `Partial`<`Record`<``"id"`` \| ``"en-US"`` \| ``"en-GB"`` \| ``"bg"`` \| ``"zh-CN"`` \| ``"zh-TW"`` \| ``"hr"`` \| ``"cs"`` \| ``"da"`` \| ``"nl"`` \| ``"fi"`` \| ``"fr"`` \| ``"de"`` \| ``"el"`` \| ``"hi"`` \| ``"hu"`` \| ``"it"`` \| ``"ja"`` \| ``"ko"`` \| ``"lt"`` \| ``"no"`` \| ``"pl"`` \| ``"pt-BR"`` \| ``"ro"`` \| ``"ru"`` \| ``"es-ES"`` \| ``"sv-SE"`` \| ``"th"`` \| ``"tr"`` \| ``"uk"`` \| ``"vi"``, ``null`` \| `string`\>\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
APIApplicationCommandOptionBase.description\_localizations
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord-api-types/payloads/v10/_interactions/_applicationCommands/_chatInput/base.d.ts:8
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
APIApplicationCommandOptionBase.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord-api-types/payloads/v10/_interactions/_applicationCommands/_chatInput/base.d.ts:5
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name\_localizations
|
||||||
|
|
||||||
|
• `Optional` **name\_localizations**: ``null`` \| `Partial`<`Record`<``"id"`` \| ``"en-US"`` \| ``"en-GB"`` \| ``"bg"`` \| ``"zh-CN"`` \| ``"zh-TW"`` \| ``"hr"`` \| ``"cs"`` \| ``"da"`` \| ``"nl"`` \| ``"fi"`` \| ``"fr"`` \| ``"de"`` \| ``"el"`` \| ``"hi"`` \| ``"hu"`` \| ``"it"`` \| ``"ja"`` \| ``"ko"`` \| ``"lt"`` \| ``"no"`` \| ``"pl"`` \| ``"pt-BR"`` \| ``"ro"`` \| ``"ru"`` \| ``"es-ES"`` \| ``"sv-SE"`` \| ``"th"`` \| ``"tr"`` \| ``"uk"`` \| ``"vi"``, ``null`` \| `string`\>\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
APIApplicationCommandOptionBase.name\_localizations
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord-api-types/payloads/v10/_interactions/_applicationCommands/_chatInput/base.d.ts:6
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### options
|
||||||
|
|
||||||
|
• `Optional` **options**: [`SernOptionsData`](../modules.md#sernoptionsdata)[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:210](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L210)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### required
|
||||||
|
|
||||||
|
• `Optional` **required**: `boolean`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
APIApplicationCommandOptionBase.required
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord-api-types/payloads/v10/_interactions/_applicationCommands/_chatInput/base.d.ts:9
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: `Subcommand`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
APIApplicationCommandOptionBase.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:209](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L209)
|
||||||
117
docs/api/interfaces/SernSubCommandGroupData.md
Normal file
117
docs/api/interfaces/SernSubCommandGroupData.md
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
---
|
||||||
|
id: "SernSubCommandGroupData"
|
||||||
|
title: "Interface: SernSubCommandGroupData"
|
||||||
|
sidebar_label: "SernSubCommandGroupData"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `BaseApplicationCommandOptionsData`
|
||||||
|
|
||||||
|
↳ **`SernSubCommandGroupData`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### autocomplete
|
||||||
|
|
||||||
|
• `Optional` **autocomplete**: `undefined`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
BaseApplicationCommandOptionsData.autocomplete
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4496
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
BaseApplicationCommandOptionsData.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4493
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### descriptionLocalizations
|
||||||
|
|
||||||
|
• `Optional` **descriptionLocalizations**: `Partial`<`Record`<``"id"`` \| ``"en-US"`` \| ``"en-GB"`` \| ``"bg"`` \| ``"zh-CN"`` \| ``"zh-TW"`` \| ``"hr"`` \| ``"cs"`` \| ``"da"`` \| ``"nl"`` \| ``"fi"`` \| ``"fr"`` \| ``"de"`` \| ``"el"`` \| ``"hi"`` \| ``"hu"`` \| ``"it"`` \| ``"ja"`` \| ``"ko"`` \| ``"lt"`` \| ``"no"`` \| ``"pl"`` \| ``"pt-BR"`` \| ``"ro"`` \| ``"ru"`` \| ``"es-ES"`` \| ``"sv-SE"`` \| ``"th"`` \| ``"tr"`` \| ``"uk"`` \| ``"vi"``, ``null`` \| `string`\>\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
BaseApplicationCommandOptionsData.descriptionLocalizations
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4494
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
BaseApplicationCommandOptionsData.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4491
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### nameLocalizations
|
||||||
|
|
||||||
|
• `Optional` **nameLocalizations**: `Partial`<`Record`<``"id"`` \| ``"en-US"`` \| ``"en-GB"`` \| ``"bg"`` \| ``"zh-CN"`` \| ``"zh-TW"`` \| ``"hr"`` \| ``"cs"`` \| ``"da"`` \| ``"nl"`` \| ``"fi"`` \| ``"fr"`` \| ``"de"`` \| ``"el"`` \| ``"hi"`` \| ``"hu"`` \| ``"it"`` \| ``"ja"`` \| ``"ko"`` \| ``"lt"`` \| ``"no"`` \| ``"pl"`` \| ``"pt-BR"`` \| ``"ro"`` \| ``"ru"`` \| ``"es-ES"`` \| ``"sv-SE"`` \| ``"th"`` \| ``"tr"`` \| ``"uk"`` \| ``"vi"``, ``null`` \| `string`\>\>
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
BaseApplicationCommandOptionsData.nameLocalizations
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4492
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### options
|
||||||
|
|
||||||
|
• `Optional` **options**: [`SernSubCommandData`](SernSubCommandData.md)[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:215](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L215)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### required
|
||||||
|
|
||||||
|
• `Optional` **required**: `boolean`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
BaseApplicationCommandOptionsData.required
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
node_modules/discord.js/typings/index.d.ts:4495
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: `SubcommandGroup`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:214](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L214)
|
||||||
122
docs/api/interfaces/SlashCommand.md
Normal file
122
docs/api/interfaces/SlashCommand.md
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
---
|
||||||
|
id: "SlashCommand"
|
||||||
|
title: "Interface: SlashCommand"
|
||||||
|
sidebar_label: "SlashCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`SlashCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• **description**: `string`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:119](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L119)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: [`Context`](../classes/Context.md), `args`: [``"slash"``, [`SlashOptions`](../modules.md#slashoptions)]) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`, `args`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | [`Context`](../classes/Context.md) |
|
||||||
|
| `args` | [``"slash"``, [`SlashOptions`](../modules.md#slashoptions)] |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:121](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L121)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### options
|
||||||
|
|
||||||
|
• `Optional` **options**: [`SernOptionsData`](../modules.md#sernoptionsdata)[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:120](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L120)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Slash`](../enums/CommandType.md#slash)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:118](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L118)
|
||||||
111
docs/api/interfaces/StringSelectCommand.md
Normal file
111
docs/api/interfaces/StringSelectCommand.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "StringSelectCommand"
|
||||||
|
title: "Interface: StringSelectCommand"
|
||||||
|
sidebar_label: "StringSelectCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`StringSelectCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `StringSelectMenuInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `StringSelectMenuInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:71](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L71)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`StringSelect`](../enums/CommandType.md#stringselect)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:70](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L70)
|
||||||
122
docs/api/interfaces/TextCommand.md
Normal file
122
docs/api/interfaces/TextCommand.md
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
---
|
||||||
|
id: "TextCommand"
|
||||||
|
title: "Interface: TextCommand"
|
||||||
|
sidebar_label: "TextCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`TextCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### alias
|
||||||
|
|
||||||
|
• `Optional` **alias**: `string`[]
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:113](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L113)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: [`Context`](../classes/Context.md), `args`: [``"text"``, `string`[]]) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`, `args`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | [`Context`](../classes/Context.md) |
|
||||||
|
| `args` | [``"text"``, `string`[]] |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:114](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L114)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`Text`](../enums/CommandType.md#text)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:112](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L112)
|
||||||
111
docs/api/interfaces/UserSelectCommand.md
Normal file
111
docs/api/interfaces/UserSelectCommand.md
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
---
|
||||||
|
id: "UserSelectCommand"
|
||||||
|
title: "Interface: UserSelectCommand"
|
||||||
|
sidebar_label: "UserSelectCommand"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
- `Module`
|
||||||
|
|
||||||
|
↳ **`UserSelectCommand`**
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### description
|
||||||
|
|
||||||
|
• `Optional` **description**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.description
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### execute
|
||||||
|
|
||||||
|
• **execute**: (`ctx`: `UserSelectMenuInteraction`<`CacheType`\>) => `unknown`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (`ctx`): `unknown`
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `ctx` | `UserSelectMenuInteraction`<`CacheType`\> |
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`unknown`
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.execute
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:91](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L91)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### name
|
||||||
|
|
||||||
|
• `Optional` **name**: `string`
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.name
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:34](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L34)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### onEvent
|
||||||
|
|
||||||
|
• **onEvent**: [`ControlPlugin`](ControlPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.onEvent
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:35](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L35)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### plugins
|
||||||
|
|
||||||
|
• **plugins**: [`InitPlugin`](InitPlugin.md)<`any`[]\>[]
|
||||||
|
|
||||||
|
#### Inherited from
|
||||||
|
|
||||||
|
Module.plugins
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### type
|
||||||
|
|
||||||
|
• **type**: [`UserSelect`](../enums/CommandType.md#userselect)
|
||||||
|
|
||||||
|
#### Overrides
|
||||||
|
|
||||||
|
Module.type
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:90](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L90)
|
||||||
69
docs/api/interfaces/Wrapper.md
Normal file
69
docs/api/interfaces/Wrapper.md
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
---
|
||||||
|
id: "Wrapper"
|
||||||
|
title: "Interface: Wrapper"
|
||||||
|
sidebar_label: "Wrapper"
|
||||||
|
sidebar_position: 0
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### commands
|
||||||
|
|
||||||
|
• **commands**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core.ts:9](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L9)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### containerConfig
|
||||||
|
|
||||||
|
• `Optional` **containerConfig**: `Object`
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `get` | (...`keys`: keyof `Dependencies`[]) => `unknown`[] |
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core.ts:20](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L20)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### defaultPrefix
|
||||||
|
|
||||||
|
• `Optional` **defaultPrefix**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core.ts:10](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L10)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### events
|
||||||
|
|
||||||
|
• `Optional` **events**: `string`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L11)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### mode
|
||||||
|
|
||||||
|
• `Optional` **mode**: `string`
|
||||||
|
|
||||||
|
Overload to enable mode in case developer does not use a .env file.
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
- https://github.com/sern-handler/handler/pull/325
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core.ts:16](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core.ts#L16)
|
||||||
2
docs/api/interfaces/_category_.yml
Normal file
2
docs/api/interfaces/_category_.yml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
label: "Interfaces"
|
||||||
|
position: 4
|
||||||
756
docs/api/modules.md
Normal file
756
docs/api/modules.md
Normal file
@@ -0,0 +1,756 @@
|
|||||||
|
---
|
||||||
|
id: "modules"
|
||||||
|
title: "@sern/handler"
|
||||||
|
sidebar_label: "Exports"
|
||||||
|
sidebar_position: 0.5
|
||||||
|
custom_edit_url: null
|
||||||
|
---
|
||||||
|
|
||||||
|
## Namespaces
|
||||||
|
|
||||||
|
- [Presence](namespaces/Presence.md)
|
||||||
|
- [Sern](namespaces/Sern.md)
|
||||||
|
|
||||||
|
## Enumerations
|
||||||
|
|
||||||
|
- [CommandType](enums/CommandType.md)
|
||||||
|
- [EventType](enums/EventType.md)
|
||||||
|
- [PayloadType](enums/PayloadType.md)
|
||||||
|
- [PluginType](enums/PluginType.md)
|
||||||
|
|
||||||
|
## Classes
|
||||||
|
|
||||||
|
- [CommandExecutable](classes/CommandExecutable.md)
|
||||||
|
- [Context](classes/Context.md)
|
||||||
|
- [DefaultErrorHandling](classes/DefaultErrorHandling.md)
|
||||||
|
- [DefaultLogging](classes/DefaultLogging.md)
|
||||||
|
- [DefaultModuleManager](classes/DefaultModuleManager.md)
|
||||||
|
- [EventExecutable](classes/EventExecutable.md)
|
||||||
|
- [ModuleStore](classes/ModuleStore.md)
|
||||||
|
- [SernEmitter](classes/SernEmitter.md)
|
||||||
|
|
||||||
|
## Interfaces
|
||||||
|
|
||||||
|
- [BothCommand](interfaces/BothCommand.md)
|
||||||
|
- [ButtonCommand](interfaces/ButtonCommand.md)
|
||||||
|
- [ChannelSelectCommand](interfaces/ChannelSelectCommand.md)
|
||||||
|
- [CommandModuleDefs](interfaces/CommandModuleDefs.md)
|
||||||
|
- [ContextMenuMsg](interfaces/ContextMenuMsg.md)
|
||||||
|
- [ContextMenuUser](interfaces/ContextMenuUser.md)
|
||||||
|
- [ControlPlugin](interfaces/ControlPlugin.md)
|
||||||
|
- [Controller](interfaces/Controller.md)
|
||||||
|
- [CoreDependencies](interfaces/CoreDependencies.md)
|
||||||
|
- [CoreModuleStore](interfaces/CoreModuleStore.md)
|
||||||
|
- [DiscordEventCommand](interfaces/DiscordEventCommand.md)
|
||||||
|
- [Disposable](interfaces/Disposable.md)
|
||||||
|
- [Emitter](interfaces/Emitter.md)
|
||||||
|
- [ErrorHandling](interfaces/ErrorHandling.md)
|
||||||
|
- [EventModuleDefs](interfaces/EventModuleDefs.md)
|
||||||
|
- [ExternalEventCommand](interfaces/ExternalEventCommand.md)
|
||||||
|
- [Init](interfaces/Init.md)
|
||||||
|
- [InitPlugin](interfaces/InitPlugin.md)
|
||||||
|
- [Logging](interfaces/Logging.md)
|
||||||
|
- [MentionableSelectCommand](interfaces/MentionableSelectCommand.md)
|
||||||
|
- [ModalSubmitCommand](interfaces/ModalSubmitCommand.md)
|
||||||
|
- [ModuleManager](interfaces/ModuleManager.md)
|
||||||
|
- [Plugin](interfaces/Plugin.md)
|
||||||
|
- [RoleSelectCommand](interfaces/RoleSelectCommand.md)
|
||||||
|
- [SernAutocompleteData](interfaces/SernAutocompleteData.md)
|
||||||
|
- [SernEventCommand](interfaces/SernEventCommand.md)
|
||||||
|
- [SernEventsMapping](interfaces/SernEventsMapping.md)
|
||||||
|
- [SernSubCommandData](interfaces/SernSubCommandData.md)
|
||||||
|
- [SernSubCommandGroupData](interfaces/SernSubCommandGroupData.md)
|
||||||
|
- [SlashCommand](interfaces/SlashCommand.md)
|
||||||
|
- [StringSelectCommand](interfaces/StringSelectCommand.md)
|
||||||
|
- [TextCommand](interfaces/TextCommand.md)
|
||||||
|
- [UserSelectCommand](interfaces/UserSelectCommand.md)
|
||||||
|
- [Wrapper](interfaces/Wrapper.md)
|
||||||
|
|
||||||
|
## Type Aliases
|
||||||
|
|
||||||
|
### AnyCommandPlugin
|
||||||
|
|
||||||
|
Ƭ **AnyCommandPlugin**: [`ControlPlugin`](interfaces/ControlPlugin.md) \| [`InitPlugin`](interfaces/InitPlugin.md)<[`InitArgs`<`Processed`<[`CommandModule`](modules.md#commandmodule)\>\>]\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:76](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L76)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### AnyEventPlugin
|
||||||
|
|
||||||
|
Ƭ **AnyEventPlugin**: [`ControlPlugin`](interfaces/ControlPlugin.md) \| [`InitPlugin`](interfaces/InitPlugin.md)<[`InitArgs`<`Processed`<[`EventModule`](modules.md#eventmodule)\>\>]\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:77](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L77)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Args
|
||||||
|
|
||||||
|
Ƭ **Args**: `ParseType`<\{ `slash`: [`SlashOptions`](modules.md#slashoptions) ; `text`: `string`[] }\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/utility.ts:16](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L16)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### CommandModule
|
||||||
|
|
||||||
|
Ƭ **CommandModule**: [`TextCommand`](interfaces/TextCommand.md) \| [`SlashCommand`](interfaces/SlashCommand.md) \| [`BothCommand`](interfaces/BothCommand.md) \| [`ContextMenuUser`](interfaces/ContextMenuUser.md) \| [`ContextMenuMsg`](interfaces/ContextMenuMsg.md) \| [`ButtonCommand`](interfaces/ButtonCommand.md) \| [`StringSelectCommand`](interfaces/StringSelectCommand.md) \| [`MentionableSelectCommand`](interfaces/MentionableSelectCommand.md) \| [`UserSelectCommand`](interfaces/UserSelectCommand.md) \| [`ChannelSelectCommand`](interfaces/ChannelSelectCommand.md) \| [`RoleSelectCommand`](interfaces/RoleSelectCommand.md) \| [`ModalSubmitCommand`](interfaces/ModalSubmitCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:133](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L133)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### EventModule
|
||||||
|
|
||||||
|
Ƭ **EventModule**: [`DiscordEventCommand`](interfaces/DiscordEventCommand.md) \| [`SernEventCommand`](interfaces/SernEventCommand.md) \| [`ExternalEventCommand`](interfaces/ExternalEventCommand.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:132](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L132)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Initializable
|
||||||
|
|
||||||
|
Ƭ **Initializable**<`T`\>: `T`
|
||||||
|
|
||||||
|
Type to annotate that something is initializable.
|
||||||
|
If T has an init method, this will be called.
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends [`Init`](interfaces/Init.md) |
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:17](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L17)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### LogPayload
|
||||||
|
|
||||||
|
Ƭ **LogPayload**<`T`\>: `Object`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | `unknown` |
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `message` | `T` |
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/contracts/logging.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/contracts/logging.ts#L11)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Payload
|
||||||
|
|
||||||
|
Ƭ **Payload**: \{ `module`: `AnyModule` ; `type`: [`Success`](enums/PayloadType.md#success) } \| \{ `module?`: `AnyModule` ; `reason`: `string` \| `Error` ; `type`: [`Failure`](enums/PayloadType.md#failure) } \| \{ `reason`: `string` ; `type`: [`Warning`](enums/PayloadType.md#warning) }
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/utility.ts:26](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L26)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### PluginResult
|
||||||
|
|
||||||
|
Ƭ **PluginResult**: `Awaitable`<`VoidResult`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-plugin.ts:51](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-plugin.ts#L51)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### SernOptionsData
|
||||||
|
|
||||||
|
Ƭ **SernOptionsData**: [`SernSubCommandData`](interfaces/SernSubCommandData.md) \| [`SernSubCommandGroupData`](interfaces/SernSubCommandGroupData.md) \| `APIApplicationCommandBasicOption` \| [`SernAutocompleteData`](interfaces/SernAutocompleteData.md)
|
||||||
|
|
||||||
|
Type that replaces autocomplete with [SernAutocompleteData](interfaces/SernAutocompleteData.md)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/core-modules.ts:201](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/core-modules.ts#L201)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Singleton
|
||||||
|
|
||||||
|
Ƭ **Singleton**<`T`\>: () => `T`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name |
|
||||||
|
| :------ |
|
||||||
|
| `T` |
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): `T`
|
||||||
|
|
||||||
|
Type to annotate that something is a singleton.
|
||||||
|
T is created once and lazily.
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:7](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/ioc.ts#L7)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### SlashOptions
|
||||||
|
|
||||||
|
Ƭ **SlashOptions**: `Omit`<`CommandInteractionOptionResolver`, ``"getMessage"`` \| ``"getFocused"``\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/utility.ts:14](https://github.com/sern-handler/handler/blob/9d5c6c7/src/types/utility.ts#L14)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Transient
|
||||||
|
|
||||||
|
Ƭ **Transient**<`T`\>: () => () => `T`
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name |
|
||||||
|
| :------ |
|
||||||
|
| `T` |
|
||||||
|
|
||||||
|
#### Type declaration
|
||||||
|
|
||||||
|
▸ (): () => `T`
|
||||||
|
|
||||||
|
Type to annotate that something is transient.
|
||||||
|
Every time this is called, a new object is created
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`fn`
|
||||||
|
|
||||||
|
▸ (): `T`
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/types/ioc.ts:12](https://github.com/sern-handler/handler/blob/9d5c6c7/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
|
||||||
|
|
||||||
|
### CommandControlPlugin
|
||||||
|
|
||||||
|
▸ **CommandControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `I` | extends [`CommandType`](enums/CommandType.md) |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `execute` | (...`args`: `CommandArgs`<`I`, [`Control`](enums/PluginType.md#control)\>) => [`PluginResult`](modules.md#pluginresult) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/create-plugins.ts:37](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L37)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### CommandInitPlugin
|
||||||
|
|
||||||
|
▸ **CommandInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `I` | extends [`CommandType`](enums/CommandType.md) |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `execute` | (...`args`: `CommandArgs`<`I`, [`Init`](enums/PluginType.md#init)\>) => [`PluginResult`](modules.md#pluginresult) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/create-plugins.ts:28](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L28)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### DiscordEventControlPlugin
|
||||||
|
|
||||||
|
▸ **DiscordEventControlPlugin**<`T`\>(`name`, `execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends keyof `ClientEvents` |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `name` | `T` |
|
||||||
|
| `execute` | (...`args`: `ClientEvents`[`T`]) => [`PluginResult`](modules.md#pluginresult) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`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
|
||||||
|
|
||||||
|
[src/core/create-plugins.ts:58](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L58)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### EventControlPlugin
|
||||||
|
|
||||||
|
▸ **EventControlPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `I` | extends [`EventType`](enums/EventType.md) |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `execute` | (...`args`: `EventArgs`<`I`, [`Control`](enums/PluginType.md#control)\>) => [`PluginResult`](modules.md#pluginresult) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/create-plugins.ts:46](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L46)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### EventInitPlugin
|
||||||
|
|
||||||
|
▸ **EventInitPlugin**<`I`\>(`execute`): [`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `I` | extends [`EventType`](enums/EventType.md) |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `execute` | (...`args`: `EventArgs`<`I`, [`Init`](enums/PluginType.md#init)\>) => [`PluginResult`](modules.md#pluginresult) |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Plugin`](interfaces/Plugin.md)<`unknown`[]\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.5.0
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/create-plugins.ts:19](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L19)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Service
|
||||||
|
|
||||||
|
▸ **Service**<`T`\>(`key`): `NonNullable`<`UnpackFunction`<`Partial`<`Dependencies`\>[`T`]\>\>
|
||||||
|
|
||||||
|
The new Service api, a cleaner alternative to useContainer
|
||||||
|
To obtain intellisense, ensure a .d.ts file exists in the root of compilation.
|
||||||
|
Usually our scaffolding tool takes care of this.
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends keyof `Dependencies` |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| :------ | :------ | :------ |
|
||||||
|
| `key` | `T` | a key that corresponds to a dependency registered. |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`NonNullable`<`UnpackFunction`<`Partial`<`Dependencies`\>[`T`]\>\>
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
3.0.0
|
||||||
|
|
||||||
|
**`Example`**
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const client = Service('@sern/client');
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/ioc/dependency-injection.ts:36](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/dependency-injection.ts#L36)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Services
|
||||||
|
|
||||||
|
▸ **Services**<`T`\>(`...keys`): `IntoDependencies`<`T`\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends keyof `Dependencies`[] |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `...keys` | [...T[]] |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`IntoDependencies`<`T`\>
|
||||||
|
|
||||||
|
array of dependencies, in the same order of keys provided
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
3.0.0
|
||||||
|
The plural version of [Service](modules.md#service)
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/ioc/dependency-injection.ts:44](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/dependency-injection.ts#L44)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### commandModule
|
||||||
|
|
||||||
|
▸ **commandModule**(`mod`): [`CommandModule`](modules.md#commandmodule)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `mod` | `InputCommand` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`CommandModule`](modules.md#commandmodule)
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
1.0.0 The wrapper function to define command modules for sern
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:25](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L25)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### discordEvent
|
||||||
|
|
||||||
|
▸ **discordEvent**<`T`\>(`mod`): [`EventModule`](modules.md#eventmodule)
|
||||||
|
|
||||||
|
Create event modules from discord.js client events,
|
||||||
|
This is an [eventModule](modules.md#eventmodule-1) for discord events,
|
||||||
|
where typings can be very bad.
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends keyof `ClientEvents` |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `mod` | `Object` |
|
||||||
|
| `mod.execute` | (...`args`: `ClientEvents`[`T`]) => `unknown` |
|
||||||
|
| `mod.name` | `T` |
|
||||||
|
| `mod.plugins?` | [`AnyEventPlugin`](modules.md#anyeventplugin)[] |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`EventModule`](modules.md#eventmodule)
|
||||||
|
|
||||||
|
**`Experimental`**
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:53](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L53)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### eventModule
|
||||||
|
|
||||||
|
▸ **eventModule**(`mod`): [`EventModule`](modules.md#eventmodule)
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `mod` | `InputEvent` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`EventModule`](modules.md#eventmodule)
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
1.0.0
|
||||||
|
The wrapper function to define event modules for sern
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/modules.ts:38](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/modules.ts#L38)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### makeDependencies
|
||||||
|
|
||||||
|
▸ **makeDependencies**<`T`\>(`conf`): `Promise`<<V\>(...`keys`: [...V[]]) => `IntoDependencies`<`V`\>\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `T` | extends `Dependencies` |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `conf` | `ValidDependencyConfig` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`Promise`<<V\>(...`keys`: [...V[]]) => `IntoDependencies`<`V`\>\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/ioc/base.ts:90](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/base.ts#L90)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### makePlugin
|
||||||
|
|
||||||
|
▸ **makePlugin**<`V`\>(`type`, `execute`): [`Plugin`](interfaces/Plugin.md)<`V`\>
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `V` | extends `unknown`[] |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `type` | [`PluginType`](enums/PluginType.md) |
|
||||||
|
| `execute` | (...`args`: `any`[]) => `any` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[`Plugin`](interfaces/Plugin.md)<`V`\>
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/create-plugins.ts:6](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/create-plugins.ts#L6)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### single
|
||||||
|
|
||||||
|
▸ **single**<`T`\>(`cb`): () => `T`
|
||||||
|
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name |
|
||||||
|
| :------ |
|
||||||
|
| `T` |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `cb` | () => `T` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`fn`
|
||||||
|
|
||||||
|
▸ (): `T`
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0.
|
||||||
|
Creates a singleton object.
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/ioc/dependency-injection.ts:11](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/dependency-injection.ts#L11)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### transient
|
||||||
|
|
||||||
|
▸ **transient**<`T`\>(`cb`): () => () => `T`
|
||||||
|
|
||||||
|
@__PURE__
|
||||||
|
|
||||||
|
#### Type parameters
|
||||||
|
|
||||||
|
| Name |
|
||||||
|
| :------ |
|
||||||
|
| `T` |
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type |
|
||||||
|
| :------ | :------ |
|
||||||
|
| `cb` | () => () => `T` |
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`fn`
|
||||||
|
|
||||||
|
▸ (): () => `T`
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`fn`
|
||||||
|
|
||||||
|
▸ (): `T`
|
||||||
|
|
||||||
|
##### Returns
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
**`Since`**
|
||||||
|
|
||||||
|
2.0.0
|
||||||
|
Creates a transient object
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/ioc/dependency-injection.ts:21](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/dependency-injection.ts#L21)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### useContainerRaw
|
||||||
|
|
||||||
|
▸ **useContainerRaw**(): `CoreContainer`<`Partial`<`Dependencies`\>\>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
`CoreContainer`<`Partial`<`Dependencies`\>\>
|
||||||
|
|
||||||
|
**`Deprecated`**
|
||||||
|
|
||||||
|
Returns the underlying data structure holding all dependencies.
|
||||||
|
Exposes methods from iti
|
||||||
|
Use the Service API. The container should be readonly
|
||||||
|
|
||||||
|
#### Defined in
|
||||||
|
|
||||||
|
[src/core/ioc/base.ts:18](https://github.com/sern-handler/handler/blob/9d5c6c7/src/core/ioc/base.ts#L18)
|
||||||
31
docs/api/namespaces/CommandError.md
Normal file
31
docs/api/namespaces/CommandError.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
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)
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user