diff --git a/404.html b/404.html index 14d564e68..d51b25f6b 100644 --- a/404.html +++ b/404.html @@ -5,14 +5,14 @@ -Page Not Found | sern - Handlers. Redefined. - - +Page Not Found | sern - Handlers. Redefined. + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- - + + \ No newline at end of file diff --git a/assets/js/0a33f845.3374e611.js b/assets/js/0a33f845.3374e611.js new file mode 100644 index 000000000..3e503aca4 --- /dev/null +++ b/assets/js/0a33f845.3374e611.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[8494],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>u});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),d=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),c=d(n),u=r,k=c["".concat(o,".").concat(u)]||c[u]||s[u]||i;return n?a.createElement(k,l(l({ref:t},m),{},{components:n})):a.createElement(k,l({ref:t},m))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=c;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"Module",title:"Interface: Module",sidebar_label:"Module",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/Module",id:"api/interfaces/Module",title:"Interface: Module",description:"Hierarchy",source:"@site/docs/api/interfaces/Module.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Module",permalink:"/docs/api/interfaces/Module",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Module",title:"Interface: Module",sidebar_label:"Module",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ModalSubmitCommand",permalink:"/docs/api/interfaces/ModalSubmitCommand"},next:{title:"ModuleManager",permalink:"/docs/api/interfaces/ModuleManager"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:d};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Module"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/TextCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"TextCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SlashCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"SlashCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/BothCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"BothCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ContextMenuUser"},(0,r.kt)("inlineCode",{parentName:"a"},"ContextMenuUser"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ContextMenuMsg"},(0,r.kt)("inlineCode",{parentName:"a"},"ContextMenuMsg"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ButtonCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/StringSelectCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"StringSelectCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ChannelSelectCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"ChannelSelectCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/RoleSelectCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"RoleSelectCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/MentionableSelectCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"MentionableSelectCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/UserSelectCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"UserSelectCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ModalSubmitCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"ModalSubmitCommand"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/AutocompleteCommand"},(0,r.kt)("inlineCode",{parentName:"a"},"AutocompleteCommand"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (...",(0,r.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (...",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L39"},"src/types/module.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandType"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/EventType"},(0,r.kt)("inlineCode",{parentName:"a"},"EventType"))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L36"},"src/types/module.ts:36")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.4425eaf5.js b/assets/js/0e384e19.ee46d918.js similarity index 98% rename from assets/js/0e384e19.4425eaf5.js rename to assets/js/0e384e19.ee46d918.js index c73d0820d..3b8e834e8 100644 --- a/assets/js/0e384e19.4425eaf5.js +++ b/assets/js/0e384e19.ee46d918.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9671],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=p(r),m=o,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||i;return r?n.createElement(f,a(a({ref:t},l),{},{components:r})):n.createElement(f,a({ref:t},l))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=d;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c.mdxType="string"==typeof e?e:o,a[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>p});var n=r(7462),o=(r(7294),r(3905));const i={sidebar_position:0},a="Welcome!",c={unversionedId:"intro",id:"intro",title:"Welcome!",description:"Content",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/intro",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/intro.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Wrapper",permalink:"/docs/api/interfaces/Wrapper"},next:{title:"Introduction",permalink:"/docs/guide/"}},s={},p=[{value:"Content",id:"content",level:2}],l={toc:p};function u(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"welcome"},"Welcome!"),(0,o.kt)("h2",{id:"content"},"Content"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"../docs/api"},"/docs/api")," contains autogenerated documentation of our codebase using ",(0,o.kt)("a",{parentName:"li",href:"https://typedoc.org/"},"typedoc")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"../docs/guide"},"/docs/guide")," contains a basic startup guide and details to get started with sern faster!")),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"This site is open source! Please do contribute if you find any bugs, typos, or sections in need of improvements.")),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"If you have problems, join the discord server ",(0,o.kt)("a",{parentName:"p",href:"https://sern-handler.js.org/discord"},"here"))))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9671],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=p(r),m=o,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||i;return r?n.createElement(f,a(a({ref:t},l),{},{components:r})):n.createElement(f,a({ref:t},l))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=d;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c.mdxType="string"==typeof e?e:o,a[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>p});var n=r(7462),o=(r(7294),r(3905));const i={sidebar_position:0},a="Welcome!",c={unversionedId:"intro",id:"intro",title:"Welcome!",description:"Content",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/intro",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/intro.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Wrapper",permalink:"/docs/api/interfaces/Wrapper"},next:{title:"Introduction",permalink:"/docs/guide/"}},s={},p=[{value:"Content",id:"content",level:2}],l={toc:p};function u(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"welcome"},"Welcome!"),(0,o.kt)("h2",{id:"content"},"Content"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"../docs/api"},"/docs/api")," contains autogenerated documentation of our codebase using ",(0,o.kt)("a",{parentName:"li",href:"https://typedoc.org/"},"typedoc")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"../docs/guide"},"/docs/guide")," contains a basic startup guide and details to get started with sern faster!")),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"This site is open source! Please do contribute if you find any bugs, typos, or sections in need of improvements.")),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"If you have problems, join the discord server ",(0,o.kt)("a",{parentName:"p",href:"https://sern.dev/discord"},"here"))))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1ac1bfe9.0d668acf.js b/assets/js/1ac1bfe9.5410b5f0.js similarity index 54% rename from assets/js/1ac1bfe9.0d668acf.js rename to assets/js/1ac1bfe9.5410b5f0.js index 5b64c041b..b10b41afa 100644 --- a/assets/js/1ac1bfe9.0d668acf.js +++ b/assets/js/1ac1bfe9.5410b5f0.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[2005],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>m});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},u=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=p(t),m=o,g=d["".concat(s,".").concat(m)]||d[m]||c[m]||a;return t?r.createElement(g,l(l({ref:n},u),{},{components:t})):r.createElement(g,l({ref:n},u))}));function m(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,l=new Array(a);l[0]=d;var i={};for(var s in n)hasOwnProperty.call(n,s)&&(i[s]=n[s]);i.originalType=e,i.mdxType="string"==typeof e?e:o,l[1]=i;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var r=t(7462),o=(t(7294),t(3905));const a={sidebar_position:5},l="Plugins",i={unversionedId:"guide/walkthrough/plugins",id:"guide/walkthrough/plugins",title:"Plugins",description:"As of now, modules seem a little underwhelming. It appears that sern doesn't have all the features of a standard handler,",source:"@site/docs/guide/walkthrough/plugins.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/plugins",permalink:"/docs/guide/walkthrough/plugins",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/plugins.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"First Event Module",permalink:"/docs/guide/walkthrough/first-event"},next:{title:"The SernEmitter class",permalink:"/docs/guide/walkthrough/sern-emitter"}},s={},p=[{value:"Command Plugins",id:"command-plugins",level:2},{value:"The controller object",id:"the-controller-object",level:3},{value:"Event Plugins",id:"event-plugins",level:2}],u={toc:p};function c(e){let{components:n,...a}=e;return(0,o.kt)("wrapper",(0,r.Z)({},u,a,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"plugins"},"Plugins"),(0,o.kt)("p",null,"As of now, modules seem a little underwhelming. It appears that sern doesn't have all the features of a standard handler, which manages permissions, categorizes, cool-downs, publishes application commands, role permissions, etc."),(0,o.kt)("p",null,"Many important parts that manage access and help streamline command creation to make are apparently absent. Below is an example of an event plugin, one of the types of plugins."),(0,o.kt)("p",null,"Typescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},'export function serenOnly(): EventPlugin {\n return {\n type: PluginType.Event,\n async execute([ctx, args], controller) {\n if (ctx.user.id !== "182326315813306368") {\n await ctx.reply({content: "You cannot use this command"})\n return controller.stop()\n }\n return controller.next();\n }\n }\n}\n')),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},'export function serenOnly() {\n return {\n type: PluginType.Event,\n async execute([ctx, args], controller) {\n if (ctx.user.id !== "182326315813306368") {\n await ctx.reply({content: "You cannot use this command"})\n return controller.stop()\n }\n return controller.next();\n }\n }\n}\n')),(0,o.kt)("br",null)," As part of our extensibility, the plugins feature make sern just as powerful, if not more powerful than standard handlers. Plugins modify and add new behavior to standard modules, extending customizability and implementing automation.",(0,o.kt)("br",null)," At the moment, there are two types of plugins:",(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Command Plugins"),(0,o.kt)("li",{parentName:"ul"},"Event Plugins")),(0,o.kt)("h2",{id:"command-plugins"},"Command Plugins"),(0,o.kt)("p",null,"All modules are registered into sern's system. With command plugins, you can modify how commands are loaded,\nor do some kind of preprocessing before they are loaded into sern."),(0,o.kt)("h3",{id:"the-controller-object"},"The controller object"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export interface Controller {\n next: () => Ok;\n stop: () => Err;\n}\n")),(0,o.kt)("p",null,"An instance of the above object is passed into every plugin. ",(0,o.kt)("br",null),"\nThis controls whether a module is stored into sern. ",(0,o.kt)("br",null),"\nTypescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export function inDir(dir : string) : CommandPlugin {\n return {\n type: PluginType.Command,\n async execute(wrapper, { absPath, module }, controller) {\n if(path.dirname(absPath) !== dir) {\n console.log(+new Date(), `${module.name} is not in the correct directory!`);\n return controller.stop()\n }\n console.log(+new Date(), `${module.name} is in the correct directory!`);\n return controller.next(); //continue\n }\n }\n}\n")),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"export function inDir(dir : string) {\n return {\n type: PluginType.Command,\n async execute(wrapper, { absPath, module }, controller) {\n if(path.dirname(absPath) !== dir) {\n console.log(+new Date(), `${module.name} is not in the correct directory!`);\n return controller.stop()\n }\n console.log(+new Date(), `${module.name} is in the correct directory!`);\n return controller.next(); //continue\n }\n }\n}\n")),(0,o.kt)("p",null,"Above, this simple plugin logs that the module has been loaded along with a timestamp. ",(0,o.kt)("br",null),"\nAgain, it is up to ",(0,o.kt)("strong",{parentName:"p"},"you")," to define plugin logic! The possibilities to customize your bots are endless."),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"Command Plugins are good for ensuring the shape, location, and preprocessing of your commands.")),(0,o.kt)("h2",{id:"event-plugins"},"Event Plugins"),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"event-plugins",src:t(6061).Z,width:"542",height:"377"})," ",(0,o.kt)("br",null)),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"An event is emitted by discord.js."),(0,o.kt)("li",{parentName:"ul"},"This event is passed to all plugins (",(0,o.kt)("strong",{parentName:"li"},"in order!!"),"),"),(0,o.kt)("li",{parentName:"ul"},"If all are successful,")),(0,o.kt)("p",null,"The command is executed. Calling ",(0,o.kt)("inlineCode",{parentName:"p"},"controller.stop()")," notifies sern that this command should not be run,\nand this event is ignored."),(0,o.kt)("p",null,"So, what does a command module look like with plugins?"),(0,o.kt)("p",null,"Typescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"import { commandModule, CommandType } from '@sern/handler';\n\nexport default commandModule({\n type: CommandType.Both,\n plugins: [\n inDir(\"other\"), \n serenOnly()\n ],\n description: 'A ping command',\n //alias : [],\n execute: async (ctx, args) => {\n await ctx.reply({ content: 'Pong \ud83c\udfd3' });\n },\n});\n")),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"const { commandModule, CommandType } = require('@sern/handler');\n\nexports.default = commandModule({\n type: CommandType.Both,\n plugins: [\n inDir(\"other\"), \n serenOnly() //The plugins in this section applied to this module!\n ],\n description: 'A ping command',\n //alias : [],\n execute: async (ctx, args) => {\n await ctx.reply({ content: 'Pong \ud83c\udfd3' });\n },\n});\n")),(0,o.kt)("p",null,"Can you predict the behavior of this command?"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Before loading into sern, this command module will check if this module is in the correct directory ",(0,o.kt)("inlineCode",{parentName:"li"},"other"),"."),(0,o.kt)("li",{parentName:"ul"},"Before an event occurs, this command module will check if the user has the id ",(0,o.kt)("inlineCode",{parentName:"li"},"182326315813306368"),".")),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"Event Plugins are good for filtering, preconditions, parsing.")),(0,o.kt)("p",null,"If all plugins return ",(0,o.kt)("inlineCode",{parentName:"p"},"controller.next()"),", this command replies ",(0,o.kt)("inlineCode",{parentName:"p"},"Pong \ud83c\udfd3")))}c.isMDXComponent=!0},6061:(e,n,t)=>{t.d(n,{Z:()=>r});const r=t.p+"assets/images/eventplugins.drawio-f22ee78041e60a62a45024f542a2b104.svg"}}]); \ No newline at end of file +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[2005],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>m});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},u=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=p(t),m=o,g=d["".concat(s,".").concat(m)]||d[m]||c[m]||a;return t?r.createElement(g,l(l({ref:n},u),{},{components:t})):r.createElement(g,l({ref:n},u))}));function m(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,l=new Array(a);l[0]=d;var i={};for(var s in n)hasOwnProperty.call(n,s)&&(i[s]=n[s]);i.originalType=e,i.mdxType="string"==typeof e?e:o,l[1]=i;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var r=t(7462),o=(t(7294),t(3905));const a={sidebar_position:5},l="Plugins",i={unversionedId:"guide/walkthrough/plugins",id:"guide/walkthrough/plugins",title:"Plugins",description:"As of now, modules seem a little underwhelming. It appears that sern doesn't have all the features of a standard handler,",source:"@site/docs/guide/walkthrough/plugins.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/plugins",permalink:"/docs/guide/walkthrough/plugins",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/plugins.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"First Event Module",permalink:"/docs/guide/walkthrough/first-event"},next:{title:"The SernEmitter class",permalink:"/docs/guide/walkthrough/sern-emitter"}},s={},p=[{value:"Command Plugins",id:"command-plugins",level:2},{value:"The controller object",id:"the-controller-object",level:3},{value:"Event Plugins",id:"event-plugins",level:2}],u={toc:p};function c(e){let{components:n,...a}=e;return(0,o.kt)("wrapper",(0,r.Z)({},u,a,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"plugins"},"Plugins"),(0,o.kt)("p",null,"As of now, modules seem a little underwhelming. It appears that sern doesn't have all the features of a standard handler, which manages permissions, categorizes, cool-downs, publishes application commands, role permissions, etc."),(0,o.kt)("p",null,"Many important parts that manage access and help streamline command creation to make are apparently absent. Below is an example of an event plugin, one of the types of plugins."),(0,o.kt)("p",null,"Typescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},'export function serenOnly(): EventPlugin {\n return {\n type: PluginType.Event,\n async execute([ctx, args], controller) {\n if (ctx.user.id !== "182326315813306368") {\n await ctx.reply({content: "You cannot use this command"})\n return controller.stop()\n }\n return controller.next();\n }\n }\n}\n')),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},'export function serenOnly() {\n return {\n type: PluginType.Event,\n async execute([ctx, args], controller) {\n if (ctx.user.id !== "182326315813306368") {\n await ctx.reply({content: "You cannot use this command"})\n return controller.stop()\n }\n return controller.next();\n }\n }\n}\n')),(0,o.kt)("br",null)," As part of our extensibility, the plugins feature make sern just as powerful, if not more powerful than standard handlers. Plugins modify and add new behavior to standard modules, extending customizability and implementing automation.",(0,o.kt)("br",null)," At the moment, there are two types of plugins:",(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Command Plugins"),(0,o.kt)("li",{parentName:"ul"},"Event Plugins")),(0,o.kt)("h2",{id:"command-plugins"},"Command Plugins"),(0,o.kt)("p",null,"All modules are registered into sern's system. With command plugins, you can modify how commands are loaded,\nor do some kind of preprocessing before they are loaded."),(0,o.kt)("h3",{id:"the-controller-object"},"The controller object"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export interface Controller {\n next: () => Ok;\n stop: () => Err;\n}\n")),(0,o.kt)("p",null,"An instance of the above object is passed into every plugin. ",(0,o.kt)("br",null),"\nThis controls whether a module is stored into sern. ",(0,o.kt)("br",null),"\nTypescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export function inDir(dir : string) : CommandPlugin {\n return {\n type: PluginType.Command,\n async execute(wrapper, { absPath, module }, controller) {\n if(path.dirname(absPath) !== dir) {\n console.log(+new Date(), `${module.name} is not in the correct directory!`);\n return controller.stop()\n }\n console.log(+new Date(), `${module.name} is in the correct directory!`);\n return controller.next(); //continue\n }\n }\n}\n")),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"export function inDir(dir : string) {\n return {\n type: PluginType.Command,\n async execute(wrapper, { absPath, module }, controller) {\n if(path.dirname(absPath) !== dir) {\n console.log(+new Date(), `${module.name} is not in the correct directory!`);\n return controller.stop()\n }\n console.log(+new Date(), `${module.name} is in the correct directory!`);\n return controller.next(); //continue\n }\n }\n}\n")),(0,o.kt)("p",null,"Above, this simple plugin logs that the module has been loaded along with a timestamp. ",(0,o.kt)("br",null),"\nAgain, it is up to ",(0,o.kt)("strong",{parentName:"p"},"you")," to define plugin logic! The possibilities to customize your bots are endless."),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"Command Plugins are good for ensuring the shape, location, and preprocessing of your commands.")),(0,o.kt)("h2",{id:"event-plugins"},"Event Plugins"),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"event-plugins",src:t(6061).Z,width:"542",height:"377"})," ",(0,o.kt)("br",null)),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"An event is emitted by discord.js."),(0,o.kt)("li",{parentName:"ul"},"This event is passed to all plugins (",(0,o.kt)("strong",{parentName:"li"},"in order!!"),"),"),(0,o.kt)("li",{parentName:"ul"},"If all are successful,")),(0,o.kt)("p",null,"The command is executed. Calling ",(0,o.kt)("inlineCode",{parentName:"p"},"controller.stop()")," notifies sern that this command should not be run,\nand this event is ignored."),(0,o.kt)("p",null,"So, what does a command module look like with plugins?"),(0,o.kt)("p",null,"Typescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"import { commandModule, CommandType } from '@sern/handler';\n\nexport default commandModule({\n type: CommandType.Both,\n plugins: [\n inDir(\"other\"), \n serenOnly()\n ],\n description: 'A ping command',\n //alias : [],\n execute: async (ctx, args) => {\n await ctx.reply({ content: 'Pong \ud83c\udfd3' });\n },\n});\n")),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"const { commandModule, CommandType } = require('@sern/handler');\n\nexports.default = commandModule({\n type: CommandType.Both,\n plugins: [\n inDir(\"other\"), \n serenOnly() //The plugins in this section applied to this module!\n ],\n description: 'A ping command',\n //alias : [],\n execute: async (ctx, args) => {\n await ctx.reply({ content: 'Pong \ud83c\udfd3' });\n },\n});\n")),(0,o.kt)("p",null,"Can you predict the behavior of this command?"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Before loading into sern, this command module will check if this module is in the correct directory ",(0,o.kt)("inlineCode",{parentName:"li"},"other"),"."),(0,o.kt)("li",{parentName:"ul"},"Before an event occurs, this command module will check if the user has the id ",(0,o.kt)("inlineCode",{parentName:"li"},"182326315813306368"),".")),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"Event Plugins are good for filtering, preconditions, parsing.")),(0,o.kt)("p",null,"If all plugins return ",(0,o.kt)("inlineCode",{parentName:"p"},"controller.next()"),", this command replies ",(0,o.kt)("inlineCode",{parentName:"p"},"Pong \ud83c\udfd3")))}c.isMDXComponent=!0},6061:(e,n,t)=>{t.d(n,{Z:()=>r});const r=t.p+"assets/images/eventplugins.drawio-f22ee78041e60a62a45024f542a2b104.svg"}}]); \ No newline at end of file diff --git a/assets/js/1aef51bd.6b77f2f4.js b/assets/js/1aef51bd.c68b21db.js similarity index 95% rename from assets/js/1aef51bd.6b77f2f4.js rename to assets/js/1aef51bd.c68b21db.js index 2412920c2..a8a7d35fa 100644 --- a/assets/js/1aef51bd.6b77f2f4.js +++ b/assets/js/1aef51bd.c68b21db.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4137],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var u=n.createContext({}),s=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},l=function(e){var t=s(e.components);return n.createElement(u.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,u=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=s(r),f=o,h=d["".concat(u,".").concat(f)]||d[f]||p[f]||i;return r?n.createElement(h,a(a({ref:t},l),{},{components:r})):n.createElement(h,a({ref:t},l))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=d;var c={};for(var u in t)hasOwnProperty.call(t,u)&&(c[u]=t[u]);c.originalType=e,c.mdxType="string"==typeof e?e:o,a[1]=c;for(var s=2;s{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>s});var n=r(7462),o=(r(7294),r(3905));const i={sidebar_position:8},a="Conclusion",c={unversionedId:"guide/walkthrough/conclusion",id:"guide/walkthrough/conclusion",title:"Conclusion",description:"If you reached this far, thank you for reading! We hope you have learned the necessities you need",source:"@site/docs/guide/walkthrough/conclusion.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/conclusion",permalink:"/docs/guide/walkthrough/conclusion",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/conclusion.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8},sidebar:"tutorialSidebar",previous:{title:"Good to know",permalink:"/docs/guide/walkthrough/good-to-know"}},u={},s=[],l={toc:s};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"conclusion"},"Conclusion"),(0,o.kt)("p",null,"If you reached this far, thank you for reading! We hope you have learned the necessities you need\nto create a bot with the sern framework. If you have any other questions, bugs, feature requests, concerns, please join our\n",(0,o.kt)("a",{parentName:"p",href:"https://discord.gg/QgnfxWzrcj"},"community server"),", and we'll be glad to answer your questions."))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4137],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var u=n.createContext({}),s=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},l=function(e){var t=s(e.components);return n.createElement(u.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,u=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=s(r),f=o,h=d["".concat(u,".").concat(f)]||d[f]||p[f]||i;return r?n.createElement(h,a(a({ref:t},l),{},{components:r})):n.createElement(h,a({ref:t},l))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=d;var c={};for(var u in t)hasOwnProperty.call(t,u)&&(c[u]=t[u]);c.originalType=e,c.mdxType="string"==typeof e?e:o,a[1]=c;for(var s=2;s{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>s});var n=r(7462),o=(r(7294),r(3905));const i={sidebar_position:8},a="Conclusion",c={unversionedId:"guide/walkthrough/conclusion",id:"guide/walkthrough/conclusion",title:"Conclusion",description:"If you reached this far, thank you for reading! We hope you have learned the necessities you need",source:"@site/docs/guide/walkthrough/conclusion.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/conclusion",permalink:"/docs/guide/walkthrough/conclusion",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/conclusion.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8},sidebar:"tutorialSidebar",previous:{title:"Good to know",permalink:"/docs/guide/walkthrough/good-to-know"}},u={},s=[],l={toc:s};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"conclusion"},"Conclusion"),(0,o.kt)("p",null,"If you reached this far, thank you for reading! We hope you have learned the necessities you need\nto create a bot with the sern framework. If you have any other questions, bugs, feature requests, concerns, please join our\n",(0,o.kt)("a",{parentName:"p",href:"https://sern.dev/discord"},"community server"),", and we'll be glad to answer your questions."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1b0c702f.0c1f4bbe.js b/assets/js/1b0c702f.0c1f4bbe.js new file mode 100644 index 000000000..279bdf23f --- /dev/null +++ b/assets/js/1b0c702f.0c1f4bbe.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[8032],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>g});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=p(n),g=r,c=u["".concat(d,".").concat(g)]||u[g]||m[g]||l;return n?a.createElement(c,i(i({ref:t},s),{},{components:n})):a.createElement(c,i({ref:t},s))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:r,i[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const l={id:"DefaultLogging",title:"Class: DefaultLogging",sidebar_label:"DefaultLogging",sidebar_position:0,custom_edit_url:null},i=void 0,o={unversionedId:"api/classes/DefaultLogging",id:"api/classes/DefaultLogging",title:"Class: DefaultLogging",description:"Implements",source:"@site/docs/api/classes/DefaultLogging.md",sourceDirName:"api/classes",slug:"/api/classes/DefaultLogging",permalink:"/docs/api/classes/DefaultLogging",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"DefaultLogging",title:"Class: DefaultLogging",sidebar_label:"DefaultLogging",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"DefaultErrorHandling",permalink:"/docs/api/classes/DefaultErrorHandling"},next:{title:"DefaultModuleManager",permalink:"/docs/api/classes/DefaultModuleManager"}},d={},p=[{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Methods",id:"methods",level:2},{value:"date",id:"date",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"debug",id:"debug",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"error",id:"error",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"warning",id:"warning",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:p};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Logging"},(0,r.kt)("inlineCode",{parentName:"a"},"Logging")))),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new DefaultLogging"),"()"),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"date"},"date"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,r.kt)("strong",{parentName:"p"},"date"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Date")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L11"},"src/handler/contracts/logging.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"debug"},"debug"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"debug"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#logpayload"},(0,r.kt)("inlineCode",{parentName:"a"},"LogPayload")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),">")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging"},"Logging"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging#debug"},"debug")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L12"},"src/handler/contracts/logging.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"error"},"error"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"error"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#logpayload"},(0,r.kt)("inlineCode",{parentName:"a"},"LogPayload")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),">")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging"},"Logging"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging#error"},"error")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L16"},"src/handler/contracts/logging.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"info"},"info"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"info"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#logpayload"},(0,r.kt)("inlineCode",{parentName:"a"},"LogPayload")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),">")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging"},"Logging"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging#info"},"info")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L20"},"src/handler/contracts/logging.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"warning"},"warning"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"warning"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#logpayload"},(0,r.kt)("inlineCode",{parentName:"a"},"LogPayload")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),">")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging"},"Logging"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging#warning"},"warning")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L24"},"src/handler/contracts/logging.ts:24")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1c127a4d.46df4335.js b/assets/js/1c127a4d.46df4335.js new file mode 100644 index 000000000..9ced21774 --- /dev/null +++ b/assets/js/1c127a4d.46df4335.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[2129],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=p(r),m=a,f=u["".concat(d,".").concat(m)]||u[m]||c[m]||i;return r?n.createElement(f,l(l({ref:t},s),{},{components:r})):n.createElement(f,l({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"ErrorHandling",title:"Interface: ErrorHandling",sidebar_label:"ErrorHandling",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/interfaces/ErrorHandling",id:"api/interfaces/ErrorHandling",title:"Interface: ErrorHandling",description:"Implemented by",source:"@site/docs/api/interfaces/ErrorHandling.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ErrorHandling",permalink:"/docs/api/interfaces/ErrorHandling",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ErrorHandling",title:"Interface: ErrorHandling",sidebar_label:"ErrorHandling",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"DiscordEventPlugin",permalink:"/docs/api/interfaces/DiscordEventPlugin"},next:{title:"EventPlugin",permalink:"/docs/api/interfaces/EventPlugin"}},d={},p=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Properties",id:"properties",level:2},{value:"keepAlive",id:"keepalive",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"crash",id:"crash",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"updateAlive",id:"updatealive",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/docs/api/classes/DefaultErrorHandling"},(0,a.kt)("inlineCode",{parentName:"a"},"DefaultErrorHandling")))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"keepalive"},"keepAlive"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"keepAlive"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("p",null,"Number of times the process should throw an error until crashing and exiting"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/errorHandling.ts#L9"},"src/handler/contracts/errorHandling.ts:9")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"crash"},"crash"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"crash"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("p",null,"Utility function to crash"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/errorHandling.ts#L15"},"src/handler/contracts/errorHandling.ts:15")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"updatealive"},"updateAlive"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"updateAlive"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"A function that is called on every crash. Updates keepAlive"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/errorHandling.ts#L21"},"src/handler/contracts/errorHandling.ts:21")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/26f1f3a5.9a6faf84.js b/assets/js/26f1f3a5.3e6fc551.js similarity index 87% rename from assets/js/26f1f3a5.9a6faf84.js rename to assets/js/26f1f3a5.3e6fc551.js index f16d4322b..9c84e5542 100644 --- a/assets/js/26f1f3a5.9a6faf84.js +++ b/assets/js/26f1f3a5.3e6fc551.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7363],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>m});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),u=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},p=function(e){var n=u(e.components);return r.createElement(s.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=u(t),m=a,y=d["".concat(s,".").concat(m)]||d[m]||c[m]||i;return t?r.createElement(y,l(l({ref:n},p),{},{components:t})):r.createElement(y,l({ref:n},p))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,l=new Array(i);l[0]=d;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var u=2;u{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=t(7462),a=(t(7294),t(3905));const i={id:"PayloadType",title:"Enumeration: PayloadType",sidebar_label:"PayloadType",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/enums/PayloadType",id:"api/enums/PayloadType",title:"Enumeration: PayloadType",description:"Enumeration Members",source:"@site/docs/api/enums/PayloadType.md",sourceDirName:"api/enums",slug:"/api/enums/PayloadType",permalink:"/docs/api/enums/PayloadType",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"PayloadType",title:"Enumeration: PayloadType",sidebar_label:"PayloadType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EventType",permalink:"/docs/api/enums/EventType"},next:{title:"PluginType",permalink:"/docs/api/enums/PluginType"}},s={},u=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Failure",id:"failure",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Success",id:"success",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Warning",id:"warning",level:3},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:u};function c(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"failure"},"Failure"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Failure")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"failure"')),(0,a.kt)("p",null,"The PayloadType for a SernEmitter failure event"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L114"},"src/handler/structures/enums.ts:114")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"success"},"Success"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Success")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"success"')),(0,a.kt)("p",null,"The PayloadType for a SernEmitter success event"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L110"},"src/handler/structures/enums.ts:110")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"warning"},"Warning"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Warning")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"warning"')),(0,a.kt)("p",null,"The PayloadType for a SernEmitter warning event"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L118"},"src/handler/structures/enums.ts:118")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7363],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>m});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),u=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},p=function(e){var n=u(e.components);return r.createElement(s.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=u(t),m=a,f=d["".concat(s,".").concat(m)]||d[m]||c[m]||i;return t?r.createElement(f,l(l({ref:n},p),{},{components:t})):r.createElement(f,l({ref:n},p))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,l=new Array(i);l[0]=d;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var u=2;u{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=t(7462),a=(t(7294),t(3905));const i={id:"PayloadType",title:"Enumeration: PayloadType",sidebar_label:"PayloadType",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/enums/PayloadType",id:"api/enums/PayloadType",title:"Enumeration: PayloadType",description:"Enumeration Members",source:"@site/docs/api/enums/PayloadType.md",sourceDirName:"api/enums",slug:"/api/enums/PayloadType",permalink:"/docs/api/enums/PayloadType",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"PayloadType",title:"Enumeration: PayloadType",sidebar_label:"PayloadType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EventType",permalink:"/docs/api/enums/EventType"},next:{title:"PluginType",permalink:"/docs/api/enums/PluginType"}},s={},u=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Failure",id:"failure",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Success",id:"success",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Warning",id:"warning",level:3},{value:"Defined in",id:"defined-in-2",level:4}],p={toc:u};function c(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"failure"},"Failure"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Failure")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"failure"')),(0,a.kt)("p",null,"The PayloadType for a SernEmitter failure event"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L124"},"src/handler/structures/enums.ts:124")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"success"},"Success"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Success")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"success"')),(0,a.kt)("p",null,"The PayloadType for a SernEmitter success event"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L120"},"src/handler/structures/enums.ts:120")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"warning"},"Warning"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Warning")," = ",(0,a.kt)("inlineCode",{parentName:"p"},'"warning"')),(0,a.kt)("p",null,"The PayloadType for a SernEmitter warning event"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L128"},"src/handler/structures/enums.ts:128")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/295686f2.62d1cfc5.js b/assets/js/295686f2.62d1cfc5.js new file mode 100644 index 000000000..918b3ee45 --- /dev/null +++ b/assets/js/295686f2.62d1cfc5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9187],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=d(n),m=a,f=c["".concat(p,".").concat(m)]||c[m]||u[m]||i;return n?r.createElement(f,l(l({ref:t},s),{},{components:n})):r.createElement(f,l({ref:t},s))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=c;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=n(7462),a=(n(7294),n(3905));const i={id:"ContextMenuUser",title:"Interface: ContextMenuUser",sidebar_label:"ContextMenuUser",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/interfaces/ContextMenuUser",id:"api/interfaces/ContextMenuUser",title:"Interface: ContextMenuUser",description:"Hierarchy",source:"@site/docs/api/interfaces/ContextMenuUser.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ContextMenuUser",permalink:"/docs/api/interfaces/ContextMenuUser",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ContextMenuUser",title:"Interface: ContextMenuUser",sidebar_label:"ContextMenuUser",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ContextMenuMsg",permalink:"/docs/api/interfaces/ContextMenuMsg"},next:{title:"Controller",permalink:"/docs/api/interfaces/Controller"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:d};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,a.kt)("inlineCode",{parentName:"a"},"Module"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ContextMenuUser"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"UserContextMenuCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ctx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"UserContextMenuCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L71"},"src/types/module.ts:71")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#ctxuser"},(0,a.kt)("inlineCode",{parentName:"a"},"CtxUser")),">","[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L69"},"src/types/module.ts:69")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L70"},"src/types/module.ts:70")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#ctxuser"},(0,a.kt)("inlineCode",{parentName:"a"},"CtxUser"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L68"},"src/types/module.ts:68")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2caf5b7a.69287ef4.js b/assets/js/2caf5b7a.69287ef4.js new file mode 100644 index 000000000..8a997e411 --- /dev/null +++ b/assets/js/2caf5b7a.69287ef4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[3173],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>k});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var o=i.createContext({}),d=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=d(e.components);return i.createElement(o.Provider,{value:n},e.children)},s={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,o=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),u=d(t),k=a,c=u["".concat(o,".").concat(k)]||u[k]||s[k]||r;return t?i.createElement(c,p(p({ref:n},m),{},{components:t})):i.createElement(c,p({ref:n},m))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,p=new Array(r);p[0]=u;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l.mdxType="string"==typeof e?e:a,p[1]=l;for(var d=2;d{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=t(7462),a=(t(7294),t(3905));const r={id:"SernSubCommandData",title:"Interface: SernSubCommandData",sidebar_label:"SernSubCommandData",sidebar_position:0,custom_edit_url:null},p=void 0,l={unversionedId:"api/interfaces/SernSubCommandData",id:"api/interfaces/SernSubCommandData",title:"Interface: SernSubCommandData",description:"Hierarchy",source:"@site/docs/api/interfaces/SernSubCommandData.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SernSubCommandData",permalink:"/docs/api/interfaces/SernSubCommandData",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SernSubCommandData",title:"Interface: SernSubCommandData",sidebar_label:"SernSubCommandData",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SernEventPlugin",permalink:"/docs/api/interfaces/SernEventPlugin"},next:{title:"SernSubCommandGroupData",permalink:"/docs/api/interfaces/SernSubCommandGroupData"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"autocomplete",id:"autocomplete",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"descriptionLocalizations",id:"descriptionlocalizations",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"nameLocalizations",id:"namelocalizations",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"required",id:"required",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-7",level:4}],m={toc:d};function s(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"BaseApplicationCommandOptionsData")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SernSubCommandData"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"autocomplete"},"autocomplete"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"autocomplete"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"undefined")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.autocomplete"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4203"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.description"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4200"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"descriptionlocalizations"},"descriptionLocalizations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"descriptionLocalizations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,a.kt)("inlineCode",{parentName:"p"},'"en-US"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"en-GB"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"bg"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-CN"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-TW"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"cs"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"da"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"nl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"de"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"el"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hu"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"it"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ja"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ko"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"lt"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"no"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pt-BR"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ro"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ru"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"es-ES"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"sv-SE"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"th"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"tr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"uk"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"vi"'),", ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">",">"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.descriptionLocalizations"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4201"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4198"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"namelocalizations"},"nameLocalizations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"nameLocalizations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,a.kt)("inlineCode",{parentName:"p"},'"en-US"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"en-GB"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"bg"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-CN"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-TW"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"cs"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"da"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"nl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"de"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"el"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hu"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"it"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ja"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ko"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"lt"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"no"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pt-BR"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ro"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ru"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"es-ES"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"sv-SE"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"th"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"tr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"uk"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"vi"'),", ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">",">"),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.nameLocalizations"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4199"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"options"},"options"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"options"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#baseoptions"},(0,a.kt)("inlineCode",{parentName:"a"},"BaseOptions")),"[]"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L201"},"src/types/module.ts:201")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"required"},"required"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"required"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"undefined")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.required"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L200"},"src/types/module.ts:200")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Subcommand")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L199"},"src/types/module.ts:199")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3a0cb3a9.4093e13f.js b/assets/js/3a0cb3a9.4093e13f.js new file mode 100644 index 000000000..2c4848438 --- /dev/null +++ b/assets/js/3a0cb3a9.4093e13f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7936],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>u});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var o=i.createContext({}),d=function(e){var n=i.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},m=function(e){var n=d(e.components);return i.createElement(o.Provider,{value:n},e.children)},s={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},c=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,o=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),c=d(t),u=a,k=c["".concat(o,".").concat(u)]||c[u]||s[u]||r;return t?i.createElement(k,l(l({ref:n},m),{},{components:t})):i.createElement(k,l({ref:n},m))}));function u(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,l=new Array(r);l[0]=c;var p={};for(var o in n)hasOwnProperty.call(n,o)&&(p[o]=n[o]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var d=2;d{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>r,metadata:()=>p,toc:()=>d});var i=t(7462),a=(t(7294),t(3905));const r={id:"SernAutocompleteData",title:"Interface: SernAutocompleteData",sidebar_label:"SernAutocompleteData",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/SernAutocompleteData",id:"api/interfaces/SernAutocompleteData",title:"Interface: SernAutocompleteData",description:"Hierarchy",source:"@site/docs/api/interfaces/SernAutocompleteData.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SernAutocompleteData",permalink:"/docs/api/interfaces/SernAutocompleteData",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SernAutocompleteData",title:"Interface: SernAutocompleteData",sidebar_label:"SernAutocompleteData",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"RoleSelectCommand",permalink:"/docs/api/interfaces/RoleSelectCommand"},next:{title:"SernEmitterPlugin",permalink:"/docs/api/interfaces/SernEmitterPlugin"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"autocomplete",id:"autocomplete",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"command",id:"command",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"descriptionLocalizations",id:"descriptionlocalizations",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"nameLocalizations",id:"namelocalizations",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"required",id:"required",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-7",level:4}],m={toc:d};function s(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"BaseApplicationCommandOptionsData"),", ",(0,a.kt)("inlineCode",{parentName:"p"},'"autocomplete"'),">"),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SernAutocompleteData"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"autocomplete"},"autocomplete"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"autocomplete"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"true")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L179"},"src/types/module.ts:179")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"command"},"command"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"command"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/AutocompleteCommand"},(0,a.kt)("inlineCode",{parentName:"a"},"AutocompleteCommand"))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L184"},"src/types/module.ts:184")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Omit.description"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4200"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"descriptionlocalizations"},"descriptionLocalizations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"descriptionLocalizations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,a.kt)("inlineCode",{parentName:"p"},'"en-US"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"en-GB"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"bg"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-CN"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-TW"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"cs"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"da"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"nl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"de"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"el"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hu"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"it"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ja"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ko"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"lt"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"no"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pt-BR"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ro"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ru"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"es-ES"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"sv-SE"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"th"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"tr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"uk"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"vi"'),", ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">",">"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Omit.descriptionLocalizations"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4201"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Omit.name"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4198"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"namelocalizations"},"nameLocalizations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"nameLocalizations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,a.kt)("inlineCode",{parentName:"p"},'"en-US"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"en-GB"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"bg"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-CN"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-TW"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"cs"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"da"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"nl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"de"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"el"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hu"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"it"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ja"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ko"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"lt"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"no"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pt-BR"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ro"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ru"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"es-ES"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"sv-SE"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"th"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"tr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"uk"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"vi"'),", ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">",">"),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Omit.nameLocalizations"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4199"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"required"},"required"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"required"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Omit.required"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4202"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"String")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Integer")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Number")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L180"},"src/types/module.ts:180")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3a25b5a8.3fdb7a05.js b/assets/js/3a25b5a8.3fdb7a05.js new file mode 100644 index 000000000..2853b0c20 --- /dev/null +++ b/assets/js/3a25b5a8.3fdb7a05.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[3012],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>m});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},d=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),u=p(t),m=a,g=u["".concat(s,".").concat(m)]||u[m]||c[m]||o;return t?r.createElement(g,l(l({ref:n},d),{},{components:t})):r.createElement(g,l({ref:n},d))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,l=new Array(o);l[0]=u;var i={};for(var s in n)hasOwnProperty.call(n,s)&&(i[s]=n[s]);i.originalType=e,i.mdxType="string"==typeof e?e:a,l[1]=i;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=t(7462),a=(t(7294),t(3905));const o={slug:"2.0.0",title:"Release 2.0.0",authors:["jacoobes"],tags:["release"]},l=void 0,i={permalink:"/blog/2.0.0",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-12-13-mdx-blog-post.md",source:"@site/blog/2022-12-13-mdx-blog-post.md",title:"Release 2.0.0",description:"2.0 Release",date:"2022-12-13T00:00:00.000Z",formattedDate:"December 13, 2022",tags:[{label:"release",permalink:"/blog/tags/release"}],readingTime:3.63,hasTruncateMarker:!1,authors:[{name:"jacoobes",title:"Head Dev",url:"https://github.com/jacoobes",imageURL:"https://github.com/jacoobes.png",key:"jacoobes"}],frontMatter:{slug:"2.0.0",title:"Release 2.0.0",authors:["jacoobes"],tags:["release"]},nextItem:{title:"How to get started with sern!",permalink:"/blog/getting-started"}},s={authorsImageUrls:[void 0]},p=[{value:"2.0 Release",id:"20-release",level:2},{value:"Plugin Support for Event Modules",id:"plugin-support-for-event-modules",level:3},{value:"Dependency Injection and Decoupling",id:"dependency-injection-and-decoupling",level:2},{value:"How do I start?",id:"how-do-i-start",level:3},{value:"New CommandTypes",id:"new-commandtypes",level:2},{value:"Typings Simplification",id:"typings-simplification",level:2},{value:"Breaking Changes",id:"breaking-changes",level:2},{value:"Context refactoring",id:"context-refactoring",level:2}],d={toc:p};function c(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"20-release"},"2.0 Release"),(0,a.kt)("p",null,"Join our ",(0,a.kt)("a",{parentName:"p",href:"https://sern.dev/discord"},"discord"),"! ",(0,a.kt)("br",null),"\nWow! We're finally increasing our semantic versioning by +",(0,a.kt)("inlineCode",{parentName:"p"},"1.7.9.")," ",(0,a.kt)("br",null),"\nWhat does this mean?"),(0,a.kt)("h3",{id:"plugin-support-for-event-modules"},"Plugin Support for Event Modules"),(0,a.kt)("p",null,"You can now use plugins for event modules. Previous version would throw an error if the\n",(0,a.kt)("inlineCode",{parentName:"p"},"plugins")," field was populated."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export function commandPlTest() : SernEmitterPlugin {\n return {\n type: PluginType.Command,\n execute: ({ mod}, controller) => {\n if(mod.name === 'module.register') {\n console.log('Event Module created correctly')\n return controller.next()\n }\n console.log('event name is wrong')\n return controller.stop()\n }\n }\n}\n")),(0,a.kt)("p",null,"Applying this plugin to some ",(0,a.kt)("inlineCode",{parentName:"p"},"eventModule"),": "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export default eventModule({\n name: 'error',\n type: EventType.Sern,\n plugins: [commandPlTest()],\n execute(m) {\n console.log(m)\n },\n})\n")),(0,a.kt)("h2",{id:"dependency-injection-and-decoupling"},"Dependency Injection and Decoupling"),(0,a.kt)("p",null,"The powerful npm package ",(0,a.kt)("inlineCode",{parentName:"p"},"iti")," decouples sern even more.\nDecoupling data structures with the Inversion of Control pattern separates data from logic, which will help speed production\nand make sern even more customizable than before."),(0,a.kt)("h3",{id:"how-do-i-start"},"How do I start?"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript",metastring:'title="src/index.ts"',title:'"src/index.ts"'},"//With typescript, you can customize / augment your typings.\ninterface MyDependencies extends Dependencies {\n '@sern/client' : Singleton;\n '@sern/logger' : Singleton\n}\n\nexport const useContainer = Sern.makeDependencies({\n// exclude: new Set(['@sern/logger']), don't autofill optional dependencies\n build: root => root\n .add({ '@sern/client': single(client) }) \n .add({ '@sern/logger': single(new DefaultLogging()) })\n});\n\nSern.init({\n defaultPrefix: '!', // removing defaultPrefix will shut down text commands\n commands: 'src/commands',\n // events: 'src/events' (optional),\n containerConfig : {\n get: useContainer //pass in your dependency getter here\n }\n});\n\n")),(0,a.kt)("p",null,"Using the ",(0,a.kt)("inlineCode",{parentName:"p"},"Sern#makeDependencies")," function, inject your dependencies.\nWe'll use specific dependencies that are created with the ",(0,a.kt)("inlineCode",{parentName:"p"},"@sern/keyword"),"\nkey.\nUsing typescript to display all ",(0,a.kt)("inlineCode",{parentName:"p"},"keywords")," and what they represent:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export interface Dependencies {\n '@sern/client': Singleton; //Discord Client\n '@sern/logger'?: Singleton; //Logger\n '@sern/emitter': Singleton; //SernEmitter\n '@sern/store' : Singleton; //Stores all Command Modules\n '@sern/modules' : Singleton; //Manages Modules\n '@sern/errors': Singleton; //A Lifetime / Crash Handler\n}\n")),(0,a.kt)("admonition",{type:"danger"},(0,a.kt)("p",{parentName:"admonition"},"Sern#addExternal has been deprecated and removed in favor of Sern#makeDependencies")),(0,a.kt)("p",null,"At the moment, one optional dependency, ",(0,a.kt)("inlineCode",{parentName:"p"},"@sern/logger"),", exists. If not added explicitly,\nwe'll ",(0,a.kt)("strong",{parentName:"p"},"autofill")," with a ",(0,a.kt)("a",{parentName:"p",href:"https://sern.dev/docs/api/classes/defaultlogging"},"DefaultLogger"),"."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"If you don't want a logger, add it to the\n",(0,a.kt)("inlineCode",{parentName:"p"},"exclude")," field while composing dependencies.")),(0,a.kt)("p",null,"Use your generated dependency getter ",(0,a.kt)("inlineCode",{parentName:"p"},"useContainer")," (use whatever name you want), access them\nfrom anywhere."),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"the function ",(0,a.kt)("a",{parentName:"p",href:"https://sern.dev/docs/api/modules#usecontainerraw"},"useContainerRaw")," is provided for direct access to dependencies and the internal\ndata structure. Use this wisely as no guarantees are made and crashes can happen.")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"build")," field follows ",(0,a.kt)("a",{parentName:"p",href:"https://itijs.org/docs/quick-start#usage"},"createContainer")," function call."),(0,a.kt)("h2",{id:"new-commandtypes"},"New CommandTypes"),(0,a.kt)("p",null,"2.0 includes all the new role select menus. ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.MenuSelect")," has been renamed into\n",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.StringSelect"),". The remaining SelectMenus are\n",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.RoleSelect"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.ChannelSelect"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.UserSelect"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.MentionableSelect")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript",metastring:'title="commands/roleselect.ts"',title:'"commands/roleselect.ts"'},"export default commandModule({\n type: CommandType.RoleSelect,\n execute(ctx) {\n ctx.reply('role select')\n },\n})\n")),(0,a.kt)("p",null,"In addition, commandModules with ContextMenus have been renamed."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"- CommandType.MenuUser, CommandType.MenuMsg \n+ CommandType.CtxUser, CommandType.CtxMsg\n")),(0,a.kt)("h2",{id:"typings-simplification"},"Typings Simplification"),(0,a.kt)("p",null,"Pre 2.0: "),(0,a.kt)("img",{src:"https://cdn.discordapp.com/attachments/820348341358952550/1038577974829666386/image.png"}),(0,a.kt)("br",null)," ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Post 2.0:",(0,a.kt)("br",null),(0,a.kt)("img",{src:"https://cdn.discordapp.com/attachments/820348341358952550/1052623728489550015/image.png"}),(0,a.kt)("p",null,"CommandPlugin"," and EventPlugin"," typings have also been static'ified, transformed from types to interfaces"),(0,a.kt)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,a.kt)("img",{src:"https://img.srizan.ml/Discord_z8Sn1UBfEe.png"}),(0,a.kt)("br",null),"All deprecation warnings from previous versions have taken effect, and are removed in 2.0.",(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"- type Module = EventModule | CommandModule\n+ type AnyModule = EventModule | CommandModule\n\n-export type SpreadParams unknown> = (\n- args: Parameters[number],\n- ) => unknown;\n")),(0,a.kt)("p",null,"Override type has been removed due to redundancy"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"- discord.js : 14.5\n+ discord.js : 14.7\n\n-typescript: 4.7\n+ typescript: 4.9\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"+ interface Wrapper {\n+ readonly defaultPrefix?: string;\n+ readonly commands: string;\n+ readonly events?: string;\n+ readonly containerConfig : {\n+ get: (...keys: (keyof Dependencies)[]) => unknown[];\n+ }\n+}\n\n- interface Wrapper {\n- readonly client: Client;\n- readonly sernEmitter?: SernEmitter;\n- readonly defaultPrefix?: string;\n- readonly commands: string;\n- readonly events?:\n- | string\n- | { mod: EventModule; absPath: string }[]\n- | (() => { mod: EventModule; absPath: string }[]);\n-}\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"+ DefaultLogger\n+ DefaultModuleManager\n+ SernEmitter\n+ DefaultErrorHandling\n+ type Singleton = () => T\n+ type Transient = () => () => T; \n+ type LogPayload = { message: T }\n+ export const single = () => T\n+ export const many = () => () => T\n")),(0,a.kt)("p",null,"Including the previous section, some names to symbols and data structures were altered to\nbe better represented. view ",(0,a.kt)("a",{parentName:"p",href:"/404.html"},"changelog")),(0,a.kt)("h2",{id:"context-refactoring"},"Context refactoring"),(0,a.kt)("p",null,"The context data structure has been internally altered to represent its dynamics better."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3a25b5a8.6f0d6be1.js b/assets/js/3a25b5a8.6f0d6be1.js deleted file mode 100644 index a7e75b09b..000000000 --- a/assets/js/3a25b5a8.6f0d6be1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[3012],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,l=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=u(n),m=o,g=d["".concat(s,".").concat(m)]||d[m]||p[m]||l;return n?r.createElement(g,a(a({ref:t},c),{},{components:n})):r.createElement(g,a({ref:t},c))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var l=n.length,a=new Array(l);a[0]=d;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i.mdxType="string"==typeof e?e:o,a[1]=i;for(var u=2;u{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>p,frontMatter:()=>l,metadata:()=>i,toc:()=>u});var r=n(7462),o=(n(7294),n(3905));const l={slug:"2.0.0",title:"Release 2.0.0",authors:["jacoobes"],tags:["release"]},a=void 0,i={permalink:"/blog/2.0.0",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-12-13-mdx-blog-post.md",source:"@site/blog/2022-12-13-mdx-blog-post.md",title:"Release 2.0.0",description:"2.0 Release",date:"2022-12-13T00:00:00.000Z",formattedDate:"December 13, 2022",tags:[{label:"release",permalink:"/blog/tags/release"}],readingTime:.63,hasTruncateMarker:!1,authors:[{name:"jacoobes",title:"Head Dev",url:"https://github.com/jacoobes",imageURL:"https://github.com/jacoobes.png",key:"jacoobes"}],frontMatter:{slug:"2.0.0",title:"Release 2.0.0",authors:["jacoobes"],tags:["release"]},nextItem:{title:"How to get started with sern!",permalink:"/blog/getting-started"}},s={authorsImageUrls:[void 0]},u=[{value:"2.0 Release",id:"20-release",level:2},{value:"Plugin Support for Event Modules",id:"plugin-support-for-event-modules",level:3},{value:"Dependency Injection and Decoupling",id:"dependency-injection-and-decoupling",level:2}],c={toc:u};function p(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"20-release"},"2.0 Release"),(0,o.kt)("p",null,"Wow! We're finally increasing our semantic versioning by +",(0,o.kt)("inlineCode",{parentName:"p"},"1.7.9.")," ",(0,o.kt)("br",null),"\nWhat does this mean?"),(0,o.kt)("h3",{id:"plugin-support-for-event-modules"},"Plugin Support for Event Modules"),(0,o.kt)("p",null,"You can now use plugins for event modules. Previous version would throw an error if the\n",(0,o.kt)("inlineCode",{parentName:"p"},"plugins")," field was populated."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export function commandPlTest() : SernEmitterPlugin {\n return {\n type: PluginType.Command,\n execute: ({ mod}, controller) => {\n if(mod.name === 'module.register') {\n console.log('Event Module created correctly')\n return controller.next()\n }\n console.log('event name is wrong')\n return controller.stop()\n }\n }\n}\n")),(0,o.kt)("p",null,"Applying this plugin to some ",(0,o.kt)("inlineCode",{parentName:"p"},"eventModule"),": "),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export default eventModule({\n name: 'error',\n type: EventType.Sern,\n plugins: [commandPlTest()],\n execute(m) {\n console.log(m)\n },\n})\n")),(0,o.kt)("h2",{id:"dependency-injection-and-decoupling"},"Dependency Injection and Decoupling"),(0,o.kt)("p",null,"THIS SECTION IS PROBABLY THE MOST IMPORTANT!! ",(0,o.kt)("br",null),"\ni should have eaten something before i feel hungry"))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3dc7c79a.346d9fd5.js b/assets/js/3dc7c79a.346d9fd5.js deleted file mode 100644 index 6cb4f9406..000000000 --- a/assets/js/3dc7c79a.346d9fd5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9712],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>g});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var c=n.createContext({}),l=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},s=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),u=l(r),g=o,f=u["".concat(c,".").concat(g)]||u[g]||d[g]||i;return r?n.createElement(f,a(a({ref:t},s),{},{components:r})):n.createElement(f,a({ref:t},s))}));function g(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=u;var p={};for(var c in t)hasOwnProperty.call(t,c)&&(p[c]=t[c]);p.originalType=e,p.mdxType="string"==typeof e?e:o,a[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>l});var n=r(7462),o=(r(7294),r(3905));const i={},a="Preparing to Code",p={unversionedId:"guide/getting-started/preparing",id:"guide/getting-started/preparing",title:"Preparing to Code",description:"After installing and IDE you need to install node.",source:"@site/docs/guide/getting-started/preparing.md",sourceDirName:"guide/getting-started",slug:"/guide/getting-started/preparing",permalink:"/docs/guide/getting-started/preparing",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/getting-started/preparing.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Choosing an IDE",permalink:"/docs/guide/getting-started/choose-ide"},next:{title:"Goal",permalink:"/docs/guide/walkthrough/goal"}},c={},l=[],s={toc:l};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"preparing-to-code"},"Preparing to Code"),(0,o.kt)("p",null,"After installing and IDE you need to install node."),(0,o.kt)("p",null,"You can download the LTS version of node right ",(0,o.kt)("a",{parentName:"p",href:"https://nodejs.org/en/download/"},"here")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3dc7c79a.e38ff606.js b/assets/js/3dc7c79a.e38ff606.js new file mode 100644 index 000000000..fd03b1854 --- /dev/null +++ b/assets/js/3dc7c79a.e38ff606.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9712],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>g});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=s(r),g=o,f=u["".concat(p,".").concat(g)]||u[g]||d[g]||a;return r?n.createElement(f,i(i({ref:t},c),{},{components:r})):n.createElement(f,i({ref:t},c))}));function g(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:o,i[1]=l;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>s});var n=r(7462),o=(r(7294),r(3905));const a={},i="Preparing to Code",l={unversionedId:"guide/getting-started/preparing",id:"guide/getting-started/preparing",title:"Preparing to Code",description:"After installing and IDE you need to install node.",source:"@site/docs/guide/getting-started/preparing.md",sourceDirName:"guide/getting-started",slug:"/guide/getting-started/preparing",permalink:"/docs/guide/getting-started/preparing",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/getting-started/preparing.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Choosing an IDE",permalink:"/docs/guide/getting-started/choose-ide"},next:{title:"Goal",permalink:"/docs/guide/walkthrough/goal"}},p={},s=[],c={toc:s};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"preparing-to-code"},"Preparing to Code"),(0,o.kt)("p",null,"After installing and IDE you need to install node."),(0,o.kt)("p",null,"You can download the LTS version of node right ",(0,o.kt)("a",{parentName:"p",href:"https://nodejs.org/en/download/"},"here")),(0,o.kt)("p",null,"Install discord.js with"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-shell"},"npm install discord.js@latest\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/425cbb82.3b3c492f.js b/assets/js/425cbb82.3b3c492f.js new file mode 100644 index 000000000..6b1d8763f --- /dev/null +++ b/assets/js/425cbb82.3b3c492f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[3650],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>m});var r=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=r.createContext({}),c=function(e){var n=r.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},d=function(e){var n=c(e.components);return r.createElement(o.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},s=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(t),m=i,f=s["".concat(o,".").concat(m)]||s[m]||u[m]||a;return t?r.createElement(f,l(l({ref:n},d),{},{components:t})):r.createElement(f,l({ref:n},d))}));function m(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,l=new Array(a);l[0]=s;var p={};for(var o in n)hasOwnProperty.call(n,o)&&(p[o]=n[o]);p.originalType=e,p.mdxType="string"==typeof e?e:i,l[1]=p;for(var c=2;c{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>p,toc:()=>c});var r=t(7462),i=(t(7294),t(3905));const a={id:"Plugin",title:"Interface: Plugin",sidebar_label:"Plugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/Plugin",id:"api/interfaces/Plugin",title:"Interface: Plugin",description:"Hierarchy",source:"@site/docs/api/interfaces/Plugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Plugin",permalink:"/docs/api/interfaces/Plugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Plugin",title:"Interface: Plugin",sidebar_label:"Plugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ModuleManager",permalink:"/docs/api/interfaces/ModuleManager"},next:{title:"RoleSelectCommand",permalink:"/docs/api/interfaces/RoleSelectCommand"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:c};function u(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Plugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"CommandPlugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/DiscordEmitterPlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"DiscordEmitterPlugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ExternalEmitterPlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"ExternalEmitterPlugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernEmitterPlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEmitterPlugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/AutocompletePlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"AutocompletePlugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"EventPlugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernEventPlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEventPlugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ExternalEventPlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"ExternalEventPlugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/DiscordEventPlugin"},(0,i.kt)("inlineCode",{parentName:"a"},"DiscordEventPlugin"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,i.kt)("p",null,"will be removed in the next update"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,i.kt)("p",null,"will be removed in the next update"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31"},"src/handler/plugins/plugin.ts:31")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType"},(0,i.kt)("inlineCode",{parentName:"a"},"PluginType"))),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L34"},"src/handler/plugins/plugin.ts:34")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4279c33d.aa0e9987.js b/assets/js/4279c33d.aa0e9987.js new file mode 100644 index 000000000..32c4774f3 --- /dev/null +++ b/assets/js/4279c33d.aa0e9987.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[6851],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,c=d(e,["components","mdxType","originalType","parentName"]),m=o(n),u=r,f=m["".concat(p,".").concat(u)]||m[u]||s[u]||i;return n?a.createElement(f,l(l({ref:t},c),{},{components:n})):a.createElement(f,l({ref:t},c))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(7462),r=(n(7294),n(3905));const i={id:"ChannelSelectCommand",title:"Interface: ChannelSelectCommand",sidebar_label:"ChannelSelectCommand",sidebar_position:0,custom_edit_url:null},l=void 0,d={unversionedId:"api/interfaces/ChannelSelectCommand",id:"api/interfaces/ChannelSelectCommand",title:"Interface: ChannelSelectCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/ChannelSelectCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ChannelSelectCommand",permalink:"/docs/api/interfaces/ChannelSelectCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ChannelSelectCommand",title:"Interface: ChannelSelectCommand",sidebar_label:"ChannelSelectCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ButtonCommand",permalink:"/docs/api/interfaces/ButtonCommand"},next:{title:"CommandPlugin",permalink:"/docs/api/interfaces/CommandPlugin"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],c={toc:o};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,r.kt)("inlineCode",{parentName:"a"},"Module"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ChannelSelectCommand"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ChannelSelectMenuInteraction"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ChannelSelectMenuInteraction"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L99"},"src/types/module.ts:99")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onevent"},"onEvent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#channelselect"},(0,r.kt)("inlineCode",{parentName:"a"},"ChannelSelect")),">","[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L97"},"src/types/module.ts:97")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"plugins"},"plugins"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"plugins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L98"},"src/types/module.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#channelselect"},(0,r.kt)("inlineCode",{parentName:"a"},"ChannelSelect"))),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L96"},"src/types/module.ts:96")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/447d9066.193186d5.js b/assets/js/447d9066.193186d5.js new file mode 100644 index 000000000..b16530913 --- /dev/null +++ b/assets/js/447d9066.193186d5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[5853],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),p=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,m=d(e,["components","mdxType","originalType","parentName"]),u=p(n),c=r,f=u["".concat(o,".").concat(c)]||u[c]||s[c]||i;return n?a.createElement(f,l(l({ref:t},m),{},{components:n})):a.createElement(f,l({ref:t},m))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=u;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const i={id:"ModalSubmitCommand",title:"Interface: ModalSubmitCommand",sidebar_label:"ModalSubmitCommand",sidebar_position:0,custom_edit_url:null},l=void 0,d={unversionedId:"api/interfaces/ModalSubmitCommand",id:"api/interfaces/ModalSubmitCommand",title:"Interface: ModalSubmitCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/ModalSubmitCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ModalSubmitCommand",permalink:"/docs/api/interfaces/ModalSubmitCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ModalSubmitCommand",title:"Interface: ModalSubmitCommand",sidebar_label:"ModalSubmitCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"MentionableSelectCommand",permalink:"/docs/api/interfaces/MentionableSelectCommand"},next:{title:"Module",permalink:"/docs/api/interfaces/Module"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],m={toc:p};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,r.kt)("inlineCode",{parentName:"a"},"Module"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"ModalSubmitCommand"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ModalSubmitInteraction"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ModalSubmitInteraction"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L127"},"src/types/module.ts:127")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onevent"},"onEvent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#modal"},(0,r.kt)("inlineCode",{parentName:"a"},"Modal")),">","[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L125"},"src/types/module.ts:125")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"plugins"},"plugins"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"plugins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L126"},"src/types/module.ts:126")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#modal"},(0,r.kt)("inlineCode",{parentName:"a"},"Modal"))),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L124"},"src/types/module.ts:124")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/462b6925.a2781165.js b/assets/js/462b6925.a2781165.js new file mode 100644 index 000000000..2a4348768 --- /dev/null +++ b/assets/js/462b6925.a2781165.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7749],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),o=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),u=o(n),c=r,f=u["".concat(d,".").concat(c)]||u[c]||m[c]||i;return n?a.createElement(f,l(l({ref:t},s),{},{components:n})):a.createElement(f,l({ref:t},s))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=u;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var a=n(7462),r=(n(7294),n(3905));const i={id:"SlashCommand",title:"Interface: SlashCommand",sidebar_label:"SlashCommand",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/SlashCommand",id:"api/interfaces/SlashCommand",title:"Interface: SlashCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/SlashCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SlashCommand",permalink:"/docs/api/interfaces/SlashCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SlashCommand",title:"Interface: SlashCommand",sidebar_label:"SlashCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SernSubCommandGroupData",permalink:"/docs/api/interfaces/SernSubCommandGroupData"},next:{title:"StringSelectCommand",permalink:"/docs/api/interfaces/StringSelectCommand"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:o};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,r.kt)("inlineCode",{parentName:"a"},"Module"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"SlashCommand"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,r.kt)("inlineCode",{parentName:"a"},"Context")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),": [",(0,r.kt)("inlineCode",{parentName:"p"},'"slash"'),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#slashoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"SlashOptions")),"]) => ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/Context"},(0,r.kt)("inlineCode",{parentName:"a"},"Context")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},'"slash"'),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#slashoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"SlashOptions")),"]")))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L55"},"src/types/module.ts:55")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onevent"},"onEvent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#slash"},(0,r.kt)("inlineCode",{parentName:"a"},"Slash")),">","[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L52"},"src/types/module.ts:52")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"options"},"options"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"options"),": (",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernSubCommandData"},(0,r.kt)("inlineCode",{parentName:"a"},"SernSubCommandData"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernSubCommandGroupData"},(0,r.kt)("inlineCode",{parentName:"a"},"SernSubCommandGroupData"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#baseoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseOptions")),")[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L54"},"src/types/module.ts:54")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"plugins"},"plugins"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"plugins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L53"},"src/types/module.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#slash"},(0,r.kt)("inlineCode",{parentName:"a"},"Slash"))),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L51"},"src/types/module.ts:51")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4b098d2e.01936f7a.js b/assets/js/4b098d2e.01936f7a.js new file mode 100644 index 000000000..907385b79 --- /dev/null +++ b/assets/js/4b098d2e.01936f7a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7453],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),o=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=o(n),u=a,f=m["".concat(p,".").concat(u)]||m[u]||c[u]||i;return n?r.createElement(f,l(l({ref:t},s),{},{components:n})):r.createElement(f,l({ref:t},s))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:a,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var r=n(7462),a=(n(7294),n(3905));const i={id:"UserSelectCommand",title:"Interface: UserSelectCommand",sidebar_label:"UserSelectCommand",sidebar_position:0,custom_edit_url:null},l=void 0,d={unversionedId:"api/interfaces/UserSelectCommand",id:"api/interfaces/UserSelectCommand",title:"Interface: UserSelectCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/UserSelectCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/UserSelectCommand",permalink:"/docs/api/interfaces/UserSelectCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"UserSelectCommand",title:"Interface: UserSelectCommand",sidebar_label:"UserSelectCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"TextCommand",permalink:"/docs/api/interfaces/TextCommand"},next:{title:"Wrapper",permalink:"/docs/api/interfaces/Wrapper"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:o};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,a.kt)("inlineCode",{parentName:"a"},"Module"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"UserSelectCommand"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"UserSelectMenuInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ctx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"UserSelectMenuInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L120"},"src/types/module.ts:120")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#userselect"},(0,a.kt)("inlineCode",{parentName:"a"},"UserSelect")),">","[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L118"},"src/types/module.ts:118")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L119"},"src/types/module.ts:119")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#userselect"},(0,a.kt)("inlineCode",{parentName:"a"},"UserSelect"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L117"},"src/types/module.ts:117")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4e28a08b.eb6206a1.js b/assets/js/4e28a08b.eb6206a1.js new file mode 100644 index 000000000..9eea1f959 --- /dev/null +++ b/assets/js/4e28a08b.eb6206a1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[6276],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),m=p(n),u=a,f=m["".concat(d,".").concat(u)]||m[u]||s[u]||i;return n?r.createElement(f,l(l({ref:t},c),{},{components:n})):r.createElement(f,l({ref:t},c))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={id:"RoleSelectCommand",title:"Interface: RoleSelectCommand",sidebar_label:"RoleSelectCommand",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/interfaces/RoleSelectCommand",id:"api/interfaces/RoleSelectCommand",title:"Interface: RoleSelectCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/RoleSelectCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/RoleSelectCommand",permalink:"/docs/api/interfaces/RoleSelectCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"RoleSelectCommand",title:"Interface: RoleSelectCommand",sidebar_label:"RoleSelectCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Plugin",permalink:"/docs/api/interfaces/Plugin"},next:{title:"SernAutocompleteData",permalink:"/docs/api/interfaces/SernAutocompleteData"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],c={toc:p};function s(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,a.kt)("inlineCode",{parentName:"a"},"Module"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"RoleSelectCommand"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"RoleSelectMenuInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ctx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"RoleSelectMenuInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L106"},"src/types/module.ts:106")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#roleselect"},(0,a.kt)("inlineCode",{parentName:"a"},"RoleSelect")),">","[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L104"},"src/types/module.ts:104")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L105"},"src/types/module.ts:105")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#roleselect"},(0,a.kt)("inlineCode",{parentName:"a"},"RoleSelect"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L103"},"src/types/module.ts:103")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/53944420.8b9ede2a.js b/assets/js/53944420.8b9ede2a.js new file mode 100644 index 000000000..3046d0ab9 --- /dev/null +++ b/assets/js/53944420.8b9ede2a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[3255],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),d=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},s=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),s=d(n),m=a,k=s["".concat(o,".").concat(m)]||s[m]||c[m]||i;return n?r.createElement(k,l(l({ref:t},u),{},{components:n})):r.createElement(k,l({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=s;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=n(7462),a=(n(7294),n(3905));const i={id:"AutocompletePlugin",title:"Interface: AutocompletePlugin",sidebar_label:"AutocompletePlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/AutocompletePlugin",id:"api/interfaces/AutocompletePlugin",title:"Interface: AutocompletePlugin",description:"Hierarchy",source:"@site/docs/api/interfaces/AutocompletePlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/AutocompletePlugin",permalink:"/docs/api/interfaces/AutocompletePlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"AutocompletePlugin",title:"Interface: AutocompletePlugin",sidebar_label:"AutocompletePlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"AutocompleteCommand",permalink:"/docs/api/interfaces/AutocompleteCommand"},next:{title:"BothCommand",permalink:"/docs/api/interfaces/BothCommand"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4}],u={toc:d};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,a.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"AutocompletePlugin"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"autocmp"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"AutocompleteInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">",", ",(0,a.kt)("inlineCode",{parentName:"p"},"controlller"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"autocmp"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"controlller"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"autocmp")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AutocompleteInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"controlller")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L73"},"src/handler/plugins/plugin.ts:73")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31"},"src/handler/plugins/plugin.ts:31")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L72"},"src/handler/plugins/plugin.ts:72")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/57fe7727.1e46753b.js b/assets/js/57fe7727.1e46753b.js new file mode 100644 index 000000000..15e109f80 --- /dev/null +++ b/assets/js/57fe7727.1e46753b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[3864],{3905:(e,n,t)=>{t.d(n,{Zo:()=>m,kt:()=>k});var i=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function p(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=i.createContext({}),d=function(e){var n=i.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):p(p({},n),e)),t},m=function(e){var n=d(e.components);return i.createElement(l.Provider,{value:n},e.children)},s={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},u=i.forwardRef((function(e,n){var t=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,m=o(e,["components","mdxType","originalType","parentName"]),u=d(t),k=a,c=u["".concat(l,".").concat(k)]||u[k]||s[k]||r;return t?i.createElement(c,p(p({ref:n},m),{},{components:t})):i.createElement(c,p({ref:n},m))}));function k(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var r=t.length,p=new Array(r);p[0]=u;var o={};for(var l in n)hasOwnProperty.call(n,l)&&(o[l]=n[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,p[1]=o;for(var d=2;d{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>p,default:()=>s,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(7462),a=(t(7294),t(3905));const r={id:"SernSubCommandGroupData",title:"Interface: SernSubCommandGroupData",sidebar_label:"SernSubCommandGroupData",sidebar_position:0,custom_edit_url:null},p=void 0,o={unversionedId:"api/interfaces/SernSubCommandGroupData",id:"api/interfaces/SernSubCommandGroupData",title:"Interface: SernSubCommandGroupData",description:"Hierarchy",source:"@site/docs/api/interfaces/SernSubCommandGroupData.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SernSubCommandGroupData",permalink:"/docs/api/interfaces/SernSubCommandGroupData",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SernSubCommandGroupData",title:"Interface: SernSubCommandGroupData",sidebar_label:"SernSubCommandGroupData",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SernSubCommandData",permalink:"/docs/api/interfaces/SernSubCommandData"},next:{title:"SlashCommand",permalink:"/docs/api/interfaces/SlashCommand"}},l={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"autocomplete",id:"autocomplete",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"descriptionLocalizations",id:"descriptionlocalizations",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"nameLocalizations",id:"namelocalizations",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"required",id:"required",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-7",level:4}],m={toc:d};function s(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,i.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"BaseApplicationCommandOptionsData")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SernSubCommandGroupData"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"autocomplete"},"autocomplete"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"autocomplete"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"undefined")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.autocomplete"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4203"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.description"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4200"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"descriptionlocalizations"},"descriptionLocalizations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"descriptionLocalizations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,a.kt)("inlineCode",{parentName:"p"},'"en-US"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"en-GB"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"bg"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-CN"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-TW"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"cs"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"da"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"nl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"de"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"el"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hu"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"it"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ja"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ko"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"lt"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"no"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pt-BR"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ro"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ru"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"es-ES"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"sv-SE"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"th"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"tr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"uk"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"vi"'),", ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">",">"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.descriptionLocalizations"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4201"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4198"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"namelocalizations"},"nameLocalizations"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"nameLocalizations"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,a.kt)("inlineCode",{parentName:"p"},'"en-US"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"en-GB"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"bg"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-CN"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"zh-TW"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"cs"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"da"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"nl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"fr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"de"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"el"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hi"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"hu"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"it"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ja"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ko"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"lt"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"no"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pl"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"pt-BR"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ro"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"ru"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"es-ES"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"sv-SE"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"th"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"tr"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"uk"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"vi"'),", ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),">",">"),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.nameLocalizations"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:4199"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"options"},"options"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"options"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernSubCommandData"},(0,a.kt)("inlineCode",{parentName:"a"},"SernSubCommandData")),"[]"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L207"},"src/types/module.ts:207")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"required"},"required"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"required"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"undefined")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"BaseApplicationCommandOptionsData.required"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L206"},"src/types/module.ts:206")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"SubcommandGroup")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L205"},"src/types/module.ts:205")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5bc4ccbc.92cc6d18.js b/assets/js/5bc4ccbc.92cc6d18.js deleted file mode 100644 index f4b388b55..000000000 --- a/assets/js/5bc4ccbc.92cc6d18.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[53],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=r.createContext({}),d=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),u=d(n),m=i,f=u["".concat(o,".").concat(m)]||u[m]||c[m]||a;return n?r.createElement(f,l(l({ref:t},s),{},{components:n})):r.createElement(f,l({ref:t},s))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:i,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>p,toc:()=>d});var r=n(7462),i=(n(7294),n(3905));const a={id:"Wrapper",title:"Interface: Wrapper",sidebar_label:"Wrapper",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/Wrapper",id:"api/interfaces/Wrapper",title:"Interface: Wrapper",description:"An object to be passed into Sern#init() function.",source:"@site/docs/api/interfaces/Wrapper.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Wrapper",permalink:"/docs/api/interfaces/Wrapper",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Wrapper",title:"Interface: Wrapper",sidebar_label:"Wrapper",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Controller",permalink:"/docs/api/interfaces/Controller"},next:{title:"Welcome!",permalink:"/docs/intro"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"client",id:"client",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"commands",id:"commands",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultPrefix",id:"defaultprefix",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"events",id:"events",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"sernEmitter",id:"sernemitter",level:3},{value:"Defined in",id:"defined-in-4",level:4}],s={toc:d};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"An object to be passed into Sern#init() function."),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"client"},"client"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"client"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L11"},"src/handler/structures/wrapper.ts:11")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"commands"},"commands"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"commands"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L15"},"src/handler/structures/wrapper.ts:15")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"defaultprefix"},"defaultPrefix"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"defaultPrefix"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L14"},"src/handler/structures/wrapper.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"events"},"events"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"events"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," { ",(0,i.kt)("inlineCode",{parentName:"p"},"absPath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"mod"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"EventModule")," }[] ","|"," () => { ",(0,i.kt)("inlineCode",{parentName:"p"},"absPath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"mod"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"EventModule")," }[]"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L16"},"src/handler/structures/wrapper.ts:16")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernemitter"},"sernEmitter"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,i.kt)("strong",{parentName:"p"},"sernEmitter"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/wrapper.ts#L13"},"src/handler/structures/wrapper.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5bc4ccbc.d6525a79.js b/assets/js/5bc4ccbc.d6525a79.js new file mode 100644 index 000000000..bcf01ca1e --- /dev/null +++ b/assets/js/5bc4ccbc.d6525a79.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[53],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),d=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),u=d(n),f=a,m=u["".concat(o,".").concat(f)]||u[f]||s[f]||i;return n?r.createElement(m,l(l({ref:t},c),{},{components:n})):r.createElement(m,l({ref:t},c))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=n(7462),a=(n(7294),n(3905));const i={id:"Wrapper",title:"Interface: Wrapper",sidebar_label:"Wrapper",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/Wrapper",id:"api/interfaces/Wrapper",title:"Interface: Wrapper",description:"An object to be passed into Sern#init() function.",source:"@site/docs/api/interfaces/Wrapper.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Wrapper",permalink:"/docs/api/interfaces/Wrapper",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Wrapper",title:"Interface: Wrapper",sidebar_label:"Wrapper",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"UserSelectCommand",permalink:"/docs/api/interfaces/UserSelectCommand"},next:{title:"Welcome!",permalink:"/docs/intro"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"commands",id:"commands",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"containerConfig",id:"containerconfig",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultPrefix",id:"defaultprefix",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"events",id:"events",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:d};function s(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"An object to be passed into Sern#init() function."),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"commands"},"commands"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"commands"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/wrapper.ts#L9"},"src/handler/structures/wrapper.ts:9")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"containerconfig"},"containerConfig"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"containerConfig"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Object")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"get")),(0,a.kt)("td",{parentName:"tr",align:"left"},"(...",(0,a.kt)("inlineCode",{parentName:"td"},"keys"),": keyof ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Dependencies"},(0,a.kt)("inlineCode",{parentName:"a"},"Dependencies")),"[]) => ",(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),"[]")))),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/wrapper.ts#L11"},"src/handler/structures/wrapper.ts:11")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"defaultprefix"},"defaultPrefix"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"defaultPrefix"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/wrapper.ts#L8"},"src/handler/structures/wrapper.ts:8")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"events"},"events"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,a.kt)("strong",{parentName:"p"},"events"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/wrapper.ts#L10"},"src/handler/structures/wrapper.ts:10")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/65578b65.b7be4bbf.js b/assets/js/65578b65.b7be4bbf.js new file mode 100644 index 000000000..de3100a15 --- /dev/null +++ b/assets/js/65578b65.b7be4bbf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7833],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=d(n),c=r,f=u["".concat(p,".").concat(c)]||u[c]||m[c]||i;return n?a.createElement(f,l(l({ref:t},s),{},{components:n})):a.createElement(f,l({ref:t},s))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"BothCommand",title:"Interface: BothCommand",sidebar_label:"BothCommand",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/interfaces/BothCommand",id:"api/interfaces/BothCommand",title:"Interface: BothCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/BothCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/BothCommand",permalink:"/docs/api/interfaces/BothCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"BothCommand",title:"Interface: BothCommand",sidebar_label:"BothCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"AutocompletePlugin",permalink:"/docs/api/interfaces/AutocompletePlugin"},next:{title:"ButtonCommand",permalink:"/docs/api/interfaces/ButtonCommand"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alias",id:"alias",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"options",id:"options",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:d};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,r.kt)("inlineCode",{parentName:"a"},"Module"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"BothCommand"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"alias"},"alias"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"alias"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L62"},"src/types/module.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,r.kt)("inlineCode",{parentName:"a"},"Context")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#args"},(0,r.kt)("inlineCode",{parentName:"a"},"Args")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/Context"},(0,r.kt)("inlineCode",{parentName:"a"},"Context")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#args"},(0,r.kt)("inlineCode",{parentName:"a"},"Args")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L64"},"src/types/module.ts:64")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onevent"},"onEvent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#both"},(0,r.kt)("inlineCode",{parentName:"a"},"Both")),">","[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L60"},"src/types/module.ts:60")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"options"},"options"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"options"),": (",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernSubCommandData"},(0,r.kt)("inlineCode",{parentName:"a"},"SernSubCommandData"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernSubCommandGroupData"},(0,r.kt)("inlineCode",{parentName:"a"},"SernSubCommandGroupData"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#baseoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"BaseOptions")),")[]"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L63"},"src/types/module.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"plugins"},"plugins"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"plugins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L61"},"src/types/module.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#both"},(0,r.kt)("inlineCode",{parentName:"a"},"Both"))),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L59"},"src/types/module.ts:59")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/67348500.7de655c3.js b/assets/js/67348500.7de655c3.js new file mode 100644 index 000000000..e1044c95b --- /dev/null +++ b/assets/js/67348500.7de655c3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[2072],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>m});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},d=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),u=p(t),m=a,g=u["".concat(s,".").concat(m)]||u[m]||c[m]||o;return t?r.createElement(g,l(l({ref:n},d),{},{components:t})):r.createElement(g,l({ref:n},d))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,l=new Array(o);l[0]=u;var i={};for(var s in n)hasOwnProperty.call(n,s)&&(i[s]=n[s]);i.originalType=e,i.mdxType="string"==typeof e?e:a,l[1]=i;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=t(7462),a=(t(7294),t(3905));const o={slug:"2.0.0",title:"Release 2.0.0",authors:["jacoobes"],tags:["release"]},l=void 0,i={permalink:"/blog/2.0.0",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-12-13-mdx-blog-post.md",source:"@site/blog/2022-12-13-mdx-blog-post.md",title:"Release 2.0.0",description:"2.0 Release",date:"2022-12-13T00:00:00.000Z",formattedDate:"December 13, 2022",tags:[{label:"release",permalink:"/blog/tags/release"}],readingTime:3.63,hasTruncateMarker:!1,authors:[{name:"jacoobes",title:"Head Dev",url:"https://github.com/jacoobes",imageURL:"https://github.com/jacoobes.png",key:"jacoobes"}],frontMatter:{slug:"2.0.0",title:"Release 2.0.0",authors:["jacoobes"],tags:["release"]},nextItem:{title:"How to get started with sern!",permalink:"/blog/getting-started"}},s={authorsImageUrls:[void 0]},p=[{value:"2.0 Release",id:"20-release",level:2},{value:"Plugin Support for Event Modules",id:"plugin-support-for-event-modules",level:3},{value:"Dependency Injection and Decoupling",id:"dependency-injection-and-decoupling",level:2},{value:"How do I start?",id:"how-do-i-start",level:3},{value:"New CommandTypes",id:"new-commandtypes",level:2},{value:"Typings Simplification",id:"typings-simplification",level:2},{value:"Breaking Changes",id:"breaking-changes",level:2},{value:"Context refactoring",id:"context-refactoring",level:2}],d={toc:p};function c(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"20-release"},"2.0 Release"),(0,a.kt)("p",null,"Join our ",(0,a.kt)("a",{parentName:"p",href:"https://sern.dev/discord"},"discord"),"! ",(0,a.kt)("br",null),"\nWow! We're finally increasing our semantic versioning by +",(0,a.kt)("inlineCode",{parentName:"p"},"1.7.9.")," ",(0,a.kt)("br",null),"\nWhat does this mean?"),(0,a.kt)("h3",{id:"plugin-support-for-event-modules"},"Plugin Support for Event Modules"),(0,a.kt)("p",null,"You can now use plugins for event modules. Previous version would throw an error if the\n",(0,a.kt)("inlineCode",{parentName:"p"},"plugins")," field was populated."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export function commandPlTest() : SernEmitterPlugin {\n return {\n type: PluginType.Command,\n execute: ({ mod}, controller) => {\n if(mod.name === 'module.register') {\n console.log('Event Module created correctly')\n return controller.next()\n }\n console.log('event name is wrong')\n return controller.stop()\n }\n }\n}\n")),(0,a.kt)("p",null,"Applying this plugin to some ",(0,a.kt)("inlineCode",{parentName:"p"},"eventModule"),": "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export default eventModule({\n name: 'error',\n type: EventType.Sern,\n plugins: [commandPlTest()],\n execute(m) {\n console.log(m)\n },\n})\n")),(0,a.kt)("h2",{id:"dependency-injection-and-decoupling"},"Dependency Injection and Decoupling"),(0,a.kt)("p",null,"The powerful npm package ",(0,a.kt)("inlineCode",{parentName:"p"},"iti")," decouples sern even more.\nDecoupling data structures with the Inversion of Control pattern separates data from logic, which will help speed production\nand make sern even more customizable than before."),(0,a.kt)("h3",{id:"how-do-i-start"},"How do I start?"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript",metastring:'title="src/index.ts"',title:'"src/index.ts"'},"//With typescript, you can customize / augment your typings.\ninterface MyDependencies extends Dependencies {\n '@sern/client' : Singleton;\n '@sern/logger' : Singleton\n}\n\nexport const useContainer = Sern.makeDependencies({\n// exclude: new Set(['@sern/logger']), don't autofill optional dependencies\n build: root => root\n .add({ '@sern/client': single(client) }) \n .add({ '@sern/logger': single(new DefaultLogging()) })\n});\n\nSern.init({\n defaultPrefix: '!', // removing defaultPrefix will shut down text commands\n commands: 'src/commands',\n // events: 'src/events' (optional),\n containerConfig : {\n get: useContainer //pass in your dependency getter here\n }\n});\n\n")),(0,a.kt)("p",null,"Using the ",(0,a.kt)("inlineCode",{parentName:"p"},"Sern#makeDependencies")," function, inject your dependencies.\nWe'll use specific dependencies that are created with the ",(0,a.kt)("inlineCode",{parentName:"p"},"@sern/keyword"),"\nkey.\nUsing typescript to display all ",(0,a.kt)("inlineCode",{parentName:"p"},"keywords")," and what they represent:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export interface Dependencies {\n '@sern/client': Singleton; //Discord Client\n '@sern/logger'?: Singleton; //Logger\n '@sern/emitter': Singleton; //SernEmitter\n '@sern/store' : Singleton; //Stores all Command Modules\n '@sern/modules' : Singleton; //Manages Modules\n '@sern/errors': Singleton; //A Lifetime / Crash Handler\n}\n")),(0,a.kt)("admonition",{type:"danger"},(0,a.kt)("p",{parentName:"admonition"},"Sern#addExternal has been deprecated and removed in favor of Sern#makeDependencies")),(0,a.kt)("p",null,"At the moment, one optional dependency, ",(0,a.kt)("inlineCode",{parentName:"p"},"@sern/logger"),", exists. If not added explicitly,\nwe'll ",(0,a.kt)("strong",{parentName:"p"},"autofill")," with a ",(0,a.kt)("a",{parentName:"p",href:"https://sern.dev/docs/api/classes/defaultlogging"},"DefaultLogger"),"."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"If you don't want a logger, add it to the\n",(0,a.kt)("inlineCode",{parentName:"p"},"exclude")," field while composing dependencies.")),(0,a.kt)("p",null,"Use your generated dependency getter ",(0,a.kt)("inlineCode",{parentName:"p"},"useContainer")," (use whatever name you want), access them\nfrom anywhere."),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"the function ",(0,a.kt)("a",{parentName:"p",href:"https://sern.dev/docs/api/modules#usecontainerraw"},"useContainerRaw")," is provided for direct access to dependencies and the internal\ndata structure. Use this wisely as no guarantees are made and crashes can happen.")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"build")," field follows ",(0,a.kt)("a",{parentName:"p",href:"https://itijs.org/docs/quick-start#usage"},"createContainer")," function call."),(0,a.kt)("h2",{id:"new-commandtypes"},"New CommandTypes"),(0,a.kt)("p",null,"2.0 includes all the new role select menus. ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.MenuSelect")," has been renamed into\n",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.StringSelect"),". The remaining SelectMenus are\n",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.RoleSelect"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.ChannelSelect"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.UserSelect"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandType.MentionableSelect")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript",metastring:'title="commands/roleselect.ts"',title:'"commands/roleselect.ts"'},"export default commandModule({\n type: CommandType.RoleSelect,\n execute(ctx) {\n ctx.reply('role select')\n },\n})\n")),(0,a.kt)("p",null,"In addition, commandModules with ContextMenus have been renamed."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"- CommandType.MenuUser, CommandType.MenuMsg \n+ CommandType.CtxUser, CommandType.CtxMsg\n")),(0,a.kt)("h2",{id:"typings-simplification"},"Typings Simplification"),(0,a.kt)("p",null,"Pre 2.0: "),(0,a.kt)("img",{src:"https://cdn.discordapp.com/attachments/820348341358952550/1038577974829666386/image.png"}),(0,a.kt)("br",null)," ",(0,a.kt)("br",null)," ",(0,a.kt)("br",null),"Post 2.0:",(0,a.kt)("br",null),(0,a.kt)("img",{src:"https://cdn.discordapp.com/attachments/820348341358952550/1052623728489550015/image.png"}),(0,a.kt)("p",null,"CommandPlugin"," and EventPlugin"," typings have also been static'ified, transformed from types to interfaces"),(0,a.kt)("h2",{id:"breaking-changes"},"Breaking Changes"),(0,a.kt)("img",{src:"https://img.srizan.ml/Discord_z8Sn1UBfEe.png"}),(0,a.kt)("br",null),"All deprecation warnings from previous versions have taken effect, and are removed in 2.0.",(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"- type Module = EventModule | CommandModule\n+ type AnyModule = EventModule | CommandModule\n\n-export type SpreadParams unknown> = (\n- args: Parameters[number],\n- ) => unknown;\n")),(0,a.kt)("p",null,"Override type has been removed due to redundancy"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"- discord.js : 14.5\n+ discord.js : 14.7\n\n-typescript: 4.7\n+ typescript: 4.9\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"+ interface Wrapper {\n+ readonly defaultPrefix?: string;\n+ readonly commands: string;\n+ readonly events?: string;\n+ readonly containerConfig : {\n+ get: (...keys: (keyof Dependencies)[]) => unknown[];\n+ }\n+}\n\n- interface Wrapper {\n- readonly client: Client;\n- readonly sernEmitter?: SernEmitter;\n- readonly defaultPrefix?: string;\n- readonly commands: string;\n- readonly events?:\n- | string\n- | { mod: EventModule; absPath: string }[]\n- | (() => { mod: EventModule; absPath: string }[]);\n-}\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"+ DefaultLogger\n+ DefaultModuleManager\n+ SernEmitter\n+ DefaultErrorHandling\n+ type Singleton = () => T\n+ type Transient = () => () => T; \n+ type LogPayload = { message: T }\n+ export const single = () => T\n+ export const many = () => () => T\n")),(0,a.kt)("p",null,"Including the previous section, some names to symbols and data structures were altered to\nbe better represented. view ",(0,a.kt)("a",{parentName:"p",href:"/404.html"},"changelog")),(0,a.kt)("h2",{id:"context-refactoring"},"Context refactoring"),(0,a.kt)("p",null,"The context data structure has been internally altered to represent its dynamics better."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/67348500.d93d35df.js b/assets/js/67348500.d93d35df.js deleted file mode 100644 index af9fb42bf..000000000 --- a/assets/js/67348500.d93d35df.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[2072],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},c=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,l=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=u(n),m=o,g=d["".concat(s,".").concat(m)]||d[m]||p[m]||l;return n?r.createElement(g,a(a({ref:t},c),{},{components:n})):r.createElement(g,a({ref:t},c))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var l=n.length,a=new Array(l);a[0]=d;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i.mdxType="string"==typeof e?e:o,a[1]=i;for(var u=2;u{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>p,frontMatter:()=>l,metadata:()=>i,toc:()=>u});var r=n(7462),o=(n(7294),n(3905));const l={slug:"2.0.0",title:"Release 2.0.0",authors:["jacoobes"],tags:["release"]},a=void 0,i={permalink:"/blog/2.0.0",editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-12-13-mdx-blog-post.md",source:"@site/blog/2022-12-13-mdx-blog-post.md",title:"Release 2.0.0",description:"2.0 Release",date:"2022-12-13T00:00:00.000Z",formattedDate:"December 13, 2022",tags:[{label:"release",permalink:"/blog/tags/release"}],readingTime:.63,hasTruncateMarker:!1,authors:[{name:"jacoobes",title:"Head Dev",url:"https://github.com/jacoobes",imageURL:"https://github.com/jacoobes.png",key:"jacoobes"}],frontMatter:{slug:"2.0.0",title:"Release 2.0.0",authors:["jacoobes"],tags:["release"]},nextItem:{title:"How to get started with sern!",permalink:"/blog/getting-started"}},s={authorsImageUrls:[void 0]},u=[{value:"2.0 Release",id:"20-release",level:2},{value:"Plugin Support for Event Modules",id:"plugin-support-for-event-modules",level:3},{value:"Dependency Injection and Decoupling",id:"dependency-injection-and-decoupling",level:2}],c={toc:u};function p(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"20-release"},"2.0 Release"),(0,o.kt)("p",null,"Wow! We're finally increasing our semantic versioning by +",(0,o.kt)("inlineCode",{parentName:"p"},"1.7.9.")," ",(0,o.kt)("br",null),"\nWhat does this mean?"),(0,o.kt)("h3",{id:"plugin-support-for-event-modules"},"Plugin Support for Event Modules"),(0,o.kt)("p",null,"You can now use plugins for event modules. Previous version would throw an error if the\n",(0,o.kt)("inlineCode",{parentName:"p"},"plugins")," field was populated."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export function commandPlTest() : SernEmitterPlugin {\n return {\n type: PluginType.Command,\n execute: ({ mod}, controller) => {\n if(mod.name === 'module.register') {\n console.log('Event Module created correctly')\n return controller.next()\n }\n console.log('event name is wrong')\n return controller.stop()\n }\n }\n}\n")),(0,o.kt)("p",null,"Applying this plugin to some ",(0,o.kt)("inlineCode",{parentName:"p"},"eventModule"),": "),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export default eventModule({\n name: 'error',\n type: EventType.Sern,\n plugins: [commandPlTest()],\n execute(m) {\n console.log(m)\n },\n})\n")),(0,o.kt)("h2",{id:"dependency-injection-and-decoupling"},"Dependency Injection and Decoupling"),(0,o.kt)("p",null,"THIS SECTION IS PROBABLY THE MOST IMPORTANT!! ",(0,o.kt)("br",null),"\ni should have eaten something before i feel hungry"))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/67e3e25a.b255c659.js b/assets/js/67e3e25a.b255c659.js new file mode 100644 index 000000000..6e8156e4c --- /dev/null +++ b/assets/js/67e3e25a.b255c659.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[1003],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>c});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function d(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var i=a.createContext({}),m=function(e){var t=a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):d(d({},t),e)),n},p=function(e){var t=m(e.components);return a.createElement(i.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,i=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),u=m(n),c=r,k=u["".concat(i,".").concat(c)]||u[c]||s[c]||l;return n?a.createElement(k,d(d({ref:t},p),{},{components:n})):a.createElement(k,d({ref:t},p))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,d=new Array(l);d[0]=u;var o={};for(var i in t)hasOwnProperty.call(t,i)&&(o[i]=t[i]);o.originalType=e,o.mdxType="string"==typeof e?e:r,d[1]=o;for(var m=2;m{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>d,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var a=n(7462),r=(n(7294),n(3905));const l={id:"ModuleStore",title:"Class: ModuleStore",sidebar_label:"ModuleStore",sidebar_position:0,custom_edit_url:null},d=void 0,o={unversionedId:"api/classes/ModuleStore",id:"api/classes/ModuleStore",title:"Class: ModuleStore",description:"Storing all command modules",source:"@site/docs/api/classes/ModuleStore.md",sourceDirName:"api/classes",slug:"/api/classes/ModuleStore",permalink:"/docs/api/classes/ModuleStore",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ModuleStore",title:"Class: ModuleStore",sidebar_label:"ModuleStore",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EventExecutable",permalink:"/docs/api/classes/EventExecutable"},next:{title:"SernEmitter",permalink:"/docs/api/classes/SernEmitter"}},i={},m=[{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Properties",id:"properties",level:2},{value:"ApplicationCommands",id:"applicationcommands",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"BothCommands",id:"bothcommands",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"InteractionHandlers",id:"interactionhandlers",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"ModalSubmit",id:"modalsubmit",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"TextCommands",id:"textcommands",level:3},{value:"Defined in",id:"defined-in-4",level:4}],p={toc:m};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,"Storing all command modules\nThis dependency is usually injected into ModuleManager"),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new ModuleStore"),"()"),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"applicationcommands"},"ApplicationCommands"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"ApplicationCommands"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"2")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"3")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/moduleStore.ts#L10"},"src/handler/structures/moduleStore.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"bothcommands"},"BothCommands"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"BothCommands"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/moduleStore.ts#L9"},"src/handler/structures/moduleStore.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"interactionhandlers"},"InteractionHandlers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"InteractionHandlers"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"2")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"3")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"5")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"6")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"7")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"8")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/moduleStore.ts#L17"},"src/handler/structures/moduleStore.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"modalsubmit"},"ModalSubmit"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"ModalSubmit"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/moduleStore.ts#L15"},"src/handler/structures/moduleStore.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"textcommands"},"TextCommands"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"TextCommands"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Map"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModule")),">"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/moduleStore.ts#L16"},"src/handler/structures/moduleStore.ts:16")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6c624b4c.4d15c544.js b/assets/js/6c624b4c.4d15c544.js deleted file mode 100644 index 7f6615d16..000000000 --- a/assets/js/6c624b4c.4d15c544.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4332],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>c});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),s=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(o.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),u=s(n),c=a,k=u["".concat(o,".").concat(c)]||u[c]||m[c]||l;return n?r.createElement(k,i(i({ref:t},d),{},{components:n})):r.createElement(k,i({ref:t},d))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,i=new Array(l);i[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:a,i[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var r=n(7462),a=(n(7294),n(3905));const l={id:"CommandExecutable",title:"Class: CommandExecutable",sidebar_label:"CommandExecutable",sidebar_position:0,custom_edit_url:null},i=void 0,p={unversionedId:"api/classes/CommandExecutable",id:"api/classes/CommandExecutable",title:"Class: CommandExecutable",description:"Type parameters",source:"@site/docs/api/classes/CommandExecutable.md",sourceDirName:"api/classes",slug:"/api/classes/CommandExecutable",permalink:"/docs/api/classes/CommandExecutable",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandExecutable",title:"Class: CommandExecutable",sidebar_label:"CommandExecutable",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PluginType",permalink:"/docs/api/enums/PluginType"},next:{title:"Context",permalink:"/docs/api/classes/Context"}},o={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Properties",id:"properties",level:2},{value:"execute",id:"execute",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:s};function m(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Type")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/enums/CommandType"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandType")))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new CommandExecutable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),">","()"),(0,a.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Type")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/enums/CommandType"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandType")))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,a.kt)("strong",{parentName:"p"},"execute"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CommandModuleDefs"),"[",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),'][``"execute"``]'),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L132"},"src/handler/sern.ts:132")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#eventplugin"},(0,a.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),">","[] = ",(0,a.kt)("inlineCode",{parentName:"p"},"[]")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L131"},"src/handler/sern.ts:131")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#commandplugin"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),">","[] = ",(0,a.kt)("inlineCode",{parentName:"p"},"[]")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L130"},"src/handler/sern.ts:130")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L129"},"src/handler/sern.ts:129")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6c624b4c.8bd3eaba.js b/assets/js/6c624b4c.8bd3eaba.js new file mode 100644 index 000000000..9fa6f5a52 --- /dev/null +++ b/assets/js/6c624b4c.8bd3eaba.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4332],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),d=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(o.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=d(n),u=r,f=m["".concat(o,".").concat(u)]||m[u]||c[u]||l;return n?a.createElement(f,i(i({ref:t},s),{},{components:n})):a.createElement(f,i({ref:t},s))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:r,i[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>c,frontMatter:()=>l,metadata:()=>p,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const l={id:"CommandExecutable",title:"Class: CommandExecutable",sidebar_label:"CommandExecutable",sidebar_position:0,custom_edit_url:null},i=void 0,p={unversionedId:"api/classes/CommandExecutable",id:"api/classes/CommandExecutable",title:"Class: CommandExecutable",description:"Type parameters",source:"@site/docs/api/classes/CommandExecutable.md",sourceDirName:"api/classes",slug:"/api/classes/CommandExecutable",permalink:"/docs/api/classes/CommandExecutable",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandExecutable",title:"Class: CommandExecutable",sidebar_label:"CommandExecutable",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PluginType",permalink:"/docs/api/enums/PluginType"},next:{title:"Context",permalink:"/docs/api/classes/Context"}},o={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Properties",id:"properties",level:2},{value:"execute",id:"execute",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:d};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Type")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/CommandType"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandType")))))),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new CommandExecutable"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Type"),">","()"),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Type")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/CommandType"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandType")))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,r.kt)("strong",{parentName:"p"},"execute"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"p"},"Type"),'][``"execute"``]'),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L101"},"src/handler/sern.ts:101")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onevent"},"onEvent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Type"),">","[] = ",(0,r.kt)("inlineCode",{parentName:"p"},"[]")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L100"},"src/handler/sern.ts:100")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"plugins"},"plugins"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"plugins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Type"),">","[] = ",(0,r.kt)("inlineCode",{parentName:"p"},"[]")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L99"},"src/handler/sern.ts:99")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Type")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L98"},"src/handler/sern.ts:98")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6ff82968.c7adaa2e.js b/assets/js/6ff82968.c7adaa2e.js new file mode 100644 index 000000000..13f00a9d7 --- /dev/null +++ b/assets/js/6ff82968.c7adaa2e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[3462],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=o(n),u=r,f=c["".concat(p,".").concat(u)]||c[u]||m[u]||i;return n?a.createElement(f,l(l({ref:t},s),{},{components:n})):a.createElement(f,l({ref:t},s))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=c;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(7462),r=(n(7294),n(3905));const i={id:"TextCommand",title:"Interface: TextCommand",sidebar_label:"TextCommand",sidebar_position:0,custom_edit_url:null},l=void 0,d={unversionedId:"api/interfaces/TextCommand",id:"api/interfaces/TextCommand",title:"Interface: TextCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/TextCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/TextCommand",permalink:"/docs/api/interfaces/TextCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"TextCommand",title:"Interface: TextCommand",sidebar_label:"TextCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"StringSelectCommand",permalink:"/docs/api/interfaces/StringSelectCommand"},next:{title:"UserSelectCommand",permalink:"/docs/api/interfaces/UserSelectCommand"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alias",id:"alias",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:o};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,r.kt)("inlineCode",{parentName:"a"},"Module"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TextCommand"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"alias"},"alias"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"alias"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L46"},"src/types/module.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,r.kt)("inlineCode",{parentName:"a"},"Context")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),": [",(0,r.kt)("inlineCode",{parentName:"p"},'"text"'),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]]) => ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/Context"},(0,r.kt)("inlineCode",{parentName:"a"},"Context")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[",(0,r.kt)("inlineCode",{parentName:"td"},'"text"'),", ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]]")))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L47"},"src/types/module.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onevent"},"onEvent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),">","[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L44"},"src/types/module.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"plugins"},"plugins"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"plugins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L45"},"src/types/module.ts:45")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text"))),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L43"},"src/types/module.ts:43")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/701614d9.4bd86165.js b/assets/js/701614d9.4bd86165.js new file mode 100644 index 000000000..89d95ea00 --- /dev/null +++ b/assets/js/701614d9.4bd86165.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4e3],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),o=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=o(e.components);return r.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),u=o(n),c=a,k=u["".concat(d,".").concat(c)]||u[c]||s[c]||i;return n?r.createElement(k,l(l({ref:t},m),{},{components:n})):r.createElement(k,l({ref:t},m))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=u;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=n(7462),a=(n(7294),n(3905));const i={id:"ExternalEmitterPlugin",title:"Interface: ExternalEmitterPlugin",sidebar_label:"ExternalEmitterPlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/ExternalEmitterPlugin",id:"api/interfaces/ExternalEmitterPlugin",title:"Interface: ExternalEmitterPlugin",description:"Hierarchy",source:"@site/docs/api/interfaces/ExternalEmitterPlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ExternalEmitterPlugin",permalink:"/docs/api/interfaces/ExternalEmitterPlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ExternalEmitterPlugin",title:"Interface: ExternalEmitterPlugin",sidebar_label:"ExternalEmitterPlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EventPlugin",permalink:"/docs/api/interfaces/EventPlugin"},next:{title:"ExternalEventPlugin",permalink:"/docs/api/interfaces/ExternalEventPlugin"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:o};function s(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,a.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ExternalEmitterPlugin"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),": { ",(0,a.kt)("inlineCode",{parentName:"p"},"absPath"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"mod"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ExternalEventCommand")," & { ",(0,a.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," } }, ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload.absPath")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload.mod")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ExternalEventCommand")," & { ",(0,a.kt)("inlineCode",{parentName:"td"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"controller")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L57"},"src/handler/plugins/plugin.ts:57")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31"},"src/handler/plugins/plugin.ts:31")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#command"},(0,a.kt)("inlineCode",{parentName:"a"},"Command"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L56"},"src/handler/plugins/plugin.ts:56")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/707baeff.367c3cac.js b/assets/js/707baeff.367c3cac.js deleted file mode 100644 index 21c438125..000000000 --- a/assets/js/707baeff.367c3cac.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9226],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>m});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},u=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},c=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),c=p(t),m=a,f=c["".concat(s,".").concat(m)]||c[m]||d[m]||i;return t?r.createElement(f,l(l({ref:n},u),{},{components:t})):r.createElement(f,l({ref:n},u))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,l=new Array(i);l[0]=c;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=t(7462),a=(t(7294),t(3905));const i={id:"EventType",title:"Enumeration: EventType",sidebar_label:"EventType",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/enums/EventType",id:"api/enums/EventType",title:"Enumeration: EventType",description:"Example",source:"@site/docs/api/enums/EventType.md",sourceDirName:"api/enums",slug:"/api/enums/EventType",permalink:"/docs/api/enums/EventType",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EventType",title:"Enumeration: EventType",sidebar_label:"EventType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CommandType",permalink:"/docs/api/enums/CommandType"},next:{title:"PayloadType",permalink:"/docs/api/enums/PayloadType"}},s={},p=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Discord",id:"discord",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"External",id:"external",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Sern",id:"sern",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:p};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export default eventModule({\n //highlight-next-line\n type : EventType.Discord,\n name : 'guildMemberAdd'\n execute(member : GuildMember) {\n console.log(member)\n }\n})\n")),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"discord"},"Discord"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Discord")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"1")),(0,a.kt)("p",null,"The EventType for handling discord events"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L68"},"src/handler/structures/enums.ts:68")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"external"},"External"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"External")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"3")),(0,a.kt)("p",null,"The EventType for handling external events.\nCould be for example, ",(0,a.kt)("inlineCode",{parentName:"p"},"process")," events, database events"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L77"},"src/handler/structures/enums.ts:77")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sern"},"Sern"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Sern")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"2")),(0,a.kt)("p",null,"The EventType for handling sern events"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L72"},"src/handler/structures/enums.ts:72")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/707baeff.d3158cdc.js b/assets/js/707baeff.d3158cdc.js new file mode 100644 index 000000000..2b09df78d --- /dev/null +++ b/assets/js/707baeff.d3158cdc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9226],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>m});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),p=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},u=function(e){var n=p(e.components);return r.createElement(s.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},c=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),c=p(t),m=a,f=c["".concat(s,".").concat(m)]||c[m]||d[m]||i;return t?r.createElement(f,l(l({ref:n},u),{},{components:t})):r.createElement(f,l({ref:n},u))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,l=new Array(i);l[0]=c;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=t(7462),a=(t(7294),t(3905));const i={id:"EventType",title:"Enumeration: EventType",sidebar_label:"EventType",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/enums/EventType",id:"api/enums/EventType",title:"Enumeration: EventType",description:"A bitfield that discriminates event modules",source:"@site/docs/api/enums/EventType.md",sourceDirName:"api/enums",slug:"/api/enums/EventType",permalink:"/docs/api/enums/EventType",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EventType",title:"Enumeration: EventType",sidebar_label:"EventType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CommandType",permalink:"/docs/api/enums/CommandType"},next:{title:"PayloadType",permalink:"/docs/api/enums/PayloadType"}},s={},p=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Discord",id:"discord",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"External",id:"external",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Sern",id:"sern",level:3},{value:"Defined in",id:"defined-in-2",level:4}],u={toc:p};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"A bitfield that discriminates event modules"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export default eventModule({\n //highlight-next-line\n type : EventType.Discord,\n name : 'guildMemberAdd'\n execute(member : GuildMember) {\n console.log(member)\n }\n})\n")),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"discord"},"Discord"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Discord")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"1")),(0,a.kt)("p",null,"The EventType for handling discord events"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L77"},"src/handler/structures/enums.ts:77")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"external"},"External"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"External")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"3")),(0,a.kt)("p",null,"The EventType for handling external events.\nCould be for example, ",(0,a.kt)("inlineCode",{parentName:"p"},"process")," events, database events"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L86"},"src/handler/structures/enums.ts:86")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sern"},"Sern"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Sern")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"2")),(0,a.kt)("p",null,"The EventType for handling sern events"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L81"},"src/handler/structures/enums.ts:81")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/720cd117.da302bd7.js b/assets/js/720cd117.da302bd7.js new file mode 100644 index 000000000..afef3b892 --- /dev/null +++ b/assets/js/720cd117.da302bd7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[6777],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),o=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=o(e.components);return r.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),u=o(n),c=a,k=u["".concat(d,".").concat(c)]||u[c]||s[c]||i;return n?r.createElement(k,l(l({ref:t},m),{},{components:n})):r.createElement(k,l({ref:t},m))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=u;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=n(7462),a=(n(7294),n(3905));const i={id:"SernEmitterPlugin",title:"Interface: SernEmitterPlugin",sidebar_label:"SernEmitterPlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/SernEmitterPlugin",id:"api/interfaces/SernEmitterPlugin",title:"Interface: SernEmitterPlugin",description:"Hierarchy",source:"@site/docs/api/interfaces/SernEmitterPlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SernEmitterPlugin",permalink:"/docs/api/interfaces/SernEmitterPlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SernEmitterPlugin",title:"Interface: SernEmitterPlugin",sidebar_label:"SernEmitterPlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SernAutocompleteData",permalink:"/docs/api/interfaces/SernAutocompleteData"},next:{title:"SernEventPlugin",permalink:"/docs/api/interfaces/SernEventPlugin"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:o};function s(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,a.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SernEmitterPlugin"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),": { ",(0,a.kt)("inlineCode",{parentName:"p"},"absPath"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,a.kt)("inlineCode",{parentName:"p"},"mod"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"SernEventCommand"),""," & { ",(0,a.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")," } }, ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload.absPath")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"payload.mod")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"SernEventCommand"),""," & { ",(0,a.kt)("inlineCode",{parentName:"td"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"controller")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L65"},"src/handler/plugins/plugin.ts:65")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31"},"src/handler/plugins/plugin.ts:31")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#command"},(0,a.kt)("inlineCode",{parentName:"a"},"Command"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L64"},"src/handler/plugins/plugin.ts:64")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/73bd57bd.383ce150.js b/assets/js/73bd57bd.383ce150.js deleted file mode 100644 index 758e09232..000000000 --- a/assets/js/73bd57bd.383ce150.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[332],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),o=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),c=o(n),u=r,k=c["".concat(d,".").concat(u)]||c[u]||m[u]||l;return n?a.createElement(k,i(i({ref:t},s),{},{components:n})):a.createElement(k,i({ref:t},s))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=n.length,i=new Array(l);i[0]=c;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,i[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>p,toc:()=>o});var a=n(7462),r=(n(7294),n(3905));const l={id:"Sern",title:"Namespace: Sern",sidebar_label:"Sern",sidebar_position:0,custom_edit_url:null},i=void 0,p={unversionedId:"api/namespaces/Sern",id:"api/namespaces/Sern",title:"Namespace: Sern",description:"References",source:"@site/docs/api/namespaces/Sern.md",sourceDirName:"api/namespaces",slug:"/api/namespaces/Sern",permalink:"/docs/api/namespaces/Sern",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Sern",title:"Namespace: Sern",sidebar_label:"Sern",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Exports",permalink:"/docs/api/modules"},next:{title:"CommandType",permalink:"/docs/api/enums/CommandType"}},d={},o=[{value:"References",id:"references",level:2},{value:"CommandExecutable",id:"commandexecutable",level:3},{value:"EventExecutable",id:"eventexecutable",level:3},{value:"commandModule",id:"commandmodule",level:3},{value:"eventModule",id:"eventmodule",level:3},{value:"Variables",id:"variables",level:2},{value:"controller",id:"controller",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Functions",id:"functions",level:2},{value:"addExternal",id:"addexternal",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"init",id:"init",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],s={toc:o};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"references"},"References"),(0,r.kt)("h3",{id:"commandexecutable"},"CommandExecutable"),(0,r.kt)("p",null,"Re-exports ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/CommandExecutable"},"CommandExecutable")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"eventexecutable"},"EventExecutable"),(0,r.kt)("p",null,"Re-exports ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/EventExecutable"},"EventExecutable")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"commandmodule"},"commandModule"),(0,r.kt)("p",null,"Re-exports ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule"},"commandModule")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"eventmodule"},"eventModule"),(0,r.kt)("p",null,"Re-exports ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodule"},"eventModule")),(0,r.kt)("h2",{id:"variables"},"Variables"),(0,r.kt)("h3",{id:"controller"},"controller"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"controller"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The object passed into every plugin to control a command's behavior"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"next")),(0,r.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,r.kt)("inlineCode",{parentName:"td"},"OkImpl"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"void"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stop")),(0,r.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,r.kt)("inlineCode",{parentName:"td"},"ErrImpl"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"void"),">")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L82"},"src/handler/sern.ts:82")),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"addexternal"},"addExternal"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addExternal"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"use Sern#makeDependencies instead")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts",metastring:'title="src/index.ts"',title:'"src/index.ts"'},"//Add this before initiating Sern!\nSern.addExternal(new Level())\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts",metastring:'title="events/level.ts"',title:'"events/level.ts"'}," export default eventModule({\n emitter: 'Level',\n type : EventType.External,\n name: 'error',\n execute(args) {\n console.log(args)\n }\n })\n")),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"__module"))))),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Any external event emitter. The object will be stored in a map, and then fetched by the name of the instance's class. As there are infinite possibilities to adding external event emitters, Most types aren't provided and are as narrow as possibly can.")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L72"},"src/handler/sern.ts:72")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"init"},"init"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"init"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"wrapper"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts",metastring:'title="src/index.ts"',title:'"src/index.ts"'},"Sern.init({\n client,\n defaultPrefix: '!',\n commands: 'dist/commands',\n})\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Wrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"Wrapper"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options to pass into sern. Function to start the handler up")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L39"},"src/handler/sern.ts:39")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/73bd57bd.4f935080.js b/assets/js/73bd57bd.4f935080.js new file mode 100644 index 000000000..d2cd96a1c --- /dev/null +++ b/assets/js/73bd57bd.4f935080.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[332],{3905:(e,t,a)=>{a.d(t,{Zo:()=>m,kt:()=>c});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},m=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),k=o(a),c=r,u=k["".concat(d,".").concat(c)]||k[c]||s[c]||l;return a?n.createElement(u,i(i({ref:t},m),{},{components:a})):n.createElement(u,i({ref:t},m))}));function c(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=k;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,i[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const l={id:"Sern",title:"Namespace: Sern",sidebar_label:"Sern",sidebar_position:0,custom_edit_url:null},i=void 0,p={unversionedId:"api/namespaces/Sern",id:"api/namespaces/Sern",title:"Namespace: Sern",description:"References",source:"@site/docs/api/namespaces/Sern.md",sourceDirName:"api/namespaces",slug:"/api/namespaces/Sern",permalink:"/docs/api/namespaces/Sern",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Sern",title:"Namespace: Sern",sidebar_label:"Sern",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Exports",permalink:"/docs/api/modules"},next:{title:"CommandType",permalink:"/docs/api/enums/CommandType"}},d={},o=[{value:"References",id:"references",level:2},{value:"CommandExecutable",id:"commandexecutable",level:3},{value:"EventExecutable",id:"eventexecutable",level:3},{value:"commandModule",id:"commandmodule",level:3},{value:"eventModule",id:"eventmodule",level:3},{value:"Variables",id:"variables",level:2},{value:"controller",id:"controller",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Functions",id:"functions",level:2},{value:"init",id:"init",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"makeDependencies",id:"makedependencies",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Type parameters",id:"type-parameters-1",level:5},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-2",level:4}],m={toc:o};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"references"},"References"),(0,r.kt)("h3",{id:"commandexecutable"},"CommandExecutable"),(0,r.kt)("p",null,"Re-exports ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/CommandExecutable"},"CommandExecutable")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"eventexecutable"},"EventExecutable"),(0,r.kt)("p",null,"Re-exports ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/EventExecutable"},"EventExecutable")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"commandmodule"},"commandModule"),(0,r.kt)("p",null,"Re-exports ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule-1"},"commandModule")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"eventmodule"},"eventModule"),(0,r.kt)("p",null,"Re-exports ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodule-1"},"eventModule")),(0,r.kt)("h2",{id:"variables"},"Variables"),(0,r.kt)("h3",{id:"controller"},"controller"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"controller"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The object passed into every plugin to control a command's behavior"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"next")),(0,r.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,r.kt)("inlineCode",{parentName:"td"},"OkImpl"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"void"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stop")),(0,r.kt)("td",{parentName:"tr",align:"left"},"() => ",(0,r.kt)("inlineCode",{parentName:"td"},"ErrImpl"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"void"),">")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L55"},"src/handler/sern.ts:55")),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"init"},"init"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"init"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"wrapper"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts",metastring:'title="src/index.ts"',title:'"src/index.ts"'},"Sern.init({\n defaultPrefix: '!',\n commands: 'dist/commands',\n events: 'dist/events',\n containerConfig : {\n get: useContainer\n }\n})\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Wrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"Wrapper"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options to pass into sern. Function to start the handler up")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L38"},"src/handler/sern.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"makedependencies"},"makeDependencies"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"makeDependencies"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"conf"),"): ","(...",(0,r.kt)("inlineCode",{parentName:"p"},"keys"),": [...V[]]) => ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#mapdeps"},(0,r.kt)("inlineCode",{parentName:"a"},"MapDeps")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"V"),">"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Dependencies"},(0,r.kt)("inlineCode",{parentName:"a"},"Dependencies")))))),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"conf")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"a configuration for creating your project dependencies")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"conf.build")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"root"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Container"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"unknown"),">",", {}",">",") => ",(0,r.kt)("inlineCode",{parentName:"td"},"Container"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",", {}",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"conf.exclude?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Set"),(0,r.kt)("a",{parentName:"td",href:"mailto:%60%60%22@sern/logger%22%60%60%5C"},'``"@sern/logger"``\\')),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"fn")),(0,r.kt)("p",null,"\u25b8 <",(0,r.kt)("inlineCode",{parentName:"p"},"V"),">","(...",(0,r.kt)("inlineCode",{parentName:"p"},"keys"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#mapdeps"},(0,r.kt)("inlineCode",{parentName:"a"},"MapDeps")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"V"),">"),(0,r.kt)("h5",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"V")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,r.kt)("h5",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...keys")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[...V[]]")))),(0,r.kt)("h5",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#mapdeps"},(0,r.kt)("inlineCode",{parentName:"a"},"MapDeps")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"V"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L87"},"src/handler/sern.ts:87")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/79e7cc44.5447ffc4.js b/assets/js/79e7cc44.5447ffc4.js new file mode 100644 index 000000000..52f233a01 --- /dev/null +++ b/assets/js/79e7cc44.5447ffc4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4009],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),o=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return r.createElement(d.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=o(n),c=a,k=m["".concat(d,".").concat(c)]||m[c]||u[c]||i;return n?r.createElement(k,l(l({ref:t},s),{},{components:n})):r.createElement(k,l({ref:t},s))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=n(7462),a=(n(7294),n(3905));const i={id:"SernEventPlugin",title:"Interface: SernEventPlugin",sidebar_label:"SernEventPlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/SernEventPlugin",id:"api/interfaces/SernEventPlugin",title:"Interface: SernEventPlugin",description:"Type parameters",source:"@site/docs/api/interfaces/SernEventPlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/SernEventPlugin",permalink:"/docs/api/interfaces/SernEventPlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SernEventPlugin",title:"Interface: SernEventPlugin",sidebar_label:"SernEventPlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SernEmitterPlugin",permalink:"/docs/api/interfaces/SernEmitterPlugin"},next:{title:"SernSubCommandData",permalink:"/docs/api/interfaces/SernSubCommandData"}},d={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:o};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,a.kt)("inlineCode",{parentName:"a"},"SernEventsMapping"))," = keyof ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,a.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")))))),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,a.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"SernEventPlugin"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#serneventsmapping"},(0,a.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,a.kt)("inlineCode",{parentName:"p"},"T"),"]",", ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"args"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"args")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,a.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,a.kt)("inlineCode",{parentName:"td"},"T"),"]")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"controller")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L91"},"src/handler/plugins/plugin.ts:91")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"T")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L89"},"src/handler/plugins/plugin.ts:89")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L90"},"src/handler/plugins/plugin.ts:90")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7cd974c8.6a16f6e6.js b/assets/js/7cd974c8.6a16f6e6.js new file mode 100644 index 000000000..1d1c16263 --- /dev/null +++ b/assets/js/7cd974c8.6a16f6e6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[6054],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),d=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),c=d(n),m=a,f=c["".concat(o,".").concat(m)]||c[m]||u[m]||i;return n?r.createElement(f,l(l({ref:t},s),{},{components:n})):r.createElement(f,l({ref:t},s))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=c;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=n(7462),a=(n(7294),n(3905));const i={id:"ContextMenuMsg",title:"Interface: ContextMenuMsg",sidebar_label:"ContextMenuMsg",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/ContextMenuMsg",id:"api/interfaces/ContextMenuMsg",title:"Interface: ContextMenuMsg",description:"Hierarchy",source:"@site/docs/api/interfaces/ContextMenuMsg.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ContextMenuMsg",permalink:"/docs/api/interfaces/ContextMenuMsg",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ContextMenuMsg",title:"Interface: ContextMenuMsg",sidebar_label:"ContextMenuMsg",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CommandPlugin",permalink:"/docs/api/interfaces/CommandPlugin"},next:{title:"ContextMenuUser",permalink:"/docs/api/interfaces/ContextMenuUser"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:d};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,a.kt)("inlineCode",{parentName:"a"},"Module"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ContextMenuMsg"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"MessageContextMenuCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ctx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"MessageContextMenuCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L78"},"src/types/module.ts:78")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#ctxmsg"},(0,a.kt)("inlineCode",{parentName:"a"},"CtxMsg")),">","[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L76"},"src/types/module.ts:76")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L77"},"src/types/module.ts:77")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#ctxmsg"},(0,a.kt)("inlineCode",{parentName:"a"},"CtxMsg"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L75"},"src/types/module.ts:75")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7e205c4a.336cecb9.js b/assets/js/7e205c4a.336cecb9.js new file mode 100644 index 000000000..56dc11d9c --- /dev/null +++ b/assets/js/7e205c4a.336cecb9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7127],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>N});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,m=d(e,["components","mdxType","originalType","parentName"]),k=o(n),N=r,u=k["".concat(p,".").concat(N)]||k[N]||s[N]||i;return n?a.createElement(u,l(l({ref:t},m),{},{components:n})):a.createElement(u,l({ref:t},m))}));function N(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=k;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(7462),r=(n(7294),n(3905));const i={id:"SernEmitter",title:"Class: SernEmitter",sidebar_label:"SernEmitter",sidebar_position:0,custom_edit_url:null},l=void 0,d={unversionedId:"api/classes/SernEmitter",id:"api/classes/SernEmitter",title:"Class: SernEmitter",description:"Hierarchy",source:"@site/docs/api/classes/SernEmitter.md",sourceDirName:"api/classes",slug:"/api/classes/SernEmitter",permalink:"/docs/api/classes/SernEmitter",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SernEmitter",title:"Class: SernEmitter",sidebar_label:"SernEmitter",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ModuleStore",permalink:"/docs/api/classes/ModuleStore"},next:{title:"AutocompleteCommand",permalink:"/docs/api/interfaces/AutocompleteCommand"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"addListener",id:"addlistener",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"emit",id:"emit",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"eventNames",id:"eventnames",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getMaxListeners",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"listenerCount",id:"listenercount",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"listeners",id:"listeners",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"off",id:"off",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"on",id:"on",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"once",id:"once",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"prependListener",id:"prependlistener",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"prependOnceListener",id:"prependoncelistener",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"rawListeners",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"removeAllListeners",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"removeListener",id:"removelistener",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setMaxListeners",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"getEventListeners",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"listenerCount",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"on",id:"on-1",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"once",id:"once-1",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"setMaxListeners",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-27",level:4}],m={toc:o};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"SernEmitter"))))),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new SernEmitter"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),")"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitterOptions"))))),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:74"),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"capturerejectionsymbol"},"captureRejectionSymbol"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"captureRejectionSymbol"),": typeof ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter#capturerejectionsymbol"},(0,r.kt)("inlineCode",{parentName:"a"},"captureRejectionSymbol"))),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.captureRejectionSymbol"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:291"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"capturerejections"},"captureRejections"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"captureRejections"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Sets or gets the default captureRejection value for all emitters."),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.captureRejections"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:296"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"defaultmaxlisteners"},"defaultMaxListeners"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"defaultMaxListeners"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.defaultMaxListeners"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:297"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"errormonitor"},"errorMonitor"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"errorMonitor"),": typeof ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter#errormonitor"},(0,r.kt)("inlineCode",{parentName:"a"},"errorMonitor"))),(0,r.kt)("p",null,"This symbol shall be used to install a listener for only monitoring ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'"),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," listeners are called."),(0,r.kt)("p",null,"Installing a listener using this symbol does not change the behavior once an\n",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," event is emitted, therefore the process will still crash if no\nregular ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," listener is installed."),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.errorMonitor"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:290"),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"addlistener"},"addListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Alias for ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.on(eventName, listener)"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.1.26"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.addListener"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:317"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"emit"},"emit"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"emit"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ...",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Listening to sern events with on. This event stays on until a crash or a normal exit"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")))))),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the arguments for emitting the eventName")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"EventEmitter.emit"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sernEmitter.ts#L32"},"src/handler/sernEmitter.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"eventnames"},"eventNames"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"eventNames"),"(): (",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"symbol"),")[]"),(0,r.kt)("p",null,"Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,r.kt)("inlineCode",{parentName:"p"},"Symbol"),"s."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v6.0.0"),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,"(",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"symbol"),")[]"),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.eventNames"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:632"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmaxlisteners"},"getMaxListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMaxListeners"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Returns the current max listener value for the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," which is either\nset by ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.setMaxListeners(n)")," or defaults to ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter#defaultmaxlisteners"},"defaultMaxListeners"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v1.0.0"),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.getMaxListeners"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:489"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listenercount"},"listenerCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"listenerCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Returns the number of listeners listening to the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v3.2.0"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the event being listened for")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.listenerCount"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:579"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listeners"},"listeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"listeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("p",null,"Returns a copy of the array of listeners for the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.1.26"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.listeners"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:502"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off"},"off"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"off"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Alias for ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.removeListener()"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v10.0.0"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.off"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:462"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"on"},"on"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"on"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Listening to sern events with on. This event stays on until a crash or a normal exit"),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")))))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"][]",") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"what to do with the data")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,"EventEmitter.on"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sernEmitter.ts#L10"},"src/handler/sernEmitter.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"once"},"once"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"once"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Listening to sern events with on. This event stays on until a crash or a normal exit"),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"][]",") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"what to do with the data")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"overrides-2"},"Overrides"),(0,r.kt)("p",null,"EventEmitter.once"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sernEmitter.ts#L21"},"src/handler/sernEmitter.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"prependlistener"},"prependListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prependListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Adds the ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," function to the ",(0,r.kt)("em",{parentName:"p"},"beginning")," of the listeners array for the\nevent named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),". No checks are made to see if the ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," has\nalready been added. Multiple calls passing the same combination of ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"and ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," will result in the ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," being added, and called, multiple\ntimes."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n")),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v6.0.0"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the event.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The callback function")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.prependListener"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:597"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"prependoncelistener"},"prependOnceListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prependOnceListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Adds a ",(0,r.kt)("strong",{parentName:"p"},"one-time"),(0,r.kt)("inlineCode",{parentName:"p"},"listener")," function for the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName")," to the ",(0,r.kt)("em",{parentName:"p"},"beginning")," of the listeners array. The next time ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName")," is triggered, this\nlistener is removed, and then invoked."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n")),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v6.0.0"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the event.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The callback function")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.prependOnceListener"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:613"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rawlisteners"},"rawListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"rawListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("p",null,"Returns a copy of the array of listeners for the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),",\nincluding any wrappers (such as those created by ",(0,r.kt)("inlineCode",{parentName:"p"},".once()"),")."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v9.4.0"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.rawListeners"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:532"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removealllisteners"},"removeAllListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeAllListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"event?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Removes all listeners, or those of the specified ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("p",null,"It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.1.26"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"event?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.removeAllListeners"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:473"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removelistener"},"removeListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Removes the specified ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," from the listener array for the event named",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n")),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"removeListener()")," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", then ",(0,r.kt)("inlineCode",{parentName:"p"},"removeListener()")," must be\ncalled multiple times to remove each instance."),(0,r.kt)("p",null,"Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,r.kt)("inlineCode",{parentName:"p"},"removeListener()")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"removeAllListeners()")," calls ",(0,r.kt)("em",{parentName:"p"},"after")," emitting and ",(0,r.kt)("em",{parentName:"p"},"before")," the last listener finishes execution\nwill not remove them from",(0,r.kt)("inlineCode",{parentName:"p"},"emit()")," in progress. Subsequent events behave as expected."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n")),(0,r.kt)("p",null,"Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,r.kt)("em",{parentName:"p"},"after")," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.listeners()")," method will need to be recreated."),(0,r.kt)("p",null,"When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,r.kt)("inlineCode",{parentName:"p"},"removeListener()")," will remove the most\nrecently added instance. In the example the ",(0,r.kt)("inlineCode",{parentName:"p"},"once('ping')"),"listener is removed:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n")),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.1.26"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.removeListener"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:457"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setmaxlisteners"},"setMaxListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setMaxListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"n"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"By default ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),"s will print a warning if more than ",(0,r.kt)("inlineCode",{parentName:"p"},"10")," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.setMaxListeners()")," method allows the limit to be\nmodified for this specific ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," instance. The value can be set to",(0,r.kt)("inlineCode",{parentName:"p"},"Infinity")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},"0"),") to indicate an unlimited number of listeners."),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.3.5"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"n")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.setMaxListeners"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:483"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"geteventlisteners"},"getEventListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"getEventListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("p",null,"Returns a copy of the array of listeners for the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("p",null,"For ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),"s this behaves exactly the same as calling ",(0,r.kt)("inlineCode",{parentName:"p"},".listeners")," on\nthe emitter."),(0,r.kt)("p",null,"For ",(0,r.kt)("inlineCode",{parentName:"p"},"EventTarget"),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v15.2.0, v14.17.0"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitter")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"DOMEventTarget"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.getEventListeners"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:262"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listenercount-1"},"listenerCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"listenerCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"A class method that returns the number of listeners for the given ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"registered on the given ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.9.12"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Since v3.2.0 - Use ",(0,r.kt)("inlineCode",{parentName:"p"},"listenerCount")," instead."),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The emitter to query")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The event name")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.listenerCount"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:234"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"on-1"},"on"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"on"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterableIterator"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n")),(0,r.kt)("p",null,"Returns an ",(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterator")," that iterates ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName")," events. It will throw\nif the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," emits ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'"),". It removes all listeners when\nexiting the loop. The ",(0,r.kt)("inlineCode",{parentName:"p"},"value")," returned by each iteration is an array\ncomposed of the emitted event arguments."),(0,r.kt)("p",null,"An ",(0,r.kt)("inlineCode",{parentName:"p"},"AbortSignal")," can be used to cancel waiting on events:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v13.6.0, v12.16.0"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the event being listened for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"StaticEventEmitterOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterableIterator"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"that iterates ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName")," events emitted by the ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter")),(0,r.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.on"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:217"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"on"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"K"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventEmitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterableIterator"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E")," extends ",(0,r.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"," ? ",(0,r.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),"]"," : ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"__module"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"K")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("inlineCode",{parentName:"td"},"ClientEvents"))))),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventEmitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E")," extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Client"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"),">"," ? ",(0,r.kt)("inlineCode",{parentName:"td"},"K")," : ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterableIterator"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E")," extends ",(0,r.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"," ? ",(0,r.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),"]"," : ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.on"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:222"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"once-1"},"once"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"once"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("p",null,"Creates a ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," that is fulfilled when the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," emits the given\nevent or that is rejected if the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," emits ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," while waiting.\nThe ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," will resolve with an array of all the arguments emitted to the\ngiven event."),(0,r.kt)("p",null,"This method is intentionally generic and works with the web platform ",(0,r.kt)("a",{parentName:"p",href:"https://dom.spec.whatwg.org/#interface-eventtarget"},"EventTarget")," interface, which has no special",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," event\nsemantics and does not listen to the ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," event."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n")),(0,r.kt)("p",null,"The special handling of the ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," event is only used when ",(0,r.kt)("inlineCode",{parentName:"p"},"events.once()"),"is used to wait for another event. If ",(0,r.kt)("inlineCode",{parentName:"p"},"events.once()")," is used to wait for the\n'",(0,r.kt)("inlineCode",{parentName:"p"},"error'")," event itself, then it is treated as any other kind of event without\nspecial handling:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n")),(0,r.kt)("p",null,"An ",(0,r.kt)("inlineCode",{parentName:"p"},"AbortSignal")," can be used to cancel waiting for the event:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v11.13.0, v10.16.0"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NodeEventTarget"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"StaticEventEmitterOptions"))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.once"),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:157"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"once"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DOMEventTarget"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"StaticEventEmitterOptions"))))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.once"),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:158"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"once"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"K"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventEmitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E")," extends ",(0,r.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"," ? ",(0,r.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),"]"," : ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"__module"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"K")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("inlineCode",{parentName:"td"},"ClientEvents"))))),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventEmitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E")," extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Client"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"),">"," ? ",(0,r.kt)("inlineCode",{parentName:"td"},"K")," : ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E")," extends ",(0,r.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"," ? ",(0,r.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),"]"," : ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.once"),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:218"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setmaxlisteners-1"},"setMaxListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"setMaxListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"n?"),", ...",(0,r.kt)("inlineCode",{parentName:"p"},"eventTargets"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v15.4.0"),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"n?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"A non-negative number. The maximum number of listeners per ",(0,r.kt)("inlineCode",{parentName:"td"},"EventTarget")," event.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...eventTargets")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitter")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"DOMEventTarget"),")[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.setMaxListeners"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:280"))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7e205c4a.41cd04ca.js b/assets/js/7e205c4a.41cd04ca.js deleted file mode 100644 index e1d1c7b8b..000000000 --- a/assets/js/7e205c4a.41cd04ca.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7127],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>N});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),o=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=o(e.components);return a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,m=d(e,["components","mdxType","originalType","parentName"]),k=o(n),N=r,u=k["".concat(p,".").concat(N)]||k[N]||s[N]||i;return n?a.createElement(u,l(l({ref:t},m),{},{components:n})):a.createElement(u,l({ref:t},m))}));function N(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=k;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:r,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=n(7462),r=(n(7294),n(3905));const i={id:"SernEmitter",title:"Class: SernEmitter",sidebar_label:"SernEmitter",sidebar_position:0,custom_edit_url:null},l=void 0,d={unversionedId:"api/classes/SernEmitter",id:"api/classes/SernEmitter",title:"Class: SernEmitter",description:"Hierarchy",source:"@site/docs/api/classes/SernEmitter.md",sourceDirName:"api/classes",slug:"/api/classes/SernEmitter",permalink:"/docs/api/classes/SernEmitter",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"SernEmitter",title:"Class: SernEmitter",sidebar_label:"SernEmitter",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"EventExecutable",permalink:"/docs/api/classes/EventExecutable"},next:{title:"Controller",permalink:"/docs/api/interfaces/Controller"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"captureRejectionSymbol",id:"capturerejectionsymbol",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"captureRejections",id:"capturerejections",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"defaultMaxListeners",id:"defaultmaxlisteners",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"errorMonitor",id:"errormonitor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"addListener",id:"addlistener",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"emit",id:"emit",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"eventNames",id:"eventnames",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getMaxListeners",id:"getmaxlisteners",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"listenerCount",id:"listenercount",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"listeners",id:"listeners",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"off",id:"off",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"on",id:"on",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"once",id:"once",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"prependListener",id:"prependlistener",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"prependOnceListener",id:"prependoncelistener",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"rawListeners",id:"rawlisteners",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"removeAllListeners",id:"removealllisteners",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"removeListener",id:"removelistener",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setMaxListeners",id:"setmaxlisteners",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"getEventListeners",id:"geteventlisteners",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"listenerCount",id:"listenercount-1",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"on",id:"on-1",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"once",id:"once-1",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Inherited from",id:"inherited-from-23",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"setMaxListeners",id:"setmaxlisteners-1",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Inherited from",id:"inherited-from-24",level:4},{value:"Defined in",id:"defined-in-27",level:4}],m={toc:o};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"SernEmitter"))))),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new SernEmitter"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),")"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitterOptions"))))),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.constructor"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:74"),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"capturerejectionsymbol"},"captureRejectionSymbol"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"captureRejectionSymbol"),": typeof ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter#capturerejectionsymbol"},(0,r.kt)("inlineCode",{parentName:"a"},"captureRejectionSymbol"))),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.captureRejectionSymbol"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:291"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"capturerejections"},"captureRejections"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"captureRejections"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Sets or gets the default captureRejection value for all emitters."),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.captureRejections"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:296"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"defaultmaxlisteners"},"defaultMaxListeners"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"defaultMaxListeners"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.defaultMaxListeners"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:297"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"errormonitor"},"errorMonitor"),(0,r.kt)("p",null,"\u25aa ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("inlineCode",{parentName:"p"},"Readonly")," ",(0,r.kt)("strong",{parentName:"p"},"errorMonitor"),": typeof ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter#errormonitor"},(0,r.kt)("inlineCode",{parentName:"a"},"errorMonitor"))),(0,r.kt)("p",null,"This symbol shall be used to install a listener for only monitoring ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'"),"\nevents. Listeners installed using this symbol are called before the regular\n",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," listeners are called."),(0,r.kt)("p",null,"Installing a listener using this symbol does not change the behavior once an\n",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," event is emitted, therefore the process will still crash if no\nregular ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," listener is installed."),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.errorMonitor"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:290"),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"addlistener"},"addListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Alias for ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.on(eventName, listener)"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.1.26"),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.addListener"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:317"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"emit"},"emit"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"emit"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ...",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Listening to sern events with on. This event stays on until a crash or a normal exit"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")))))),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"the arguments for emitting the { eventName }")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,"EventEmitter.emit"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sernEmitter.ts#L32"},"src/handler/sernEmitter.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"eventnames"},"eventNames"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"eventNames"),"(): (",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"symbol"),")[]"),(0,r.kt)("p",null,"Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or ",(0,r.kt)("inlineCode",{parentName:"p"},"Symbol"),"s."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const EventEmitter = require('events');\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v6.0.0"),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,"(",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"symbol"),")[]"),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.eventNames"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:632"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmaxlisteners"},"getMaxListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMaxListeners"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Returns the current max listener value for the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," which is either\nset by ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.setMaxListeners(n)")," or defaults to ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter#defaultmaxlisteners"},"defaultMaxListeners"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v1.0.0"),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.getMaxListeners"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:489"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listenercount"},"listenerCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"listenerCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Returns the number of listeners listening to the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v3.2.0"),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the event being listened for")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.listenerCount"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:579"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listeners"},"listeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"listeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("p",null,"Returns a copy of the array of listeners for the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"server.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.1.26"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.listeners"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:502"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"off"},"off"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"off"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Alias for ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.removeListener()"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v10.0.0"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.off"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:462"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"on"},"on"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"on"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Listening to sern events with on. This event stays on until a crash or a normal exit"),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")))))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"][]",") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"what to do with the data")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,"EventEmitter.on"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sernEmitter.ts#L10"},"src/handler/sernEmitter.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"once"},"once"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"once"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Listening to sern events with on. This event stays on until a crash or a normal exit"),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"][]",") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"what to do with the data")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"overrides-2"},"Overrides"),(0,r.kt)("p",null,"EventEmitter.once"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sernEmitter.ts#L21"},"src/handler/sernEmitter.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"prependlistener"},"prependListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prependListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Adds the ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," function to the ",(0,r.kt)("em",{parentName:"p"},"beginning")," of the listeners array for the\nevent named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),". No checks are made to see if the ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," has\nalready been added. Multiple calls passing the same combination of ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"and ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," will result in the ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," being added, and called, multiple\ntimes."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"server.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n")),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v6.0.0"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the event.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The callback function")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.prependListener"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:597"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"prependoncelistener"},"prependOnceListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prependOnceListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Adds a ",(0,r.kt)("strong",{parentName:"p"},"one-time"),(0,r.kt)("inlineCode",{parentName:"p"},"listener")," function for the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName")," to the ",(0,r.kt)("em",{parentName:"p"},"beginning")," of the listeners array. The next time ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName")," is triggered, this\nlistener is removed, and then invoked."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"server.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n")),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v6.0.0"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the event.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The callback function")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.prependOnceListener"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:613"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rawlisteners"},"rawListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"rawListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("p",null,"Returns a copy of the array of listeners for the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),",\nincluding any wrappers (such as those created by ",(0,r.kt)("inlineCode",{parentName:"p"},".once()"),")."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v9.4.0"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.rawListeners"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:532"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removealllisteners"},"removeAllListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeAllListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"event?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Removes all listeners, or those of the specified ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("p",null,"It is bad practice to remove listeners added elsewhere in the code,\nparticularly when the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," instance was created by some other\ncomponent or module (e.g. sockets or file streams)."),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.1.26"),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"event?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.removeAllListeners"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:473"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removelistener"},"removeListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"Removes the specified ",(0,r.kt)("inlineCode",{parentName:"p"},"listener")," from the listener array for the event named",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n")),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"removeListener()")," will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", then ",(0,r.kt)("inlineCode",{parentName:"p"},"removeListener()")," must be\ncalled multiple times to remove each instance."),(0,r.kt)("p",null,"Once an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any",(0,r.kt)("inlineCode",{parentName:"p"},"removeListener()")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"removeAllListeners()")," calls ",(0,r.kt)("em",{parentName:"p"},"after")," emitting and ",(0,r.kt)("em",{parentName:"p"},"before")," the last listener finishes execution\nwill not remove them from",(0,r.kt)("inlineCode",{parentName:"p"},"emit()")," in progress. Subsequent events behave as expected."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n")),(0,r.kt)("p",null,"Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered ",(0,r.kt)("em",{parentName:"p"},"after")," the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.listeners()")," method will need to be recreated."),(0,r.kt)("p",null,"When a single function has been added as a handler multiple times for a single\nevent (as in the example below), ",(0,r.kt)("inlineCode",{parentName:"p"},"removeListener()")," will remove the most\nrecently added instance. In the example the ",(0,r.kt)("inlineCode",{parentName:"p"},"once('ping')"),"listener is removed:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n")),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.1.26"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(...",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.removeListener"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:457"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setmaxlisteners"},"setMaxListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setMaxListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"n"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("p",null,"By default ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),"s will print a warning if more than ",(0,r.kt)("inlineCode",{parentName:"p"},"10")," listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter.setMaxListeners()")," method allows the limit to be\nmodified for this specific ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," instance. The value can be set to",(0,r.kt)("inlineCode",{parentName:"p"},"Infinity")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},"0"),") to indicate an unlimited number of listeners."),(0,r.kt)("p",null,"Returns a reference to the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),", so that calls can be chained."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.3.5"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"n")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,r.kt)("inlineCode",{parentName:"a"},"SernEmitter"))),(0,r.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.setMaxListeners"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:483"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"geteventlisteners"},"getEventListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"getEventListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("p",null,"Returns a copy of the array of listeners for the event named ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"."),(0,r.kt)("p",null,"For ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter"),"s this behaves exactly the same as calling ",(0,r.kt)("inlineCode",{parentName:"p"},".listeners")," on\nthe emitter."),(0,r.kt)("p",null,"For ",(0,r.kt)("inlineCode",{parentName:"p"},"EventTarget"),"s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { getEventListeners, EventEmitter } = require('events');\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n getEventListeners(ee, 'foo'); // [listener]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n getEventListeners(et, 'foo'); // [listener]\n}\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v15.2.0, v14.17.0"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitter")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"DOMEventTarget"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Function"),"[]"),(0,r.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.getEventListeners"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:262"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listenercount-1"},"listenerCount"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"listenerCount"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"A class method that returns the number of listeners for the given ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"registered on the given ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { EventEmitter, listenerCount } = require('events');\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v0.9.12"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Since v3.2.0 - Use ",(0,r.kt)("inlineCode",{parentName:"p"},"listenerCount")," instead."),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The emitter to query")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The event name")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.listenerCount"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:234"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"on-1"},"on"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"on"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterableIterator"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { on, EventEmitter } = require('events');\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n")),(0,r.kt)("p",null,"Returns an ",(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterator")," that iterates ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName")," events. It will throw\nif the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," emits ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'"),". It removes all listeners when\nexiting the loop. The ",(0,r.kt)("inlineCode",{parentName:"p"},"value")," returned by each iteration is an array\ncomposed of the emitted event arguments."),(0,r.kt)("p",null,"An ",(0,r.kt)("inlineCode",{parentName:"p"},"AbortSignal")," can be used to cancel waiting on events:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { on, EventEmitter } = require('events');\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v13.6.0, v12.16.0"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the event being listened for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"StaticEventEmitterOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterableIterator"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"that iterates ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName")," events emitted by the ",(0,r.kt)("inlineCode",{parentName:"p"},"emitter")),(0,r.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.on"),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:217"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"on"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"K"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventEmitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterableIterator"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),"]",">"),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"K")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("inlineCode",{parentName:"td"},"ClientEvents"))))),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventEmitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Client"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"K"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"AsyncIterableIterator"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),"]",">"),(0,r.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.on"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:197"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"once-1"},"once"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"once"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("p",null,"Creates a ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," that is fulfilled when the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," emits the given\nevent or that is rejected if the ",(0,r.kt)("inlineCode",{parentName:"p"},"EventEmitter")," emits ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," while waiting.\nThe ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," will resolve with an array of all the arguments emitted to the\ngiven event."),(0,r.kt)("p",null,"This method is intentionally generic and works with the web platform ",(0,r.kt)("a",{parentName:"p",href:"https://dom.spec.whatwg.org/#interface-eventtarget"},"EventTarget")," interface, which has no special",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," event\nsemantics and does not listen to the ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," event."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { once, EventEmitter } = require('events');\n\nasync function run() {\n const ee = new EventEmitter();\n\n process.nextTick(() => {\n ee.emit('myevent', 42);\n });\n\n const [value] = await once(ee, 'myevent');\n console.log(value);\n\n const err = new Error('kaboom');\n process.nextTick(() => {\n ee.emit('error', err);\n });\n\n try {\n await once(ee, 'myevent');\n } catch (err) {\n console.log('error happened', err);\n }\n}\n\nrun();\n")),(0,r.kt)("p",null,"The special handling of the ",(0,r.kt)("inlineCode",{parentName:"p"},"'error'")," event is only used when ",(0,r.kt)("inlineCode",{parentName:"p"},"events.once()"),"is used to wait for another event. If ",(0,r.kt)("inlineCode",{parentName:"p"},"events.once()")," is used to wait for the\n'",(0,r.kt)("inlineCode",{parentName:"p"},"error'")," event itself, then it is treated as any other kind of event without\nspecial handling:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.log('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n")),(0,r.kt)("p",null,"An ",(0,r.kt)("inlineCode",{parentName:"p"},"AbortSignal")," can be used to cancel waiting for the event:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const { EventEmitter, once } = require('events');\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v11.13.0, v10.16.0"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NodeEventTarget"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"symbol"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"StaticEventEmitterOptions"))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.once"),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:157"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"once"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"emitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DOMEventTarget"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"StaticEventEmitterOptions"))))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]",">"),(0,r.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.once"),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:158"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"once"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"K"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"eventEmitter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"eventName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),"]",">"),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"K")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("inlineCode",{parentName:"td"},"ClientEvents"))))),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventEmitter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Client"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"eventName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"K"))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),"]",">"),(0,r.kt)("h4",{id:"inherited-from-23"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.once"),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,"node_modules/discord.js/typings/index.d.ts:196"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setmaxlisteners-1"},"setMaxListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,r.kt)("strong",{parentName:"p"},"setMaxListeners"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"n?"),", ...",(0,r.kt)("inlineCode",{parentName:"p"},"eventTargets"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const {\n setMaxListeners,\n EventEmitter\n} = require('events');\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Since"))),(0,r.kt)("p",null,"v15.4.0"),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"n?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"A non-negative number. The maximum number of listeners per ",(0,r.kt)("inlineCode",{parentName:"td"},"EventTarget")," event.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...eventTargets")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"EventEmitter")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"DOMEventTarget"),")[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"inherited-from-24"},"Inherited from"),(0,r.kt)("p",null,"EventEmitter.setMaxListeners"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/node/events.d.ts:280"))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7f2ac8b7.2509d017.js b/assets/js/7f2ac8b7.2509d017.js new file mode 100644 index 000000000..6a687610c --- /dev/null +++ b/assets/js/7f2ac8b7.2509d017.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[3247],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),u=d(n),m=a,f=u["".concat(p,".").concat(m)]||u[m]||s[m]||i;return n?r.createElement(f,l(l({ref:t},c),{},{components:n})):r.createElement(f,l({ref:t},c))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=n(7462),a=(n(7294),n(3905));const i={id:"AutocompleteCommand",title:"Interface: AutocompleteCommand",sidebar_label:"AutocompleteCommand",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/interfaces/AutocompleteCommand",id:"api/interfaces/AutocompleteCommand",title:"Interface: AutocompleteCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/AutocompleteCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/AutocompleteCommand",permalink:"/docs/api/interfaces/AutocompleteCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"AutocompleteCommand",title:"Interface: AutocompleteCommand",sidebar_label:"AutocompleteCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SernEmitter",permalink:"/docs/api/classes/SernEmitter"},next:{title:"AutocompletePlugin",permalink:"/docs/api/interfaces/AutocompletePlugin"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-4",level:4}],c={toc:d};function s(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,a.kt)("inlineCode",{parentName:"a"},"Module"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"AutocompleteCommand"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"undefined")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L132"},"src/types/module.ts:132")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"AutocompleteInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ctx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"AutocompleteInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L135"},"src/types/module.ts:135")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"undefined")),(0,a.kt)("h4",{id:"overrides-2"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L131"},"src/types/module.ts:131")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/AutocompletePlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"AutocompletePlugin")),"[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L134"},"src/types/module.ts:134")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"undefined")),(0,a.kt)("h4",{id:"overrides-3"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L133"},"src/types/module.ts:133")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/82cdda05.3c51a115.js b/assets/js/82cdda05.3c51a115.js new file mode 100644 index 000000000..706a48599 --- /dev/null +++ b/assets/js/82cdda05.3c51a115.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9107],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),o=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return a.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),u=o(n),c=r,k=u["".concat(d,".").concat(c)]||u[c]||m[c]||i;return n?a.createElement(k,l(l({ref:t},s),{},{components:n})):a.createElement(k,l({ref:t},s))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=u;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var a=n(7462),r=(n(7294),n(3905));const i={id:"EventPlugin",title:"Interface: EventPlugin",sidebar_label:"EventPlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/EventPlugin",id:"api/interfaces/EventPlugin",title:"Interface: EventPlugin",description:"Type parameters",source:"@site/docs/api/interfaces/EventPlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/EventPlugin",permalink:"/docs/api/interfaces/EventPlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EventPlugin",title:"Interface: EventPlugin",sidebar_label:"EventPlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ErrorHandling",permalink:"/docs/api/interfaces/ErrorHandling"},next:{title:"ExternalEmitterPlugin",permalink:"/docs/api/interfaces/ExternalEmitterPlugin"}},d={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:o};function m(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"K")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs"))," = keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")))))),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,r.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"EventPlugin"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"will be removed in the next update"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"event"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Parameters"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"p"},"K"),'][``"execute"``]',">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,r.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"event"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"controller"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"event")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Parameters"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"K"),'][``"execute"``]',">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"controller")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,r.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L82"},"src/handler/plugins/plugin.ts:82")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"will be removed in the next update"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31"},"src/handler/plugins/plugin.ts:31")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,r.kt)("inlineCode",{parentName:"a"},"Event"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L81"},"src/handler/plugins/plugin.ts:81")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8a062262.61a23507.js b/assets/js/8a062262.61a23507.js new file mode 100644 index 000000000..bb743d43f --- /dev/null +++ b/assets/js/8a062262.61a23507.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4252],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),o=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return r.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),u=o(n),m=a,k=u["".concat(d,".").concat(m)]||u[m]||c[m]||i;return n?r.createElement(k,l(l({ref:t},s),{},{components:n})):r.createElement(k,l({ref:t},s))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=u;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=n(7462),a=(n(7294),n(3905));const i={id:"DiscordEventPlugin",title:"Interface: DiscordEventPlugin",sidebar_label:"DiscordEventPlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/DiscordEventPlugin",id:"api/interfaces/DiscordEventPlugin",title:"Interface: DiscordEventPlugin",description:"Type parameters",source:"@site/docs/api/interfaces/DiscordEventPlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/DiscordEventPlugin",permalink:"/docs/api/interfaces/DiscordEventPlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"DiscordEventPlugin",title:"Interface: DiscordEventPlugin",sidebar_label:"DiscordEventPlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"DiscordEmitterPlugin",permalink:"/docs/api/interfaces/DiscordEmitterPlugin"},next:{title:"ErrorHandling",permalink:"/docs/api/interfaces/ErrorHandling"}},d={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:o};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"T")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,a.kt)("inlineCode",{parentName:"td"},"ClientEvents")," = keyof ",(0,a.kt)("inlineCode",{parentName:"td"},"ClientEvents"))))),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,a.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"DiscordEventPlugin"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,a.kt)("inlineCode",{parentName:"p"},"T"),"]",", ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"args"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"args")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ClientEvents"),"[",(0,a.kt)("inlineCode",{parentName:"td"},"T"),"]")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"controller")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L105"},"src/handler/plugins/plugin.ts:105")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"T")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L103"},"src/handler/plugins/plugin.ts:103")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L104"},"src/handler/plugins/plugin.ts:104")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/90fdad0c.b21aee37.js b/assets/js/90fdad0c.b21aee37.js new file mode 100644 index 000000000..7405eef14 --- /dev/null +++ b/assets/js/90fdad0c.b21aee37.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9476],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),d=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=d(r),m=a,f=u["".concat(p,".").concat(m)]||u[m]||c[m]||l;return r?n.createElement(f,i(i({ref:t},s),{},{components:r})):n.createElement(f,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,i=new Array(l);i[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var d=2;d{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var n=r(7462),a=(r(7294),r(3905));const l={id:"DefaultErrorHandling",title:"Class: DefaultErrorHandling",sidebar_label:"DefaultErrorHandling",sidebar_position:0,custom_edit_url:null},i=void 0,o={unversionedId:"api/classes/DefaultErrorHandling",id:"api/classes/DefaultErrorHandling",title:"Class: DefaultErrorHandling",description:"Implements",source:"@site/docs/api/classes/DefaultErrorHandling.md",sourceDirName:"api/classes",slug:"/api/classes/DefaultErrorHandling",permalink:"/docs/api/classes/DefaultErrorHandling",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"DefaultErrorHandling",title:"Class: DefaultErrorHandling",sidebar_label:"DefaultErrorHandling",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Context",permalink:"/docs/api/classes/Context"},next:{title:"DefaultLogging",permalink:"/docs/api/classes/DefaultLogging"}},p={},d=[{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Properties",id:"properties",level:2},{value:"keepAlive",id:"keepalive",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"crash",id:"crash",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"updateAlive",id:"updatealive",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}],s={toc:d};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ErrorHandling"},(0,a.kt)("inlineCode",{parentName:"a"},"ErrorHandling")))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new DefaultErrorHandling"),"()"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"keepalive"},"keepAlive"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"keepAlive"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"5")),(0,a.kt)("p",null,"Number of times the process should throw an error until crashing and exiting"),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ErrorHandling"},"ErrorHandling"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ErrorHandling#keepalive"},"keepAlive")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/errorHandling.ts#L25"},"src/handler/contracts/errorHandling.ts:25")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"crash"},"crash"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"crash"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"error"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("p",null,"Utility function to crash"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"error")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))))),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"never")),(0,a.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ErrorHandling"},"ErrorHandling"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ErrorHandling#crash"},"crash")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/errorHandling.ts#L26"},"src/handler/contracts/errorHandling.ts:26")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"updatealive"},"updateAlive"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"updateAlive"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"e"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"A function that is called on every crash. Updates keepAlive"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"e")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ErrorHandling"},"ErrorHandling"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ErrorHandling#updatealive"},"updateAlive")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/errorHandling.ts#L29"},"src/handler/contracts/errorHandling.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.47826bb0.js b/assets/js/935f2afb.47826bb0.js deleted file mode 100644 index 3101a6cc3..000000000 --- a/assets/js/935f2afb.47826bb0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[2197],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"category","label":"API","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/docs/api/modules","docId":"api/modules"},{"type":"category","label":"Namespaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sern","href":"/docs/api/namespaces/Sern","docId":"api/namespaces/Sern"}]},{"type":"category","label":"Enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CommandType","href":"/docs/api/enums/CommandType","docId":"api/enums/CommandType"},{"type":"link","label":"EventType","href":"/docs/api/enums/EventType","docId":"api/enums/EventType"},{"type":"link","label":"PayloadType","href":"/docs/api/enums/PayloadType","docId":"api/enums/PayloadType"},{"type":"link","label":"PluginType","href":"/docs/api/enums/PluginType","docId":"api/enums/PluginType"}]},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CommandExecutable","href":"/docs/api/classes/CommandExecutable","docId":"api/classes/CommandExecutable"},{"type":"link","label":"Context","href":"/docs/api/classes/Context","docId":"api/classes/Context"},{"type":"link","label":"EventExecutable","href":"/docs/api/classes/EventExecutable","docId":"api/classes/EventExecutable"},{"type":"link","label":"SernEmitter","href":"/docs/api/classes/SernEmitter","docId":"api/classes/SernEmitter"}]},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Controller","href":"/docs/api/interfaces/Controller","docId":"api/interfaces/Controller"},{"type":"link","label":"Wrapper","href":"/docs/api/interfaces/Wrapper","docId":"api/interfaces/Wrapper"}]}],"href":"/docs/api/"},{"type":"link","label":"Welcome!","href":"/docs/intro","docId":"intro"},{"type":"category","label":"Introduction","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"getting-started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Choosing an IDE","href":"/docs/guide/getting-started/choose-ide","docId":"guide/getting-started/choose-ide"},{"type":"link","label":"Preparing to Code","href":"/docs/guide/getting-started/preparing","docId":"guide/getting-started/preparing"}]},{"type":"category","label":"walkthrough","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Goal","href":"/docs/guide/walkthrough/goal","docId":"guide/walkthrough/goal"},{"type":"link","label":"CLI","href":"/docs/guide/walkthrough/cli","docId":"guide/walkthrough/cli"},{"type":"link","label":"First Command","href":"/docs/guide/walkthrough/first-command","docId":"guide/walkthrough/first-command"},{"type":"link","label":"First Event Module","href":"/docs/guide/walkthrough/first-event","docId":"guide/walkthrough/first-event"},{"type":"link","label":"Plugins","href":"/docs/guide/walkthrough/plugins","docId":"guide/walkthrough/plugins"},{"type":"link","label":"The SernEmitter class","href":"/docs/guide/walkthrough/sern-emitter","docId":"guide/walkthrough/sern-emitter"},{"type":"link","label":"Good to know","href":"/docs/guide/walkthrough/good-to-know","docId":"guide/walkthrough/good-to-know"},{"type":"link","label":"Conclusion","href":"/docs/guide/walkthrough/conclusion","docId":"guide/walkthrough/conclusion"}]}],"href":"/docs/guide/"}]},"docs":{"api/classes/CommandExecutable":{"id":"api/classes/CommandExecutable","title":"Class: CommandExecutable","description":"Type parameters","sidebar":"tutorialSidebar"},"api/classes/Context":{"id":"api/classes/Context","title":"Class: Context","description":"Provides values shared between","sidebar":"tutorialSidebar"},"api/classes/EventExecutable":{"id":"api/classes/EventExecutable","title":"Class: EventExecutable","description":"Type parameters","sidebar":"tutorialSidebar"},"api/classes/SernEmitter":{"id":"api/classes/SernEmitter","title":"Class: SernEmitter","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/enums/CommandType":{"id":"api/enums/CommandType","title":"Enumeration: CommandType","description":"Example","sidebar":"tutorialSidebar"},"api/enums/EventType":{"id":"api/enums/EventType","title":"Enumeration: EventType","description":"Example","sidebar":"tutorialSidebar"},"api/enums/PayloadType":{"id":"api/enums/PayloadType","title":"Enumeration: PayloadType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"api/enums/PluginType":{"id":"api/enums/PluginType","title":"Enumeration: PluginType","description":"Example","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"@sern/handler","description":"Handlers. Redefined.","sidebar":"tutorialSidebar"},"api/interfaces/Controller":{"id":"api/interfaces/Controller","title":"Interface: Controller","description":"Properties","sidebar":"tutorialSidebar"},"api/interfaces/Wrapper":{"id":"api/interfaces/Wrapper","title":"Interface: Wrapper","description":"An object to be passed into Sern#init() function.","sidebar":"tutorialSidebar"},"api/modules":{"id":"api/modules","title":"@sern/handler","description":"Namespaces","sidebar":"tutorialSidebar"},"api/namespaces/Sern":{"id":"api/namespaces/Sern","title":"Namespace: Sern","description":"References","sidebar":"tutorialSidebar"},"guide/getting-started/choose-ide":{"id":"guide/getting-started/choose-ide","title":"Choosing an IDE","description":"Choosing an IDE is a matter of personal preference. The following are some","sidebar":"tutorialSidebar"},"guide/getting-started/preparing":{"id":"guide/getting-started/preparing","title":"Preparing to Code","description":"After installing and IDE you need to install node.","sidebar":"tutorialSidebar"},"guide/README":{"id":"guide/README","title":"Introduction","description":"Welcome to our official guide. This guide will go through all the core features of the framework.","sidebar":"tutorialSidebar"},"guide/walkthrough/cli":{"id":"guide/walkthrough/cli","title":"CLI","description":"Setting up the CLI is easy.","sidebar":"tutorialSidebar"},"guide/walkthrough/conclusion":{"id":"guide/walkthrough/conclusion","title":"Conclusion","description":"If you reached this far, thank you for reading! We hope you have learned the necessities you need","sidebar":"tutorialSidebar"},"guide/walkthrough/first-command":{"id":"guide/walkthrough/first-command","title":"First Command","description":"We will dissect a basic command.","sidebar":"tutorialSidebar"},"guide/walkthrough/first-event":{"id":"guide/walkthrough/first-event","title":"First Event Module","description":"We will dissect a basic event module.","sidebar":"tutorialSidebar"},"guide/walkthrough/goal":{"id":"guide/walkthrough/goal","title":"Goal","description":"sern strives to be minimalist, but with all batteries included. Meaning, this framework provides the necessary tools","sidebar":"tutorialSidebar"},"guide/walkthrough/good-to-know":{"id":"guide/walkthrough/good-to-know","title":"Good to know","description":"sern.config.json","sidebar":"tutorialSidebar"},"guide/walkthrough/plugins":{"id":"guide/walkthrough/plugins","title":"Plugins","description":"As of now, modules seem a little underwhelming. It appears that sern doesn\'t have all the features of a standard handler,","sidebar":"tutorialSidebar"},"guide/walkthrough/sern-emitter":{"id":"guide/walkthrough/sern-emitter","title":"The SernEmitter class","description":"You\'re shipped with the SernEmitter. This EventEmitter listens to","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Welcome!","description":"Content","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.f5092855.js b/assets/js/935f2afb.f5092855.js new file mode 100644 index 000000000..fffe97b50 --- /dev/null +++ b/assets/js/935f2afb.f5092855.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[2197],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"category","label":"API","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/docs/api/modules","docId":"api/modules"},{"type":"category","label":"Namespaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sern","href":"/docs/api/namespaces/Sern","docId":"api/namespaces/Sern"}]},{"type":"category","label":"Enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CommandType","href":"/docs/api/enums/CommandType","docId":"api/enums/CommandType"},{"type":"link","label":"EventType","href":"/docs/api/enums/EventType","docId":"api/enums/EventType"},{"type":"link","label":"PayloadType","href":"/docs/api/enums/PayloadType","docId":"api/enums/PayloadType"},{"type":"link","label":"PluginType","href":"/docs/api/enums/PluginType","docId":"api/enums/PluginType"}]},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"CommandExecutable","href":"/docs/api/classes/CommandExecutable","docId":"api/classes/CommandExecutable"},{"type":"link","label":"Context","href":"/docs/api/classes/Context","docId":"api/classes/Context"},{"type":"link","label":"DefaultErrorHandling","href":"/docs/api/classes/DefaultErrorHandling","docId":"api/classes/DefaultErrorHandling"},{"type":"link","label":"DefaultLogging","href":"/docs/api/classes/DefaultLogging","docId":"api/classes/DefaultLogging"},{"type":"link","label":"DefaultModuleManager","href":"/docs/api/classes/DefaultModuleManager","docId":"api/classes/DefaultModuleManager"},{"type":"link","label":"EventExecutable","href":"/docs/api/classes/EventExecutable","docId":"api/classes/EventExecutable"},{"type":"link","label":"ModuleStore","href":"/docs/api/classes/ModuleStore","docId":"api/classes/ModuleStore"},{"type":"link","label":"SernEmitter","href":"/docs/api/classes/SernEmitter","docId":"api/classes/SernEmitter"}]},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AutocompleteCommand","href":"/docs/api/interfaces/AutocompleteCommand","docId":"api/interfaces/AutocompleteCommand"},{"type":"link","label":"AutocompletePlugin","href":"/docs/api/interfaces/AutocompletePlugin","docId":"api/interfaces/AutocompletePlugin"},{"type":"link","label":"BothCommand","href":"/docs/api/interfaces/BothCommand","docId":"api/interfaces/BothCommand"},{"type":"link","label":"ButtonCommand","href":"/docs/api/interfaces/ButtonCommand","docId":"api/interfaces/ButtonCommand"},{"type":"link","label":"ChannelSelectCommand","href":"/docs/api/interfaces/ChannelSelectCommand","docId":"api/interfaces/ChannelSelectCommand"},{"type":"link","label":"CommandPlugin","href":"/docs/api/interfaces/CommandPlugin","docId":"api/interfaces/CommandPlugin"},{"type":"link","label":"ContextMenuMsg","href":"/docs/api/interfaces/ContextMenuMsg","docId":"api/interfaces/ContextMenuMsg"},{"type":"link","label":"ContextMenuUser","href":"/docs/api/interfaces/ContextMenuUser","docId":"api/interfaces/ContextMenuUser"},{"type":"link","label":"Controller","href":"/docs/api/interfaces/Controller","docId":"api/interfaces/Controller"},{"type":"link","label":"Dependencies","href":"/docs/api/interfaces/Dependencies","docId":"api/interfaces/Dependencies"},{"type":"link","label":"DiscordEmitterPlugin","href":"/docs/api/interfaces/DiscordEmitterPlugin","docId":"api/interfaces/DiscordEmitterPlugin"},{"type":"link","label":"DiscordEventPlugin","href":"/docs/api/interfaces/DiscordEventPlugin","docId":"api/interfaces/DiscordEventPlugin"},{"type":"link","label":"ErrorHandling","href":"/docs/api/interfaces/ErrorHandling","docId":"api/interfaces/ErrorHandling"},{"type":"link","label":"EventPlugin","href":"/docs/api/interfaces/EventPlugin","docId":"api/interfaces/EventPlugin"},{"type":"link","label":"ExternalEmitterPlugin","href":"/docs/api/interfaces/ExternalEmitterPlugin","docId":"api/interfaces/ExternalEmitterPlugin"},{"type":"link","label":"ExternalEventPlugin","href":"/docs/api/interfaces/ExternalEventPlugin","docId":"api/interfaces/ExternalEventPlugin"},{"type":"link","label":"Logging","href":"/docs/api/interfaces/Logging","docId":"api/interfaces/Logging"},{"type":"link","label":"MentionableSelectCommand","href":"/docs/api/interfaces/MentionableSelectCommand","docId":"api/interfaces/MentionableSelectCommand"},{"type":"link","label":"ModalSubmitCommand","href":"/docs/api/interfaces/ModalSubmitCommand","docId":"api/interfaces/ModalSubmitCommand"},{"type":"link","label":"Module","href":"/docs/api/interfaces/Module","docId":"api/interfaces/Module"},{"type":"link","label":"ModuleManager","href":"/docs/api/interfaces/ModuleManager","docId":"api/interfaces/ModuleManager"},{"type":"link","label":"Plugin","href":"/docs/api/interfaces/Plugin","docId":"api/interfaces/Plugin"},{"type":"link","label":"RoleSelectCommand","href":"/docs/api/interfaces/RoleSelectCommand","docId":"api/interfaces/RoleSelectCommand"},{"type":"link","label":"SernAutocompleteData","href":"/docs/api/interfaces/SernAutocompleteData","docId":"api/interfaces/SernAutocompleteData"},{"type":"link","label":"SernEmitterPlugin","href":"/docs/api/interfaces/SernEmitterPlugin","docId":"api/interfaces/SernEmitterPlugin"},{"type":"link","label":"SernEventPlugin","href":"/docs/api/interfaces/SernEventPlugin","docId":"api/interfaces/SernEventPlugin"},{"type":"link","label":"SernSubCommandData","href":"/docs/api/interfaces/SernSubCommandData","docId":"api/interfaces/SernSubCommandData"},{"type":"link","label":"SernSubCommandGroupData","href":"/docs/api/interfaces/SernSubCommandGroupData","docId":"api/interfaces/SernSubCommandGroupData"},{"type":"link","label":"SlashCommand","href":"/docs/api/interfaces/SlashCommand","docId":"api/interfaces/SlashCommand"},{"type":"link","label":"StringSelectCommand","href":"/docs/api/interfaces/StringSelectCommand","docId":"api/interfaces/StringSelectCommand"},{"type":"link","label":"TextCommand","href":"/docs/api/interfaces/TextCommand","docId":"api/interfaces/TextCommand"},{"type":"link","label":"UserSelectCommand","href":"/docs/api/interfaces/UserSelectCommand","docId":"api/interfaces/UserSelectCommand"},{"type":"link","label":"Wrapper","href":"/docs/api/interfaces/Wrapper","docId":"api/interfaces/Wrapper"}]}],"href":"/docs/api/"},{"type":"link","label":"Welcome!","href":"/docs/intro","docId":"intro"},{"type":"category","label":"Introduction","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"getting-started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Choosing an IDE","href":"/docs/guide/getting-started/choose-ide","docId":"guide/getting-started/choose-ide"},{"type":"link","label":"Preparing to Code","href":"/docs/guide/getting-started/preparing","docId":"guide/getting-started/preparing"}]},{"type":"category","label":"walkthrough","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Goal","href":"/docs/guide/walkthrough/goal","docId":"guide/walkthrough/goal"},{"type":"link","label":"CLI","href":"/docs/guide/walkthrough/cli","docId":"guide/walkthrough/cli"},{"type":"link","label":"First Command","href":"/docs/guide/walkthrough/first-command","docId":"guide/walkthrough/first-command"},{"type":"link","label":"First Event Module","href":"/docs/guide/walkthrough/first-event","docId":"guide/walkthrough/first-event"},{"type":"link","label":"Plugins","href":"/docs/guide/walkthrough/plugins","docId":"guide/walkthrough/plugins"},{"type":"link","label":"The SernEmitter class","href":"/docs/guide/walkthrough/sern-emitter","docId":"guide/walkthrough/sern-emitter"},{"type":"link","label":"Good to know","href":"/docs/guide/walkthrough/good-to-know","docId":"guide/walkthrough/good-to-know"},{"type":"link","label":"Conclusion","href":"/docs/guide/walkthrough/conclusion","docId":"guide/walkthrough/conclusion"}]}],"href":"/docs/guide/"}]},"docs":{"api/classes/CommandExecutable":{"id":"api/classes/CommandExecutable","title":"Class: CommandExecutable","description":"Type parameters","sidebar":"tutorialSidebar"},"api/classes/Context":{"id":"api/classes/Context","title":"Class: Context","description":"Provides values shared between","sidebar":"tutorialSidebar"},"api/classes/DefaultErrorHandling":{"id":"api/classes/DefaultErrorHandling","title":"Class: DefaultErrorHandling","description":"Implements","sidebar":"tutorialSidebar"},"api/classes/DefaultLogging":{"id":"api/classes/DefaultLogging","title":"Class: DefaultLogging","description":"Implements","sidebar":"tutorialSidebar"},"api/classes/DefaultModuleManager":{"id":"api/classes/DefaultModuleManager","title":"Class: DefaultModuleManager","description":"Implements","sidebar":"tutorialSidebar"},"api/classes/EventExecutable":{"id":"api/classes/EventExecutable","title":"Class: EventExecutable","description":"Type parameters","sidebar":"tutorialSidebar"},"api/classes/ModuleStore":{"id":"api/classes/ModuleStore","title":"Class: ModuleStore","description":"Storing all command modules","sidebar":"tutorialSidebar"},"api/classes/SernEmitter":{"id":"api/classes/SernEmitter","title":"Class: SernEmitter","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/enums/CommandType":{"id":"api/enums/CommandType","title":"Enumeration: CommandType","description":"A bitfield that discriminates command modules","sidebar":"tutorialSidebar"},"api/enums/EventType":{"id":"api/enums/EventType","title":"Enumeration: EventType","description":"A bitfield that discriminates event modules","sidebar":"tutorialSidebar"},"api/enums/PayloadType":{"id":"api/enums/PayloadType","title":"Enumeration: PayloadType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"api/enums/PluginType":{"id":"api/enums/PluginType","title":"Enumeration: PluginType","description":"A bitfield that discriminates plugins","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"@sern/handler","description":"Handlers. Redefined.","sidebar":"tutorialSidebar"},"api/interfaces/AutocompleteCommand":{"id":"api/interfaces/AutocompleteCommand","title":"Interface: AutocompleteCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/AutocompletePlugin":{"id":"api/interfaces/AutocompletePlugin","title":"Interface: AutocompletePlugin","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/BothCommand":{"id":"api/interfaces/BothCommand","title":"Interface: BothCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/ButtonCommand":{"id":"api/interfaces/ButtonCommand","title":"Interface: ButtonCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/ChannelSelectCommand":{"id":"api/interfaces/ChannelSelectCommand","title":"Interface: ChannelSelectCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/CommandPlugin":{"id":"api/interfaces/CommandPlugin","title":"Interface: CommandPlugin","description":"Type parameters","sidebar":"tutorialSidebar"},"api/interfaces/ContextMenuMsg":{"id":"api/interfaces/ContextMenuMsg","title":"Interface: ContextMenuMsg","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/ContextMenuUser":{"id":"api/interfaces/ContextMenuUser","title":"Interface: ContextMenuUser","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/Controller":{"id":"api/interfaces/Controller","title":"Interface: Controller","description":"Properties","sidebar":"tutorialSidebar"},"api/interfaces/Dependencies":{"id":"api/interfaces/Dependencies","title":"Interface: Dependencies","description":"Properties","sidebar":"tutorialSidebar"},"api/interfaces/DiscordEmitterPlugin":{"id":"api/interfaces/DiscordEmitterPlugin","title":"Interface: DiscordEmitterPlugin","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/DiscordEventPlugin":{"id":"api/interfaces/DiscordEventPlugin","title":"Interface: DiscordEventPlugin","description":"Type parameters","sidebar":"tutorialSidebar"},"api/interfaces/ErrorHandling":{"id":"api/interfaces/ErrorHandling","title":"Interface: ErrorHandling","description":"Implemented by","sidebar":"tutorialSidebar"},"api/interfaces/EventPlugin":{"id":"api/interfaces/EventPlugin","title":"Interface: EventPlugin","description":"Type parameters","sidebar":"tutorialSidebar"},"api/interfaces/ExternalEmitterPlugin":{"id":"api/interfaces/ExternalEmitterPlugin","title":"Interface: ExternalEmitterPlugin","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/ExternalEventPlugin":{"id":"api/interfaces/ExternalEventPlugin","title":"Interface: ExternalEventPlugin","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/Logging":{"id":"api/interfaces/Logging","title":"Interface: Logging","description":"Type parameters","sidebar":"tutorialSidebar"},"api/interfaces/MentionableSelectCommand":{"id":"api/interfaces/MentionableSelectCommand","title":"Interface: MentionableSelectCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/ModalSubmitCommand":{"id":"api/interfaces/ModalSubmitCommand","title":"Interface: ModalSubmitCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/Module":{"id":"api/interfaces/Module","title":"Interface: Module","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/ModuleManager":{"id":"api/interfaces/ModuleManager","title":"Interface: ModuleManager","description":"Implemented by","sidebar":"tutorialSidebar"},"api/interfaces/Plugin":{"id":"api/interfaces/Plugin","title":"Interface: Plugin","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/RoleSelectCommand":{"id":"api/interfaces/RoleSelectCommand","title":"Interface: RoleSelectCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/SernAutocompleteData":{"id":"api/interfaces/SernAutocompleteData","title":"Interface: SernAutocompleteData","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/SernEmitterPlugin":{"id":"api/interfaces/SernEmitterPlugin","title":"Interface: SernEmitterPlugin","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/SernEventPlugin":{"id":"api/interfaces/SernEventPlugin","title":"Interface: SernEventPlugin","description":"Type parameters","sidebar":"tutorialSidebar"},"api/interfaces/SernSubCommandData":{"id":"api/interfaces/SernSubCommandData","title":"Interface: SernSubCommandData","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/SernSubCommandGroupData":{"id":"api/interfaces/SernSubCommandGroupData","title":"Interface: SernSubCommandGroupData","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/SlashCommand":{"id":"api/interfaces/SlashCommand","title":"Interface: SlashCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/StringSelectCommand":{"id":"api/interfaces/StringSelectCommand","title":"Interface: StringSelectCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/TextCommand":{"id":"api/interfaces/TextCommand","title":"Interface: TextCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/UserSelectCommand":{"id":"api/interfaces/UserSelectCommand","title":"Interface: UserSelectCommand","description":"Hierarchy","sidebar":"tutorialSidebar"},"api/interfaces/Wrapper":{"id":"api/interfaces/Wrapper","title":"Interface: Wrapper","description":"An object to be passed into Sern#init() function.","sidebar":"tutorialSidebar"},"api/modules":{"id":"api/modules","title":"@sern/handler","description":"Namespaces","sidebar":"tutorialSidebar"},"api/namespaces/Sern":{"id":"api/namespaces/Sern","title":"Namespace: Sern","description":"References","sidebar":"tutorialSidebar"},"guide/getting-started/choose-ide":{"id":"guide/getting-started/choose-ide","title":"Choosing an IDE","description":"Choosing an IDE is a matter of personal preference. The following are some","sidebar":"tutorialSidebar"},"guide/getting-started/preparing":{"id":"guide/getting-started/preparing","title":"Preparing to Code","description":"After installing and IDE you need to install node.","sidebar":"tutorialSidebar"},"guide/README":{"id":"guide/README","title":"Introduction","description":"Welcome to our official guide. This guide will go through all the core features of the framework.","sidebar":"tutorialSidebar"},"guide/walkthrough/cli":{"id":"guide/walkthrough/cli","title":"CLI","description":"Setting up the CLI is easy.","sidebar":"tutorialSidebar"},"guide/walkthrough/conclusion":{"id":"guide/walkthrough/conclusion","title":"Conclusion","description":"If you reached this far, thank you for reading! We hope you have learned the necessities you need","sidebar":"tutorialSidebar"},"guide/walkthrough/first-command":{"id":"guide/walkthrough/first-command","title":"First Command","description":"We will dissect a basic command.","sidebar":"tutorialSidebar"},"guide/walkthrough/first-event":{"id":"guide/walkthrough/first-event","title":"First Event Module","description":"We will dissect a basic event module.","sidebar":"tutorialSidebar"},"guide/walkthrough/goal":{"id":"guide/walkthrough/goal","title":"Goal","description":"sern strives to be minimalist, but with all batteries included. Meaning, this framework provides the necessary tools","sidebar":"tutorialSidebar"},"guide/walkthrough/good-to-know":{"id":"guide/walkthrough/good-to-know","title":"Good to know","description":"sern.config.json","sidebar":"tutorialSidebar"},"guide/walkthrough/plugins":{"id":"guide/walkthrough/plugins","title":"Plugins","description":"As of now, modules seem a little underwhelming. It appears that sern doesn\'t have all the features of a standard handler,","sidebar":"tutorialSidebar"},"guide/walkthrough/sern-emitter":{"id":"guide/walkthrough/sern-emitter","title":"The SernEmitter class","description":"You\'re shipped with the SernEmitter. This EventEmitter listens to","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Welcome!","description":"Content","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/9693de07.db75ad65.js b/assets/js/9693de07.db75ad65.js new file mode 100644 index 000000000..de20c0777 --- /dev/null +++ b/assets/js/9693de07.db75ad65.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[9248],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>f});var r=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var o=r.createContext({}),p=function(e){var n=r.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},d=function(e){var n=p(e.components);return r.createElement(o.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},u=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=p(t),f=i,m=u["".concat(o,".").concat(f)]||u[f]||c[f]||a;return t?r.createElement(m,l(l({ref:n},d),{},{components:t})):r.createElement(m,l({ref:n},d))}));function f(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,l=new Array(a);l[0]=u;var s={};for(var o in n)hasOwnProperty.call(n,o)&&(s[o]=n[o]);s.originalType=e,s.mdxType="string"==typeof e?e:i,l[1]=s;for(var p=2;p{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var r=t(7462),i=(t(7294),t(3905));const a={id:"Dependencies",title:"Interface: Dependencies",sidebar_label:"Dependencies",sidebar_position:0,custom_edit_url:null},l=void 0,s={unversionedId:"api/interfaces/Dependencies",id:"api/interfaces/Dependencies",title:"Interface: Dependencies",description:"Properties",source:"@site/docs/api/interfaces/Dependencies.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Dependencies",permalink:"/docs/api/interfaces/Dependencies",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Dependencies",title:"Interface: Dependencies",sidebar_label:"Dependencies",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Controller",permalink:"/docs/api/interfaces/Controller"},next:{title:"DiscordEmitterPlugin",permalink:"/docs/api/interfaces/DiscordEmitterPlugin"}},o={},p=[{value:"Properties",id:"properties",level:2},{value:"@sern/client",id:"sernclient",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"@sern/emitter",id:"sernemitter",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"@sern/errors",id:"sernerrors",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"@sern/logger",id:"sernlogger",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"@sern/modules",id:"sernmodules",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"@sern/store",id:"sernstore",level:3},{value:"Defined in",id:"defined-in-5",level:4}],d={toc:p};function c(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"sernclient"},"@sern/client"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"@sern/client"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#singleton"},(0,i.kt)("inlineCode",{parentName:"a"},"Singleton")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"__module"),">"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L41"},"src/types/handler.ts:41")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernemitter"},"@sern/emitter"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"@sern/emitter"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#singleton"},(0,i.kt)("inlineCode",{parentName:"a"},"Singleton")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEmitter")),">"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L43"},"src/types/handler.ts:43")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernerrors"},"@sern/errors"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"@sern/errors"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#singleton"},(0,i.kt)("inlineCode",{parentName:"a"},"Singleton")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ErrorHandling"},(0,i.kt)("inlineCode",{parentName:"a"},"ErrorHandling")),">"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L46"},"src/types/handler.ts:46")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernlogger"},"@sern/logger"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"@sern/logger"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#singleton"},(0,i.kt)("inlineCode",{parentName:"a"},"Singleton")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Logging"},(0,i.kt)("inlineCode",{parentName:"a"},"Logging")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L42"},"src/types/handler.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernmodules"},"@sern/modules"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"@sern/modules"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#singleton"},(0,i.kt)("inlineCode",{parentName:"a"},"Singleton")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ModuleManager"},(0,i.kt)("inlineCode",{parentName:"a"},"ModuleManager")),">"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L45"},"src/types/handler.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernstore"},"@sern/store"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"@sern/store"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#singleton"},(0,i.kt)("inlineCode",{parentName:"a"},"Singleton")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/ModuleStore"},(0,i.kt)("inlineCode",{parentName:"a"},"ModuleStore")),">"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L44"},"src/types/handler.ts:44")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/97c22b42.72389451.js b/assets/js/97c22b42.72389451.js new file mode 100644 index 000000000..4408f7a5a --- /dev/null +++ b/assets/js/97c22b42.72389451.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7254],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),o=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=o(n),u=a,f=m["".concat(p,".").concat(u)]||m[u]||c[u]||i;return n?r.createElement(f,l(l({ref:t},s),{},{components:n})):r.createElement(f,l({ref:t},s))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:a,l[1]=d;for(var o=2;o{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var r=n(7462),a=(n(7294),n(3905));const i={id:"StringSelectCommand",title:"Interface: StringSelectCommand",sidebar_label:"StringSelectCommand",sidebar_position:0,custom_edit_url:null},l=void 0,d={unversionedId:"api/interfaces/StringSelectCommand",id:"api/interfaces/StringSelectCommand",title:"Interface: StringSelectCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/StringSelectCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/StringSelectCommand",permalink:"/docs/api/interfaces/StringSelectCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"StringSelectCommand",title:"Interface: StringSelectCommand",sidebar_label:"StringSelectCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SlashCommand",permalink:"/docs/api/interfaces/SlashCommand"},next:{title:"TextCommand",permalink:"/docs/api/interfaces/TextCommand"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:o};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,a.kt)("inlineCode",{parentName:"a"},"Module"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"StringSelectCommand"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"StringSelectMenuInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ctx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"StringSelectMenuInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L92"},"src/types/module.ts:92")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#stringselect"},(0,a.kt)("inlineCode",{parentName:"a"},"StringSelect")),">","[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L90"},"src/types/module.ts:90")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L91"},"src/types/module.ts:91")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#stringselect"},(0,a.kt)("inlineCode",{parentName:"a"},"StringSelect"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L89"},"src/types/module.ts:89")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/981f6151.853bc346.js b/assets/js/981f6151.2c047c6d.js similarity index 52% rename from assets/js/981f6151.853bc346.js rename to assets/js/981f6151.2c047c6d.js index 258f4b0c4..0001e901d 100644 --- a/assets/js/981f6151.853bc346.js +++ b/assets/js/981f6151.2c047c6d.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[703],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=a.createContext({}),m=function(e){var t=a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=m(e.components);return a.createElement(i.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,i=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=m(n),u=o,y=c["".concat(i,".").concat(u)]||c[u]||d[u]||r;return n?a.createElement(y,l(l({ref:t},p),{},{components:n})):a.createElement(y,l({ref:t},p))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,l=new Array(r);l[0]=c;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s.mdxType="string"==typeof e?e:o,l[1]=s;for(var m=2;m{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var a=n(7462),o=(n(7294),n(3905));const r={sidebar_position:3},l="First Command",s={unversionedId:"guide/walkthrough/first-command",id:"guide/walkthrough/first-command",title:"First Command",description:"We will dissect a basic command.",source:"@site/docs/guide/walkthrough/first-command.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/first-command",permalink:"/docs/guide/walkthrough/first-command",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/first-command.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"CLI",permalink:"/docs/guide/walkthrough/cli"},next:{title:"First Event Module",permalink:"/docs/guide/walkthrough/first-event"}},i={},m=[{value:"Types of command modules",id:"types-of-command-modules",level:3}],p={toc:m};function d(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"first-command"},"First Command"),(0,o.kt)("p",null,"We will dissect a basic command.\nIf you installed a new project via the cli, This is the ",(0,o.kt)("inlineCode",{parentName:"p"},"ping")," command located in src/commands folder."),(0,o.kt)("p",null,"Typescript"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"import { commandModule, CommandType } from '@sern/handler';\n\nexport default commandModule({\n type: CommandType.Both,\n plugins: [],\n description: 'A ping command',\n // alias : [],\n execute: async (ctx, args) => {\n await ctx.reply({ content: 'Pong \ud83c\udfd3' });\n },\n});\n")),(0,o.kt)("p",null,"Javascript"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"const { CommandType, commandModule } = require('@sern/handler');\n\nexports.default = commandModule({\n type: CommandType.Both,\n plugins: [],\n description: 'A ping command',\n // alias : [],\n execute: async (ctx, args) => {\n await ctx.reply('Pong \ud83c\udfd3');\n },\n})\n")),(0,o.kt)("p",null,"To view what each of these properties mean in depth, visit the ",(0,o.kt)("a",{parentName:"p",href:"https://sern-handler.js.org/docs/api/enums/CommandType"},"official documentation"),"."),(0,o.kt)("h3",{id:"types-of-command-modules"},"Types of command modules"),(0,o.kt)("p",null,"Every command module ",(0,o.kt)("inlineCode",{parentName:"p"},"type")," is part of an enum. This field allows type inference for the rest of a module's fields. ",(0,o.kt)("br",null),"\nAll the command types can be found in the ",(0,o.kt)("a",{parentName:"p",href:"https://sern-handler.js.org/docs/api/enums/CommandType"},"official documentation"),"!"),(0,o.kt)("p",null,"So, lets say you want to make a command module that listens to modals. "),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},"Note"),": Keep in mind you'll need to send a modal with a custom id ",(0,o.kt)("inlineCode",{parentName:"p"},"dm-me"),". This example below is the response to a modal being sent."),(0,o.kt)("br",null),(0,o.kt)("p",null,"Typescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"import { commandModule, CommandType } from '@sern/handler';\nexport default commandModule({\n name: 'dm-me',\n type: CommandType.Modal,\n async execute (modal) {\n const value = modal.fields.getTextInputValue('message');\n modal.client.users.fetch('182326315813306368').then( u =>\n u.send(value + ` from ${modal.user}`)\n );\n modal.reply( { ephemeral:true, content: 'Sent' })\n }\n});\n")),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"const { CommandType, commandModule } = require('@sern/handler');\nexports.default = commandModule({\n name: 'dm-me',\n type: CommandType.Modal,\n async execute (modal) {\n const value = modal.fields.getTextInputValue('message');\n modal.client.users.fetch('182326315813306368').then( u =>\n u.send(value + ` from ${modal.user}`)\n );\n modal.reply( { ephemeral:true, content: 'Sent' })\n }\n});\n")),(0,o.kt)("p",null,"Commands are straight forward. Keep in mind, every other property on the commandModule object is\noptional ",(0,o.kt)("strong",{parentName:"p"},"except")," the type and execute function."),(0,o.kt)("h1",{id:"context-class"},"Context class"),(0,o.kt)("p",null,"The provided Context class helps with modules of ",(0,o.kt)("inlineCode",{parentName:"p"},"CommandType.Both")," (A mixture of slash / legacy commands)."),(0,o.kt)("p",null,"The Context class is passed into modules with type:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"CommandType.Both")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"CommandType.Slash")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"CommandType.Text"))),(0,o.kt)("p",null,"This data structure helps interop between legacy commands and slash commands with ease."),(0,o.kt)("admonition",{type:"note"},(0,o.kt)("p",{parentName:"admonition"},"View the ",(0,o.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},"docs"))),(0,o.kt)("p",null,"Typescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export default commandModule({\n name: 'ping',\n type: CommandType.Both,\n async execute(ctx: Context) {\n await ctx.reply(`pong ${ctx.user}`) \n // .reply is shared between both message and interaction!\n // So is an User object!\n }\n});\n")),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"exports.default = commandModule({\n name: 'ping',\n type: CommandType.Both,\n async execute(ctx) { //ctx is a Context instance\n await ctx.reply(`pong ${ctx.user}`) \n // .reply is shared between both message and interaction!\n // So is an User object!\n }\n});\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[703],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>u});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=a.createContext({}),m=function(e){var t=a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=m(e.components);return a.createElement(i.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,i=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=m(n),u=o,y=c["".concat(i,".").concat(u)]||c[u]||d[u]||r;return n?a.createElement(y,l(l({ref:t},p),{},{components:n})):a.createElement(y,l({ref:t},p))}));function u(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,l=new Array(r);l[0]=c;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s.mdxType="string"==typeof e?e:o,l[1]=s;for(var m=2;m{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var a=n(7462),o=(n(7294),n(3905));const r={sidebar_position:3},l="First Command",s={unversionedId:"guide/walkthrough/first-command",id:"guide/walkthrough/first-command",title:"First Command",description:"We will dissect a basic command.",source:"@site/docs/guide/walkthrough/first-command.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/first-command",permalink:"/docs/guide/walkthrough/first-command",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/first-command.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"CLI",permalink:"/docs/guide/walkthrough/cli"},next:{title:"First Event Module",permalink:"/docs/guide/walkthrough/first-event"}},i={},m=[{value:"Types of command modules",id:"types-of-command-modules",level:3}],p={toc:m};function d(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"first-command"},"First Command"),(0,o.kt)("p",null,"We will dissect a basic command.\nIf you installed a new project via the cli, This is the ",(0,o.kt)("inlineCode",{parentName:"p"},"ping")," command located in src/commands folder."),(0,o.kt)("p",null,"Typescript"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"import { commandModule, CommandType } from '@sern/handler';\n\nexport default commandModule({\n type: CommandType.Both,\n plugins: [],\n description: 'A ping command',\n // alias : [],\n execute: async (ctx, args) => {\n await ctx.reply({ content: 'Pong \ud83c\udfd3' });\n },\n});\n")),(0,o.kt)("p",null,"Javascript"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"const { CommandType, commandModule } = require('@sern/handler');\n\nexports.default = commandModule({\n type: CommandType.Both,\n plugins: [],\n description: 'A ping command',\n // alias : [],\n execute: async (ctx, args) => {\n await ctx.reply('Pong \ud83c\udfd3');\n },\n})\n")),(0,o.kt)("p",null,"To view what each of these properties mean in depth, visit the ",(0,o.kt)("a",{parentName:"p",href:"https://sern.dev/docs/api/enums/CommandType"},"official documentation"),"."),(0,o.kt)("h3",{id:"types-of-command-modules"},"Types of command modules"),(0,o.kt)("p",null,"Every command module ",(0,o.kt)("inlineCode",{parentName:"p"},"type")," is part of an enum. This field allows type inference for the rest of a module's fields. ",(0,o.kt)("br",null),"\nAll the command types can be found in the ",(0,o.kt)("a",{parentName:"p",href:"https://sern.dev/docs/api/enums/CommandType"},"official documentation"),"!"),(0,o.kt)("p",null,"So, lets say you want to make a command module that listens to modals. "),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},"Note"),": Keep in mind you'll need to send a modal with a custom id ",(0,o.kt)("inlineCode",{parentName:"p"},"dm-me"),". This example below is the response to a modal being sent."),(0,o.kt)("br",null),(0,o.kt)("p",null,"Typescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"import { commandModule, CommandType } from '@sern/handler';\nexport default commandModule({\n name: 'dm-me',\n type: CommandType.Modal,\n async execute (modal) {\n const value = modal.fields.getTextInputValue('message');\n modal.client.users.fetch('182326315813306368').then( u =>\n u.send(value + ` from ${modal.user}`)\n );\n modal.reply( { ephemeral:true, content: 'Sent' })\n }\n});\n")),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"const { CommandType, commandModule } = require('@sern/handler');\nexports.default = commandModule({\n name: 'dm-me',\n type: CommandType.Modal,\n async execute (modal) {\n const value = modal.fields.getTextInputValue('message');\n modal.client.users.fetch('182326315813306368').then( u =>\n u.send(value + ` from ${modal.user}`)\n );\n modal.reply( { ephemeral:true, content: 'Sent' })\n }\n});\n")),(0,o.kt)("p",null,"Commands are straight forward. Keep in mind, every other property on the commandModule object is\noptional ",(0,o.kt)("strong",{parentName:"p"},"except")," the type and execute function."),(0,o.kt)("h1",{id:"context-class"},"Context class"),(0,o.kt)("p",null,"The provided Context class helps with modules of ",(0,o.kt)("inlineCode",{parentName:"p"},"CommandType.Both")," (A mixture of slash / legacy commands)."),(0,o.kt)("p",null,"The Context class is passed into modules with type:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"CommandType.Both")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"CommandType.Slash")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"CommandType.Text"))),(0,o.kt)("p",null,"This data structure helps interop between legacy commands and slash commands with ease."),(0,o.kt)("admonition",{type:"note"},(0,o.kt)("p",{parentName:"admonition"},"View the ",(0,o.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},"docs"))),(0,o.kt)("p",null,"Typescript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-typescript"},"export default commandModule({\n name: 'ping',\n type: CommandType.Both,\n async execute(ctx: Context) {\n await ctx.reply(`pong ${ctx.user}`) \n // .reply is shared between both message and interaction!\n // So is an User object!\n }\n});\n")),(0,o.kt)("p",null,"Javascript:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"exports.default = commandModule({\n name: 'ping',\n type: CommandType.Both,\n async execute(ctx) { //ctx is a Context instance\n await ctx.reply(`pong ${ctx.user}`) \n // .reply is shared between both message and interaction!\n // So is an User object!\n }\n});\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9b620520.2c552335.js b/assets/js/9b620520.2c552335.js new file mode 100644 index 000000000..b643c440b --- /dev/null +++ b/assets/js/9b620520.2c552335.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[5502],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>c});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var d=r.createContext({}),p=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return r.createElement(d.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=p(n),c=a,f=m["".concat(d,".").concat(c)]||m[c]||u[c]||i;return n?r.createElement(f,l(l({ref:t},s),{},{components:n})):r.createElement(f,l({ref:t},s))}));function c(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={id:"ButtonCommand",title:"Interface: ButtonCommand",sidebar_label:"ButtonCommand",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/interfaces/ButtonCommand",id:"api/interfaces/ButtonCommand",title:"Interface: ButtonCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/ButtonCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ButtonCommand",permalink:"/docs/api/interfaces/ButtonCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ButtonCommand",title:"Interface: ButtonCommand",sidebar_label:"ButtonCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"BothCommand",permalink:"/docs/api/interfaces/BothCommand"},next:{title:"ChannelSelectCommand",permalink:"/docs/api/interfaces/ChannelSelectCommand"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,a.kt)("inlineCode",{parentName:"a"},"Module"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ButtonCommand"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ButtonInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ctx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ButtonInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L85"},"src/types/module.ts:85")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#button"},(0,a.kt)("inlineCode",{parentName:"a"},"Button")),">","[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L83"},"src/types/module.ts:83")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,a.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L84"},"src/types/module.ts:84")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#button"},(0,a.kt)("inlineCode",{parentName:"a"},"Button"))),(0,a.kt)("h4",{id:"overrides-1"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L82"},"src/types/module.ts:82")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9f1290f8.7bf7cf00.js b/assets/js/9f1290f8.7bf7cf00.js new file mode 100644 index 000000000..c6f4b8b84 --- /dev/null +++ b/assets/js/9f1290f8.7bf7cf00.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[5433],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var d=r.createContext({}),o=function(e){var t=r.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=o(e.components);return r.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),c=o(n),u=i,k=c["".concat(d,".").concat(u)]||c[u]||m[u]||a;return n?r.createElement(k,l(l({ref:t},s),{},{components:n})):r.createElement(k,l({ref:t},s))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=c;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:i,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>a,metadata:()=>p,toc:()=>o});var r=n(7462),i=(n(7294),n(3905));const a={id:"DiscordEmitterPlugin",title:"Interface: DiscordEmitterPlugin",sidebar_label:"DiscordEmitterPlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/DiscordEmitterPlugin",id:"api/interfaces/DiscordEmitterPlugin",title:"Interface: DiscordEmitterPlugin",description:"Hierarchy",source:"@site/docs/api/interfaces/DiscordEmitterPlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/DiscordEmitterPlugin",permalink:"/docs/api/interfaces/DiscordEmitterPlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"DiscordEmitterPlugin",title:"Interface: DiscordEmitterPlugin",sidebar_label:"DiscordEmitterPlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Dependencies",permalink:"/docs/api/interfaces/Dependencies"},next:{title:"DiscordEventPlugin",permalink:"/docs/api/interfaces/DiscordEventPlugin"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4}],s={toc:o};function m(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,i.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"DiscordEmitterPlugin"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,i.kt)("p",null,"will be removed in the next update"),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"execute"},"execute"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"payload"),": { ",(0,i.kt)("inlineCode",{parentName:"p"},"absPath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"mod"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"DiscordEventCommand"),""," & { ",(0,i.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," } }, ",(0,i.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"controller"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"payload")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"payload.absPath")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"payload.mod")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"DiscordEventCommand"),""," & { ",(0,i.kt)("inlineCode",{parentName:"td"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"controller")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L49"},"src/handler/plugins/plugin.ts:49")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,i.kt)("p",null,"will be removed in the next update"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31"},"src/handler/plugins/plugin.ts:31")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#command"},(0,i.kt)("inlineCode",{parentName:"a"},"Command"))),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L48"},"src/handler/plugins/plugin.ts:48")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a3030d1c.de2b1eb5.js b/assets/js/a3030d1c.de2b1eb5.js new file mode 100644 index 000000000..49034a5ff --- /dev/null +++ b/assets/js/a3030d1c.de2b1eb5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4461],{3905:(e,t,a)=>{a.d(t,{Zo:()=>m,kt:()=>c});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),p=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},m=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,o=e.parentName,m=d(e,["components","mdxType","originalType","parentName"]),u=p(a),c=r,f=u["".concat(o,".").concat(c)]||u[c]||s[c]||l;return a?n.createElement(f,i(i({ref:t},m),{},{components:a})):n.createElement(f,i({ref:t},m))}));function c(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=u;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d.mdxType="string"==typeof e?e:r,i[1]=d;for(var p=2;p{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>d,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const l={id:"ModuleManager",title:"Interface: ModuleManager",sidebar_label:"ModuleManager",sidebar_position:0,custom_edit_url:null},i=void 0,d={unversionedId:"api/interfaces/ModuleManager",id:"api/interfaces/ModuleManager",title:"Interface: ModuleManager",description:"Implemented by",source:"@site/docs/api/interfaces/ModuleManager.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ModuleManager",permalink:"/docs/api/interfaces/ModuleManager",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ModuleManager",title:"Interface: ModuleManager",sidebar_label:"ModuleManager",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Module",permalink:"/docs/api/interfaces/Module"},next:{title:"Plugin",permalink:"/docs/api/interfaces/Plugin"}},o={},p=[{value:"Implemented by",id:"implemented-by",level:2},{value:"Methods",id:"methods",level:2},{value:"get",id:"get",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"set",id:"set",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}],m={toc:p};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/DefaultModuleManager"},(0,r.kt)("inlineCode",{parentName:"a"},"DefaultModuleManager")))),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"strat"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/CommandType"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandType")))))),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strat")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"ms"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/ModuleStore"},(0,r.kt)("inlineCode",{parentName:"a"},"ModuleStore")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"]")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/moduleManager.ts#L7"},"src/handler/contracts/moduleManager.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"set"},"set"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"set"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"strat"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strat")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"ms"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/ModuleStore"},(0,r.kt)("inlineCode",{parentName:"a"},"ModuleStore")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/moduleManager.ts#L8"},"src/handler/contracts/moduleManager.ts:8")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a4d0ee3e.0bbe7358.js b/assets/js/a4d0ee3e.0bbe7358.js new file mode 100644 index 000000000..120f0d4d4 --- /dev/null +++ b/assets/js/a4d0ee3e.0bbe7358.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[8902],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>u});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),p=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=p(n),u=r,f=m["".concat(d,".").concat(u)]||m[u]||c[u]||i;return n?a.createElement(f,l(l({ref:t},s),{},{components:n})):a.createElement(f,l({ref:t},s))}));function u(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const i={id:"MentionableSelectCommand",title:"Interface: MentionableSelectCommand",sidebar_label:"MentionableSelectCommand",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/interfaces/MentionableSelectCommand",id:"api/interfaces/MentionableSelectCommand",title:"Interface: MentionableSelectCommand",description:"Hierarchy",source:"@site/docs/api/interfaces/MentionableSelectCommand.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/MentionableSelectCommand",permalink:"/docs/api/interfaces/MentionableSelectCommand",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"MentionableSelectCommand",title:"Interface: MentionableSelectCommand",sidebar_label:"MentionableSelectCommand",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Logging",permalink:"/docs/api/interfaces/Logging"},next:{title:"ModalSubmitCommand",permalink:"/docs/api/interfaces/ModalSubmitCommand"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:p};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},(0,r.kt)("inlineCode",{parentName:"a"},"Module"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"MentionableSelectCommand"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#description"},"description")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L38"},"src/types/module.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"MentionableSelectMenuInteraction"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"CacheType"),">",") => ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MentionableSelectMenuInteraction"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#execute"},"execute")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L113"},"src/types/module.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#name"},"name")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L37"},"src/types/module.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onevent"},"onEvent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#mentionableselect"},(0,r.kt)("inlineCode",{parentName:"a"},"MentionableSelect")),">","[]"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L111"},"src/types/module.ts:111")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"plugins"},"plugins"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"plugins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"","[]"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L112"},"src/types/module.ts:112")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#mentionableselect"},(0,r.kt)("inlineCode",{parentName:"a"},"MentionableSelect"))),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module"},"Module"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Module#type"},"type")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L110"},"src/types/module.ts:110")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a5467962.7c6716f2.js b/assets/js/a5467962.7c6716f2.js new file mode 100644 index 000000000..4c492cee6 --- /dev/null +++ b/assets/js/a5467962.7c6716f2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[6322],{3905:(e,n,t)=>{t.d(n,{Zo:()=>o,kt:()=>m});var r=t(7294);function l(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(l[t]=e[t]);return l}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(l[t]=e[t])}return l}var d=r.createContext({}),u=function(e){var n=r.useContext(d),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},o=function(e){var n=u(e.components);return r.createElement(d.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},c=r.forwardRef((function(e,n){var t=e.components,l=e.mdxType,a=e.originalType,d=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=u(t),m=l,h=c["".concat(d,".").concat(m)]||c[m]||p[m]||a;return t?r.createElement(h,i(i({ref:n},o),{},{components:t})):r.createElement(h,i({ref:n},o))}));function m(e,n){var t=arguments,l=n&&n.mdxType;if("string"==typeof e||l){var a=t.length,i=new Array(a);i[0]=c;var s={};for(var d in n)hasOwnProperty.call(n,d)&&(s[d]=n[d]);s.originalType=e,s.mdxType="string"==typeof e?e:l,i[1]=s;for(var u=2;u{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>u});var r=t(7462),l=(t(7294),t(3905));const a={id:"CommandType",title:"Enumeration: CommandType",sidebar_label:"CommandType",sidebar_position:0,custom_edit_url:null},i=void 0,s={unversionedId:"api/enums/CommandType",id:"api/enums/CommandType",title:"Enumeration: CommandType",description:"A bitfield that discriminates command modules",source:"@site/docs/api/enums/CommandType.md",sourceDirName:"api/enums",slug:"/api/enums/CommandType",permalink:"/docs/api/enums/CommandType",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandType",title:"Enumeration: CommandType",sidebar_label:"CommandType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Sern",permalink:"/docs/api/namespaces/Sern"},next:{title:"EventType",permalink:"/docs/api/enums/EventType"}},d={},u=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Both",id:"both",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Button",id:"button",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ChannelSelect",id:"channelselect",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"CtxMsg",id:"ctxmsg",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"CtxUser",id:"ctxuser",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"MentionableSelect",id:"mentionableselect",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Modal",id:"modal",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"RoleSelect",id:"roleselect",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"Slash",id:"slash",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"StringSelect",id:"stringselect",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"Text",id:"text",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"UserSelect",id:"userselect",level:3},{value:"Defined in",id:"defined-in-11",level:4}],o={toc:u};function p(e){let{components:n,...t}=e;return(0,l.kt)("wrapper",(0,r.Z)({},o,t,{components:n,mdxType:"MDXLayout"}),(0,l.kt)("p",null,"A bitfield that discriminates command modules"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},(0,l.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-ts"},"export default commandModule({\n // highlight-next-line\n type : CommandType.Text,\n name : 'a text command'\n execute(message) {\n console.log(message.content)\n }\n})\n")),(0,l.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,l.kt)("h3",{id:"both"},"Both"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"Both")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"3")),(0,l.kt)("p",null,"The CommandType for hybrid commands, text and slash"),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L28"},"src/handler/structures/enums.ts:28")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"button"},"Button"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"Button")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"16")),(0,l.kt)("p",null,"The CommandType for ButtonInteraction commands"),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L40"},"src/handler/structures/enums.ts:40")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"channelselect"},"ChannelSelect"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"ChannelSelect")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"256")),(0,l.kt)("p",null,"The CommandType for the other SelectMenuInteractions"),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L52"},"src/handler/structures/enums.ts:52")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ctxmsg"},"CtxMsg"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"CtxMsg")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"8")),(0,l.kt)("p",null,"The CommandType for MessageContextMenuInteraction commands"),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L36"},"src/handler/structures/enums.ts:36")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"ctxuser"},"CtxUser"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"CtxUser")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"4")),(0,l.kt)("p",null,"The CommandType for UserContextMenuInteraction commands"),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L32"},"src/handler/structures/enums.ts:32")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"mentionableselect"},"MentionableSelect"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"MentionableSelect")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"512")),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L53"},"src/handler/structures/enums.ts:53")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"modal"},"Modal"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"Modal")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"64")),(0,l.kt)("p",null,"The CommandType for ModalSubmitInteraction commands"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L48"},"src/handler/structures/enums.ts:48")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"roleselect"},"RoleSelect"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"RoleSelect")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"1024")),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L54"},"src/handler/structures/enums.ts:54")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"slash"},"Slash"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"Slash")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"2")),(0,l.kt)("p",null,"The CommandType for slash commands"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L24"},"src/handler/structures/enums.ts:24")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"stringselect"},"StringSelect"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"StringSelect")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"32")),(0,l.kt)("p",null,"The CommandType for StringSelectMenuInteraction commands"),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L44"},"src/handler/structures/enums.ts:44")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"text"},"Text"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"Text")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"1")),(0,l.kt)("p",null,"The CommandType for text commands"),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L20"},"src/handler/structures/enums.ts:20")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"userselect"},"UserSelect"),(0,l.kt)("p",null,"\u2022 ",(0,l.kt)("strong",{parentName:"p"},"UserSelect")," = ",(0,l.kt)("inlineCode",{parentName:"p"},"2048")),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L55"},"src/handler/structures/enums.ts:55")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a5467962.89fc49a2.js b/assets/js/a5467962.89fc49a2.js deleted file mode 100644 index cd1cbbd56..000000000 --- a/assets/js/a5467962.89fc49a2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[6322],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>c});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function l(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var o=r.createContext({}),u=function(e){var n=r.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},d=function(e){var n=u(e.components);return r.createElement(o.Provider,{value:n},e.children)},m={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},p=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,l=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),p=u(t),c=a,h=p["".concat(o,".").concat(c)]||p[c]||m[c]||l;return t?r.createElement(h,i(i({ref:n},d),{},{components:t})):r.createElement(h,i({ref:n},d))}));function c(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var l=t.length,i=new Array(l);i[0]=p;var s={};for(var o in n)hasOwnProperty.call(n,o)&&(s[o]=n[o]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var u=2;u{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>s,toc:()=>u});var r=t(7462),a=(t(7294),t(3905));const l={id:"CommandType",title:"Enumeration: CommandType",sidebar_label:"CommandType",sidebar_position:0,custom_edit_url:null},i=void 0,s={unversionedId:"api/enums/CommandType",id:"api/enums/CommandType",title:"Enumeration: CommandType",description:"Example",source:"@site/docs/api/enums/CommandType.md",sourceDirName:"api/enums",slug:"/api/enums/CommandType",permalink:"/docs/api/enums/CommandType",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandType",title:"Enumeration: CommandType",sidebar_label:"CommandType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Sern",permalink:"/docs/api/namespaces/Sern"},next:{title:"EventType",permalink:"/docs/api/enums/EventType"}},o={},u=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Both",id:"both",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Button",id:"button",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"MenuMsg",id:"menumsg",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"MenuSelect",id:"menuselect",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"MenuUser",id:"menuuser",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"Modal",id:"modal",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Slash",id:"slash",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Text",id:"text",level:3},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:u};function m(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export default commandModule({\n // highlight-next-line\n type : CommandType.Text,\n name : 'a text command'\n execute(message) {\n console.log(message.content)\n }\n})\n")),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"both"},"Both"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Both")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"3")),(0,a.kt)("p",null,"The CommandType for hybrid commands, text and slash"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L27"},"src/handler/structures/enums.ts:27")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"button"},"Button"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Button")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"16")),(0,a.kt)("p",null,"The CommandType for ButtonInteraction commands"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L39"},"src/handler/structures/enums.ts:39")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menumsg"},"MenuMsg"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"MenuMsg")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"8")),(0,a.kt)("p",null,"The CommandType for MessageContextMenuInteraction commands"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L35"},"src/handler/structures/enums.ts:35")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menuselect"},"MenuSelect"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"MenuSelect")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"32")),(0,a.kt)("p",null,"The CommandType for SelectMenuInteraction commands"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L43"},"src/handler/structures/enums.ts:43")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menuuser"},"MenuUser"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"MenuUser")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"4")),(0,a.kt)("p",null,"The CommandType for UserContextMenuInteraction commands"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L31"},"src/handler/structures/enums.ts:31")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"modal"},"Modal"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Modal")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"64")),(0,a.kt)("p",null,"The CommandType for ModalSubmitInteraction commands"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L47"},"src/handler/structures/enums.ts:47")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"slash"},"Slash"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Slash")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"2")),(0,a.kt)("p",null,"The CommandType for slash commands"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L23"},"src/handler/structures/enums.ts:23")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"text"},"Text"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"Text")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"1")),(0,a.kt)("p",null,"The CommandType for text commands"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L19"},"src/handler/structures/enums.ts:19")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b2f554cd.325a1e35.js b/assets/js/b2f554cd.325a1e35.js deleted file mode 100644 index b94506928..000000000 --- a/assets/js/b2f554cd.325a1e35.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[1477],{10:e=>{e.exports=JSON.parse('{"blogPosts":[{"id":"2.0.0","metadata":{"permalink":"/blog/2.0.0","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-12-13-mdx-blog-post.md","source":"@site/blog/2022-12-13-mdx-blog-post.md","title":"Release 2.0.0","description":"2.0 Release","date":"2022-12-13T00:00:00.000Z","formattedDate":"December 13, 2022","tags":[{"label":"release","permalink":"/blog/tags/release"}],"readingTime":0.63,"hasTruncateMarker":false,"authors":[{"name":"jacoobes","title":"Head Dev","url":"https://github.com/jacoobes","imageURL":"https://github.com/jacoobes.png","key":"jacoobes"}],"frontMatter":{"slug":"2.0.0","title":"Release 2.0.0","authors":["jacoobes"],"tags":["release"]},"nextItem":{"title":"How to get started with sern!","permalink":"/blog/getting-started"}},"content":"## 2.0 Release\\nWow! We\'re finally increasing our semantic versioning by +`1.7.9.`
\\nWhat does this mean?\\n\\n### Plugin Support for Event Modules\\nYou can now use plugins for event modules. Previous version would throw an error if the \\n`plugins` field was populated.\\n\\n```typescript \\nexport function commandPlTest() : SernEmitterPlugin {\\n return {\\n type: PluginType.Command,\\n execute: ({ mod}, controller) => {\\n if(mod.name === \'module.register\') {\\n console.log(\'Event Module created correctly\')\\n return controller.next()\\n }\\n console.log(\'event name is wrong\')\\n return controller.stop()\\n }\\n }\\n}\\n```\\nApplying this plugin to some `eventModule`: \\n```typescript\\nexport default eventModule({\\n name: \'error\',\\n type: EventType.Sern,\\n plugins: [commandPlTest()],\\n execute(m) {\\n console.log(m)\\n },\\n})\\n```\\n## Dependency Injection and Decoupling\\n\\nTHIS SECTION IS PROBABLY THE MOST IMPORTANT!!
\\ni should have eaten something before i feel hungry"},{"id":"getting-started","metadata":{"permalink":"/blog/getting-started","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-09-30-mdx-blog-post.md","source":"@site/blog/2022-09-30-mdx-blog-post.md","title":"How to get started with sern!","description":"Hello everyone!","date":"2022-09-30T00:00:00.000Z","formattedDate":"September 30, 2022","tags":[{"label":"guides","permalink":"/blog/tags/guides"}],"readingTime":1.31,"hasTruncateMarker":false,"authors":[{"name":"Sr Izan","title":"Contributor","url":"https://github.com/SrIzan10","imageURL":"https://github.com/SrIzan10.png","key":"Sr Izan"}],"frontMatter":{"slug":"getting-started","title":"How to get started with sern!","authors":["Sr Izan"],"tags":["guides"]},"prevItem":{"title":"Release 2.0.0","permalink":"/blog/2.0.0"},"nextItem":{"title":"Release 1.2.0","permalink":"/blog/1.2.0"}},"content":"## Hello everyone!\\n\\nI\'m Sr Izan, your fellow user and contributor.\\n\\nToday I\'m going to show you how to get started with sern and all its cool features.\\n\\n### Step 1: Install the CLI.\\n\\nInstall the CLI:\\n```\\nnpm i -g @sern/cli\\n```\\nand then run\\n```\\nsern init\\n```\\n:::tip\\nYou can also run `sern init -y` if you want to use the default options.\\n:::\\n\\nThe CLI is written in Typescript and open-sourced on [Github](https://github.com/sern-handler/cli). (thanks [evo](https://github.com/EvolutionX-10)!)\\n\\n### Step 2: Have some way to store secrets.\\n\\nNormally you\'d need a way to store secrets, and the best way to do that is by installing another package: `dotenv`\\n\\njust `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.\\n\\n:::caution\\nIf you\'re using ESM, configure dotenv with `import \'dotenv/config\'` instead of `require(\'dotenv\').config()`.\\n:::\\n\\n### And... that\'s it?\\n\\nYes, that\'s it. Here\'s a little FAQ to get you started. You can also join the [Discord](https://sern-handler.js.org/discord) for any problems.\\n\\n### Extra: Video tutorial!\\n\\n\\n\\n## FAQ\\n\\n**Q**: How do I publish a slash command? \\n**A**: Install the publish extension. Little video: \\n\\n\\n**Q**: Any snippet VSCode extension? \\n**A**: Yeah, just search `sern Snippets` made by a verified publisher called Sr Izan (haha yeah me funny!) \\n\\n**Q**: HEEEELLLPPPP!!!! \\n**A**: Hey, don\'t panic! We\'re here to help so, join the [Discord](https://sern-handler.js.org/discord). We\'re trying to get to 100 members!"},{"id":"1.2.0","metadata":{"permalink":"/blog/1.2.0","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-09-28-mdx-blog-post.md","source":"@site/blog/2022-09-28-mdx-blog-post.md","title":"Release 1.2.0","description":"Class-based modules","date":"2022-09-28T00:00:00.000Z","formattedDate":"September 28, 2022","tags":[{"label":"release","permalink":"/blog/tags/release"}],"readingTime":1.71,"hasTruncateMarker":false,"authors":[{"name":"jacoobes","title":"Head Dev","url":"https://github.com/jacoobes","imageURL":"https://github.com/jacoobes.png","key":"jacoobes"}],"frontMatter":{"slug":"1.2.0","title":"Release 1.2.0","authors":["jacoobes"],"tags":["release"]},"prevItem":{"title":"How to get started with sern!","permalink":"/blog/getting-started"}},"content":"## Class-based modules\\n\\nToday we\'re announcing the ability to create class based modules!\\nTo get started, install\\n```\\nnpm install @sern/handler@latest\\n```\\n\\nQuick List of changes!\\n- [Class based modules](#class-based-modules)\\n- [Deprecation Warnings](#deprecation-warnings)\\n- [Dependencies update](#dependencies-update)\\n\\n\\n### Class based modules\\nIncorporate class based modules into your project instead of the traditional `commandModule` or `eventModule`\\nExtend the new [CommandExecutable](docs/api/classes/CommandExecutable) or [EventExecutable](docs/api/classes/EventExecutable)\\n```ts title=\\"commands/meaning-of-life.ts\\"\\nimport { CommandType, CommandExecutable, type Args, type Context } from \'@sern/handler\';\\nimport { publish } from \'../plugins/publish.js\';\\nimport { serendipityOnly } from \'../plugins/serendipityOnly.js\';\\n\\nexport default class extends CommandExecutable {\\n type = CommandType.Both as const;\\n description = \'What is the meaning of life?\'\\n override onEvent = [\\n serendipityOnly()\\n ];\\n override plugins = [\\n publish(),\\n ];\\n // highlight-next-line\\n execute = async (ctx: Context, args: Args) => {\\n await ctx.reply(\'42\')\\n };\\n}\\n```\\n:::caution\\n\\nexecute must not be a method of the class. It should be as above, a property on the class!\\n\\n:::\\n\\n```ts title=\\"events/guildMemberAdd.ts\\"\\nimport { CommandType, EventExecutable, type EventType } from \'@sern/handler\';\\nimport type { GuildMember } from \'discord.js\'\\n\\nexport default class extends EventExecutable {\\n type = EventType.Discord as const;\\n // highlight-next-line\\n execute = (member: GuildMember) => {\\n console.log(member)\\n };\\n}\\n```\\nNow, you might ask **why** this feature was added.
Simply put, to give flexibility to the developers.\\nI believe that you should build your own structures however you might like and customize to your liking.\\nIn addition, **decorators now unofficially work with modules!**\\nFeel free to use TypeScript experimental decorators to augment and customize your classes. \\n\\n### Deprecation Warnings\\nThe next update will bring sern v2 with some important features. Here are some things to watch out for.\\n\\n- [Wrapper#client](docs/api/interfaces/Wrapper) will be deprecated\\n- [Wrapper#sernEmitter](docs/api/interfaces/Wrapper) will be deprecated\\n - a SernEmitter will be automatically created once Sern#init is called\\n- The option to pass in a function or array for [Wrapper#events](docs/api/interfaces/Wrapper) will be deprecated. Only strings are accepted.\\n- [Sern#addExternal](docs/api/classes/SernEmitter) will be deprecated in favor of a better way.\\n\\n### Dependencies Update\\n- TypeScript has been updated to 4.8.3\\n- Discord.js has been upgraded to 14.5"}]}')}}]); \ No newline at end of file diff --git a/assets/js/b2f554cd.7f056a62.js b/assets/js/b2f554cd.7f056a62.js new file mode 100644 index 000000000..cf2e779f6 --- /dev/null +++ b/assets/js/b2f554cd.7f056a62.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[1477],{10:e=>{e.exports=JSON.parse('{"blogPosts":[{"id":"2.0.0","metadata":{"permalink":"/blog/2.0.0","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-12-13-mdx-blog-post.md","source":"@site/blog/2022-12-13-mdx-blog-post.md","title":"Release 2.0.0","description":"2.0 Release","date":"2022-12-13T00:00:00.000Z","formattedDate":"December 13, 2022","tags":[{"label":"release","permalink":"/blog/tags/release"}],"readingTime":3.63,"hasTruncateMarker":false,"authors":[{"name":"jacoobes","title":"Head Dev","url":"https://github.com/jacoobes","imageURL":"https://github.com/jacoobes.png","key":"jacoobes"}],"frontMatter":{"slug":"2.0.0","title":"Release 2.0.0","authors":["jacoobes"],"tags":["release"]},"nextItem":{"title":"How to get started with sern!","permalink":"/blog/getting-started"}},"content":"## 2.0 Release\\nJoin our [discord](https://sern.dev/discord)!
\\nWow! We\'re finally increasing our semantic versioning by +`1.7.9.`
\\nWhat does this mean?\\n\\n### Plugin Support for Event Modules\\nYou can now use plugins for event modules. Previous version would throw an error if the \\n`plugins` field was populated.\\n\\n```typescript \\nexport function commandPlTest() : SernEmitterPlugin {\\n return {\\n type: PluginType.Command,\\n execute: ({ mod}, controller) => {\\n if(mod.name === \'module.register\') {\\n console.log(\'Event Module created correctly\')\\n return controller.next()\\n }\\n console.log(\'event name is wrong\')\\n return controller.stop()\\n }\\n }\\n}\\n```\\nApplying this plugin to some `eventModule`: \\n```typescript\\nexport default eventModule({\\n name: \'error\',\\n type: EventType.Sern,\\n plugins: [commandPlTest()],\\n execute(m) {\\n console.log(m)\\n },\\n})\\n```\\n## Dependency Injection and Decoupling\\n\\nThe powerful npm package `iti` decouples sern even more.\\nDecoupling data structures with the Inversion of Control pattern separates data from logic, which will help speed production\\nand make sern even more customizable than before.\\n\\n### How do I start?\\n```typescript title=\\"src/index.ts\\"\\n//With typescript, you can customize / augment your typings.\\ninterface MyDependencies extends Dependencies {\\n \'@sern/client\' : Singleton;\\n \'@sern/logger\' : Singleton\\n}\\n\\nexport const useContainer = Sern.makeDependencies({\\n// exclude: new Set([\'@sern/logger\']), don\'t autofill optional dependencies\\n build: root => root\\n .add({ \'@sern/client\': single(client) }) \\n .add({ \'@sern/logger\': single(new DefaultLogging()) })\\n});\\n\\nSern.init({\\n defaultPrefix: \'!\', // removing defaultPrefix will shut down text commands\\n commands: \'src/commands\',\\n // events: \'src/events\' (optional),\\n containerConfig : {\\n get: useContainer //pass in your dependency getter here\\n }\\n});\\n\\n```\\nUsing the `Sern#makeDependencies` function, inject your dependencies. \\nWe\'ll use specific dependencies that are created with the `@sern/keyword`\\nkey.\\nUsing typescript to display all `keywords` and what they represent:\\n```typescript\\nexport interface Dependencies {\\n \'@sern/client\': Singleton; //Discord Client\\n \'@sern/logger\'?: Singleton; //Logger\\n \'@sern/emitter\': Singleton; //SernEmitter\\n \'@sern/store\' : Singleton; //Stores all Command Modules\\n \'@sern/modules\' : Singleton; //Manages Modules\\n \'@sern/errors\': Singleton; //A Lifetime / Crash Handler\\n}\\n```\\n:::danger\\nSern#addExternal has been deprecated and removed in favor of Sern#makeDependencies\\n:::\\nAt the moment, one optional dependency, `@sern/logger`, exists. If not added explicitly,\\nwe\'ll **autofill** with a [DefaultLogger](https://sern.dev/docs/api/classes/defaultlogging).\\n\\n:::tip\\nIf you don\'t want a logger, add it to the\\n`exclude` field while composing dependencies.\\n:::\\n\\nUse your generated dependency getter `useContainer` (use whatever name you want), access them\\nfrom anywhere.\\n:::note\\nthe function [useContainerRaw](https://sern.dev/docs/api/modules#usecontainerraw) is provided for direct access to dependencies and the internal\\ndata structure. Use this wisely as no guarantees are made and crashes can happen.\\n:::\\n\\nThe `build` field follows [createContainer](https://itijs.org/docs/quick-start#usage) function call.\\n\\n## New CommandTypes\\n2.0 includes all the new role select menus. `CommandType.MenuSelect` has been renamed into\\n`CommandType.StringSelect`. The remaining SelectMenus are\\n`CommandType.RoleSelect`, `CommandType.ChannelSelect`, `CommandType.UserSelect`, `CommandType.MentionableSelect`\\n```typescript title=\\"commands/roleselect.ts\\"\\nexport default commandModule({\\n type: CommandType.RoleSelect,\\n execute(ctx) {\\n ctx.reply(\'role select\')\\n },\\n})\\n```\\nIn addition, commandModules with ContextMenus have been renamed.\\n```diff\\n- CommandType.MenuUser, CommandType.MenuMsg \\n+ CommandType.CtxUser, CommandType.CtxMsg\\n```\\n## Typings Simplification\\nPre 2.0: \\n\\n


\\nPost 2.0:\\n
\\n\\n\\nCommandPlugin and EventPlugin typings have also been static\'ified, transformed from types to interfaces\\n## Breaking Changes\\n\\n
\\nAll deprecation warnings from previous versions have taken effect, and are removed in 2.0.\\n\\n```diff\\n- type Module = EventModule | CommandModule\\n+ type AnyModule = EventModule | CommandModule\\n\\n-export type SpreadParams unknown> = (\\n- args: Parameters[number],\\n- ) => unknown;\\n```\\nOverride type has been removed due to redundancy\\n```diff\\n- discord.js : 14.5\\n+ discord.js : 14.7\\n\\n-typescript: 4.7\\n+ typescript: 4.9\\n```\\n```diff\\n+ interface Wrapper {\\n+ readonly defaultPrefix?: string;\\n+ readonly commands: string;\\n+ readonly events?: string;\\n+ readonly containerConfig : {\\n+ get: (...keys: (keyof Dependencies)[]) => unknown[];\\n+ }\\n+}\\n\\n- interface Wrapper {\\n- readonly client: Client;\\n- readonly sernEmitter?: SernEmitter;\\n- readonly defaultPrefix?: string;\\n- readonly commands: string;\\n- readonly events?:\\n- | string\\n- | { mod: EventModule; absPath: string }[]\\n- | (() => { mod: EventModule; absPath: string }[]);\\n-}\\n```\\n```diff\\n+ DefaultLogger\\n+ DefaultModuleManager\\n+ SernEmitter\\n+ DefaultErrorHandling\\n+ type Singleton = () => T\\n+ type Transient = () => () => T; \\n+ type LogPayload = { message: T }\\n+ export const single = () => T\\n+ export const many = () => () => T\\n```\\nIncluding the previous section, some names to symbols and data structures were altered to\\nbe better represented. view [changelog](/404.html)\\n\\n## Context refactoring\\nThe context data structure has been internally altered to represent its dynamics better."},{"id":"getting-started","metadata":{"permalink":"/blog/getting-started","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-09-30-mdx-blog-post.md","source":"@site/blog/2022-09-30-mdx-blog-post.md","title":"How to get started with sern!","description":"Hello everyone!","date":"2022-09-30T00:00:00.000Z","formattedDate":"September 30, 2022","tags":[{"label":"guides","permalink":"/blog/tags/guides"}],"readingTime":1.31,"hasTruncateMarker":false,"authors":[{"name":"Sr Izan","title":"Contributor","url":"https://github.com/SrIzan10","imageURL":"https://github.com/SrIzan10.png","key":"Sr Izan"}],"frontMatter":{"slug":"getting-started","title":"How to get started with sern!","authors":["Sr Izan"],"tags":["guides"]},"prevItem":{"title":"Release 2.0.0","permalink":"/blog/2.0.0"},"nextItem":{"title":"Release 1.2.0","permalink":"/blog/1.2.0"}},"content":"## Hello everyone!\\n\\nI\'m Sr Izan, your fellow user and contributor.\\n\\nToday I\'m going to show you how to get started with sern and all its cool features.\\n\\n### Step 1: Install the CLI.\\n\\nInstall the CLI:\\n```\\nnpm i -g @sern/cli\\n```\\nand then run\\n```\\nsern init\\n```\\n:::tip\\nYou can also run `sern init -y` if you want to use the default options.\\n:::\\n\\nThe CLI is written in Typescript and open-sourced on [Github](https://github.com/sern-handler/cli). (thanks [evo](https://github.com/EvolutionX-10)!)\\n\\n### Step 2: Have some way to store secrets.\\n\\nNormally you\'d need a way to store secrets, and the best way to do that is by installing another package: `dotenv`\\n\\njust `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.\\n\\n:::caution\\nIf you\'re using ESM, configure dotenv with `import \'dotenv/config\'` instead of `require(\'dotenv\').config()`.\\n:::\\n\\n### And... that\'s it?\\n\\nYes, that\'s it. Here\'s a little FAQ to get you started. You can also join the [Discord](https://sern-handler.js.org/discord) for any problems.\\n\\n### Extra: Video tutorial!\\n\\n\\n\\n## FAQ\\n\\n**Q**: How do I publish a slash command? \\n**A**: Install the publish extension. Little video: \\n\\n\\n**Q**: Any snippet VSCode extension? \\n**A**: Yeah, just search `sern Snippets` made by a verified publisher called Sr Izan (haha yeah me funny!) \\n\\n**Q**: HEEEELLLPPPP!!!! \\n**A**: Hey, don\'t panic! We\'re here to help so, join the [Discord](https://sern-handler.js.org/discord). We\'re trying to get to 100 members!"},{"id":"1.2.0","metadata":{"permalink":"/blog/1.2.0","editUrl":"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/blog/2022-09-28-mdx-blog-post.md","source":"@site/blog/2022-09-28-mdx-blog-post.md","title":"Release 1.2.0","description":"Class-based modules","date":"2022-09-28T00:00:00.000Z","formattedDate":"September 28, 2022","tags":[{"label":"release","permalink":"/blog/tags/release"}],"readingTime":1.71,"hasTruncateMarker":false,"authors":[{"name":"jacoobes","title":"Head Dev","url":"https://github.com/jacoobes","imageURL":"https://github.com/jacoobes.png","key":"jacoobes"}],"frontMatter":{"slug":"1.2.0","title":"Release 1.2.0","authors":["jacoobes"],"tags":["release"]},"prevItem":{"title":"How to get started with sern!","permalink":"/blog/getting-started"}},"content":"## Class-based modules\\n\\nToday we\'re announcing the ability to create class based modules!\\nTo get started, install\\n```\\nnpm install @sern/handler@latest\\n```\\n\\nQuick List of changes!\\n- [Class based modules](#class-based-modules)\\n- [Deprecation Warnings](#deprecation-warnings)\\n- [Dependencies update](#dependencies-update)\\n\\n\\n### Class based modules\\nIncorporate class based modules into your project instead of the traditional `commandModule` or `eventModule`\\nExtend the new [CommandExecutable](docs/api/classes/CommandExecutable) or [EventExecutable](docs/api/classes/EventExecutable)\\n```ts title=\\"commands/meaning-of-life.ts\\"\\nimport { CommandType, CommandExecutable, type Args, type Context } from \'@sern/handler\';\\nimport { publish } from \'../plugins/publish.js\';\\nimport { serendipityOnly } from \'../plugins/serendipityOnly.js\';\\n\\nexport default class extends CommandExecutable {\\n type = CommandType.Both as const;\\n description = \'What is the meaning of life?\'\\n override onEvent = [\\n serendipityOnly()\\n ];\\n override plugins = [\\n publish(),\\n ];\\n // highlight-next-line\\n execute = async (ctx: Context, args: Args) => {\\n await ctx.reply(\'42\')\\n };\\n}\\n```\\n:::caution\\n\\nexecute must not be a method of the class. It should be as above, a property on the class!\\n\\n:::\\n\\n```ts title=\\"events/guildMemberAdd.ts\\"\\nimport { CommandType, EventExecutable, type EventType } from \'@sern/handler\';\\nimport type { GuildMember } from \'discord.js\'\\n\\nexport default class extends EventExecutable {\\n type = EventType.Discord as const;\\n // highlight-next-line\\n execute = (member: GuildMember) => {\\n console.log(member)\\n };\\n}\\n```\\nNow, you might ask **why** this feature was added.
Simply put, to give flexibility to the developers.\\nI believe that you should build your own structures however you might like and customize to your liking.\\nIn addition, **decorators now unofficially work with modules!**\\nFeel free to use TypeScript experimental decorators to augment and customize your classes. \\n\\n### Deprecation Warnings\\nThe next update will bring sern v2 with some important features. Here are some things to watch out for.\\n\\n- [Wrapper#client](docs/api/interfaces/Wrapper) will be deprecated\\n- [Wrapper#sernEmitter](docs/api/interfaces/Wrapper) will be deprecated\\n - a SernEmitter will be automatically created once Sern#init is called\\n- The option to pass in a function or array for [Wrapper#events](docs/api/interfaces/Wrapper) will be deprecated. Only strings are accepted.\\n- [Sern#addExternal](docs/api/classes/SernEmitter) will be deprecated in favor of a better way.\\n\\n### Dependencies Update\\n- TypeScript has been updated to 4.8.3\\n- Discord.js has been upgraded to 14.5"}]}')}}]); \ No newline at end of file diff --git a/assets/js/bcd9df7e.37a2ef32.js b/assets/js/bcd9df7e.37a2ef32.js new file mode 100644 index 000000000..062e51789 --- /dev/null +++ b/assets/js/bcd9df7e.37a2ef32.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[8652],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},o=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=p(n),m=a,k=c["".concat(s,".").concat(m)]||c[m]||u[m]||l;return n?r.createElement(k,i(i({ref:t},o),{},{components:n})):r.createElement(k,i({ref:t},o))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,i=new Array(l);i[0]=c;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d.mdxType="string"==typeof e?e:a,i[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>d,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const l={id:"Context",title:"Class: Context",sidebar_label:"Context",sidebar_position:0,custom_edit_url:null},i=void 0,d={unversionedId:"api/classes/Context",id:"api/classes/Context",title:"Class: Context",description:"Provides values shared between",source:"@site/docs/api/classes/Context.md",sourceDirName:"api/classes",slug:"/api/classes/Context",permalink:"/docs/api/classes/Context",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Context",title:"Class: Context",sidebar_label:"Context",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CommandExecutable",permalink:"/docs/api/classes/CommandExecutable"},next:{title:"DefaultErrorHandling",permalink:"/docs/api/classes/DefaultErrorHandling"}},s={},p=[{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Accessors",id:"accessors",level:2},{value:"channel",id:"channel",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"client",id:"client",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"createdTimestamp",id:"createdtimestamp",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"guild",id:"guild",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"guildId",id:"guildid",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"inGuild",id:"inguild",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"interaction",id:"interaction",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"member",id:"member",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"message",id:"message",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"user",id:"user",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Methods",id:"methods",level:2},{value:"isMessage",id:"ismessage",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"isSlash",id:"isslash",level:3},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"reply",id:"reply",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"wrap",id:"wrap",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-15",level:4}],o={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"Provides values shared between\nMessage and ChatInputCommandInteraction"),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"new Context"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"ctx"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ctx")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"boolean"),">",", ",(0,a.kt)("inlineCode",{parentName:"td"},"ChatInputCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">",">")))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L23"},"src/handler/structures/context.ts:23")),(0,a.kt)("h2",{id:"accessors"},"Accessors"),(0,a.kt)("h3",{id:"channel"},"channel"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"channel"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"TextBasedChannel")),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"TextBasedChannel")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L51"},"src/handler/structures/context.ts:51")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"client"},"client"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"client"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L98"},"src/handler/structures/context.ts:98")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"createdtimestamp"},"createdTimestamp"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"createdTimestamp"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L67"},"src/handler/structures/context.ts:67")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"guild"},"guild"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"guild"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Guild")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"Guild")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L74"},"src/handler/structures/context.ts:74")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"guildid"},"guildId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"guildId"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L81"},"src/handler/structures/context.ts:81")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"id"},"id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"id"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L44"},"src/handler/structures/context.ts:44")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"inguild"},"inGuild"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"inGuild"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L105"},"src/handler/structures/context.ts:105")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"interaction"},"interaction"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"interaction"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"ChatInputCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">"),(0,a.kt)("p",null,"Getting the ChatInputCommandInteraction object. Crashes if module type is\nCommandType.Text or the event fired in a Both command was\nMessage"),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"ChatInputCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L40"},"src/handler/structures/context.ts:40")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"member"},"member"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"member"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"GuildMember")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"APIInteractionGuildMember")),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"GuildMember")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"APIInteractionGuildMember")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L91"},"src/handler/structures/context.ts:91")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"message"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("p",null,"Getting the Message object. Crashes if module type is\nCommandType.Slash or the event fired in a Both command was\nChatInputCommandInteraction"),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L32"},"src/handler/structures/context.ts:32")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"user"},"user"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"user"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"User")),(0,a.kt)("p",null,"If context is holding a message, message.author\nelse, interaction.user"),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"User")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L60"},"src/handler/structures/context.ts:60")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"ismessage"},"isMessage"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isMessage"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L111"},"src/handler/structures/context.ts:111")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"isslash"},"isSlash"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isSlash"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L115"},"src/handler/structures/context.ts:115")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"reply"},"reply"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"reply"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"content"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">",">"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"content")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/modules#replyoptions"},(0,a.kt)("inlineCode",{parentName:"a"},"ReplyOptions")))))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">",">"),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L126"},"src/handler/structures/context.ts:126")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wrap"},"wrap"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"wrap"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"wrappable"),"): ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,a.kt)("inlineCode",{parentName:"a"},"Context"))),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"wrappable")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"boolean"),">"," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"ChatInputCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h4",{id:"returns-14"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,a.kt)("inlineCode",{parentName:"a"},"Context"))),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/context.ts#L119"},"src/handler/structures/context.ts:119")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bcd9df7e.fd236fd7.js b/assets/js/bcd9df7e.fd236fd7.js deleted file mode 100644 index b2b61aaf9..000000000 --- a/assets/js/bcd9df7e.fd236fd7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[8652],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>k});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},o=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),m=p(n),k=a,c=m["".concat(s,".").concat(k)]||m[k]||u[k]||l;return n?r.createElement(c,i(i({ref:t},o),{},{components:n})):r.createElement(c,i({ref:t},o))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,i=new Array(l);i[0]=m;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d.mdxType="string"==typeof e?e:a,i[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>d,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const l={id:"Context",title:"Class: Context",sidebar_label:"Context",sidebar_position:0,custom_edit_url:null},i=void 0,d={unversionedId:"api/classes/Context",id:"api/classes/Context",title:"Class: Context",description:"Provides values shared between",source:"@site/docs/api/classes/Context.md",sourceDirName:"api/classes",slug:"/api/classes/Context",permalink:"/docs/api/classes/Context",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Context",title:"Class: Context",sidebar_label:"Context",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"CommandExecutable",permalink:"/docs/api/classes/CommandExecutable"},next:{title:"EventExecutable",permalink:"/docs/api/classes/EventExecutable"}},s={},p=[{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Accessors",id:"accessors",level:2},{value:"channel",id:"channel",level:3},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"client",id:"client",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"createdTimestamp",id:"createdtimestamp",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"guild",id:"guild",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"guildId",id:"guildid",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"inGuild",id:"inguild",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"interaction",id:"interaction",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"member",id:"member",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"message",id:"message",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"user",id:"user",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Methods",id:"methods",level:2},{value:"isEmpty",id:"isempty",level:3},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"reply",id:"reply",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"wrap",id:"wrap",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-14",level:4}],o={toc:p};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"Provides values shared between\nMessage and ChatInputCommandInteraction"),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Private")," ",(0,a.kt)("strong",{parentName:"p"},"new Context"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"oMsg?"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"oInterac?"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"oMsg")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Option"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"boolean"),">",">"),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"None"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"oInterac")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Option"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"ChatInputCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">",">"),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"None"))))),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L31"},"src/handler/structures/context.ts:31")),(0,a.kt)("h2",{id:"accessors"},"Accessors"),(0,a.kt)("h3",{id:"channel"},"channel"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"channel"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#nullish"},(0,a.kt)("inlineCode",{parentName:"a"},"Nullish")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"TextBasedChannel"),">"),(0,a.kt)("h4",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#nullish"},(0,a.kt)("inlineCode",{parentName:"a"},"Nullish")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"TextBasedChannel"),">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L63"},"src/handler/structures/context.ts:63")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"client"},"client"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"client"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Client"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L108"},"src/handler/structures/context.ts:108")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"createdtimestamp"},"createdTimestamp"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"createdTimestamp"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"returns-2"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L77"},"src/handler/structures/context.ts:77")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"guild"},"guild"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"guild"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Guild")),(0,a.kt)("h4",{id:"returns-3"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Guild")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L84"},"src/handler/structures/context.ts:84")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"guildid"},"guildId"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"guildId"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-4"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L91"},"src/handler/structures/context.ts:91")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"id"},"id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"id"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"returns-5"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L56"},"src/handler/structures/context.ts:56")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"inguild"},"inGuild"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"inGuild"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-6"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L115"},"src/handler/structures/context.ts:115")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"interaction"},"interaction"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"interaction"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"ChatInputCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">"),(0,a.kt)("p",null,"Getting the ChatInputCommandInteraction object. Crashes if module type is\nCommandType.Text or the event fired in a Both command was\nMessage"),(0,a.kt)("h4",{id:"returns-7"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"ChatInputCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"CacheType"),">"),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L52"},"src/handler/structures/context.ts:52")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"member"},"member"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"member"),"(): ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#nullish"},(0,a.kt)("inlineCode",{parentName:"a"},"Nullish")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"GuildMember")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"APIGuildMember"),">"),(0,a.kt)("h4",{id:"returns-8"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#nullish"},(0,a.kt)("inlineCode",{parentName:"a"},"Nullish")),"<",(0,a.kt)("inlineCode",{parentName:"p"},"GuildMember")," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},"APIGuildMember"),">"),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L101"},"src/handler/structures/context.ts:101")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"message"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("p",null,"Getting the Message object. Crashes if module type is\nCommandType.Slash or the event fired in a Both command was\nChatInputCommandInteraction"),(0,a.kt)("h4",{id:"returns-9"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L44"},"src/handler/structures/context.ts:44")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"user"},"user"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"get")," ",(0,a.kt)("strong",{parentName:"p"},"user"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"User")),(0,a.kt)("h4",{id:"returns-10"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"User")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L70"},"src/handler/structures/context.ts:70")),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"isempty"},"isEmpty"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"isEmpty"),"(): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"returns-11"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L129"},"src/handler/structures/context.ts:129")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"reply"},"reply"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("strong",{parentName:"p"},"reply"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"content"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">",">"),(0,a.kt)("h4",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"content")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/modules#replyoptions"},(0,a.kt)("inlineCode",{parentName:"a"},"ReplyOptions")))))),(0,a.kt)("h4",{id:"returns-12"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"boolean"),">",">"),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L133"},"src/handler/structures/context.ts:133")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"wrap"},"wrap"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"wrap"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"wrappable"),"): ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,a.kt)("inlineCode",{parentName:"a"},"Context"))),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"wrappable")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Message"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"boolean"),">"," ","|"," ",(0,a.kt)("inlineCode",{parentName:"td"},"ChatInputCommandInteraction"),"<",(0,a.kt)("inlineCode",{parentName:"td"},"CacheType"),">")))),(0,a.kt)("h4",{id:"returns-13"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,a.kt)("inlineCode",{parentName:"a"},"Context"))),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/context.ts#L122"},"src/handler/structures/context.ts:122")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c0846785.1d264012.js b/assets/js/c0846785.1d264012.js new file mode 100644 index 000000000..cc4b14258 --- /dev/null +++ b/assets/js/c0846785.1d264012.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[1036],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),s=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(o.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=s(n),m=a,f=c["".concat(o,".").concat(m)]||c[m]||u[m]||l;return n?r.createElement(f,i(i({ref:t},d),{},{components:n})):r.createElement(f,i({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,i=new Array(l);i[0]=c;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:a,i[1]=p;for(var s=2;s{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>p,toc:()=>s});var r=n(7462),a=(n(7294),n(3905));const l={id:"EventExecutable",title:"Class: EventExecutable",sidebar_label:"EventExecutable",sidebar_position:0,custom_edit_url:null},i=void 0,p={unversionedId:"api/classes/EventExecutable",id:"api/classes/EventExecutable",title:"Class: EventExecutable",description:"Type parameters",source:"@site/docs/api/classes/EventExecutable.md",sourceDirName:"api/classes",slug:"/api/classes/EventExecutable",permalink:"/docs/api/classes/EventExecutable",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EventExecutable",title:"Class: EventExecutable",sidebar_label:"EventExecutable",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"DefaultModuleManager",permalink:"/docs/api/classes/DefaultModuleManager"},next:{title:"ModuleStore",permalink:"/docs/api/classes/ModuleStore"}},o={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Properties",id:"properties",level:2},{value:"execute",id:"execute",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:s};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Type")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/enums/EventType"},(0,a.kt)("inlineCode",{parentName:"a"},"EventType")))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new EventExecutable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),">","()"),(0,a.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Type")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/enums/EventType"},(0,a.kt)("inlineCode",{parentName:"a"},"EventType")))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,a.kt)("strong",{parentName:"p"},"execute"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmoduledefs"},(0,a.kt)("inlineCode",{parentName:"a"},"EventModuleDefs")),"[",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),'][``"execute"``]'),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L108"},"src/handler/sern.ts:108")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmoduleeventplugindefs"},(0,a.kt)("inlineCode",{parentName:"a"},"EventModuleEventPluginDefs")),"[",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),"][]"," = ",(0,a.kt)("inlineCode",{parentName:"p"},"[]")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L107"},"src/handler/sern.ts:107")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodulecommandplugindefs"},(0,a.kt)("inlineCode",{parentName:"a"},"EventModuleCommandPluginDefs")),"[",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),"][]"," = ",(0,a.kt)("inlineCode",{parentName:"p"},"[]")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L106"},"src/handler/sern.ts:106")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L105"},"src/handler/sern.ts:105")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c0846785.91a9ca08.js b/assets/js/c0846785.91a9ca08.js deleted file mode 100644 index 53c681919..000000000 --- a/assets/js/c0846785.91a9ca08.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[1036],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),o=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=o(e.components);return r.createElement(s.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=o(n),m=a,f=c["".concat(s,".").concat(m)]||c[m]||u[m]||l;return n?r.createElement(f,i(i({ref:t},d),{},{components:n})):r.createElement(f,i({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,i=new Array(l);i[0]=c;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p.mdxType="string"==typeof e?e:a,i[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>p,toc:()=>o});var r=n(7462),a=(n(7294),n(3905));const l={id:"EventExecutable",title:"Class: EventExecutable",sidebar_label:"EventExecutable",sidebar_position:0,custom_edit_url:null},i=void 0,p={unversionedId:"api/classes/EventExecutable",id:"api/classes/EventExecutable",title:"Class: EventExecutable",description:"Type parameters",source:"@site/docs/api/classes/EventExecutable.md",sourceDirName:"api/classes",slug:"/api/classes/EventExecutable",permalink:"/docs/api/classes/EventExecutable",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"EventExecutable",title:"Class: EventExecutable",sidebar_label:"EventExecutable",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Context",permalink:"/docs/api/classes/Context"},next:{title:"SernEmitter",permalink:"/docs/api/classes/SernEmitter"}},s={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Properties",id:"properties",level:2},{value:"execute",id:"execute",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"onEvent",id:"onevent",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"plugins",id:"plugins",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:o};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Type")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/enums/EventType"},(0,a.kt)("inlineCode",{parentName:"a"},"EventType")))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new EventExecutable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),">","()"),(0,a.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Type")),(0,a.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,a.kt)("a",{parentName:"td",href:"/docs/api/enums/EventType"},(0,a.kt)("inlineCode",{parentName:"a"},"EventType")))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,a.kt)("strong",{parentName:"p"},"execute"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"EventModuleDefs"),"[",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),'][``"execute"``]'),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L139"},"src/handler/sern.ts:139")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"onevent"},"onEvent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"onEvent"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmoduleeventplugindefs"},(0,a.kt)("inlineCode",{parentName:"a"},"EventModuleEventPluginDefs")),"[",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),"][]"," = ",(0,a.kt)("inlineCode",{parentName:"p"},"[]")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L138"},"src/handler/sern.ts:138")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"plugins"},"plugins"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"plugins"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodulecommandplugindefs"},(0,a.kt)("inlineCode",{parentName:"a"},"EventModuleCommandPluginDefs")),"[",(0,a.kt)("inlineCode",{parentName:"p"},"Type"),"][]"," = ",(0,a.kt)("inlineCode",{parentName:"p"},"[]")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L137"},"src/handler/sern.ts:137")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L136"},"src/handler/sern.ts:136")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c606405e.1359213e.js b/assets/js/c606405e.1359213e.js new file mode 100644 index 000000000..f4194cefb --- /dev/null +++ b/assets/js/c606405e.1359213e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[8046],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var o=r.createContext({}),d=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),c=d(n),m=a,k=c["".concat(o,".").concat(m)]||c[m]||s[m]||i;return n?r.createElement(k,l(l({ref:t},u),{},{components:n})):r.createElement(k,l({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=c;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var d=2;d{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=n(7462),a=(n(7294),n(3905));const i={id:"ExternalEventPlugin",title:"Interface: ExternalEventPlugin",sidebar_label:"ExternalEventPlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/ExternalEventPlugin",id:"api/interfaces/ExternalEventPlugin",title:"Interface: ExternalEventPlugin",description:"Hierarchy",source:"@site/docs/api/interfaces/ExternalEventPlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/ExternalEventPlugin",permalink:"/docs/api/interfaces/ExternalEventPlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ExternalEventPlugin",title:"Interface: ExternalEventPlugin",sidebar_label:"ExternalEventPlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ExternalEmitterPlugin",permalink:"/docs/api/interfaces/ExternalEmitterPlugin"},next:{title:"Logging",permalink:"/docs/api/interfaces/Logging"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4}],u={toc:d};function s(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,a.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ExternalEventPlugin"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"execute"},"execute"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"execute"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown"),"[], ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"args"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"controller"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"args")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"unknown"),"[]")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"controller")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,a.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,a.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L99"},"src/handler/plugins/plugin.ts:99")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,a.kt)("p",null,"will be removed in the next update"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31"},"src/handler/plugins/plugin.ts:31")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,a.kt)("inlineCode",{parentName:"a"},"Event"))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L98"},"src/handler/plugins/plugin.ts:98")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cf183316.eb995599.js b/assets/js/cf183316.cabca74f.js similarity index 85% rename from assets/js/cf183316.eb995599.js rename to assets/js/cf183316.cabca74f.js index 4cffdfe2e..42b41eda4 100644 --- a/assets/js/cf183316.eb995599.js +++ b/assets/js/cf183316.cabca74f.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[1472],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var n=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},c=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=u(r),m=i,h=d["".concat(l,".").concat(m)]||d[m]||p[m]||o;return r?n.createElement(h,a(a({ref:t},c),{},{components:r})):n.createElement(h,a({ref:t},c))}));function m(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=r.length,a=new Array(o);a[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,a[1]=s;for(var u=2;u{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>u});var n=r(7462),i=(r(7294),r(3905));const o={sidebar_position:6},a="The SernEmitter class",s={unversionedId:"guide/walkthrough/sern-emitter",id:"guide/walkthrough/sern-emitter",title:"The SernEmitter class",description:"You're shipped with the SernEmitter. This EventEmitter listens to",source:"@site/docs/guide/walkthrough/sern-emitter.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/sern-emitter",permalink:"/docs/guide/walkthrough/sern-emitter",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/sern-emitter.md",tags:[],version:"current",sidebarPosition:6,frontMatter:{sidebar_position:6},sidebar:"tutorialSidebar",previous:{title:"Plugins",permalink:"/docs/guide/walkthrough/plugins"},next:{title:"Good to know",permalink:"/docs/guide/walkthrough/good-to-know"}},l={},u=[],c={toc:u};function p(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"the-sernemitter-class"},"The SernEmitter class"),(0,i.kt)("p",null,"You're shipped with the SernEmitter. This EventEmitter listens to"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"command modules executing and its status, the ",(0,i.kt)("inlineCode",{parentName:"li"},"module.activate")," event"),(0,i.kt)("li",{parentName:"ul"},"command modules registered and its status, the ",(0,i.kt)("inlineCode",{parentName:"li"},"module.register")," event"),(0,i.kt)("li",{parentName:"ul"},"any error that occurs, the ",(0,i.kt)("inlineCode",{parentName:"li"},"error")," event"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"warn")," events, where it is possible to throw errors")),(0,i.kt)("p",null,"You can put these and other event listeners into ",(0,i.kt)("a",{parentName:"p",href:"/docs/guide/walkthrough/first-event"},"event modules"),"! "),(0,i.kt)("br",null),"View all ",(0,i.kt)("a",{href:"https://sern-handler.js.org/docs/api/modules#serneventsmapping"},"events"))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[1472],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var n=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},c=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=u(r),m=i,h=d["".concat(l,".").concat(m)]||d[m]||p[m]||o;return r?n.createElement(h,a(a({ref:t},c),{},{components:r})):n.createElement(h,a({ref:t},c))}));function m(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=r.length,a=new Array(o);a[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,a[1]=s;for(var u=2;u{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>u});var n=r(7462),i=(r(7294),r(3905));const o={sidebar_position:6},a="The SernEmitter class",s={unversionedId:"guide/walkthrough/sern-emitter",id:"guide/walkthrough/sern-emitter",title:"The SernEmitter class",description:"You're shipped with the SernEmitter. This EventEmitter listens to",source:"@site/docs/guide/walkthrough/sern-emitter.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/sern-emitter",permalink:"/docs/guide/walkthrough/sern-emitter",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/sern-emitter.md",tags:[],version:"current",sidebarPosition:6,frontMatter:{sidebar_position:6},sidebar:"tutorialSidebar",previous:{title:"Plugins",permalink:"/docs/guide/walkthrough/plugins"},next:{title:"Good to know",permalink:"/docs/guide/walkthrough/good-to-know"}},l={},u=[],c={toc:u};function p(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"the-sernemitter-class"},"The SernEmitter class"),(0,i.kt)("p",null,"You're shipped with the SernEmitter. This EventEmitter listens to"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"command modules executing and its status, the ",(0,i.kt)("inlineCode",{parentName:"li"},"module.activate")," event"),(0,i.kt)("li",{parentName:"ul"},"command modules registered and its status, the ",(0,i.kt)("inlineCode",{parentName:"li"},"module.register")," event"),(0,i.kt)("li",{parentName:"ul"},"On default, sern creates a single SernEmitter for your bot process."),(0,i.kt)("li",{parentName:"ul"},"any error that occurs, the ",(0,i.kt)("inlineCode",{parentName:"li"},"error")," event"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"warn")," events, where it is possible to throw errors")),(0,i.kt)("p",null,"You can put these and other event listeners into ",(0,i.kt)("a",{parentName:"p",href:"/docs/guide/walkthrough/first-event"},"event modules"),"! "),(0,i.kt)("br",null),"View all ",(0,i.kt)("a",{href:"https://sern.dev/docs/api/modules#serneventsmapping"},"events"))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d9ea5336.1291352a.js b/assets/js/d9ea5336.1291352a.js new file mode 100644 index 000000000..f8634edb4 --- /dev/null +++ b/assets/js/d9ea5336.1291352a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4626],{3905:(e,t,a)=>{a.d(t,{Zo:()=>m,kt:()=>g});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),p=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},m=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,o=e.parentName,m=d(e,["components","mdxType","originalType","parentName"]),u=p(a),g=r,k=u["".concat(o,".").concat(g)]||u[g]||s[g]||l;return a?n.createElement(k,i(i({ref:t},m),{},{components:a})):n.createElement(k,i({ref:t},m))}));function g(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=u;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d.mdxType="string"==typeof e?e:r,i[1]=d;for(var p=2;p{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>d,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const l={id:"Logging",title:"Interface: Logging",sidebar_label:"Logging",sidebar_position:0,custom_edit_url:null},i=void 0,d={unversionedId:"api/interfaces/Logging",id:"api/interfaces/Logging",title:"Interface: Logging",description:"Type parameters",source:"@site/docs/api/interfaces/Logging.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Logging",permalink:"/docs/api/interfaces/Logging",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Logging",title:"Interface: Logging",sidebar_label:"Logging",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ExternalEventPlugin",permalink:"/docs/api/interfaces/ExternalEventPlugin"},next:{title:"MentionableSelectCommand",permalink:"/docs/api/interfaces/MentionableSelectCommand"}},o={},p=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implemented by",id:"implemented-by",level:2},{value:"Methods",id:"methods",level:2},{value:"debug",id:"debug",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"info",id:"info",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"warning",id:"warning",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:p};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,r.kt)("h2",{id:"implemented-by"},"Implemented by"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/DefaultLogging"},(0,r.kt)("inlineCode",{parentName:"a"},"DefaultLogging")))),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"debug"},"debug"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"debug"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#logpayload"},(0,r.kt)("inlineCode",{parentName:"a"},"LogPayload")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L7"},"src/handler/contracts/logging.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"error"},"error"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"error"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#logpayload"},(0,r.kt)("inlineCode",{parentName:"a"},"LogPayload")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L4"},"src/handler/contracts/logging.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"info"},"info"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"info"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#logpayload"},(0,r.kt)("inlineCode",{parentName:"a"},"LogPayload")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L6"},"src/handler/contracts/logging.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"warning"},"warning"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"warning"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#logpayload"},(0,r.kt)("inlineCode",{parentName:"a"},"LogPayload")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/logging.ts#L5"},"src/handler/contracts/logging.ts:5")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e2a53654.baf64fd7.js b/assets/js/e2a53654.baf64fd7.js new file mode 100644 index 000000000..2edcf74b4 --- /dev/null +++ b/assets/js/e2a53654.baf64fd7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4781],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>c});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var d=a.createContext({}),o=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=o(e.components);return a.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),u=o(n),c=r,k=u["".concat(d,".").concat(c)]||u[c]||s[c]||i;return n?a.createElement(k,l(l({ref:t},m),{},{components:n})):a.createElement(k,l({ref:t},m))}));function c(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=u;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var a=n(7462),r=(n(7294),n(3905));const i={id:"CommandPlugin",title:"Interface: CommandPlugin",sidebar_label:"CommandPlugin",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"api/interfaces/CommandPlugin",id:"api/interfaces/CommandPlugin",title:"Interface: CommandPlugin",description:"Type parameters",source:"@site/docs/api/interfaces/CommandPlugin.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/CommandPlugin",permalink:"/docs/api/interfaces/CommandPlugin",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"CommandPlugin",title:"Interface: CommandPlugin",sidebar_label:"CommandPlugin",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ChannelSelectCommand",permalink:"/docs/api/interfaces/ChannelSelectCommand"},next:{title:"ContextMenuMsg",permalink:"/docs/api/interfaces/ContextMenuMsg"}},d={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"execute",id:"execute",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:o};function s(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs"))," = keyof ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")))))),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},(0,r.kt)("inlineCode",{parentName:"a"},"Plugin"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CommandPlugin"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"will be removed in the next update"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#description"},"description")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L33"},"src/handler/plugins/plugin.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"execute"},"execute"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"execute"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"absPath"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"mod"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"p"},"T"),"]"," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } }, ",(0,r.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,r.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"controller"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload.absPath")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload.mod")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"]"," & { ",(0,r.kt)("inlineCode",{parentName:"td"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"controller")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Controller"},(0,r.kt)("inlineCode",{parentName:"a"},"Controller")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">",">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L39"},"src/handler/plugins/plugin.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"will be removed in the next update"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#name"},"name")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L31"},"src/handler/plugins/plugin.ts:31")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#command"},(0,r.kt)("inlineCode",{parentName:"a"},"Command"))),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin"},"Plugin"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Plugin#type"},"type")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L38"},"src/handler/plugins/plugin.ts:38")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e4877132.45d27c7e.js b/assets/js/e4877132.45d27c7e.js new file mode 100644 index 000000000..b631a3e85 --- /dev/null +++ b/assets/js/e4877132.45d27c7e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[6270],{3905:(e,n,t)=>{t.d(n,{Zo:()=>s,kt:()=>m});var r=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var u=r.createContext({}),p=function(e){var n=r.useContext(u),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},s=function(e){var n=p(e.components);return r.createElement(u.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,u=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=p(t),m=i,f=d["".concat(u,".").concat(m)]||d[m]||c[m]||a;return t?r.createElement(f,l(l({ref:n},s),{},{components:t})):r.createElement(f,l({ref:n},s))}));function m(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,l=new Array(a);l[0]=d;var o={};for(var u in n)hasOwnProperty.call(n,u)&&(o[u]=n[u]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var p=2;p{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var r=t(7462),i=(t(7294),t(3905));const a={id:"PluginType",title:"Enumeration: PluginType",sidebar_label:"PluginType",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/enums/PluginType",id:"api/enums/PluginType",title:"Enumeration: PluginType",description:"A bitfield that discriminates plugins",source:"@site/docs/api/enums/PluginType.md",sourceDirName:"api/enums",slug:"/api/enums/PluginType",permalink:"/docs/api/enums/PluginType",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"PluginType",title:"Enumeration: PluginType",sidebar_label:"PluginType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PayloadType",permalink:"/docs/api/enums/PayloadType"},next:{title:"CommandExecutable",permalink:"/docs/api/classes/CommandExecutable"}},u={},p=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Command",id:"command",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Event",id:"event",level:3},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:p};function c(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"A bitfield that discriminates plugins"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"export default function myPlugin() : EventPlugin {\n //highlight-next-line\n type : PluginType.Event,\n execute([ctx, args], controller) {\n return controller.next();\n }\n}\n")),(0,i.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("h3",{id:"command"},"Command"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"Command")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1")),(0,i.kt)("p",null,"The PluginType for CommandPlugins"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L107"},"src/handler/structures/enums.ts:107")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"event"},"Event"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"Event")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"2")),(0,i.kt)("p",null,"The PluginType for EventPlugins"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/structures/enums.ts#L111"},"src/handler/structures/enums.ts:111")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e4877132.c7d96e55.js b/assets/js/e4877132.c7d96e55.js deleted file mode 100644 index c567827cb..000000000 --- a/assets/js/e4877132.c7d96e55.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[6270],{3905:(e,n,t)=>{t.d(n,{Zo:()=>s,kt:()=>d});var r=t(7294);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var u=r.createContext({}),p=function(e){var n=r.useContext(u),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},s=function(e){var n=p(e.components);return r.createElement(u.Provider,{value:n},e.children)},c={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},m=r.forwardRef((function(e,n){var t=e.components,i=e.mdxType,a=e.originalType,u=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=p(t),d=i,f=m["".concat(u,".").concat(d)]||m[d]||c[d]||a;return t?r.createElement(f,l(l({ref:n},s),{},{components:t})):r.createElement(f,l({ref:n},s))}));function d(e,n){var t=arguments,i=n&&n.mdxType;if("string"==typeof e||i){var a=t.length,l=new Array(a);l[0]=m;var o={};for(var u in n)hasOwnProperty.call(n,u)&&(o[u]=n[u]);o.originalType=e,o.mdxType="string"==typeof e?e:i,l[1]=o;for(var p=2;p{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>l,default:()=>c,frontMatter:()=>a,metadata:()=>o,toc:()=>p});var r=t(7462),i=(t(7294),t(3905));const a={id:"PluginType",title:"Enumeration: PluginType",sidebar_label:"PluginType",sidebar_position:0,custom_edit_url:null},l=void 0,o={unversionedId:"api/enums/PluginType",id:"api/enums/PluginType",title:"Enumeration: PluginType",description:"Example",source:"@site/docs/api/enums/PluginType.md",sourceDirName:"api/enums",slug:"/api/enums/PluginType",permalink:"/docs/api/enums/PluginType",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"PluginType",title:"Enumeration: PluginType",sidebar_label:"PluginType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PayloadType",permalink:"/docs/api/enums/PayloadType"},next:{title:"CommandExecutable",permalink:"/docs/api/classes/CommandExecutable"}},u={},p=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Command",id:"command",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Event",id:"event",level:3},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:p};function c(e){let{components:n,...t}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"export default function myPlugin() : EventPlugin {\n //highlight-next-line\n type : PluginType.Event,\n execute([ctx, args], controller) {\n return controller.next();\n }\n}\n")),(0,i.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,i.kt)("h3",{id:"command"},"Command"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"Command")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"1")),(0,i.kt)("p",null,"The PluginType for CommandPlugins"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L97"},"src/handler/structures/enums.ts:97")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"event"},"Event"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"Event")," = ",(0,i.kt)("inlineCode",{parentName:"p"},"2")),(0,i.kt)("p",null,"The PluginType for EventPlugins"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/enums.ts#L101"},"src/handler/structures/enums.ts:101")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e8e3d8c7.589397c6.js b/assets/js/e8e3d8c7.b7614d2a.js similarity index 75% rename from assets/js/e8e3d8c7.589397c6.js rename to assets/js/e8e3d8c7.b7614d2a.js index eba836cd8..8a0c76a5b 100644 --- a/assets/js/e8e3d8c7.589397c6.js +++ b/assets/js/e8e3d8c7.b7614d2a.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4865],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=u(n),m=a,f=d["".concat(s,".").concat(m)]||d[m]||c[m]||o;return n?r.createElement(f,l(l({ref:t},p),{},{components:n})):r.createElement(f,l({ref:t},p))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=d;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i.mdxType="string"==typeof e?e:a,l[1]=i;for(var u=2;u{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const o={sidebar_position:4},l="First Event Module",i={unversionedId:"guide/walkthrough/first-event",id:"guide/walkthrough/first-event",title:"First Event Module",description:"We will dissect a basic event module.",source:"@site/docs/guide/walkthrough/first-event.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/first-event",permalink:"/docs/guide/walkthrough/first-event",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/first-event.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"First Command",permalink:"/docs/guide/walkthrough/first-command"},next:{title:"Plugins",permalink:"/docs/guide/walkthrough/plugins"}},s={},u=[{value:"Another example of an event module",id:"another-example-of-an-event-module",level:3}],p={toc:u};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"first-event-module"},"First Event Module"),(0,a.kt)("p",null,"We will dissect a basic event module. ",(0,a.kt)("br",null),"\nTypescript:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export default eventModule({\n type: EventType.Sern,\n plugins : [], //NOT SUPPORTED YET!!\n name: 'module.activate', //name of event.\n execute(event) {\n console.log(event); \n }\n})\n")),(0,a.kt)("p",null,"Javascript:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"exports.default = eventModule({\n type: EventType.Sern,\n plugins : [], //NOT SUPPORTED YET!!\n name: 'module.activate',\n execute(event) {\n console.log(event); \n }\n})\n")),(0,a.kt)("p",null,"Like command modules, the ",(0,a.kt)("inlineCode",{parentName:"p"},"type")," property denotes what kind of event it is, which\ncan be found ",(0,a.kt)("a",{parentName:"p",href:"https://sern-handler.js.org/docs/api/enums/EventType"},"here"),"."),(0,a.kt)("p",null,"To view what each of these properties mean in depth, visit the ",(0,a.kt)("a",{parentName:"p",href:"https://sern-handler.js.org/docs/api/enums/EventType"},"official documentation"),"."),(0,a.kt)("br",null),"Event modules are laid out similarly to command modules. These listen to any and all event you provide. In the current version 1.1.0-beta, plugins are not supported.",(0,a.kt)("h3",{id:"another-example-of-an-event-module"},"Another example of an event module"),(0,a.kt)("p",null,"Typescript:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export default eventModule({\n type: EventType.Discord,\n plugins : [], //NOT SUPPORTED YET!!\n name: 'guildMemberAdd', //name of event.\n async execute(member: GuildMember) {\n (await member.guild.channels.fetch('channel-id') as TextChannel).send(`Welcome, ${member}`); \n }\n})\n")),(0,a.kt)("p",null,"Javascript:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"\nexports.default = eventModule({\n type: EventType.Discord,\n plugins : [], //NOT SUPPORTED YET!!\n name: 'guildMemberAdd', //name of event.\n async execute(member) {\n (await member.guild.channels.fetch('channel-id')).send(`Welcome, ${member}`); \n }\n})\n")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4865],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=u(n),m=a,f=d["".concat(s,".").concat(m)]||d[m]||c[m]||o;return n?r.createElement(f,l(l({ref:t},p),{},{components:n})):r.createElement(f,l({ref:t},p))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=d;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i.mdxType="string"==typeof e?e:a,l[1]=i;for(var u=2;u{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const o={sidebar_position:4},l="First Event Module",i={unversionedId:"guide/walkthrough/first-event",id:"guide/walkthrough/first-event",title:"First Event Module",description:"We will dissect a basic event module.",source:"@site/docs/guide/walkthrough/first-event.md",sourceDirName:"guide/walkthrough",slug:"/guide/walkthrough/first-event",permalink:"/docs/guide/walkthrough/first-event",draft:!1,editUrl:"https://github.com/sern-handler/website/edit/main/docs/guide/walkthrough/first-event.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"First Command",permalink:"/docs/guide/walkthrough/first-command"},next:{title:"Plugins",permalink:"/docs/guide/walkthrough/plugins"}},s={},u=[{value:"Another example of an event module",id:"another-example-of-an-event-module",level:3}],p={toc:u};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"first-event-module"},"First Event Module"),(0,a.kt)("p",null,"We will dissect a basic event module. ",(0,a.kt)("br",null),"\nTypescript:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export default eventModule({\n type: EventType.Sern,\n plugins : [], //NOT SUPPORTED YET!!\n name: 'module.activate', //name of event.\n execute(event) {\n console.log(event); \n }\n})\n")),(0,a.kt)("p",null,"Javascript:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"exports.default = eventModule({\n type: EventType.Sern,\n plugins : [], //NOT SUPPORTED YET!!\n name: 'module.activate',\n execute(event) {\n console.log(event); \n }\n})\n")),(0,a.kt)("p",null,"Like command modules, the ",(0,a.kt)("inlineCode",{parentName:"p"},"type")," property denotes what kind of event it is, which\ncan be found ",(0,a.kt)("a",{parentName:"p",href:"https://sern.dev/docs/api/enums/EventType"},"here"),"."),(0,a.kt)("p",null,"To view what each of these properties mean in depth, visit the ",(0,a.kt)("a",{parentName:"p",href:"https://sern.dev/docs/api/enums/EventType"},"official documentation"),"."),(0,a.kt)("br",null),"Event modules are laid out similarly to command modules. These listen to any and all event you provide. In the current version 1.1.0-beta, plugins are not supported.",(0,a.kt)("h3",{id:"another-example-of-an-event-module"},"Another example of an event module"),(0,a.kt)("p",null,"Typescript:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-typescript"},"export default eventModule({\n type: EventType.Discord,\n plugins : [],\n name: 'guildMemberAdd', //name of event.\n async execute(member: GuildMember) {\n (await member.guild.channels.fetch('channel-id') as TextChannel).send(`Welcome, ${member}`); \n }\n})\n")),(0,a.kt)("p",null,"Javascript:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"\nexports.default = eventModule({\n type: EventType.Discord,\n plugins : [], //NOT SUPPORTED YET!!\n name: 'guildMemberAdd', //name of event.\n async execute(member) {\n (await member.guild.channels.fetch('channel-id')).send(`Welcome, ${member}`); \n }\n})\n")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/eea0bf40.478d27af.js b/assets/js/eea0bf40.478d27af.js new file mode 100644 index 000000000..c6a5823b2 --- /dev/null +++ b/assets/js/eea0bf40.478d27af.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4429],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>f});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var p=r.createContext({}),d=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},s=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=d(n),f=i,m=u["".concat(p,".").concat(f)]||u[f]||c[f]||l;return n?r.createElement(m,a(a({ref:t},s),{},{components:n})):r.createElement(m,a({ref:t},s))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,a=new Array(l);a[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,a[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>c,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var r=n(7462),i=(n(7294),n(3905));const l={id:"Controller",title:"Interface: Controller",sidebar_label:"Controller",sidebar_position:0,custom_edit_url:null},a=void 0,o={unversionedId:"api/interfaces/Controller",id:"api/interfaces/Controller",title:"Interface: Controller",description:"Properties",source:"@site/docs/api/interfaces/Controller.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Controller",permalink:"/docs/api/interfaces/Controller",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Controller",title:"Interface: Controller",sidebar_label:"Controller",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ContextMenuUser",permalink:"/docs/api/interfaces/ContextMenuUser"},next:{title:"Dependencies",permalink:"/docs/api/interfaces/Dependencies"}},p={},d=[{value:"Properties",id:"properties",level:2},{value:"next",id:"next",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"stop",id:"stop",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:d};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"next"},"next"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"next"),": () => ",(0,i.kt)("inlineCode",{parentName:"p"},"Ok"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (): ",(0,i.kt)("inlineCode",{parentName:"p"},"Ok"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Ok"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L26"},"src/handler/plugins/plugin.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"stop"},"stop"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"stop"),": () => ",(0,i.kt)("inlineCode",{parentName:"p"},"Err"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (): ",(0,i.kt)("inlineCode",{parentName:"p"},"Err"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h5",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Err"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L27"},"src/handler/plugins/plugin.ts:27")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/eea0bf40.6eea27e0.js b/assets/js/eea0bf40.6eea27e0.js deleted file mode 100644 index ccd633c01..000000000 --- a/assets/js/eea0bf40.6eea27e0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[4429],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var n=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function a(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},d=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=s(r),f=i,m=u["".concat(p,".").concat(f)]||u[f]||c[f]||l;return r?n.createElement(m,a(a({ref:t},d),{},{components:r})):n.createElement(m,a({ref:t},d))}));function f(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=r.length,a=new Array(l);a[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o.mdxType="string"==typeof e?e:i,a[1]=o;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>c,frontMatter:()=>l,metadata:()=>o,toc:()=>s});var n=r(7462),i=(r(7294),r(3905));const l={id:"Controller",title:"Interface: Controller",sidebar_label:"Controller",sidebar_position:0,custom_edit_url:null},a=void 0,o={unversionedId:"api/interfaces/Controller",id:"api/interfaces/Controller",title:"Interface: Controller",description:"Properties",source:"@site/docs/api/interfaces/Controller.md",sourceDirName:"api/interfaces",slug:"/api/interfaces/Controller",permalink:"/docs/api/interfaces/Controller",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"Controller",title:"Interface: Controller",sidebar_label:"Controller",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"SernEmitter",permalink:"/docs/api/classes/SernEmitter"},next:{title:"Wrapper",permalink:"/docs/api/interfaces/Wrapper"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"next",id:"next",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4},{value:"stop",id:"stop",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:4}],d={toc:s};function c(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"next"},"next"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"next"),": () => ",(0,i.kt)("inlineCode",{parentName:"p"},"Ok"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (): ",(0,i.kt)("inlineCode",{parentName:"p"},"Ok"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Ok"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L29"},"src/handler/plugins/plugin.ts:29")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"stop"},"stop"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"stop"),": () => ",(0,i.kt)("inlineCode",{parentName:"p"},"Err"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (): ",(0,i.kt)("inlineCode",{parentName:"p"},"Err"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h5",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Err"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L30"},"src/handler/plugins/plugin.ts:30")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f1cc380d.3bf7473a.js b/assets/js/f1cc380d.3bf7473a.js new file mode 100644 index 000000000..b8802a180 --- /dev/null +++ b/assets/js/f1cc380d.3bf7473a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[681],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>c});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),p=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),u=p(a),c=r,f=u["".concat(d,".").concat(c)]||u[c]||m[c]||l;return a?n.createElement(f,i(i({ref:t},s),{},{components:a})):n.createElement(f,i({ref:t},s))}));function c(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o.mdxType="string"==typeof e?e:r,i[1]=o;for(var p=2;p{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const l={id:"DefaultModuleManager",title:"Class: DefaultModuleManager",sidebar_label:"DefaultModuleManager",sidebar_position:0,custom_edit_url:null},i=void 0,o={unversionedId:"api/classes/DefaultModuleManager",id:"api/classes/DefaultModuleManager",title:"Class: DefaultModuleManager",description:"Implements",source:"@site/docs/api/classes/DefaultModuleManager.md",sourceDirName:"api/classes",slug:"/api/classes/DefaultModuleManager",permalink:"/docs/api/classes/DefaultModuleManager",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"DefaultModuleManager",title:"Class: DefaultModuleManager",sidebar_label:"DefaultModuleManager",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"DefaultLogging",permalink:"/docs/api/classes/DefaultLogging"},next:{title:"EventExecutable",permalink:"/docs/api/classes/EventExecutable"}},d={},p=[{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Methods",id:"methods",level:2},{value:"get",id:"get",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"set",id:"set",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}],s={toc:p};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"implements"},"Implements"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ModuleManager"},(0,r.kt)("inlineCode",{parentName:"a"},"ModuleManager")))),(0,r.kt)("h2",{id:"constructors"},"Constructors"),(0,r.kt)("h3",{id:"constructor"},"constructor"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"new DefaultModuleManager"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"moduleStore"),")"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"moduleStore")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/ModuleStore"},(0,r.kt)("inlineCode",{parentName:"a"},"ModuleStore")))))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/moduleManager.ts#L12"},"src/handler/contracts/moduleManager.ts:12")),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"get"},"get"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"get"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"strat"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/CommandType"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandType")))))),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strat")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"ms"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/ModuleStore"},(0,r.kt)("inlineCode",{parentName:"a"},"ModuleStore")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"]")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmoduledefs"},(0,r.kt)("inlineCode",{parentName:"a"},"CommandModuleDefs")),"[",(0,r.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,r.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ModuleManager"},"ModuleManager"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ModuleManager#get"},"get")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/moduleManager.ts#L13"},"src/handler/contracts/moduleManager.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"set"},"set"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"set"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"strat"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"strat")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"ms"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/ModuleStore"},(0,r.kt)("inlineCode",{parentName:"a"},"ModuleStore")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ModuleManager"},"ModuleManager"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ModuleManager#set"},"set")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/contracts/moduleManager.ts#L17"},"src/handler/contracts/moduleManager.ts:17")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f6aebfbf.408acc4f.js b/assets/js/f6aebfbf.408acc4f.js new file mode 100644 index 000000000..a6eac9d7c --- /dev/null +++ b/assets/js/f6aebfbf.408acc4f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7306],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>u});var n=a(7294);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var p=n.createContext({}),m=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},o=function(e){var t=m(e.components);return n.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,l=e.mdxType,r=e.originalType,p=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),k=m(a),u=l,N=k["".concat(p,".").concat(u)]||k[u]||s[u]||r;return a?n.createElement(N,i(i({ref:t},o),{},{components:a})):n.createElement(N,i({ref:t},o))}));function u(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var r=a.length,i=new Array(r);i[0]=k;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d.mdxType="string"==typeof e?e:l,i[1]=d;for(var m=2;m{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>r,metadata:()=>d,toc:()=>m});var n=a(7462),l=(a(7294),a(3905));const r={id:"modules",title:"@sern/handler",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,d={unversionedId:"api/modules",id:"api/modules",title:"@sern/handler",description:"Namespaces",source:"@site/docs/api/modules.md",sourceDirName:"api",slug:"/api/modules",permalink:"/docs/api/modules",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@sern/handler",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Readme",permalink:"/docs/api/"},next:{title:"Sern",permalink:"/docs/api/namespaces/Sern"}},p={},m=[{value:"Namespaces",id:"namespaces",level:2},{value:"Enumerations",id:"enumerations",level:2},{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"AnyDefinedModule",id:"anydefinedmodule",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"AnyModule",id:"anymodule",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"Args",id:"args",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"BaseOptions",id:"baseoptions",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"CommandModule",id:"commandmodule",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"CommandModuleDefs",id:"commandmoduledefs",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"CommandModuleNoPlugins",id:"commandmodulenoplugins",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"CommandModulePlugin",id:"commandmoduleplugin",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"DefinedCommandModule",id:"definedcommandmodule",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"DefinedEventModule",id:"definedeventmodule",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"EventModule",id:"eventmodule",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"EventModuleCommandPluginDefs",id:"eventmodulecommandplugindefs",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"EventModuleDefs",id:"eventmoduledefs",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"EventModuleEventPluginDefs",id:"eventmoduleeventplugindefs",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"EventModulePlugin",id:"eventmoduleplugin",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"EventModulesNoPlugins",id:"eventmodulesnoplugins",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"InputCommandModule",id:"inputcommandmodule",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"InputEventModule",id:"inputeventmodule",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"LogPayload",id:"logpayload",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"MapDeps",id:"mapdeps",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"OptionalDependencies",id:"optionaldependencies",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"ParseType",id:"parsetype",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"Payload",id:"payload",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"ReplyOptions",id:"replyoptions",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"SernEventsMapping",id:"serneventsmapping",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"SernOptionsData",id:"sernoptionsdata",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"Singleton",id:"singleton",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-26",level:4},{value:"SlashOptions",id:"slashoptions",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"Transient",id:"transient",level:3},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Returns",id:"returns-1",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-28",level:4},{value:"Functions",id:"functions",level:2},{value:"commandModule",id:"commandmodule-1",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"eventModule",id:"eventmodule-1",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"many",id:"many",level:3},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Returns",id:"returns-6",level:5},{value:"Returns",id:"returns-7",level:5},{value:"Defined in",id:"defined-in-31",level:4},{value:"single",id:"single",level:3},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Returns",id:"returns-9",level:5},{value:"Defined in",id:"defined-in-32",level:4},{value:"useContainerRaw",id:"usecontainerraw",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-33",level:4}],o={toc:m};function s(e){let{components:t,...a}=e;return(0,l.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("h2",{id:"namespaces"},"Namespaces"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/namespaces/Sern"},"Sern"))),(0,l.kt)("h2",{id:"enumerations"},"Enumerations"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/enums/CommandType"},"CommandType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/enums/EventType"},"EventType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/enums/PayloadType"},"PayloadType")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/enums/PluginType"},"PluginType"))),(0,l.kt)("h2",{id:"classes"},"Classes"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/CommandExecutable"},"CommandExecutable")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/Context"},"Context")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/DefaultErrorHandling"},"DefaultErrorHandling")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/DefaultLogging"},"DefaultLogging")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/DefaultModuleManager"},"DefaultModuleManager")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/EventExecutable"},"EventExecutable")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/ModuleStore"},"ModuleStore")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/classes/SernEmitter"},"SernEmitter"))),(0,l.kt)("h2",{id:"interfaces"},"Interfaces"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/AutocompleteCommand"},"AutocompleteCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/AutocompletePlugin"},"AutocompletePlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/BothCommand"},"BothCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ButtonCommand"},"ButtonCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ChannelSelectCommand"},"ChannelSelectCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/CommandPlugin"},"CommandPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ContextMenuMsg"},"ContextMenuMsg")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ContextMenuUser"},"ContextMenuUser")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Controller"},"Controller")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Dependencies"},"Dependencies")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/DiscordEmitterPlugin"},"DiscordEmitterPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/DiscordEventPlugin"},"DiscordEventPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ErrorHandling"},"ErrorHandling")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/EventPlugin"},"EventPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ExternalEmitterPlugin"},"ExternalEmitterPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ExternalEventPlugin"},"ExternalEventPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Logging"},"Logging")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/MentionableSelectCommand"},"MentionableSelectCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ModalSubmitCommand"},"ModalSubmitCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Module"},"Module")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/ModuleManager"},"ModuleManager")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Plugin"},"Plugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/RoleSelectCommand"},"RoleSelectCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/SernAutocompleteData"},"SernAutocompleteData")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/SernEmitterPlugin"},"SernEmitterPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/SernEventPlugin"},"SernEventPlugin")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/SernSubCommandData"},"SernSubCommandData")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/SernSubCommandGroupData"},"SernSubCommandGroupData")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/SlashCommand"},"SlashCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/StringSelectCommand"},"StringSelectCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/TextCommand"},"TextCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/UserSelectCommand"},"UserSelectCommand")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Wrapper"},"Wrapper"))),(0,l.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,l.kt)("h3",{id:"anydefinedmodule"},"AnyDefinedModule"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"AnyDefinedModule"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#definedcommandmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"DefinedCommandModule"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#definedeventmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"DefinedEventModule"))),(0,l.kt)("h4",{id:"defined-in"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L25"},"src/types/handler.ts:25")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"anymodule"},"AnyModule"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"AnyModule"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"CommandModule"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"EventModule"))),(0,l.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L153"},"src/types/module.ts:153")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"args"},"Args"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"Args"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#parsetype"},(0,l.kt)("inlineCode",{parentName:"a"},"ParseType")),"<{ ",(0,l.kt)("inlineCode",{parentName:"p"},"slash"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#slashoptions"},(0,l.kt)("inlineCode",{parentName:"a"},"SlashOptions"))," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"text"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string"),"[] }",">"),(0,l.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L15"},"src/types/handler.ts:15")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"baseoptions"},"BaseOptions"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"BaseOptions"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"ApplicationCommandChoicesData")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"ApplicationCommandNonOptionsData")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"ApplicationCommandChannelOptionData")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"ApplicationCommandNumericOptionData")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"ApplicationCommandAttachmentOption")," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernAutocompleteData"},(0,l.kt)("inlineCode",{parentName:"a"},"SernAutocompleteData"))),(0,l.kt)("p",null,"Type that replaces autocomplete with ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernAutocompleteData"},"SernAutocompleteData")),(0,l.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L190"},"src/types/module.ts:190")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"commandmodule"},"CommandModule"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"CommandModule"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/TextCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"TextCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SlashCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"SlashCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/BothCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"BothCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ContextMenuUser"},(0,l.kt)("inlineCode",{parentName:"a"},"ContextMenuUser"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ContextMenuMsg"},(0,l.kt)("inlineCode",{parentName:"a"},"ContextMenuMsg"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ButtonCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"ButtonCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/StringSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"StringSelectCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/MentionableSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"MentionableSelectCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/UserSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"UserSelectCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ChannelSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"ChannelSelectCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/RoleSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"RoleSelectCommand"))," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/ModalSubmitCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"ModalSubmitCommand"))),(0,l.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L139"},"src/types/module.ts:139")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"commandmoduledefs"},"CommandModuleDefs"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"CommandModuleDefs"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"1")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/TextCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"TextCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"1024")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/RoleSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"RoleSelectCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"16")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/ButtonCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"ButtonCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"2")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/SlashCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"SlashCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"2048")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/UserSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"UserSelectCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"256")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/ChannelSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"ChannelSelectCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"3")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/BothCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"BothCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"32")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/StringSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"StringSelectCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"4")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/ContextMenuUser"},(0,l.kt)("inlineCode",{parentName:"a"},"ContextMenuUser")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"512")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/MentionableSelectCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"MentionableSelectCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"64")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/ModalSubmitCommand"},(0,l.kt)("inlineCode",{parentName:"a"},"ModalSubmitCommand")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"8")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/ContextMenuMsg"},(0,l.kt)("inlineCode",{parentName:"a"},"ContextMenuMsg")))))),(0,l.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L157"},"src/types/module.ts:157")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"commandmodulenoplugins"},"CommandModuleNoPlugins"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"CommandModuleNoPlugins"),": { ","[T in CommandType]",": Omit"," }"),(0,l.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L108"},"src/handler/plugins/plugin.ts:108")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"commandmoduleplugin"},"CommandModulePlugin"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"CommandModulePlugin"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/EventPlugin"},(0,l.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">"," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/CommandPlugin"},(0,l.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,l.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,l.kt)("a",{parentName:"td",href:"/docs/api/enums/CommandType"},(0,l.kt)("inlineCode",{parentName:"a"},"CommandType")))))),(0,l.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L136"},"src/handler/plugins/plugin.ts:136")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"definedcommandmodule"},"DefinedCommandModule"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"DefinedCommandModule"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"CommandModule"))," & { ",(0,l.kt)("inlineCode",{parentName:"p"},"description"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,l.kt)("p",null,"After modules are transformed, name and description are given default values if none\nare provided to Module. This type represents that transformation"),(0,l.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L23"},"src/types/handler.ts:23")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"definedeventmodule"},"DefinedEventModule"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"DefinedEventModule"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"EventModule"))," & { ",(0,l.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,l.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L24"},"src/types/handler.ts:24")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"eventmodule"},"EventModule"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"EventModule"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"DiscordEventCommand")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"SernEventCommand")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"ExternalEventCommand")),(0,l.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L138"},"src/types/module.ts:138")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"eventmodulecommandplugindefs"},"EventModuleCommandPluginDefs"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"EventModuleCommandPluginDefs"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("p",null,"Event Module Command Plugins"),(0,l.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"1")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/DiscordEmitterPlugin"},(0,l.kt)("inlineCode",{parentName:"a"},"DiscordEmitterPlugin")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"2")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/SernEmitterPlugin"},(0,l.kt)("inlineCode",{parentName:"a"},"SernEmitterPlugin")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"3")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/ExternalEmitterPlugin"},(0,l.kt)("inlineCode",{parentName:"a"},"ExternalEmitterPlugin")))))),(0,l.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L126"},"src/handler/plugins/plugin.ts:126")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"eventmoduledefs"},"EventModuleDefs"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"EventModuleDefs"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"1")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"DiscordEventCommand"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"2")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"SernEventCommand"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"3")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"ExternalEventCommand"))))),(0,l.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L172"},"src/types/module.ts:172")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"eventmoduleeventplugindefs"},"EventModuleEventPluginDefs"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"EventModuleEventPluginDefs"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("p",null,"Event Module Event Plugins"),(0,l.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"1")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/DiscordEventPlugin"},(0,l.kt)("inlineCode",{parentName:"a"},"DiscordEventPlugin")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"2")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/SernEventPlugin"},(0,l.kt)("inlineCode",{parentName:"a"},"SernEventPlugin")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"3")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/ExternalEventPlugin"},(0,l.kt)("inlineCode",{parentName:"a"},"ExternalEventPlugin")))))),(0,l.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L117"},"src/handler/plugins/plugin.ts:117")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"eventmoduleplugin"},"EventModulePlugin"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"EventModulePlugin"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmoduleeventplugindefs"},(0,l.kt)("inlineCode",{parentName:"a"},"EventModuleEventPluginDefs")),"[",(0,l.kt)("inlineCode",{parentName:"p"},"T"),"]"," ","|"," ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodulecommandplugindefs"},(0,l.kt)("inlineCode",{parentName:"a"},"EventModuleCommandPluginDefs")),"[",(0,l.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,l.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,l.kt)("a",{parentName:"td",href:"/docs/api/enums/EventType"},(0,l.kt)("inlineCode",{parentName:"a"},"EventType")))))),(0,l.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L132"},"src/handler/plugins/plugin.ts:132")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"eventmodulesnoplugins"},"EventModulesNoPlugins"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"EventModulesNoPlugins"),": { ","[T in EventType]",": Omit"," }"),(0,l.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L111"},"src/handler/plugins/plugin.ts:111")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"inputcommandmodule"},"InputCommandModule"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"InputCommandModule"),": { ","[T in CommandType]",": CommandModuleNoPlugins","[T]"," & Object }[",(0,l.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType"},(0,l.kt)("inlineCode",{parentName:"a"},"CommandType")),"]"),(0,l.kt)("p",null,"User inputs this type. Sern processes behind the scenes for better usage"),(0,l.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L141"},"src/handler/plugins/plugin.ts:141")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"inputeventmodule"},"InputEventModule"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"InputEventModule"),": { ","[T in EventType]",": EventModulesNoPlugins","[T]"," & Object }[",(0,l.kt)("a",{parentName:"p",href:"/docs/api/enums/EventType"},(0,l.kt)("inlineCode",{parentName:"a"},"EventType")),"]"),(0,l.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/plugins/plugin.ts#L145"},"src/handler/plugins/plugin.ts:145")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"logpayload"},"LogPayload"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"LogPayload"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,l.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"message")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L36"},"src/types/handler.ts:36")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"mapdeps"},"MapDeps"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"MapDeps"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Deps"),", ",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,l.kt)("inlineCode",{parentName:"p"},"T")," extends [infer First, ...(infer Rest extends readonly unknown[])] ? [",(0,l.kt)("inlineCode",{parentName:"p"},"UnpackFunction"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"Deps"),"[",(0,l.kt)("inlineCode",{parentName:"p"},"First"),"]",">",", ...(MapDeps"," extends ","[never]"," ? [] : MapDeps",")] : ","[",(0,l.kt)("inlineCode",{parentName:"p"},"never"),"]"),(0,l.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"Deps")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,l.kt)("a",{parentName:"td",href:"/docs/api/interfaces/Dependencies"},(0,l.kt)("inlineCode",{parentName:"a"},"Dependencies")))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends readonly ",(0,l.kt)("inlineCode",{parentName:"td"},"unknown"),"[]")))),(0,l.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L51"},"src/types/handler.ts:51")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"optionaldependencies"},"OptionalDependencies"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"OptionalDependencies"),": ",(0,l.kt)("inlineCode",{parentName:"p"},'"@sern/logger"')),(0,l.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L57"},"src/types/handler.ts:57")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"parsetype"},"ParseType"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"ParseType"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">",": { ","[K in keyof T]",": T","[K]"," extends unknown ? [k: K, args: T","[K]","] : never }","[keyof ",(0,l.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,l.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L11"},"src/types/handler.ts:11")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"payload"},"Payload"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"Payload"),": { ",(0,l.kt)("inlineCode",{parentName:"p"},"module"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#anymodule"},(0,l.kt)("inlineCode",{parentName:"a"},"AnyModule"))," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/enums/PayloadType#success"},(0,l.kt)("inlineCode",{parentName:"a"},"Success"))," } ","|"," { ",(0,l.kt)("inlineCode",{parentName:"p"},"module?"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#anymodule"},(0,l.kt)("inlineCode",{parentName:"a"},"AnyModule"))," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"reason"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Error")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/enums/PayloadType#failure"},(0,l.kt)("inlineCode",{parentName:"a"},"Failure"))," } ","|"," { ",(0,l.kt)("inlineCode",{parentName:"p"},"reason"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,l.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/enums/PayloadType#warning"},(0,l.kt)("inlineCode",{parentName:"a"},"Warning"))," }"),(0,l.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L26"},"src/types/handler.ts:26")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"replyoptions"},"ReplyOptions"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"ReplyOptions"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"InteractionReplyOptions"),", ",(0,l.kt)("inlineCode",{parentName:"p"},'"fetchReply"'),">"," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"MessageReplyOptions")),(0,l.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L49"},"src/types/handler.ts:49")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"serneventsmapping"},"SernEventsMapping"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"SernEventsMapping"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Object")),(0,l.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"error")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("a",{parentName:"td",href:"/docs/api/modules#payload"},(0,l.kt)("inlineCode",{parentName:"a"},"Payload")),"]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"module.activate")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("a",{parentName:"td",href:"/docs/api/modules#payload"},(0,l.kt)("inlineCode",{parentName:"a"},"Payload")),"]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"module.register")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("a",{parentName:"td",href:"/docs/api/modules#payload"},(0,l.kt)("inlineCode",{parentName:"a"},"Payload")),"]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"warning")),(0,l.kt)("td",{parentName:"tr",align:"left"},"[",(0,l.kt)("a",{parentName:"td",href:"/docs/api/modules#payload"},(0,l.kt)("inlineCode",{parentName:"a"},"Payload")),"]")))),(0,l.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L30"},"src/types/handler.ts:30")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"sernoptionsdata"},"SernOptionsData"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"SernOptionsData"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"U"),">",": ",(0,l.kt)("inlineCode",{parentName:"p"},"U")," extends ",(0,l.kt)("inlineCode",{parentName:"p"},"ApplicationCommandSubCommandData")," ? ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernSubCommandData"},(0,l.kt)("inlineCode",{parentName:"a"},"SernSubCommandData"))," : ",(0,l.kt)("inlineCode",{parentName:"p"},"U")," extends ",(0,l.kt)("inlineCode",{parentName:"p"},"ApplicationCommandSubGroupData")," ? ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/SernSubCommandGroupData"},(0,l.kt)("inlineCode",{parentName:"a"},"SernSubCommandGroupData"))," : ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#baseoptions"},(0,l.kt)("inlineCode",{parentName:"a"},"BaseOptions"))),(0,l.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"U")),(0,l.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,l.kt)("inlineCode",{parentName:"td"},"ApplicationCommandOptionData")," = ",(0,l.kt)("inlineCode",{parentName:"td"},"ApplicationCommandOptionData"))))),(0,l.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/module.ts#L210"},"src/types/module.ts:210")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"singleton"},"Singleton"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"Singleton"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">",": () => ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,l.kt)("p",null,"\u25b8 (): ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h5",{id:"returns"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L37"},"src/types/handler.ts:37")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"slashoptions"},"SlashOptions"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"SlashOptions"),": ",(0,l.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"CommandInteractionOptionResolver"),", ",(0,l.kt)("inlineCode",{parentName:"p"},'"getMessage"')," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},'"getFocused"'),">"),(0,l.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L17"},"src/types/handler.ts:17")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"transient"},"Transient"),(0,l.kt)("p",null,"\u01ac ",(0,l.kt)("strong",{parentName:"p"},"Transient"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">",": () => () => ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,l.kt)("p",null,"\u25b8 (): () => ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h5",{id:"returns-1"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"fn")),(0,l.kt)("p",null,"\u25b8 (): ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h5",{id:"returns-2"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/types/handler.ts#L38"},"src/types/handler.ts:38")),(0,l.kt)("h2",{id:"functions"},"Functions"),(0,l.kt)("h3",{id:"commandmodule-1"},"commandModule"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"commandModule"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"mod"),"): ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"CommandModule"))),(0,l.kt)("p",null,"The wrapper function to define command modules for sern"),(0,l.kt)("h4",{id:"parameters"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"mod")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/modules#inputcommandmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"InputCommandModule")))))),(0,l.kt)("h4",{id:"returns-3"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#commandmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"CommandModule"))),(0,l.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L64"},"src/handler/sern.ts:64")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"eventmodule-1"},"eventModule"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"eventModule"),"(",(0,l.kt)("inlineCode",{parentName:"p"},"mod"),"): ",(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"EventModule"))),(0,l.kt)("p",null,"The wrapper function to define event modules for sern"),(0,l.kt)("h4",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"mod")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("a",{parentName:"td",href:"/docs/api/modules#inputeventmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"InputEventModule")))))),(0,l.kt)("h4",{id:"returns-4"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodule"},(0,l.kt)("inlineCode",{parentName:"a"},"EventModule"))),(0,l.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/sern.ts#L76"},"src/handler/sern.ts:76")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"many"},"many"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"many"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"value"),"): () => () => ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("p",null,"A function that returns another function\nUsed for transient in iti"),(0,l.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"value")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"returns-5"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"fn")),(0,l.kt)("p",null,"\u25b8 (): () => ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h5",{id:"returns-6"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"fn")),(0,l.kt)("p",null,"\u25b8 (): ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h5",{id:"returns-7"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/utilities/functions.ts#L16"},"src/handler/utilities/functions.ts:16")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"single"},"single"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"single"),"<",(0,l.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,l.kt)("inlineCode",{parentName:"p"},"value"),"): () => ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("p",null,"A function that returns whatever value is provided.\nUsed for singleton in iti"),(0,l.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,l.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"value")),(0,l.kt)("td",{parentName:"tr",align:"left"},(0,l.kt)("inlineCode",{parentName:"td"},"T"))))),(0,l.kt)("h4",{id:"returns-8"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"fn")),(0,l.kt)("p",null,"\u25b8 (): ",(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h5",{id:"returns-9"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"T")),(0,l.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/utilities/functions.ts#L10"},"src/handler/utilities/functions.ts:10")),(0,l.kt)("hr",null),(0,l.kt)("h3",{id:"usecontainerraw"},"useContainerRaw"),(0,l.kt)("p",null,"\u25b8 ",(0,l.kt)("strong",{parentName:"p"},"useContainerRaw"),"(): ",(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Container"),"<",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Dependencies"},(0,l.kt)("inlineCode",{parentName:"a"},"Dependencies")),", ",(0,l.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Dependencies"},(0,l.kt)("inlineCode",{parentName:"a"},"Dependencies")),">",">"),(0,l.kt)("p",null,"Returns the underlying data structure holding all dependencies.\nExposes some methods from iti"),(0,l.kt)("h4",{id:"returns-10"},"Returns"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,l.kt)("inlineCode",{parentName:"p"},"Container"),"<",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Dependencies"},(0,l.kt)("inlineCode",{parentName:"a"},"Dependencies")),", ",(0,l.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,l.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Dependencies"},(0,l.kt)("inlineCode",{parentName:"a"},"Dependencies")),">",">"),(0,l.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,l.kt)("p",null,(0,l.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/3daacfc/src/handler/dependencies/provider.ts#L74"},"src/handler/dependencies/provider.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f6aebfbf.daff3f4e.js b/assets/js/f6aebfbf.daff3f4e.js deleted file mode 100644 index e332e76aa..000000000 --- a/assets/js/f6aebfbf.daff3f4e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[7306],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>u});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var d=a.createContext({}),o=function(e){var t=a.useContext(d),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},m=function(e){var t=o(e.components);return a.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,d=e.parentName,m=p(e,["components","mdxType","originalType","parentName"]),k=o(n),u=i,N=k["".concat(d,".").concat(u)]||k[u]||s[u]||l;return n?a.createElement(N,r(r({ref:t},m),{},{components:n})):a.createElement(N,r({ref:t},m))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,r=new Array(l);r[0]=k;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:i,r[1]=p;for(var o=2;o{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>r,default:()=>s,frontMatter:()=>l,metadata:()=>p,toc:()=>o});var a=n(7462),i=(n(7294),n(3905));const l={id:"modules",title:"@sern/handler",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},r=void 0,p={unversionedId:"api/modules",id:"api/modules",title:"@sern/handler",description:"Namespaces",source:"@site/docs/api/modules.md",sourceDirName:"api",slug:"/api/modules",permalink:"/docs/api/modules",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@sern/handler",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Readme",permalink:"/docs/api/"},next:{title:"Sern",permalink:"/docs/api/namespaces/Sern"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Enumerations",id:"enumerations",level:2},{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"Args",id:"args",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"AutocompletePlugin",id:"autocompleteplugin",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"BaseOptions",id:"baseoptions",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"BothCommand",id:"bothcommand",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"CommandModuleNoPlugins",id:"commandmodulenoplugins",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"CommandModulePlugin",id:"commandmoduleplugin",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"CommandPlugin",id:"commandplugin",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"DefinedCommandModule",id:"definedcommandmodule",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"DefinedEventModule",id:"definedeventmodule",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"DefinedModule",id:"definedmodule",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"DefinitelyDefined",id:"definitelydefined",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"DiscordEmitterPlugin",id:"discordemitterplugin",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"DiscordEventPlugin",id:"discordeventplugin",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"EventInput",id:"eventinput",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"EventModuleCommandPluginDefs",id:"eventmodulecommandplugindefs",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"EventModuleEventPluginDefs",id:"eventmoduleeventplugindefs",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"EventModulePlugin",id:"eventmoduleplugin",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"EventModulesNoPlugins",id:"eventmodulesnoplugins",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"EventPlugin",id:"eventplugin",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"ExternalEmitterPlugin",id:"externalemitterplugin",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"ExternalEventPlugin",id:"externaleventplugin",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"InputCommandModule",id:"inputcommandmodule",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"InputEventModule",id:"inputeventmodule",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"Module",id:"module",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"Nullish",id:"nullish",level:3},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"Override",id:"override",level:3},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"ParseType",id:"parsetype",level:3},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"Payload",id:"payload",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"ReplyOptions",id:"replyoptions",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"SernAutocompleteData",id:"sernautocompletedata",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"SernEmitterPlugin",id:"sernemitterplugin",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"SernEventPlugin",id:"serneventplugin",level:3},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"SernEventsMapping",id:"serneventsmapping",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"SernOptionsData",id:"sernoptionsdata",level:3},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"SernSubCommandData",id:"sernsubcommanddata",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"SernSubCommandGroupData",id:"sernsubcommandgroupdata",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"SlashCommand",id:"slashcommand",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"SlashOptions",id:"slashoptions",level:3},{value:"Defined in",id:"defined-in-37",level:4},{value:"SpreadParams",id:"spreadparams",level:3},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-38",level:4},{value:"TextCommand",id:"textcommand",level:3},{value:"Defined in",id:"defined-in-39",level:4},{value:"Functions",id:"functions",level:2},{value:"commandModule",id:"commandmodule",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"eventModule",id:"eventmodule",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-41",level:4}],m={toc:o};function s(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"namespaces"},"Namespaces"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/namespaces/Sern"},"Sern"))),(0,i.kt)("h2",{id:"enumerations"},"Enumerations"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/enums/CommandType"},"CommandType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/enums/EventType"},"EventType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/enums/PayloadType"},"PayloadType")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/enums/PluginType"},"PluginType"))),(0,i.kt)("h2",{id:"classes"},"Classes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/CommandExecutable"},"CommandExecutable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/Context"},"Context")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/EventExecutable"},"EventExecutable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/SernEmitter"},"SernEmitter"))),(0,i.kt)("h2",{id:"interfaces"},"Interfaces"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Controller"},"Controller")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/Wrapper"},"Wrapper"))),(0,i.kt)("h2",{id:"type-aliases"},"Type Aliases"),(0,i.kt)("h3",{id:"args"},"Args"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Args"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#parsetype"},(0,i.kt)("inlineCode",{parentName:"a"},"ParseType")),"<{ ",(0,i.kt)("inlineCode",{parentName:"p"},"slash"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#slashoptions"},(0,i.kt)("inlineCode",{parentName:"a"},"SlashOptions"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"text"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[] }",">"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L12"},"src/types/handler.ts:12")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"autocompleteplugin"},"AutocompletePlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"AutocompletePlugin"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BaseModule"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"autocmp"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"AutocompleteInteraction"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"controlller"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event"))," }",">"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L92"},"src/handler/plugins/plugin.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"baseoptions"},"BaseOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"BaseOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandChoicesData")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandNonOptionsData")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandChannelOptionData")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandNumericOptionData")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandAttachmentOption")," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#sernautocompletedata"},(0,i.kt)("inlineCode",{parentName:"a"},"SernAutocompleteData"))),(0,i.kt)("p",null,"Type that replaces autocomplete with ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#sernautocompletedata"},"SernAutocompleteData")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L181"},"src/handler/structures/module.ts:181")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"bothcommand"},"BothCommand"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"BothCommand"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BaseModule"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"alias?"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,i.kt)("inlineCode",{parentName:"a"},"Context")),", ",(0,i.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#args"},(0,i.kt)("inlineCode",{parentName:"a"},"Args")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"onEvent"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#eventplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#both"},(0,i.kt)("inlineCode",{parentName:"a"},"Both")),">","[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#sernoptionsdata"},(0,i.kt)("inlineCode",{parentName:"a"},"SernOptionsData")),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"plugins"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#commandplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#both"},(0,i.kt)("inlineCode",{parentName:"a"},"Both"))," }",">"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L55"},"src/handler/structures/module.ts:55")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"commandmodulenoplugins"},"CommandModuleNoPlugins"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"CommandModuleNoPlugins"),": { ","[T in CommandType]",": Omit"," }"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L145"},"src/handler/plugins/plugin.ts:145")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"commandmoduleplugin"},"CommandModulePlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"CommandModulePlugin"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#eventplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#commandplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/enums/CommandType"},(0,i.kt)("inlineCode",{parentName:"a"},"CommandType")))))),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L173"},"src/handler/plugins/plugin.ts:173")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"commandplugin"},"CommandPlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"CommandPlugin"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": { ","[K in T]",": Override"," }","[",(0,i.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,i.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"CommandModuleDefs")," = keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"CommandModuleDefs"))))),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L40"},"src/handler/plugins/plugin.ts:40")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"definedcommandmodule"},"DefinedCommandModule"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"DefinedCommandModule"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#definitelydefined"},(0,i.kt)("inlineCode",{parentName:"a"},"DefinitelyDefined")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"CommandModule"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"description"'),">"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L43"},"src/types/handler.ts:43")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"definedeventmodule"},"DefinedEventModule"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"DefinedEventModule"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#definitelydefined"},(0,i.kt)("inlineCode",{parentName:"a"},"DefinitelyDefined")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"EventModule"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"description"'),">"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L44"},"src/types/handler.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"definedmodule"},"DefinedModule"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"DefinedModule"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#definitelydefined"},(0,i.kt)("inlineCode",{parentName:"a"},"DefinitelyDefined")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#module"},(0,i.kt)("inlineCode",{parentName:"a"},"Module")),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"description"'),">"),(0,i.kt)("p",null,"After modules are transformed, name and description are given default values if none\nare provided to Module. This type represents that transformation"),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L42"},"src/types/handler.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"definitelydefined"},"DefinitelyDefined"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"DefinitelyDefined"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"K"),">",": { ","[L in K]","-?: T","[L]"," extends Record"," ? DefinitelyDefined"," : Required","[L]"," } & ",(0,i.kt)("inlineCode",{parentName:"p"},"T")),(0,i.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"K")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"T")," = keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L19"},"src/types/handler.ts:19")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"discordemitterplugin"},"DiscordEmitterPlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"DiscordEmitterPlugin"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BasePlugin"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"wrapper"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Client"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"module"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#definitelydefined"},(0,i.kt)("inlineCode",{parentName:"a"},"DefinitelyDefined")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"DiscordEventCommand"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"description"'),">",", ",(0,i.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#command"},(0,i.kt)("inlineCode",{parentName:"a"},"Command"))," }",">"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L57"},"src/handler/plugins/plugin.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"discordeventplugin"},"DiscordEventPlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"DiscordEventPlugin"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BasePlugin"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ClientEvents"),"[",(0,i.kt)("inlineCode",{parentName:"p"},"T"),"]",", ",(0,i.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"T")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event"))," }",">"),(0,i.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"ClientEvents")," = keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"ClientEvents"))))),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L136"},"src/handler/plugins/plugin.ts:136")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"eventinput"},"EventInput"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"EventInput"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," { ",(0,i.kt)("inlineCode",{parentName:"p"},"absPath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"mod"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"EventModule")," }[] ","|"," () => { ",(0,i.kt)("inlineCode",{parentName:"p"},"absPath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"mod"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"EventModule")," }[]"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L25"},"src/types/handler.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"eventmodulecommandplugindefs"},"EventModuleCommandPluginDefs"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"EventModuleCommandPluginDefs"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Event Module Command Plugins"),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"1")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#discordemitterplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"DiscordEmitterPlugin")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"2")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#sernemitterplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEmitterPlugin")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"3")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#externalemitterplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"ExternalEmitterPlugin")))))),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L163"},"src/handler/plugins/plugin.ts:163")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"eventmoduleeventplugindefs"},"EventModuleEventPluginDefs"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"EventModuleEventPluginDefs"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Event Module Event Plugins"),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"1")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#discordeventplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"DiscordEventPlugin")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"2")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEventPlugin")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"3")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#externaleventplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"ExternalEventPlugin")))))),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L154"},"src/handler/plugins/plugin.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"eventmoduleplugin"},"EventModulePlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"EventModulePlugin"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmoduleeventplugindefs"},(0,i.kt)("inlineCode",{parentName:"a"},"EventModuleEventPluginDefs")),"[",(0,i.kt)("inlineCode",{parentName:"p"},"T"),"]"," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#eventmodulecommandplugindefs"},(0,i.kt)("inlineCode",{parentName:"a"},"EventModuleCommandPluginDefs")),"[",(0,i.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,i.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/enums/EventType"},(0,i.kt)("inlineCode",{parentName:"a"},"EventType")))))),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L169"},"src/handler/plugins/plugin.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"eventmodulesnoplugins"},"EventModulesNoPlugins"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"EventModulesNoPlugins"),": { ","[T in EventType]",": Omit"," }"),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L148"},"src/handler/plugins/plugin.ts:148")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"eventplugin"},"EventPlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"EventPlugin"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": { ","[K in T]",": Override"," }","[",(0,i.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,i.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"CommandModuleDefs")," = keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"CommandModuleDefs"))))),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L103"},"src/handler/plugins/plugin.ts:103")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"externalemitterplugin"},"ExternalEmitterPlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ExternalEmitterPlugin"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BasePlugin"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"wrapper"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"module"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#definitelydefined"},(0,i.kt)("inlineCode",{parentName:"a"},"DefinitelyDefined")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"ExternalEventCommand"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"description"'),">",", ",(0,i.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#command"},(0,i.kt)("inlineCode",{parentName:"a"},"Command"))," }",">"),(0,i.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"EventEmitter")," = ",(0,i.kt)("inlineCode",{parentName:"td"},"EventEmitter"))))),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L68"},"src/handler/plugins/plugin.ts:68")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"externaleventplugin"},"ExternalEventPlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ExternalEventPlugin"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BasePlugin"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),"[], ",(0,i.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event"))," }",">"),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L128"},"src/handler/plugins/plugin.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"inputcommandmodule"},"InputCommandModule"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"InputCommandModule"),": { ","[T in CommandType]",": CommandModuleNoPlugins","[T]"," & Object }[",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType"},(0,i.kt)("inlineCode",{parentName:"a"},"CommandType")),"]"),(0,i.kt)("p",null,"User inputs this type. Sern processes behind the scenes for better usage"),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L178"},"src/handler/plugins/plugin.ts:178")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"inputeventmodule"},"InputEventModule"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"InputEventModule"),": { ","[T in EventType]",": EventModulesNoPlugins","[T]"," & Object }[",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/EventType"},(0,i.kt)("inlineCode",{parentName:"a"},"EventType")),"]"),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L182"},"src/handler/plugins/plugin.ts:182")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"module"},"Module"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Module"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"CommandModule")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"EventModule")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L141"},"src/handler/structures/module.ts:141")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"nullish"},"Nullish"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Nullish"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,i.kt)("inlineCode",{parentName:"p"},"T")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"null")),(0,i.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L5"},"src/types/handler.ts:5")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"override"},"Override"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Override"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T1"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"T2"),">",": ",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T1"),", keyof ",(0,i.kt)("inlineCode",{parentName:"p"},"T2"),">"," & ",(0,i.kt)("inlineCode",{parentName:"p"},"T2")),(0,i.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T1"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T2"))))),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L17"},"src/types/handler.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parsetype"},"ParseType"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ParseType"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": { ","[K in keyof T]",": T","[K]"," extends unknown ? [k: K, args: T","[K]","] : never }","[keyof ",(0,i.kt)("inlineCode",{parentName:"p"},"T"),"]"),(0,i.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L8"},"src/types/handler.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"payload"},"Payload"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Payload"),": { ",(0,i.kt)("inlineCode",{parentName:"p"},"module"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#module"},(0,i.kt)("inlineCode",{parentName:"a"},"Module"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PayloadType#success"},(0,i.kt)("inlineCode",{parentName:"a"},"Success"))," } ","|"," { ",(0,i.kt)("inlineCode",{parentName:"p"},"module?"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#module"},(0,i.kt)("inlineCode",{parentName:"a"},"Module"))," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"reason"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Error")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PayloadType#failure"},(0,i.kt)("inlineCode",{parentName:"a"},"Failure"))," }"),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L45"},"src/types/handler.ts:45")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"replyoptions"},"ReplyOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ReplyOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"InteractionReplyOptions"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"fetchReply"'),">"," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"MessageReplyOptions")),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L55"},"src/types/handler.ts:55")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernautocompletedata"},"SernAutocompleteData"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SernAutocompleteData"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BaseApplicationCommandOptionsData"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"autocomplete"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"true")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"command"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"AutocompleteCommand")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandOptionType.String")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandOptionType.Number")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandOptionType.Integer")," }",">"),(0,i.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L166"},"src/handler/structures/module.ts:166")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernemitterplugin"},"SernEmitterPlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SernEmitterPlugin"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BasePlugin"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"wrapper"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/SernEmitter"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEmitter")),", ",(0,i.kt)("inlineCode",{parentName:"p"},"module"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#definitelydefined"},(0,i.kt)("inlineCode",{parentName:"a"},"DefinitelyDefined")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"SernEventCommand"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"description"'),">",", ",(0,i.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#command"},(0,i.kt)("inlineCode",{parentName:"a"},"Command"))," }",">"),(0,i.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L80"},"src/handler/plugins/plugin.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"serneventplugin"},"SernEventPlugin"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SernEventPlugin"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BasePlugin"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#serneventsmapping"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")),"[",(0,i.kt)("inlineCode",{parentName:"p"},"T"),"]",", ",(0,i.kt)("inlineCode",{parentName:"p"},"controller"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/Controller"},(0,i.kt)("inlineCode",{parentName:"a"},"Controller")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Result"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">",">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"T")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/PluginType#event"},(0,i.kt)("inlineCode",{parentName:"a"},"Event"))," }",">"),(0,i.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEventsMapping"))," = keyof ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#serneventsmapping"},(0,i.kt)("inlineCode",{parentName:"a"},"SernEventsMapping")))))),(0,i.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/plugins/plugin.ts#L116"},"src/handler/plugins/plugin.ts:116")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"serneventsmapping"},"SernEventsMapping"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SernEventsMapping"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"error")),(0,i.kt)("td",{parentName:"tr",align:"left"},"[",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")),"]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"module.activate")),(0,i.kt)("td",{parentName:"tr",align:"left"},"[",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")),"]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"module.register")),(0,i.kt)("td",{parentName:"tr",align:"left"},"[",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#payload"},(0,i.kt)("inlineCode",{parentName:"a"},"Payload")),"]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"warning")),(0,i.kt)("td",{parentName:"tr",align:"left"},"[",(0,i.kt)("inlineCode",{parentName:"td"},"string"),"]")))),(0,i.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L48"},"src/types/handler.ts:48")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernoptionsdata"},"SernOptionsData"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SernOptionsData"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"U"),">",": ",(0,i.kt)("inlineCode",{parentName:"p"},"U")," extends ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandSubCommandData")," ? ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#sernsubcommanddata"},(0,i.kt)("inlineCode",{parentName:"a"},"SernSubCommandData"))," : ",(0,i.kt)("inlineCode",{parentName:"p"},"U")," extends ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandSubGroupData")," ? ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#sernsubcommandgroupdata"},(0,i.kt)("inlineCode",{parentName:"a"},"SernSubCommandGroupData"))," : ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#baseoptions"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseOptions"))),(0,i.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"U")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"ApplicationCommandOptionData")," = ",(0,i.kt)("inlineCode",{parentName:"td"},"ApplicationCommandOptionData"))))),(0,i.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L205"},"src/handler/structures/module.ts:205")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernsubcommanddata"},"SernSubCommandData"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SernSubCommandData"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BaseApplicationCommandOptionsData"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"required"'),">",", { ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#baseoptions"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseOptions")),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandOptionType.Subcommand")," }",">"),(0,i.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L189"},"src/handler/structures/module.ts:189")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sernsubcommandgroupdata"},"SernSubCommandGroupData"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SernSubCommandGroupData"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BaseApplicationCommandOptionsData"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"required"'),">",", { ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#sernsubcommanddata"},(0,i.kt)("inlineCode",{parentName:"a"},"SernSubCommandData")),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ApplicationCommandOptionType.SubcommandGroup")," }",">"),(0,i.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L197"},"src/handler/structures/module.ts:197")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slashcommand"},"SlashCommand"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SlashCommand"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BaseModule"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,i.kt)("inlineCode",{parentName:"a"},"Context")),", ",(0,i.kt)("inlineCode",{parentName:"p"},"args"),": [",(0,i.kt)("inlineCode",{parentName:"p"},'"slash"'),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#slashoptions"},(0,i.kt)("inlineCode",{parentName:"a"},"SlashOptions")),"]) => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"onEvent"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#eventplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#slash"},(0,i.kt)("inlineCode",{parentName:"a"},"Slash")),">","[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#sernoptionsdata"},(0,i.kt)("inlineCode",{parentName:"a"},"SernOptionsData")),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"plugins"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#commandplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#slash"},(0,i.kt)("inlineCode",{parentName:"a"},"Slash"))," }",">"),(0,i.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L44"},"src/handler/structures/module.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slashoptions"},"SlashOptions"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SlashOptions"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"CommandInteractionOptionResolver"),", ",(0,i.kt)("inlineCode",{parentName:"p"},'"getMessage"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"getFocused"'),">"),(0,i.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L14"},"src/types/handler.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"spreadparams"},"SpreadParams"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"SpreadParams"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": (",(0,i.kt)("inlineCode",{parentName:"p"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Parameters"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">","[",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"]",") => ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown")),(0,i.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends (...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"never"),") => ",(0,i.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,i.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown")),(0,i.kt)("p",null,"Turns a function with a union of array of args into a single union\n","[ T , V , B ]"," | ","[ A ]"," => T | V | B | A"),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"args")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Parameters"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">","[",(0,i.kt)("inlineCode",{parentName:"td"},"number"),"]")))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"unknown")),(0,i.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/types/handler.ts#L34"},"src/types/handler.ts:34")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"textcommand"},"TextCommand"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TextCommand"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#override"},(0,i.kt)("inlineCode",{parentName:"a"},"Override")),"<",(0,i.kt)("inlineCode",{parentName:"p"},"BaseModule"),", { ",(0,i.kt)("inlineCode",{parentName:"p"},"alias?"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"execute"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"ctx"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/Context"},(0,i.kt)("inlineCode",{parentName:"a"},"Context")),", ",(0,i.kt)("inlineCode",{parentName:"p"},"args"),": [",(0,i.kt)("inlineCode",{parentName:"p"},'"text"'),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]]) => ",(0,i.kt)("inlineCode",{parentName:"p"},"Awaitable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"onEvent"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#eventplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"EventPlugin")),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#text"},(0,i.kt)("inlineCode",{parentName:"a"},"Text")),">","[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"plugins"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules#commandplugin"},(0,i.kt)("inlineCode",{parentName:"a"},"CommandPlugin")),"[] ; ",(0,i.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/enums/CommandType#text"},(0,i.kt)("inlineCode",{parentName:"a"},"Text"))," }",">"),(0,i.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/structures/module.ts#L33"},"src/handler/structures/module.ts:33")),(0,i.kt)("h2",{id:"functions"},"Functions"),(0,i.kt)("h3",{id:"commandmodule"},"commandModule"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"commandModule"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"mod"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"CommandModule")),(0,i.kt)("p",null,"The wrapper function to define command modules for sern"),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"mod")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#inputcommandmodule"},(0,i.kt)("inlineCode",{parentName:"a"},"InputCommandModule")))))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"CommandModule")),(0,i.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L91"},"src/handler/sern.ts:91")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"eventmodule"},"eventModule"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("strong",{parentName:"p"},"eventModule"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"mod"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"EventModule")),(0,i.kt)("p",null,"The wrapper function to define event modules for sern"),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"mod")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules#inputeventmodule"},(0,i.kt)("inlineCode",{parentName:"a"},"InputEventModule")))))),(0,i.kt)("h4",{id:"returns-2"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"EventModule")),(0,i.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/sern-handler/handler/blob/4074274/src/handler/sern.ts#L112"},"src/handler/sern.ts:112")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/main.7aa64296.js b/assets/js/main.7aa64296.js deleted file mode 100644 index 505a2609a..000000000 --- a/assets/js/main.7aa64296.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! For license information please see main.7aa64296.js.LICENSE.txt */ -(self.webpackChunk_sern_website=self.webpackChunk_sern_website||[]).push([[179],{723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});var r=n(7294),a=n(7462),o=n(8356),i=n.n(o),l=n(6887);const s={"01a85c17":[()=>Promise.all([n.e(532),n.e(4013)]).then(n.bind(n,1223)),"@theme/BlogTagsListPage",1223],"0e384e19":[()=>n.e(9671).then(n.bind(n,9881)),"@site/docs/intro.md",9881],17896441:[()=>Promise.all([n.e(532),n.e(7540),n.e(7918)]).then(n.bind(n,9055)),"@theme/DocItem",9055],"1ac1bfe9":[()=>n.e(2005).then(n.bind(n,4291)),"@site/docs/guide/walkthrough/plugins.md",4291],"1aef51bd":[()=>n.e(4137).then(n.bind(n,9156)),"@site/docs/guide/walkthrough/conclusion.md",9156],"1be78505":[()=>Promise.all([n.e(532),n.e(9514)]).then(n.bind(n,9963)),"@theme/DocPage",9963],"1f391b9e":[()=>Promise.all([n.e(532),n.e(7540),n.e(3085)]).then(n.bind(n,4247)),"@theme/MDXPage",4247],"26f1f3a5":[()=>n.e(7363).then(n.bind(n,8349)),"@site/docs/api/enums/PayloadType.md",8349],"2f13d849":[()=>n.e(65).then(n.bind(n,7902)),"@site/blog/2022-09-30-mdx-blog-post.md?truncated=true",7902],"3020eeee":[()=>n.e(7223).then(n.bind(n,377)),"@site/blog/2022-09-28-mdx-blog-post.md",377],"312c2bc5":[()=>Promise.all([n.e(532),n.e(5397)]).then(n.bind(n,4412)),"@site/src/pages/plugins.js",4412],"393be207":[()=>n.e(7414).then(n.bind(n,7575)),"@site/src/pages/markdown-page.md",7575],"3a25b5a8":[()=>n.e(3012).then(n.bind(n,7257)),"@site/blog/2022-12-13-mdx-blog-post.md",7257],"3a2d3092":[()=>n.e(7750).then(n.bind(n,4355)),"@site/docs/guide/walkthrough/good-to-know.md",4355],"3dc7c79a":[()=>n.e(9712).then(n.bind(n,1772)),"@site/docs/guide/getting-started/preparing.md",1772],"5bc4ccbc":[()=>n.e(53).then(n.bind(n,8199)),"@site/docs/api/interfaces/Wrapper.md",8199],"5e8c322a":[()=>n.e(7597).then(n.bind(n,7926)),"@site/docs/api/index.md",7926],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,6809)),"@generated/docusaurus.config",6809],"608ca171":[()=>n.e(6146).then(n.bind(n,9017)),"@site/docs/guide/walkthrough/cli.md",9017],67348500:[()=>n.e(2072).then(n.bind(n,5661)),"@site/blog/2022-12-13-mdx-blog-post.md?truncated=true",5661],"6875c492":[()=>Promise.all([n.e(532),n.e(7540),n.e(2529),n.e(8610)]).then(n.bind(n,1714)),"@theme/BlogTagsPostsPage",1714],"69369ae2":[()=>n.e(5062).then(n.t.bind(n,3769,19)),"/home/runner/work/website/website/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],"6ba1d2c1":[()=>n.e(7374).then(n.bind(n,7346)),"@site/blog/2022-09-28-mdx-blog-post.md?truncated=true",7346],"6c624b4c":[()=>n.e(4332).then(n.bind(n,8622)),"@site/docs/api/classes/CommandExecutable.md",8622],"6cfc4513":[()=>n.e(496).then(n.t.bind(n,8811,19)),"~blog/default/blog-tags-guides-c2f.json",8811],"707baeff":[()=>n.e(9226).then(n.bind(n,7827)),"@site/docs/api/enums/EventType.md",7827],"73bd57bd":[()=>n.e(332).then(n.bind(n,3607)),"@site/docs/api/namespaces/Sern.md",3607],"7c2ff145":[()=>n.e(1505).then(n.t.bind(n,4469,19)),"/home/runner/work/website/website/.docusaurus/docusaurus-plugin-content-blog/default/plugin-route-context-module-100.json",4469],"7e205c4a":[()=>n.e(7127).then(n.bind(n,3024)),"@site/docs/api/classes/SernEmitter.md",3024],"814f3328":[()=>n.e(2535).then(n.t.bind(n,5641,19)),"~blog/default/blog-post-list-prop-default.json",5641],"83d480e9":[()=>n.e(205).then(n.t.bind(n,3672,19)),"~blog/default/blog-tags-release-b5c.json",3672],"888566f1":[()=>n.e(3045).then(n.bind(n,1991)),"@site/docs/guide/getting-started/choose-ide.md",1991],"9201de17":[()=>n.e(4803).then(n.bind(n,4743)),"@site/docs/guide/README.md",4743],"935f2afb":[()=>n.e(2197).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"981f6151":[()=>n.e(703).then(n.bind(n,1830)),"@site/docs/guide/walkthrough/first-command.md",1830],"9c021584":[()=>n.e(7438).then(n.t.bind(n,8055,19)),"~blog/default/blog-tags-release-b5c-list.json",8055],"9e4087bc":[()=>n.e(3608).then(n.bind(n,3169)),"@theme/BlogArchivePage",3169],a5467962:[()=>n.e(6322).then(n.bind(n,5953)),"@site/docs/api/enums/CommandType.md",5953],a6aa9e1f:[()=>Promise.all([n.e(532),n.e(7540),n.e(2529),n.e(3089)]).then(n.bind(n,46)),"@theme/BlogListPage",46],a7023ddc:[()=>n.e(1713).then(n.t.bind(n,3457,19)),"~blog/default/blog-tags-tags-4c2.json",3457],a96c96b0:[()=>n.e(2640).then(n.bind(n,4713)),"@site/docs/guide/walkthrough/goal.md",4713],b2b675dd:[()=>n.e(533).then(n.t.bind(n,8017,19)),"~blog/default/blog-c06.json",8017],b2f554cd:[()=>n.e(1477).then(n.t.bind(n,10,19)),"~blog/default/blog-archive-80c.json",10],bcd9df7e:[()=>n.e(8652).then(n.bind(n,4836)),"@site/docs/api/classes/Context.md",4836],c0846785:[()=>n.e(1036).then(n.bind(n,4188)),"@site/docs/api/classes/EventExecutable.md",4188],c4348237:[()=>n.e(277).then(n.t.bind(n,5745,19)),"/home/runner/work/website/website/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",5745],c4f5d8e4:[()=>Promise.all([n.e(532),n.e(4195)]).then(n.bind(n,2773)),"@site/src/pages/index.js",2773],ccc49370:[()=>Promise.all([n.e(532),n.e(7540),n.e(2529),n.e(6103)]).then(n.bind(n,9178)),"@theme/BlogPostPage",9178],cf183316:[()=>n.e(1472).then(n.bind(n,2472)),"@site/docs/guide/walkthrough/sern-emitter.md",2472],cfb1619e:[()=>n.e(4685).then(n.t.bind(n,6550,19)),"~blog/default/blog-tags-guides-c2f-list.json",6550],e4877132:[()=>n.e(6270).then(n.bind(n,4609)),"@site/docs/api/enums/PluginType.md",4609],e8e3d8c7:[()=>n.e(4865).then(n.bind(n,6631)),"@site/docs/guide/walkthrough/first-event.md",6631],eea0bf40:[()=>n.e(4429).then(n.bind(n,624)),"@site/docs/api/interfaces/Controller.md",624],f6aebfbf:[()=>n.e(7306).then(n.bind(n,4440)),"@site/docs/api/modules.md",4440],f7831d67:[()=>n.e(9881).then(n.bind(n,9571)),"@site/blog/2022-09-30-mdx-blog-post.md",9571]};function u(e){let{error:t,retry:n,pastDelay:a}=e;return t?r.createElement("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"}},r.createElement("p",null,String(t)),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},"Retry"))):a?r.createElement("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"}},r.createElement("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb"},r.createElement("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2"},r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"8"},r.createElement("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"}))))):null}var c=n(9670),d=n(226);function f(e,t){if("*"===e)return i()({loading:u,loader:()=>n.e(4972).then(n.bind(n,4972)),modules:["@theme/NotFound"],webpack:()=>[4972],render(e,t){const n=e.default;return r.createElement(d.z,{value:{plugin:{name:"native",id:"default"}}},r.createElement(n,t))}});const o=l[e+"-"+t],f={},p=[],m=[],g=(0,c.Z)(o);return Object.entries(g).forEach((e=>{let[t,n]=e;const r=s[n];r&&(f[t]=r[0],p.push(r[1]),m.push(r[2]))})),i().Map({loading:u,loader:f,modules:p,webpack:()=>m,render(t,n){const i=JSON.parse(JSON.stringify(o));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error("The page component at "+e+" doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.");"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let o=i;const l=n.split(".");l.slice(0,-1).forEach((e=>{o=o[e]})),o[l[l.length-1]]=a}));const l=i.__comp;delete i.__comp;const s=i.__context;return delete i.__context,r.createElement(d.z,{value:s},r.createElement(l,(0,a.Z)({},i,n)))}})}const p=[{path:"/blog",component:f("/blog","9ee"),exact:!0},{path:"/blog/1.2.0",component:f("/blog/1.2.0","cba"),exact:!0},{path:"/blog/2.0.0",component:f("/blog/2.0.0","c58"),exact:!0},{path:"/blog/archive",component:f("/blog/archive","825"),exact:!0},{path:"/blog/getting-started",component:f("/blog/getting-started","e5e"),exact:!0},{path:"/blog/tags",component:f("/blog/tags","61b"),exact:!0},{path:"/blog/tags/guides",component:f("/blog/tags/guides","0da"),exact:!0},{path:"/blog/tags/release",component:f("/blog/tags/release","588"),exact:!0},{path:"/markdown-page",component:f("/markdown-page","494"),exact:!0},{path:"/plugins",component:f("/plugins","bcd"),exact:!0},{path:"/docs",component:f("/docs","86a"),routes:[{path:"/docs/api",component:f("/docs/api","c13"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/CommandExecutable",component:f("/docs/api/classes/CommandExecutable","574"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/Context",component:f("/docs/api/classes/Context","d4a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/EventExecutable",component:f("/docs/api/classes/EventExecutable","494"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/SernEmitter",component:f("/docs/api/classes/SernEmitter","a53"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/enums/CommandType",component:f("/docs/api/enums/CommandType","f9d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/enums/EventType",component:f("/docs/api/enums/EventType","a4e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/enums/PayloadType",component:f("/docs/api/enums/PayloadType","ea7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/enums/PluginType",component:f("/docs/api/enums/PluginType","36e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/Controller",component:f("/docs/api/interfaces/Controller","6fd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/Wrapper",component:f("/docs/api/interfaces/Wrapper","cc3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/modules",component:f("/docs/api/modules","98a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/namespaces/Sern",component:f("/docs/api/namespaces/Sern","350"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide",component:f("/docs/guide","f2d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/getting-started/choose-ide",component:f("/docs/guide/getting-started/choose-ide","2c7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/getting-started/preparing",component:f("/docs/guide/getting-started/preparing","c46"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/walkthrough/cli",component:f("/docs/guide/walkthrough/cli","6dc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/walkthrough/conclusion",component:f("/docs/guide/walkthrough/conclusion","195"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/walkthrough/first-command",component:f("/docs/guide/walkthrough/first-command","1a8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/walkthrough/first-event",component:f("/docs/guide/walkthrough/first-event","218"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/walkthrough/goal",component:f("/docs/guide/walkthrough/goal","ed0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/walkthrough/good-to-know",component:f("/docs/guide/walkthrough/good-to-know","7b6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/walkthrough/plugins",component:f("/docs/guide/walkthrough/plugins","63f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/guide/walkthrough/sern-emitter",component:f("/docs/guide/walkthrough/sern-emitter","200"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/intro",component:f("/docs/intro","aed"),exact:!0,sidebar:"tutorialSidebar"}]},{path:"/",component:f("/","473"),exact:!0},{path:"*",component:f("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>o});var r=n(7294);const a=r.createContext(!1);function o(e){let{children:t}=e;const[n,o]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{o(!0)}),[]),r.createElement(a.Provider,{value:n},t)}},9383:(e,t,n)=>{"use strict";var r=n(7294),a=n(3935),o=n(3727),i=n(405),l=n(412);const s=[n(2497),n(3310),n(8320),n(2295)];var u=n(723),c=n(6775),d=n(8790);function f(e){let{children:t}=e;return r.createElement(r.Fragment,null,t)}var p=n(7462),m=n(5742),g=n(2263),h=n(4996),b=n(6668),v=n(1944),y=n(4711),w=n(9727),k=n(3320),E=n(197);function S(){const{i18n:{defaultLocale:e,localeConfigs:t}}=(0,g.Z)(),n=(0,y.l)();return r.createElement(m.Z,null,Object.entries(t).map((e=>{let[t,{htmlLang:a}]=e;return r.createElement("link",{key:t,rel:"alternate",href:n.createUrl({locale:t,fullyQualified:!0}),hrefLang:a})})),r.createElement("link",{rel:"alternate",href:n.createUrl({locale:e,fullyQualified:!0}),hrefLang:"x-default"}))}function x(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,g.Z)(),a=function(){const{siteConfig:{url:e}}=(0,g.Z)(),{pathname:t}=(0,c.TH)();return e+(0,h.Z)(t)}(),o=t?""+n+t:a;return r.createElement(m.Z,null,r.createElement("meta",{property:"og:url",content:o}),r.createElement("link",{rel:"canonical",href:o}))}function _(){const{i18n:{currentLocale:e}}=(0,g.Z)(),{metadata:t,image:n}=(0,b.L)();return r.createElement(r.Fragment,null,r.createElement(m.Z,null,r.createElement("meta",{name:"twitter:card",content:"summary_large_image"}),r.createElement("body",{className:w.h})),n&&r.createElement(v.d,{image:n}),r.createElement(x,null),r.createElement(S,null),r.createElement(E.Z,{tag:k.HX,locale:e}),r.createElement(m.Z,null,t.map(((e,t)=>r.createElement("meta",(0,p.Z)({key:t},e))))))}const C=new Map;function T(e){if(C.has(e.pathname))return{...e,pathname:C.get(e.pathname)};if((0,d.f)(u.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return C.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return C.set(e.pathname,t),{...e,pathname:t}}var A=n(8934),L=n(8940);function P(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{var r,a;const o=null!=(r=null==(a=t.default)?void 0:a[e])?r:t[e];return null==o?void 0:o(...n)}));return()=>a.forEach((e=>null==e?void 0:e()))}const R=function(e){let{children:t,location:n,previousLocation:a}=e;return(0,r.useLayoutEffect)((()=>{a!==n&&(a&&function(e){const{hash:t}=e;if(t){const e=decodeURIComponent(t.substring(1)),n=document.getElementById(e);null==n||n.scrollIntoView()}else window.scrollTo(0,0)}(n),P("onRouteDidUpdate",{previousLocation:a,location:n}))}),[a,n]),t};function N(e){const t=(0,d.f)(u.Z,e);return Promise.all(t.map((e=>null==e.route.component.preload?void 0:e.route.component.preload())))}class O extends r.Component{constructor(e){super(e),this.previousLocation=void 0,this.routeUpdateCleanupCb=void 0,this.previousLocation=null,this.routeUpdateCleanupCb=l.Z.canUseDOM?P("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=P("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),N(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return r.createElement(R,{previousLocation:this.previousLocation,location:t},r.createElement(c.AW,{location:t,render:()=>e}))}}const D=O,I="docusaurus-base-url-issue-banner-container",M="docusaurus-base-url-issue-banner-suggestion-container",F="__DOCUSAURUS_INSERT_BASEURL_BANNER";function j(e){return"\nwindow['"+F+"'] = true;\n\ndocument.addEventListener('DOMContentLoaded', maybeInsertBanner);\n\nfunction maybeInsertBanner() {\n var shouldInsert = window['"+F+"'];\n shouldInsert && insertBanner();\n}\n\nfunction insertBanner() {\n var bannerContainer = document.getElementById('"+I+"');\n if (!bannerContainer) {\n return;\n }\n var bannerHtml = "+JSON.stringify(function(e){return'\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = '+e+" "+("/"===e?" (default value)":"")+'

\n

We suggest trying baseUrl =

\n
\n'}(e)).replace(/{window[F]=!1}),[]),r.createElement(r.Fragment,null,!l.Z.canUseDOM&&r.createElement(m.Z,null,r.createElement("script",null,j(e))),r.createElement("div",{id:I}))}function z(){const{siteConfig:{baseUrl:e,baseUrlIssueBanner:t}}=(0,g.Z)(),{pathname:n}=(0,c.TH)();return t&&n===e?r.createElement(B,null):null}function U(){const{siteConfig:{favicon:e,title:t},i18n:{currentLocale:n,localeConfigs:a}}=(0,g.Z)(),o=(0,h.Z)(e),{htmlLang:i,direction:l}=a[n];return r.createElement(m.Z,null,r.createElement("html",{lang:i,dir:l}),r.createElement("title",null,t),r.createElement("meta",{property:"og:title",content:t}),e&&r.createElement("link",{rel:"icon",href:o}))}var $=n(4763);function q(){const e=(0,d.H)(u.Z),t=(0,c.TH)();return r.createElement($.Z,null,r.createElement(L.M,null,r.createElement(A.t,null,r.createElement(f,null,r.createElement(U,null),r.createElement(_,null),r.createElement(z,null),r.createElement(D,{location:T(t)},e)))))}var H=n(6887);const G=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{var r,a;if("undefined"==typeof document)return void n();const o=document.createElement("link");o.setAttribute("rel","prefetch"),o.setAttribute("href",e),o.onload=()=>t(),o.onerror=()=>n();const i=null!=(r=document.getElementsByTagName("head")[0])?r:null==(a=document.getElementsByName("script")[0])?void 0:a.parentNode;null==i||i.appendChild(o)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var Z=n(9670);const W=new Set,V=new Set,Y=()=>{var e,t;return(null==(e=navigator.connection)?void 0:e.effectiveType.includes("2g"))||(null==(t=navigator.connection)?void 0:t.saveData)},K={prefetch(e){if(!(e=>!Y()&&!V.has(e)&&!W.has(e))(e))return!1;W.add(e);const t=(0,d.f)(u.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(H).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,Z.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?G(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!Y()&&!V.has(e))(e)&&(V.add(e),N(e))},Q=Object.freeze(K);if(l.Z.canUseDOM){window.docusaurus=Q;const e=a.hydrate;N(window.location.pathname).then((()=>{e(r.createElement(i.B6,null,r.createElement(o.VK,null,r.createElement(q,null))),document.getElementById("__docusaurus"))}))}},8940:(e,t,n)=>{"use strict";n.d(t,{_:()=>c,M:()=>d});var r=n(7294),a=n(6809);const o=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs","mainDocId":"api/index","docs":[{"id":"api/classes/CommandExecutable","path":"/docs/api/classes/CommandExecutable","sidebar":"tutorialSidebar"},{"id":"api/classes/Context","path":"/docs/api/classes/Context","sidebar":"tutorialSidebar"},{"id":"api/classes/EventExecutable","path":"/docs/api/classes/EventExecutable","sidebar":"tutorialSidebar"},{"id":"api/classes/SernEmitter","path":"/docs/api/classes/SernEmitter","sidebar":"tutorialSidebar"},{"id":"api/enums/CommandType","path":"/docs/api/enums/CommandType","sidebar":"tutorialSidebar"},{"id":"api/enums/EventType","path":"/docs/api/enums/EventType","sidebar":"tutorialSidebar"},{"id":"api/enums/PayloadType","path":"/docs/api/enums/PayloadType","sidebar":"tutorialSidebar"},{"id":"api/enums/PluginType","path":"/docs/api/enums/PluginType","sidebar":"tutorialSidebar"},{"id":"api/index","path":"/docs/api/","sidebar":"tutorialSidebar"},{"id":"api/interfaces/Controller","path":"/docs/api/interfaces/Controller","sidebar":"tutorialSidebar"},{"id":"api/interfaces/Wrapper","path":"/docs/api/interfaces/Wrapper","sidebar":"tutorialSidebar"},{"id":"api/modules","path":"/docs/api/modules","sidebar":"tutorialSidebar"},{"id":"api/namespaces/Sern","path":"/docs/api/namespaces/Sern","sidebar":"tutorialSidebar"},{"id":"guide/getting-started/choose-ide","path":"/docs/guide/getting-started/choose-ide","sidebar":"tutorialSidebar"},{"id":"guide/getting-started/preparing","path":"/docs/guide/getting-started/preparing","sidebar":"tutorialSidebar"},{"id":"guide/README","path":"/docs/guide/","sidebar":"tutorialSidebar"},{"id":"guide/walkthrough/cli","path":"/docs/guide/walkthrough/cli","sidebar":"tutorialSidebar"},{"id":"guide/walkthrough/conclusion","path":"/docs/guide/walkthrough/conclusion","sidebar":"tutorialSidebar"},{"id":"guide/walkthrough/first-command","path":"/docs/guide/walkthrough/first-command","sidebar":"tutorialSidebar"},{"id":"guide/walkthrough/first-event","path":"/docs/guide/walkthrough/first-event","sidebar":"tutorialSidebar"},{"id":"guide/walkthrough/goal","path":"/docs/guide/walkthrough/goal","sidebar":"tutorialSidebar"},{"id":"guide/walkthrough/good-to-know","path":"/docs/guide/walkthrough/good-to-know","sidebar":"tutorialSidebar"},{"id":"guide/walkthrough/plugins","path":"/docs/guide/walkthrough/plugins","sidebar":"tutorialSidebar"},{"id":"guide/walkthrough/sern-emitter","path":"/docs/guide/walkthrough/sern-emitter","sidebar":"tutorialSidebar"},{"id":"intro","path":"/docs/intro","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/docs/api/","label":"API"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en","fr","tr"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"},"fr":{"label":"Fran\xe7ais","direction":"ltr","htmlLang":"fr","calendar":"gregory","path":"fr"},"tr":{"label":"T\xfcrk\xe7e","direction":"ltr","htmlLang":"tr","calendar":"gregory","path":"tr"}}}');var l=n(7529);const s=JSON.parse('{"docusaurusVersion":"2.0.0-rc.1","siteVersion":"1.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"2.0.0-rc.1"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"2.0.0-rc.1"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"2.0.0-rc.1"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"2.0.0-rc.1"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"2.0.0-rc.1"}}}'),u={siteConfig:a.default,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},c=r.createContext(u);function d(e){let{children:t}=e;return r.createElement(c.Provider,{value:u},t)}},4763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c});var r=n(7294),a=n(412),o=n(5742),i=n(2164);function l(e){let{error:t,tryAgain:n}=e;return r.createElement("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"center",height:"50vh",width:"100%",fontSize:"20px"}},r.createElement("h1",null,"This page crashed."),r.createElement("p",null,t.message),r.createElement("button",{type:"button",onClick:n},"Try again"))}function s(e){let{error:t,tryAgain:n}=e;return r.createElement(c,{fallback:()=>r.createElement(l,{error:t,tryAgain:n})},r.createElement(o.Z,null,r.createElement("title",null,"Page Error")),r.createElement(i.Z,null,r.createElement(l,{error:t,tryAgain:n})))}const u=e=>r.createElement(s,e);class c extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){var n;const e={error:t,tryAgain:()=>this.setState({error:null})};return(null!=(n=this.props.fallback)?n:u)(e)}return null!=e?e:null}}},412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5742:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(405);function o(e){return r.createElement(a.ql,e)}},9960:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});var r=n(7462),a=n(7294),o=n(3727),i=n(8780),l=n(2263),s=n(3919),u=n(412);const c=a.createContext({collectLink:()=>{}});var d=n(4996);function f(e,t){var n,f;let{isNavLink:p,to:m,href:g,activeClassName:h,isActive:b,"data-noBrokenLinkCheck":v,autoAddBaseUrl:y=!0,...w}=e;const{siteConfig:{trailingSlash:k,baseUrl:E}}=(0,l.Z)(),{withBaseUrl:S}=(0,d.C)(),x=(0,a.useContext)(c),_=(0,a.useRef)(null);(0,a.useImperativeHandle)(t,(()=>_.current));const C=m||g;const T=(0,s.Z)(C),A=null==C?void 0:C.replace("pathname://","");let L=void 0!==A?(P=A,y&&(e=>e.startsWith("/"))(P)?S(P):P):void 0;var P;L&&T&&(L=(0,i.applyTrailingSlash)(L,{trailingSlash:k,baseUrl:E}));const R=(0,a.useRef)(!1),N=p?o.OL:o.rU,O=u.Z.canUseIntersectionObserver,D=(0,a.useRef)();(0,a.useEffect)((()=>(!O&&T&&null!=L&&window.docusaurus.prefetch(L),()=>{O&&D.current&&D.current.disconnect()})),[D,L,O,T]);const I=null!=(n=null==(f=L)?void 0:f.startsWith("#"))&&n,M=!L||!T||I;return M||v||x.collectLink(L),M?a.createElement("a",(0,r.Z)({ref:_,href:L},C&&!T&&{target:"_blank",rel:"noopener noreferrer"},w)):a.createElement(N,(0,r.Z)({},w,{onMouseEnter:()=>{R.current||null==L||(window.docusaurus.preload(L),R.current=!0)},innerRef:e=>{_.current=e,O&&e&&T&&(D.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(D.current.unobserve(e),D.current.disconnect(),null!=L&&window.docusaurus.prefetch(L))}))})),D.current.observe(e))},to:L},p&&{isActive:b,activeClassName:h}))}const p=a.forwardRef(f)},5999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>s,I:()=>l});var r=n(7294);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=null==t?void 0:t[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var o=n(7529);function i(e){var t,n;let{id:r,message:a}=e;if(void 0===r&&void 0===a)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return null!=(t=null!=(n=o[null!=r?r:a])?n:a)?t:r}function l(e,t){let{message:n,id:r}=e;return a(i({message:n,id:r}),t)}function s(e){let{children:t,id:n,values:o}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const l=i({message:t,id:n});return r.createElement(r.Fragment,null,a(l,o))}},9935:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},3919:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},4996:(e,t,n)=>{"use strict";n.d(t,{C:()=>o,Z:()=>i});var r=n(2263),a=n(3919);function o(){const{siteConfig:{baseUrl:e,url:t}}=(0,r.Z)();return{withBaseUrl:(n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:o=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,a.b)(n))return n;if(o)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const l=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+l:l}(t,e,n,r)}}function i(e,t){void 0===t&&(t={});const{withBaseUrl:n}=o();return n(e,t)}},2263:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8940);function o(){return(0,r.useContext)(a._)}},2389:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8934);function o(){return(0,r.useContext)(a._)}},9670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});function r(e){const t={};return function e(n,r){Object.entries(n).forEach((n=>{let[a,o]=n;const i=r?r+"."+a:a;var l;"object"==typeof(l=o)&&l&&Object.keys(l).length>0?e(o,i):t[i]=o}))}(e),t}},226:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,z:()=>o});var r=n(7294);const a=r.createContext(null);function o(e){let{children:t,value:n}=e;const o=r.useContext(a),i=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...null==n?void 0:n.data};return{plugin:t.plugin,data:r}}({parent:o,value:n})),[o,n]);return r.createElement(a.Provider,{value:i},t)}},143:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>g,gA:()=>f,_r:()=>c,Jo:()=>h,zh:()=>d,yW:()=>m,gB:()=>p});var r=n(6775),a=n(2263),o=n(9935);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,a.Z)();return e}()[e];if(!n&&t.failfast)throw new Error('Docusaurus plugin global data not found for "'+e+'" plugin.');return n}const l=e=>e.versions.find((e=>e.isLast));function s(e,t){const n=function(e,t){const n=l(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),a=null==n?void 0:n.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const u={},c=()=>{var e;return null!=(e=i("docusaurus-plugin-content-docs"))?e:u},d=e=>function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});const r=i(e),a=null==r?void 0:r[t];if(!a&&n.failfast)throw new Error('Docusaurus plugin global data not found for "'+e+'" plugin with id "'+t+'".');return a}("docusaurus-plugin-content-docs",e,{failfast:!0});function f(e){void 0===e&&(e={});const t=c(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error("Can't find active docs plugin for \""+t+'" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: '+Object.values(e).map((e=>e.path)).join(", "));return o}(t,n,e)}function p(e){return d(e).versions}function m(e){const t=d(e);return l(t)}function g(e){const t=d(e),{pathname:n}=(0,r.TH)();return s(t,n)}function h(e){const t=d(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=l(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},8320:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(4865),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r=n(7410),a=n(6809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{n(6726)("./prism-"+e)})),delete globalThis.Prism}(r.Z)},9471:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294);const a="iconExternalLink_nPIU";function o(e){let{width:t=13.5,height:n=13.5}=e;return r.createElement("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:a},r.createElement("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"}))}},2164:(e,t,n)=>{"use strict";n.d(t,{Z:()=>rt});var r=n(7294),a=n(6010),o=n(4763),i=n(1944),l=n(5281),s=n(9727),u=n(5999),c=n(6775),d=n(5936);function f(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}const p="skipToContent_fXgn";function m(){const{containerRef:e,handleSkip:t}=function(){const e=(0,r.useRef)(null),{action:t}=(0,c.k6)(),n=(0,r.useCallback)((e=>{var t;e.preventDefault();const n=null!=(t=document.querySelector("main:first-of-type"))?t:document.querySelector("."+l.k.wrapper.main);n&&f(n)}),[]);return(0,d.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&f(e.current)})),{containerRef:e,handleSkip:n}}();return r.createElement("div",{ref:e,role:"region"},r.createElement("a",{href:"#",className:p,onClick:t},r.createElement(u.Z,{id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation"},"Skip to main content")))}var g=n(6668),h=n(9689),b=n(7462);function v(e){let{width:t=21,height:n=21,color:a="currentColor",strokeWidth:o=1.2,className:i,...l}=e;return r.createElement("svg",(0,b.Z)({viewBox:"0 0 15 15",width:t,height:n},l),r.createElement("g",{stroke:a,strokeWidth:o},r.createElement("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})))}const y="announcementBar_mb4j",w="announcementBarPlaceholder_vyr4",k="announcementBarClose_gvF7",E="announcementBarContent_xLdY";function S(){const{isActive:e,close:t}=(0,h.nT)(),{announcementBar:n}=(0,g.L)();if(!e)return null;const{content:o,backgroundColor:i,textColor:l,isCloseable:s}=n;return r.createElement("div",{className:y,style:{backgroundColor:i,color:l},role:"banner"},s&&r.createElement("div",{className:w}),r.createElement("div",{className:E,dangerouslySetInnerHTML:{__html:o}}),s?r.createElement("button",{type:"button",className:(0,a.Z)("clean-btn close",k),onClick:t,"aria-label":(0,u.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"})},r.createElement(v,{width:14,height:14,strokeWidth:3.1})):null)}var x=n(2961),_=n(2466);var C=n(902),T=n(3102);const A=r.createContext(null);function L(e){let{children:t}=e;const n=function(){const e=(0,x.e)(),t=(0,T.HY)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,C.D9)(o);return(0,r.useEffect)((()=>{o&&!i&&a(!0)}),[o,i]),(0,r.useEffect)((()=>{o?e.shown||a(!0):a(!1)}),[e.shown,o]),(0,r.useMemo)((()=>[n,a]),[n])}();return r.createElement(A.Provider,{value:n},t)}function P(e){if(e.component){const t=e.component;return r.createElement(t,e.props)}}function R(){const e=(0,r.useContext)(A);if(!e)throw new C.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,T.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:P(o)})),[a,o,t])}function N(e){let{header:t,primaryMenu:n,secondaryMenu:o}=e;const{shown:i}=R();return r.createElement("div",{className:"navbar-sidebar"},t,r.createElement("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":i})},r.createElement("div",{className:"navbar-sidebar__item menu"},n),r.createElement("div",{className:"navbar-sidebar__item menu"},o)))}var O=n(2949),D=n(2389);function I(e){return r.createElement("svg",(0,b.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"}))}function M(e){return r.createElement("svg",(0,b.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"}))}const F={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function j(e){let{className:t,value:n,onChange:o}=e;const i=(0,D.Z)(),l=(0,u.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===n?(0,u.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,u.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return r.createElement("div",{className:(0,a.Z)(F.toggle,t)},r.createElement("button",{className:(0,a.Z)("clean-btn",F.toggleButton,!i&&F.toggleButtonDisabled),type:"button",onClick:()=>o("dark"===n?"light":"dark"),disabled:!i,title:l,"aria-label":l},r.createElement(I,{className:(0,a.Z)(F.toggleIcon,F.lightToggleIcon)}),r.createElement(M,{className:(0,a.Z)(F.toggleIcon,F.darkToggleIcon)})))}const B=r.memo(j);function z(e){let{className:t}=e;const n=(0,g.L)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,O.I)();return n?null:r.createElement(B,{className:t,value:a,onChange:o})}var U=n(1327);function $(){return r.createElement(U.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function q(){const e=(0,x.e)();return r.createElement("button",{type:"button",className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle()},r.createElement(v,{color:"var(--ifm-color-emphasis-600)"}))}function H(){return r.createElement("div",{className:"navbar-sidebar__brand"},r.createElement($,null),r.createElement(z,{className:"margin-right--md"}),r.createElement(q,null))}var G=n(9960),Z=n(4996),W=n(3919);function V(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var Y=n(9471);function K(e){let{activeBasePath:t,activeBaseRegex:n,to:a,href:o,label:i,html:l,isDropdownLink:s,prependBaseUrlToHref:u,...c}=e;const d=(0,Z.Z)(a),f=(0,Z.Z)(t),p=(0,Z.Z)(o,{forcePrependBaseUrl:!0}),m=i&&o&&!(0,W.Z)(o),g=l?{dangerouslySetInnerHTML:{__html:l}}:{children:r.createElement(r.Fragment,null,i,m&&r.createElement(Y.Z,s&&{width:12,height:12}))};return o?r.createElement(G.Z,(0,b.Z)({href:u?p:o},c,g)):r.createElement(G.Z,(0,b.Z)({to:d,isNavLink:!0},(t||n)&&{isActive:(e,t)=>n?V(n,t.pathname):t.pathname.startsWith(f)},c,g))}function Q(e){let{className:t,isDropdownItem:n=!1,...o}=e;const i=r.createElement(K,(0,b.Z)({className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n},o));return n?r.createElement("li",null,i):i}function X(e){let{className:t,isDropdownItem:n,...o}=e;return r.createElement("li",{className:"menu__list-item"},r.createElement(K,(0,b.Z)({className:(0,a.Z)("menu__link",t)},o)))}function J(e){var t;let{mobile:n=!1,position:a,...o}=e;const i=n?X:Q;return r.createElement(i,(0,b.Z)({},o,{activeClassName:null!=(t=o.activeClassName)?t:n?"menu__link--active":"navbar__link--active"}))}var ee=n(6043),te=n(8596),ne=n(2263);function re(e,t){return e.some((e=>function(e,t){return!!(0,te.Mg)(e.to,t)||!!V(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function ae(e){var t;let{items:n,position:o,className:i,onClick:l,...s}=e;const u=(0,r.useRef)(null),[c,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{u.current&&!u.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e)}}),[u]),r.createElement("div",{ref:u,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===o,"dropdown--show":c})},r.createElement(K,(0,b.Z)({"aria-haspopup":"true","aria-expanded":c,role:"button",href:s.to?void 0:"#",className:(0,a.Z)("navbar__link",i)},s,{onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!c))}}),null!=(t=s.children)?t:s.label),r.createElement("ul",{className:"dropdown__menu"},n.map(((e,t)=>r.createElement(ve,(0,b.Z)({isDropdownItem:!0,onKeyDown:e=>{if(t===n.length-1&&"Tab"===e.key){e.preventDefault(),d(!1);const t=u.current.nextElementSibling;if(t){(t instanceof HTMLAnchorElement?t:t.querySelector("a")).focus()}}},activeClassName:"dropdown__link--active"},e,{key:t}))))))}function oe(e){var t;let{items:n,className:o,position:i,onClick:l,...s}=e;const u=function(){const{siteConfig:{baseUrl:e}}=(0,ne.Z)(),{pathname:t}=(0,c.TH)();return t.replace(e,"/")}(),d=re(n,u),{collapsed:f,toggleCollapsed:p,setCollapsed:m}=(0,ee.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&m(!d)}),[u,d,m]),r.createElement("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":f})},r.createElement(K,(0,b.Z)({role:"button",className:(0,a.Z)("menu__link menu__link--sublist menu__link--sublist-caret",o)},s,{onClick:e=>{e.preventDefault(),p()}}),null!=(t=s.children)?t:s.label),r.createElement(ee.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:f},n.map(((e,t)=>r.createElement(ve,(0,b.Z)({mobile:!0,isDropdownItem:!0,onClick:l,activeClassName:"menu__link--active"},e,{key:t}))))))}function ie(e){let{mobile:t=!1,...n}=e;const a=t?oe:ae;return r.createElement(a,n)}var le=n(4711);function se(e){let{width:t=20,height:n=20,...a}=e;return r.createElement("svg",(0,b.Z)({viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0},a),r.createElement("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"}))}const ue="iconLanguage_nlXk";const ce=()=>null,de="searchBox_ZlJk";function fe(e){let{children:t,className:n}=e;return r.createElement("div",{className:(0,a.Z)(n,de)},t)}var pe=n(143),me=n(2802);var ge=n(373);const he=e=>e.docs.find((t=>t.id===e.mainDocId));const be={default:J,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:a,...o}=e;const{i18n:{currentLocale:i,locales:l,localeConfigs:s}}=(0,ne.Z)(),c=(0,le.l)(),d=[...n,...l.map((e=>{const n="pathname://"+c.createUrl({locale:e,fullyQualified:!1});return{label:s[e].label,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...a],f=t?(0,u.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):s[i].label;return r.createElement(ie,(0,b.Z)({},o,{mobile:t,label:r.createElement(r.Fragment,null,r.createElement(se,{className:ue}),f),items:d}))},search:function(e){let{mobile:t,className:n}=e;return t?null:r.createElement(fe,{className:n},r.createElement(ce,null))},dropdown:ie,html:function(e){let{value:t,className:n,mobile:o=!1,isDropdownItem:i=!1}=e;const l=i?"li":"div";return r.createElement(l,{className:(0,a.Z)({navbar__item:!o&&!i,"menu__list-item":o},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,pe.Iw)(a),l=(0,me.vY)(t,a);return null===l?null:r.createElement(J,(0,b.Z)({exact:!0},o,{isActive:()=>(null==i?void 0:i.path)===l.path||!(null==i||!i.sidebar)&&i.sidebar===l.sidebar,label:null!=n?n:l.id,to:l.path}))},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,pe.Iw)(a),l=(0,me.oz)(t,a).link;if(!l)throw new Error('DocSidebarNavbarItem: Sidebar with ID "'+t+"\" doesn't have anything to be linked to.");return r.createElement(J,(0,b.Z)({exact:!0},o,{isActive:()=>(null==i?void 0:i.sidebar)===t,label:null!=n?n:l.label,to:l.path}))},docsVersion:function(e){let{label:t,to:n,docsPluginId:a,...o}=e;const i=(0,me.lO)(a)[0],l=null!=t?t:i.label,s=null!=n?n:(e=>e.docs.find((t=>t.id===e.mainDocId)))(i).path;return r.createElement(J,(0,b.Z)({},o,{label:l,to:s}))},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:a,dropdownItemsBefore:o,dropdownItemsAfter:i,...l}=e;const s=(0,pe.Iw)(n),c=(0,pe.gB)(n),{savePreferredVersionName:d}=(0,ge.J)(n),f=[...o,...c.map((e=>{var t;const n=null!=(t=s.alternateDocVersions[e.name])?t:he(e);return{label:e.label,to:n.path,isActive:()=>e===s.activeVersion,onClick:()=>d(e.name)}})),...i],p=(0,me.lO)(n)[0],m=t&&f.length>1?(0,u.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):p.label,g=t&&f.length>1?void 0:he(p).path;return f.length<=1?r.createElement(J,(0,b.Z)({},l,{mobile:t,label:m,to:g,isActive:a?()=>!1:void 0})):r.createElement(ie,(0,b.Z)({},l,{mobile:t,label:m,to:g,items:f,isActive:a?()=>!1:void 0}))}};function ve(e){let{type:t,...n}=e;const a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=be[a];if(!o)throw new Error('No NavbarItem component found for type "'+t+'".');return r.createElement(o,n)}function ye(){const e=(0,x.e)(),t=(0,g.L)().navbar.items;return r.createElement("ul",{className:"menu__list"},t.map(((t,n)=>r.createElement(ve,(0,b.Z)({mobile:!0},t,{onClick:()=>e.toggle(),key:n})))))}function we(e){return r.createElement("button",(0,b.Z)({},e,{type:"button",className:"clean-btn navbar-sidebar__back"}),r.createElement(u.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"},"\u2190 Back to main menu"))}function ke(){const e=0===(0,g.L)().navbar.items.length,t=R();return r.createElement(r.Fragment,null,!e&&r.createElement(we,{onClick:()=>t.hide()}),t.content)}function Ee(){const e=(0,x.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?r.createElement(N,{header:r.createElement(H,null),primaryMenu:r.createElement(ye,null),secondaryMenu:r.createElement(ke,null)}):null}const Se="navbarHideable_m1mJ",xe="navbarHidden_jGov";function _e(e){return r.createElement("div",(0,b.Z)({role:"presentation"},e,{className:(0,a.Z)("navbar-sidebar__backdrop",e.className)}))}function Ce(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,g.L)(),i=(0,x.e)(),{navbarRef:l,isNavbarVisible:s}=function(e){const[t,n]=(0,r.useState)(e),a=(0,r.useRef)(!1),o=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(o.current=e.getBoundingClientRect().height)}),[]);return(0,_.RF)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=l?n(!1):i+u{if(e)return t.location.hash?(a.current=!0,void n(!1)):void n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return r.createElement("nav",{ref:l,className:(0,a.Z)("navbar","navbar--fixed-top",n&&[Se,!s&&xe],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown})},t,r.createElement(_e,{onClick:i.toggle}),r.createElement(Ee,null))}function Te(e){let{width:t=30,height:n=30,className:a,...o}=e;return r.createElement("svg",(0,b.Z)({className:a,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true"},o),r.createElement("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"}))}function Ae(){const e=(0,x.e)();return r.createElement("button",{onClick:e.toggle,onKeyDown:e.toggle,"aria-label":"Navigation bar toggle",className:"navbar__toggle clean-btn",type:"button",tabIndex:0},r.createElement(Te,null))}const Le="colorModeToggle_DEke";function Pe(e){let{items:t}=e;return r.createElement(r.Fragment,null,t.map(((e,t)=>r.createElement(ve,(0,b.Z)({},e,{key:t})))))}function Re(e){let{left:t,right:n}=e;return r.createElement("div",{className:"navbar__inner"},r.createElement("div",{className:"navbar__items"},t),r.createElement("div",{className:"navbar__items navbar__items--right"},n))}function Ne(){const e=(0,x.e)(),t=(0,g.L)().navbar.items,[n,a]=function(e){function t(e){var t;return"left"===(null!=(t=e.position)?t:"right")}return[e.filter(t),e.filter((e=>!t(e)))]}(t),o=t.find((e=>"search"===e.type));return r.createElement(Re,{left:r.createElement(r.Fragment,null,!e.disabled&&r.createElement(Ae,null),r.createElement($,null),r.createElement(Pe,{items:n})),right:r.createElement(r.Fragment,null,r.createElement(Pe,{items:a}),r.createElement(z,{className:Le}),!o&&r.createElement(fe,null,r.createElement(ce,null)))})}function Oe(){return r.createElement(Ce,null,r.createElement(Ne,null))}function De(e){let{item:t}=e;const{to:n,href:a,label:o,prependBaseUrlToHref:i,...l}=t,s=(0,Z.Z)(n),u=(0,Z.Z)(a,{forcePrependBaseUrl:!0});return r.createElement(G.Z,(0,b.Z)({className:"footer__link-item"},a?{href:i?u:a}:{to:s},l),o,a&&!(0,W.Z)(a)&&r.createElement(Y.Z,null))}function Ie(e){var t;let{item:n}=e;return n.html?r.createElement("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:n.html}}):r.createElement("li",{key:null!=(t=n.href)?t:n.to,className:"footer__item"},r.createElement(De,{item:n}))}function Me(e){let{column:t}=e;return r.createElement("div",{className:"col footer__col"},r.createElement("div",{className:"footer__title"},t.title),r.createElement("ul",{className:"footer__items clean-list"},t.items.map(((e,t)=>r.createElement(Ie,{key:t,item:e})))))}function Fe(e){let{columns:t}=e;return r.createElement("div",{className:"row footer__links"},t.map(((e,t)=>r.createElement(Me,{key:t,column:e}))))}function je(){return r.createElement("span",{className:"footer__link-separator"},"\xb7")}function Be(e){let{item:t}=e;return t.html?r.createElement("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement(De,{item:t})}function ze(e){let{links:t}=e;return r.createElement("div",{className:"footer__links text--center"},r.createElement("div",{className:"footer__links"},t.map(((e,n)=>r.createElement(r.Fragment,{key:n},r.createElement(Be,{item:e}),t.length!==n+1&&r.createElement(je,null))))))}function Ue(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?r.createElement(Fe,{columns:t}):r.createElement(ze,{links:t})}var $e=n(941);const qe="footerLogoLink_BH7S";function He(e){var t;let{logo:n}=e;const{withBaseUrl:o}=(0,Z.C)(),i={light:o(n.src),dark:o(null!=(t=n.srcDark)?t:n.src)};return r.createElement($e.Z,{className:(0,a.Z)("footer__logo",n.className),alt:n.alt,sources:i,width:n.width,height:n.height,style:n.style})}function Ge(e){let{logo:t}=e;return t.href?r.createElement(G.Z,{href:t.href,className:qe,target:t.target},r.createElement(He,{logo:t})):r.createElement(He,{logo:t})}function Ze(e){let{copyright:t}=e;return r.createElement("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function We(e){let{style:t,links:n,logo:o,copyright:i}=e;return r.createElement("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t})},r.createElement("div",{className:"container container-fluid"},n,(o||i)&&r.createElement("div",{className:"footer__bottom text--center"},o&&r.createElement("div",{className:"margin-bottom--sm"},o),i)))}function Ve(){const{footer:e}=(0,g.L)();if(!e)return null;const{copyright:t,links:n,logo:a,style:o}=e;return r.createElement(We,{style:o,links:n&&n.length>0&&r.createElement(Ue,{links:n}),logo:a&&r.createElement(Ge,{logo:a}),copyright:t&&r.createElement(Ze,{copyright:t})})}const Ye=r.memo(Ve);var Ke=n(12);const Qe="docusaurus.tab.",Xe=r.createContext(void 0);const Je=(0,C.Qc)([O.S,h.pl,function(e){let{children:t}=e;const n=function(){const[e,t]=(0,r.useState)({}),n=(0,r.useCallback)(((e,t)=>{(0,Ke.W)("docusaurus.tab."+e).set(t)}),[]);(0,r.useEffect)((()=>{try{const e={};(0,Ke._)().forEach((t=>{if(t.startsWith(Qe)){const n=t.substring(Qe.length);e[n]=(0,Ke.W)(t).get()}})),t(e)}catch(e){console.error(e)}}),[]);const a=(0,r.useCallback)(((e,r)=>{t((t=>({...t,[e]:r}))),n(e,r)}),[n]);return(0,r.useMemo)((()=>({tabGroupChoices:e,setTabGroupChoices:a})),[e,a])}();return r.createElement(Xe.Provider,{value:n},t)},_.OC,ge.L5,i.VC,function(e){let{children:t}=e;return r.createElement(T.n2,null,r.createElement(x.M,null,r.createElement(L,null,t)))}]);function et(e){let{children:t}=e;return r.createElement(Je,null,t)}function tt(e){let{error:t,tryAgain:n}=e;return r.createElement("main",{className:"container margin-vert--xl"},r.createElement("div",{className:"row"},r.createElement("div",{className:"col col--6 col--offset-3"},r.createElement("h1",{className:"hero__title"},r.createElement(u.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed"},"This page crashed.")),r.createElement("p",null,t.message),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},r.createElement(u.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again when the page crashed"},"Try again"))))))}const nt="mainWrapper_z2l0";function rt(e){const{children:t,noFooter:n,wrapperClassName:u,title:c,description:d}=e;return(0,s.t)(),r.createElement(et,null,r.createElement(i.d,{title:c,description:d}),r.createElement(m,null),r.createElement(S,null),r.createElement(Oe,null),r.createElement("div",{className:(0,a.Z)(l.k.wrapper.main,nt,u)},r.createElement(o.Z,{fallback:e=>r.createElement(tt,e)},t)),!n&&r.createElement(Ye,null))}},1327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});var r=n(7462),a=n(7294),o=n(9960),i=n(4996),l=n(2263),s=n(6668),u=n(941);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,i.Z)(t.src),dark:(0,i.Z)(t.srcDark||t.src)},l=a.createElement(u.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?a.createElement("div",{className:r},l):l}function d(e){var t;const{siteConfig:{title:n}}=(0,l.Z)(),{navbar:{title:u,logo:d}}=(0,s.L)(),{imageClassName:f,titleClassName:p,...m}=e,g=(0,i.Z)((null==d?void 0:d.href)||"/"),h=u?"":n,b=null!=(t=null==d?void 0:d.alt)?t:h;return a.createElement(o.Z,(0,r.Z)({to:g},m,(null==d?void 0:d.target)&&{target:d.target}),d&&a.createElement(c,{logo:d,alt:b,imageClassName:f}),null!=u&&a.createElement("b",{className:p},u))}},197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(5742);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return r.createElement(a.Z,null,t&&r.createElement("meta",{name:"docusaurus_locale",content:t}),n&&r.createElement("meta",{name:"docusaurus_version",content:n}),o&&r.createElement("meta",{name:"docusaurus_tag",content:o}),i&&r.createElement("meta",{name:"docsearch:language",content:i}),n&&r.createElement("meta",{name:"docsearch:version",content:n}),o&&r.createElement("meta",{name:"docsearch:docusaurus_tag",content:o}))}},941:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});var r=n(7462),a=n(7294),o=n(6010),i=n(2389),l=n(2949);const s={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"};function u(e){const t=(0,i.Z)(),{colorMode:n}=(0,l.I)(),{sources:u,className:c,alt:d,...f}=e,p=t?"dark"===n?["dark"]:["light"]:["light","dark"];return a.createElement(a.Fragment,null,p.map((e=>a.createElement("img",(0,r.Z)({key:e,src:u[e],alt:d,className:(0,o.Z)(s.themedImage,s["themedImage--"+e],c)},f)))))}},6043:(e,t,n)=>{"use strict";n.d(t,{u:()=>i,z:()=>m});var r=n(7462),a=n(7294),o=n(412);function i(e){let{initialState:t}=e;const[n,r]=(0,a.useState)(null!=t&&t),o=(0,a.useCallback)((()=>{r((e=>!e))}),[]);return{collapsed:n,setCollapsed:r,toggleCollapsed:o}}const l={display:"none",overflow:"hidden",height:"0px"},s={display:"block",overflow:"visible",height:"auto"};function u(e,t){const n=t?l:s;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function c(e){let{collapsibleRef:t,collapsed:n,animation:r}=e;const o=(0,a.useRef)(!1);(0,a.useEffect)((()=>{const e=t.current;function a(){var t,n;const a=e.scrollHeight,o=null!=(t=null==r?void 0:r.duration)?t:function(e){const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(a);return{transition:"height "+o+"ms "+(null!=(n=null==r?void 0:r.easing)?n:"ease-in-out"),height:a+"px"}}function i(){const t=a();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return u(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(i(),requestAnimationFrame((()=>{e.style.height=l.height,e.style.overflow=l.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{i()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,r])}function d(e){if(!o.Z.canUseDOM)return e?l:s}function f(e){let{as:t="div",collapsed:n,children:r,animation:o,onCollapseTransitionEnd:i,className:l,disableSSRStyle:s}=e;const f=(0,a.useRef)(null);return c({collapsibleRef:f,collapsed:n,animation:o}),a.createElement(t,{ref:f,style:s?void 0:d(n),onTransitionEnd:e=>{"height"===e.propertyName&&(u(f.current,n),null==i||i(n))},className:l},r)}function p(e){let{collapsed:t,...n}=e;const[o,i]=(0,a.useState)(!t),[l,s]=(0,a.useState)(t);return(0,a.useLayoutEffect)((()=>{t||i(!0)}),[t]),(0,a.useLayoutEffect)((()=>{o&&s(t)}),[o,t]),o?a.createElement(f,(0,r.Z)({},n,{collapsed:l})):null}function m(e){let{lazy:t,...n}=e;const r=t?p:f;return a.createElement(r,n)}},9689:(e,t,n)=>{"use strict";n.d(t,{nT:()=>m,pl:()=>p});var r=n(7294),a=n(2389),o=n(12),i=n(902),l=n(6668);const s=(0,o.W)("docusaurus.announcement.dismiss"),u=(0,o.W)("docusaurus.announcement.id"),c=()=>"true"===s.get(),d=e=>s.set(String(e)),f=r.createContext(null);function p(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.L)(),t=(0,a.Z)(),[n,o]=(0,r.useState)((()=>!!t&&c()));(0,r.useEffect)((()=>{o(c())}),[]);const i=(0,r.useCallback)((()=>{d(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.set(t),r&&d(!1),!r&&c()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return r.createElement(f.Provider,{value:n},t)}function m(){const e=(0,r.useContext)(f);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},2949:(e,t,n)=>{"use strict";n.d(t,{I:()=>h,S:()=>g});var r=n(7294),a=n(412),o=n(902),i=n(12),l=n(6668);const s=r.createContext(void 0),u="theme",c=(0,i.W)(u),d="light",f="dark",p=e=>e===f?f:d;function m(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.L)(),[o,i]=(0,r.useState)((e=>a.Z.canUseDOM?p(document.documentElement.getAttribute("data-theme")):p(e))(e));(0,r.useEffect)((()=>{t&&c.del()}),[t]);const s=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(i(t),a&&(e=>{c.set(p(e))})(t)):(i(n?window.matchMedia("(prefers-color-scheme: dark)").matches?f:d:e),c.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",p(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=c.get();null!==t&&s(p(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,s]);const m=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||m.current?m.current=window.matchMedia("print").matches:s(null)};return e.addListener(r),()=>e.removeListener(r)}),[s,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:s,get isDarkTheme(){return o===f},setLightTheme(){s(d)},setDarkTheme(){s(f)}})),[o,s])}function g(e){let{children:t}=e;const n=m();return r.createElement(s.Provider,{value:n},t)}function h(){const e=(0,r.useContext)(s);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},373:(e,t,n)=>{"use strict";n.d(t,{J:()=>y,L5:()=>b});var r=n(7294),a=n(143),o=n(9935),i=n(6668),l=n(2802),s=n(902),u=n(12);const c=e=>"docs-preferred-version-"+e,d=(e,t,n)=>{(0,u.W)(c(e),{persistence:t}).set(n)},f=(e,t)=>(0,u.W)(c(e),{persistence:t}).get(),p=(e,t)=>{(0,u.W)(c(e),{persistence:t}).del()};const m=r.createContext(null);function g(){const e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,l]=(0,r.useState)((()=>(e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}]))))(n)));(0,r.useEffect)((()=>{l(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=f(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){d(e,t,n),l((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function h(e){let{children:t}=e;const n=g();return r.createElement(m.Provider,{value:n},t)}function b(e){let{children:t}=e;return l.cE?r.createElement(h,null,t):r.createElement(r.Fragment,null,t)}function v(){const e=(0,r.useContext)(m);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function y(e){var t;void 0===e&&(e=o.m);const n=(0,a.zh)(e),[i,l]=v(),{preferredVersionName:s}=i[e];return{preferredVersion:null!=(t=n.versions.find((e=>e.name===s)))?t:null,savePreferredVersionName:(0,r.useCallback)((t=>{l.savePreferredVersion(e,t)}),[l,e])}}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>s,b:()=>l});var r=n(7294),a=n(902);const o=Symbol("EmptyContext"),i=r.createContext(o);function l(e){let{children:t,name:n,items:a}=e;const o=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return r.createElement(i.Provider,{value:o},t)}function s(){const e=(0,r.useContext)(i);if(e===o)throw new a.i6("DocsSidebarProvider");return e}},2961:(e,t,n)=>{"use strict";n.d(t,{M:()=>f,e:()=>p});var r=n(7294),a=n(3102),o=n(7524),i=n(6775),l=n(902);function s(e){!function(e){const t=(0,i.k6)(),n=(0,l.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}var u=n(6668);const c=r.createContext(void 0);function d(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,u.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[i,l]=(0,r.useState)(!1);s((()=>{if(i)return l(!1),!1}));const c=(0,r.useCallback)((()=>{l((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&l(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:c,shown:i})),[e,n,c,i])}function f(e){let{children:t}=e;const n=d();return r.createElement(c.Provider,{value:n},t)}function p(){const e=r.useContext(c);if(void 0===e)throw new l.i6("NavbarMobileSidebarProvider");return e}},3102:(e,t,n)=>{"use strict";n.d(t,{HY:()=>l,Zo:()=>s,n2:()=>i});var r=n(7294),a=n(902);const o=r.createContext(null);function i(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return r.createElement(o.Provider,{value:n},t)}function l(){const e=(0,r.useContext)(o);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function s(e){let{component:t,props:n}=e;const i=(0,r.useContext)(o);if(!i)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,l]=i,s=(0,a.Ql)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},9727:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(7294);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7524:(e,t,n)=>{"use strict";n.d(t,{i:()=>u});var r=n(7294),a=n(412);const o="desktop",i="mobile",l="ssr";function s(){return a.Z.canUseDOM?window.innerWidth>996?o:i:l}function u(){const[e,t]=(0,r.useState)((()=>s()));return(0,r.useEffect)((()=>{function e(){t(s())}return window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e),clearTimeout(undefined)}}),[]),e}},5281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",admonitionType:e=>"theme-admonition-"+e},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>"theme-doc-sidebar-item-category-level-"+e,docSidebarItemLinkLevel:e=>"theme-doc-sidebar-item-link-level-"+e},blog:{}}},2802:(e,t,n)=>{"use strict";n.d(t,{Wl:()=>f,_F:()=>m,cE:()=>d,hI:()=>y,lO:()=>h,vY:()=>v,oz:()=>b,s1:()=>g});var r=n(7294),a=n(6775),o=n(8790),i=n(143),l=n(373),s=n(1116);function u(e){return Array.from(new Set(e))}var c=n(8596);const d=!!i._r;function f(e){if(e.href)return e.href;for(const t of e.items){if("link"===t.type)return t.href;if("category"===t.type){const e=f(t);if(e)return e}}}const p=(e,t)=>void 0!==e&&(0,c.Mg)(e,t);function m(e,t){return"link"===e.type?p(e.href,t):"category"===e.type&&(p(e.href,t)||((e,t)=>e.some((e=>m(e,t))))(e.items,t))}function g(){var e;const t=(0,s.V)(),{pathname:n}=(0,a.TH)();if(!1===(null==(e=(0,i.gA)())?void 0:e.pluginData.breadcrumbs)||!t)return null;const r=[];return function e(t){for(const a of t)if("category"===a.type&&((0,c.Mg)(a.href,n)||e(a.items))||"link"===a.type&&(0,c.Mg)(a.href,n))return r.push(a),!0;return!1}(t.items),r.reverse()}function h(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,l.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>u([t,n,a].filter(Boolean))),[t,n,a])}function b(e,t){const n=h(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error("Can't find any sidebar with id \""+e+'" in version'+(n.length>1?"s":"")+" "+n.map((e=>e.name)).join(", ")+'".\n Available sidebar ids are:\n - '+Object.keys(t).join("\n- "));return r[1]}),[e,n])}function v(e,t){const n=h(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error("DocNavbarItem: couldn't find any doc with id \""+e+'" in version'+(n.length>1?"s":"")+" "+n.map((e=>e.name)).join(", ")+'".\nAvailable doc ids are:\n- '+u(t.map((e=>e.id))).join("\n- "))}return r}),[e,n])}function y(e){let{route:t,versionMetadata:n}=e;const r=(0,a.TH)(),i=t.routes,l=i.find((e=>(0,a.LX)(r.pathname,e)));if(!l)return null;const s=l.sidebar,u=s?n.docsSidebars[s]:void 0;return{docElement:(0,o.H)(i),sidebarName:s,sidebarItems:u}}},1944:(e,t,n)=>{"use strict";n.d(t,{FG:()=>f,d:()=>c,VC:()=>p});var r=n(7294),a=n(6010),o=n(5742),i=n(226);function l(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(4996),u=n(2263);function c(e){let{title:t,description:n,keywords:a,image:i,children:l}=e;const c=function(e){const{siteConfig:t}=(0,u.Z)(),{title:n,titleDelimiter:r}=t;return null!=e&&e.trim().length?e.trim()+" "+r+" "+n:n}(t),{withBaseUrl:d}=(0,s.C)(),f=i?d(i,{absolute:!0}):void 0;return r.createElement(o.Z,null,t&&r.createElement("title",null,c),t&&r.createElement("meta",{property:"og:title",content:c}),n&&r.createElement("meta",{name:"description",content:n}),n&&r.createElement("meta",{property:"og:description",content:n}),a&&r.createElement("meta",{name:"keywords",content:Array.isArray(a)?a.join(","):a}),f&&r.createElement("meta",{property:"og:image",content:f}),f&&r.createElement("meta",{name:"twitter:image",content:f}),l)}const d=r.createContext(void 0);function f(e){let{className:t,children:n}=e;const i=r.useContext(d),l=(0,a.Z)(i,t);return r.createElement(d.Provider,{value:l},r.createElement(o.Z,null,r.createElement("html",{className:l})),n)}function p(e){let{children:t}=e;const n=l(),o="plugin-"+n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"");const i="plugin-id-"+n.plugin.id;return r.createElement(f,{className:(0,a.Z)(o,i)},t)}},902:(e,t,n)=>{"use strict";n.d(t,{D9:()=>i,Qc:()=>u,Ql:()=>s,i6:()=>l,zX:()=>o});var r=n(7294);const a=n(412).Z.canUseDOM?r.useLayoutEffect:r.useEffect;function o(e){const t=(0,r.useRef)(e);return a((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function i(e){const t=(0,r.useRef)();return a((()=>{t.current=e})),t.current}class l extends Error{constructor(e,t){var n,r,a,o;super(),this.name="ReactContextError",this.message="Hook "+(null!=(n=null==(r=this.stack)||null==(a=r.split("\n")[1])||null==(o=a.match(/at (?:\w+\.)?(?\w+)/))?void 0:o.groups.name)?n:"")+" is called outside the <"+e+">. "+(null!=t?t:"")}}function s(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return r.createElement(r.Fragment,null,e.reduceRight(((e,t)=>r.createElement(t,null,e)),n))}}},8596:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>l});var r=n(7294),a=n(723),o=n(2263);function i(e,t){const n=e=>{var t;return null==(t=!e||e.endsWith("/")?e:e+"/")?void 0:t.toLowerCase()};return n(e)===n(t)}function l(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>{var t;return null!=(t=e.routes)?t:[]})))}(n)}({routes:a.Z,baseUrl:e})),[e])}},2466:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>f,OC:()=>s,RF:()=>d});var r=n(7294),a=n(412),o=n(2389),i=n(902);const l=r.createContext(void 0);function s(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return r.createElement(l.Provider,{value:n},t)}function u(){const e=(0,r.useContext)(l);if(null==e)throw new i.i6("ScrollControllerProvider");return e}const c=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function d(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=u(),a=(0,r.useRef)(c()),o=(0,i.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=c();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function f(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&at&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>null==e.current?void 0:e.current()}}},3320:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(2263);const r="default";function a(e,t){return"docs-"+e+"-"+t}},12:(e,t,n)=>{"use strict";n.d(t,{W:()=>l,_:()=>s});const r="localStorage";function a(e){if(void 0===e&&(e=r),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,o||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),o=!0),null}var t}let o=!1;const i={get:()=>null,set:()=>{},del:()=>{}};function l(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error('Illegal storage API usage for storage key "'+e+'".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.')}return{get:t,set:t,del:t}}(e);const n=a(null==t?void 0:t.persistence);return null===n?i:{get:()=>{try{return n.getItem(e)}catch(t){return console.error("Docusaurus storage error, can't get key="+e,t),null}},set:t=>{try{n.setItem(e,t)}catch(r){console.error("Docusaurus storage error, can't set "+e+"="+t,r)}},del:()=>{try{n.removeItem(e)}catch(t){console.error("Docusaurus storage error, can't delete key="+e,t)}}}}function s(e){void 0===e&&(e=r);const t=a(e);if(!t)return[];const n=[];for(let r=0;r{"use strict";n.d(t,{l:()=>o});var r=n(2263),a=n(6775);function o(){const{siteConfig:{baseUrl:e,url:t},i18n:{defaultLocale:n,currentLocale:o}}=(0,r.Z)(),{pathname:i}=(0,a.TH)(),l=o===n?e:e.replace("/"+o+"/","/"),s=i.replace(e,"");return{createUrl:function(e){let{locale:r,fullyQualified:a}=e;return""+(a?t:"")+function(e){return e===n?""+l:""+l+e+"/"}(r)+s}}}},5936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(7294),a=n(6775),o=n(902);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6668:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(2263);function a(){return(0,r.Z)().siteConfig.themeConfig}},8802:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:e+"/"}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},8780:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="post-content";var a=n(8802);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}})},6010:(e,t,n)=>{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,n=0,a="";n{"use strict";n.d(t,{lX:()=>w,q_:()=>C,ob:()=>p,PP:()=>A,Ep:()=>f});var r=n(7462);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;f--){var p=i[f];"."===p?o(i,f):".."===p?(o(i,f),d++):d&&(o(i,f),d--)}if(!u)for(;d--;d)i.unshift("..");!u||""===i[0]||i[0]&&a(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var l=n(2177);function s(e){return"/"===e.charAt(0)?e:"/"+e}function u(e){return"/"===e.charAt(0)?e.substr(1):e}function c(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function f(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function p(e,t,n,a){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),o.state=t):(void 0===(o=(0,r.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function m(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof r?r(o,a):a(!0):a(!1!==o)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=p(e,t,g(),w.location);c.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(9864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||a}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var u=Object.defineProperty,c=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,f=Object.getOwnPropertyDescriptor,p=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var a=p(n);a&&a!==m&&e(t,a,r)}var i=c(n);d&&(i=i.concat(d(n)));for(var l=s(t),g=s(n),h=0;h{"use strict";e.exports=function(e,t,n,r,a,o,i,l){if(!e){var s;if(void 0===t)s=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var u=[n,r,a,o,i,l],c=0;(s=new Error(t.replace(/%s/g,(function(){return u[c++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},2497:(e,t,n)=>{"use strict";n.r(t)},2295:(e,t,n)=>{"use strict";n.r(t)},4865:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),u=o.querySelector(r.barSelector),c=r.speed,d=r.easing;return o.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(u,i(e,c,d)),1===e?(s(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){s(o,{transition:"all "+c+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),c)}),c)):setTimeout(t,c)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");c(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,i=t.querySelector(r.barSelector),l=e?"-100":o(n.status||0),u=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&p(a),u!=document.body&&c(u,"nprogress-custom-parent"),u.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&p(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+o)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function o(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&o(e,n,r);else o(e,a[1],a[2])}}();function u(e,t){return("string"==typeof e?e:f(e)).indexOf(" "+t+" ")>=0}function c(e,t){var n=f(e),r=n+t;u(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=f(e);u(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function f(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function p(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},7418:e=>{"use strict";var t=Object.getOwnPropertySymbols,n=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;function a(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(a){return!1}}()?Object.assign:function(e,o){for(var i,l,s=a(e),u=1;u{var r=n(5826);e.exports=p,e.exports.parse=o,e.exports.compile=function(e,t){return l(o(e,t),t)},e.exports.tokensToFunction=l,e.exports.tokensToRegExp=f;var a=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function o(e,t){for(var n,r=[],o=0,i=0,l="",c=t&&t.delimiter||"/";null!=(n=a.exec(e));){var d=n[0],f=n[1],p=n.index;if(l+=e.slice(i,p),i=p+d.length,f)l+=f[1];else{var m=e[i],g=n[2],h=n[3],b=n[4],v=n[5],y=n[6],w=n[7];l&&(r.push(l),l="");var k=null!=g&&null!=m&&m!==g,E="+"===y||"*"===y,S="?"===y||"*"===y,x=n[2]||c,_=b||v;r.push({name:h||o++,prefix:g||"",delimiter:x,optional:S,repeat:E,partial:k,asterisk:!!w,pattern:_?u(_):w?".*":"[^"+s(x)+"]+?"})}}return i{"use strict";n.d(t,{Z:()=>o});var r=function(){var e=/(?:^|\s)lang(?:uage)?-([\w-]+)(?=\s|$)/i,t=0,n={},r={util:{encode:function e(t){return t instanceof a?new a(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&").replace(/=d.reach);S+=E.value.length,E=E.next){var x=E.value;if(t.length>e.length)return;if(!(x instanceof a)){var _,C=1;if(v){if(!(_=o(k,S,e,b))||_.index>=e.length)break;var T=_.index,A=_.index+_[0].length,L=S;for(L+=E.value.length;T>=L;)L+=(E=E.next).value.length;if(S=L-=E.value.length,E.value instanceof a)continue;for(var P=E;P!==t.tail&&(Ld.reach&&(d.reach=D);var I=E.prev;if(N&&(I=s(t,I,N),S+=N.length),u(t,I,C),E=s(t,I,new a(f,h?r.tokenize(R,h):R,y,R)),O&&s(t,E,O),C>1){var M={cause:f+","+m,reach:D};i(e,t,n,E.prev,S,M),d&&M.reach>d.reach&&(d.reach=M.reach)}}}}}}function l(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function s(e,t,n){var r=t.next,a={value:n,prev:t,next:r};return t.next=a,r.prev=a,e.length++,a}function u(e,t,n){for(var r=t.next,a=0;a"+o.content+""},r}(),a=r;r.default=r,a.languages.markup={comment:{pattern://,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern://i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},a.languages.markup.tag.inside["attr-value"].inside.entity=a.languages.markup.entity,a.languages.markup.doctype.inside["internal-subset"].inside=a.languages.markup,a.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(a.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^$)/i,lookbehind:!0,inside:a.languages[t]},n.cdata=/^$/i;var r={"included-cdata":{pattern://i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:a.languages[t]};var o={};o[e]={pattern:RegExp(/(<__[^>]*>)(?:))*\]\]>|(?!)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:r},a.languages.insertBefore("markup","cdata",o)}}),Object.defineProperty(a.languages.markup.tag,"addAttribute",{value:function(e,t){a.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:a.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),a.languages.html=a.languages.markup,a.languages.mathml=a.languages.markup,a.languages.svg=a.languages.markup,a.languages.xml=a.languages.extend("markup",{}),a.languages.ssml=a.languages.xml,a.languages.atom=a.languages.xml,a.languages.rss=a.languages.xml,function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:r},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:r.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var a=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],o=r.variable[1].inside,i=0;i]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},a.languages.c=a.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),a.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),a.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},a.languages.c.string],char:a.languages.c.char,comment:a.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:a.languages.c}}}}),a.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete a.languages.c.boolean,function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,n=/\b(?!)\w+(?:\s*\.\s*\w+)*\b/.source.replace(//g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!)\w+/.source.replace(//g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/(?:\s*:\s*)?|:\s*/.source.replace(//g,(function(){return n}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(a),function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),n.tag.addAttribute("style","css"))}(a),function(e){var t,n=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css.selector={pattern:e.languages.css.selector.pattern,lookbehind:!0,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+n.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[n,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}});var r={pattern:/(\b\d+)(?:%|[a-z]+(?![\w-]))/,lookbehind:!0},a={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0};e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#[\da-f]{3,8}\b/i,alias:"color"},color:[{pattern:/(^|[^\w-])(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)(?![\w-])/i,lookbehind:!0},{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:r,number:a,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:r,number:a})}(a),a.languages.javascript=a.languages.extend("clike",{"class-name":[a.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),a.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,a.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:a.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:a.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:a.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:a.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:a.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),a.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:a.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),a.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),a.languages.markup&&(a.languages.markup.tag.addInlined("script","javascript"),a.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),a.languages.js=a.languages.javascript,function(e){var t=/#(?!\{).+/,n={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:n}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:n}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:e.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:n}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(a),function(e){var t=/[*&][^\s[\]{},]+/,n=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,r="(?:"+n.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+n.source+")?)",a=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-])(?:[ \t]*(?:(?![#:])|:))*/.source.replace(//g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),o=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function i(e,t){t=(t||"").replace(/m/g,"")+"m";var n=/([:\-,[{]\s*(?:\s<>[ \t]+)?)(?:<>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return e}));return RegExp(n,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<>/g,(function(){return r}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<>[ \t]+)?)<>(?=\s*:\s)/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return"(?:"+a+"|"+o+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:i(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:i(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:i(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:i(o),lookbehind:!0,greedy:!0},number:{pattern:i(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:n,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(a),function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?![\r\n]))/.source;function n(e){return e=e.replace(//g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var r=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,a=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return r})),o=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source;e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"front-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+a+o+"(?:"+a+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+a+o+")(?:"+a+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(r),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+a+")"+o+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+a+"$"),inside:{"table-header":{pattern:RegExp(r),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:n(/\b__(?:(?!_)|_(?:(?!_))+_)+__\b|\*\*(?:(?!\*)|\*(?:(?!\*))+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:n(/\b_(?:(?!_)|__(?:(?!_))+__)+_\b|\*(?:(?!\*)|\*\*(?:(?!\*))+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:n(/(~~?)(?:(?!~))+\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},"code-snippet":{pattern:/(^|[^\\`])(?:``[^`\r\n]+(?:`[^`\r\n]+)*``(?!`)|`[^`\r\n]+`(?!`))/,lookbehind:!0,greedy:!0,alias:["code","keyword"]},url:{pattern:n(/!?\[(?:(?!\]))+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\]))+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike","code-snippet"].forEach((function(n){t!==n&&(e.languages.markdown[t].inside.content.inside[n]=e.languages.markdown[n])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var n=0,r=t.length;n",quot:'"'},s=String.fromCodePoint||String.fromCharCode;e.languages.md=e.languages.markdown}(a),a.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:a.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:false|true)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/\b[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"atom-input":{pattern:/\b[A-Z]\w*Input\b/,alias:"class-name"},scalar:/\b(?:Boolean|Float|ID|Int|String)\b/,constant:/\b[A-Z][A-Z_\d]*\b/,"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*|:\s*|\[)[A-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-mutation":{pattern:/(\bmutation\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-query":{pattern:/(\bquery\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,"property-query":/\w+(?=\s*\()/,object:/\w+(?=\s*\{)/,punctuation:/[!(){}\[\]:=,]/,property:/\w+/},a.hooks.add("after-tokenize",(function(e){if("graphql"===e.language)for(var t=e.tokens.filter((function(e){return"string"!=typeof e&&"comment"!==e.type&&"scalar"!==e.type})),n=0;n0)){var l=f(/^\{$/,/^\}$/);if(-1===l)continue;for(var s=n;s=0&&p(u,"variable-input")}}}}function c(e){return t[n+e]}function d(e,t){t=t||0;for(var n=0;n?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t=e.languages.javascript["template-string"],n=t.pattern.source,r=t.inside.interpolation,a=r.inside["interpolation-punctuation"],o=r.pattern.source;function i(t,r){if(e.languages[t])return{pattern:RegExp("((?:"+r+")\\s*)"+n),lookbehind:!0,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},"embedded-code":{pattern:/[\s\S]+/,alias:t}}}}function l(e,t){return"___"+t.toUpperCase()+"_"+e+"___"}function s(t,n,r){var a={code:t,grammar:n,language:r};return e.hooks.run("before-tokenize",a),a.tokens=e.tokenize(a.code,a.grammar),e.hooks.run("after-tokenize",a),a.tokens}function u(t){var n={};n["interpolation-punctuation"]=a;var o=e.tokenize(t,n);if(3===o.length){var i=[1,1];i.push.apply(i,s(o[1],e.languages.javascript,"javascript")),o.splice.apply(o,i)}return new e.Token("interpolation",o,r.alias,t)}function c(t,n,r){var a=e.tokenize(t,{interpolation:{pattern:RegExp(o),lookbehind:!0}}),i=0,c={},d=s(a.map((function(e){if("string"==typeof e)return e;for(var n,a=e.content;-1!==t.indexOf(n=l(i++,r)););return c[n]=a,n})).join(""),n,r),f=Object.keys(c);return i=0,function e(t){for(var n=0;n=f.length)return;var r=t[n];if("string"==typeof r||"string"==typeof r.content){var a=f[i],o="string"==typeof r?r:r.content,l=o.indexOf(a);if(-1!==l){++i;var s=o.substring(0,l),d=u(c[a]),p=o.substring(l+a.length),m=[];if(s&&m.push(s),m.push(d),p){var g=[p];e(g),m.push.apply(m,g)}"string"==typeof r?(t.splice.apply(t,[n,1].concat(m)),n+=m.length-1):r.content=m}}else{var h=r.content;Array.isArray(h)?e(h):e([h])}}}(d),new e.Token(r,d,"language-"+r,t)}e.languages.javascript["template-string"]=[i("css",/\b(?:styled(?:\([^)]*\))?(?:\s*\.\s*\w+(?:\([^)]*\))*)*|css(?:\s*\.\s*(?:global|resolve))?|createGlobalStyle|keyframes)/.source),i("html",/\bhtml|\.\s*(?:inner|outer)HTML\s*\+?=/.source),i("svg",/\bsvg/.source),i("markdown",/\b(?:markdown|md)/.source),i("graphql",/\b(?:gql|graphql(?:\s*\.\s*experimental)?)/.source),i("sql",/\bsql/.source),t].filter(Boolean);var d={javascript:!0,js:!0,typescript:!0,ts:!0,jsx:!0,tsx:!0};function f(e){return"string"==typeof e?e:Array.isArray(e)?e.map(f).join(""):f(e.content)}e.hooks.add("after-tokenize",(function(t){t.language in d&&function t(n){for(var r=0,a=n.length;r]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},builtin:/\b(?:Array|Function|Promise|any|boolean|console|never|number|string|symbol|unknown)\b/}),e.languages.typescript.keyword.push(/\b(?:abstract|declare|is|keyof|readonly|require)\b/,/\b(?:asserts|infer|interface|module|namespace|type)\b(?=\s*(?:[{_$a-zA-Z\xA0-\uFFFF]|$))/,/\btype\b(?=\s*(?:[\{*]|$))/),delete e.languages.typescript.parameter,delete e.languages.typescript["literal-property"];var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{decorator:{pattern:/@[$\w\xA0-\uFFFF]+/,inside:{at:{pattern:/^@/,alias:"operator"},function:/^[\s\S]+/}},"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(a),function(e){function t(e,t){return RegExp(e.replace(//g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:Float(?:32|64)|(?:Int|Uint)(?:8|16|32)|Uint8Clamped)?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|(?:Weak)?(?:Map|Set)|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:(?:\s*,\s*(?:\*\s*as\s+|\{[^{}]*\}))?|\*\s*as\s+|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|finally|for|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|(?:local|session)Storage|location|navigator|performance|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var n=["function","function-variable","method","method-variable","property-access"],r=0;r*\.{3}(?:[^{}]|)*\})/.source;function o(e,t){return e=e.replace(//g,(function(){return n})).replace(//g,(function(){return r})).replace(//g,(function(){return a})),RegExp(e,t)}a=o(a).source,e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=o(/<\/?(?:[\w.:-]+(?:+(?:[\w.:$-]+(?:=(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s{'"/>=]+|))?|))**\/?)?>/.source),e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s'">]+)/,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.jsx.tag.inside.comment=t.comment,e.languages.insertBefore("inside","attr-name",{spread:{pattern:o(//.source),inside:e.languages.jsx}},e.languages.jsx.tag),e.languages.insertBefore("inside","special-attr",{script:{pattern:o(/=/.source),alias:"language-javascript",inside:{"script-punctuation":{pattern:/^=(?=\{)/,alias:"punctuation"},rest:e.languages.jsx}}},e.languages.jsx.tag);var i=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(i).join(""):""},l=function(t){for(var n=[],r=0;r0&&n[n.length-1].tagName===i(a.content[0].content[1])&&n.pop():"/>"===a.content[a.content.length-1].content||n.push({tagName:i(a.content[0].content[1]),openedBraces:0}):n.length>0&&"punctuation"===a.type&&"{"===a.content?n[n.length-1].openedBraces++:n.length>0&&n[n.length-1].openedBraces>0&&"punctuation"===a.type&&"}"===a.content?n[n.length-1].openedBraces--:o=!0),(o||"string"==typeof a)&&n.length>0&&0===n[n.length-1].openedBraces){var s=i(a);r0&&("string"==typeof t[r-1]||"plain-text"===t[r-1].type)&&(s=i(t[r-1])+s,t.splice(r-1,1),r--),t[r]=new e.Token("plain-text",s,null,s)}a.content&&"string"!=typeof a.content&&l(a.content)}};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||l(e.tokens)}))}(a),function(e){e.languages.diff={coord:[/^(?:\*{3}|-{3}|\+{3}).*$/m,/^@@.*@@$/m,/^\d.*$/m]};var t={"deleted-sign":"-","deleted-arrow":"<","inserted-sign":"+","inserted-arrow":">",unchanged:" ",diff:"!"};Object.keys(t).forEach((function(n){var r=t[n],a=[];/^\w+$/.test(n)||a.push(/\w+/.exec(n)[0]),"diff"===n&&a.push("bold"),e.languages.diff[n]={pattern:RegExp("^(?:["+r+"].*(?:\r\n?|\n|(?![\\s\\S])))+","m"),alias:a,inside:{line:{pattern:/(.)(?=[\s\S]).*(?:\r\n?|\n)?/,lookbehind:!0},prefix:{pattern:/[\s\S]/,alias:/\w+/.exec(n)[0]}}}})),Object.defineProperty(e.languages.diff,"PREFIXES",{value:t})}(a),a.languages.git={comment:/^#.*/m,deleted:/^[-\u2013].*/m,inserted:/^\+.*/m,string:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,command:{pattern:/^.*\$ git .*$/m,inside:{parameter:/\s--?\w+/}},coord:/^@@.*@@$/m,"commit-sha1":/^commit \w{40}$/m},a.languages.go=a.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),a.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete a.languages.go["class-name"],function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,l=i.length;-1!==n.code.indexOf(a=t(r,l));)++l;return i[l]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(l){for(var s=0;s=o.length);s++){var u=l[s];if("string"==typeof u||u.content&&"string"==typeof u.content){var c=o[a],d=n.tokenStack[c],f="string"==typeof u?u:u.content,p=t(r,c),m=f.indexOf(p);if(m>-1){++a;var g=f.substring(0,m),h=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),b=f.substring(m+p.length),v=[];g&&v.push.apply(v,i([g])),v.push(h),b&&v.push.apply(v,i([b])),"string"==typeof u?l.splice.apply(l,[s,1].concat(v)):u.content=v}}else u.content&&i(u.content)}return l}(n.tokens)}}}})}(a),function(e){e.languages.handlebars={comment:/\{\{![\s\S]*?\}\}/,delimiter:{pattern:/^\{\{\{?|\}\}\}?$/,alias:"punctuation"},string:/(["'])(?:\\.|(?!\1)[^\\\r\n])*\1/,number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee][+-]?\d+)?/,boolean:/\b(?:false|true)\b/,block:{pattern:/^(\s*(?:~\s*)?)[#\/]\S+?(?=\s*(?:~\s*)?$|\s)/,lookbehind:!0,alias:"keyword"},brackets:{pattern:/\[[^\]]+\]/,inside:{punctuation:/\[|\]/,variable:/[\s\S]+/}},punctuation:/[!"#%&':()*+,.\/;<=>@\[\\\]^`{|}~]/,variable:/[^!"#%&'()*+,\/;<=>@\[\\\]^`{|}~\s]+/},e.hooks.add("before-tokenize",(function(t){e.languages["markup-templating"].buildPlaceholders(t,"handlebars",/\{\{\{[\s\S]+?\}\}\}|\{\{[\s\S]+?\}\}/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"handlebars")})),e.languages.hbs=e.languages.handlebars}(a),a.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},a.languages.webmanifest=a.languages.json,a.languages.less=a.languages.extend("css",{comment:[/\/\*[\s\S]*?\*\//,{pattern:/(^|[^\\])\/\/.*/,lookbehind:!0}],atrule:{pattern:/@[\w-](?:\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{punctuation:/[:()]/}},selector:{pattern:/(?:@\{[\w-]+\}|[^{};\s@])(?:@\{[\w-]+\}|\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};@\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{variable:/@+[\w-]+/}},property:/(?:@\{[\w-]+\}|[\w-])+(?:\+_?)?(?=\s*:)/,operator:/[+\-*\/]/}),a.languages.insertBefore("less","property",{variable:[{pattern:/@[\w-]+\s*:/,inside:{punctuation:/:/}},/@@?[\w-]+/],"mixin-usage":{pattern:/([{;]\s*)[.#](?!\d)[\w-].*?(?=[(;])/,lookbehind:!0,alias:"function"}}),a.languages.makefile={comment:{pattern:/(^|[^\\])#(?:\\(?:\r\n|[\s\S])|[^\\\r\n])*/,lookbehind:!0},string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"builtin-target":{pattern:/\.[A-Z][^:#=\s]+(?=\s*:(?!=))/,alias:"builtin"},target:{pattern:/^(?:[^:=\s]|[ \t]+(?![\s:]))+(?=\s*:(?!=))/m,alias:"symbol",inside:{variable:/\$+(?:(?!\$)[^(){}:#=\s]+|(?=[({]))/}},variable:/\$+(?:(?!\$)[^(){}:#=\s]+|\([@*%<^+?][DF]\)|(?=[({]))/,keyword:/-include\b|\b(?:define|else|endef|endif|export|ifn?def|ifn?eq|include|override|private|sinclude|undefine|unexport|vpath)\b/,function:{pattern:/(\()(?:abspath|addsuffix|and|basename|call|dir|error|eval|file|filter(?:-out)?|findstring|firstword|flavor|foreach|guile|if|info|join|lastword|load|notdir|or|origin|patsubst|realpath|shell|sort|strip|subst|suffix|value|warning|wildcard|word(?:list|s)?)(?=[ \t])/,lookbehind:!0},operator:/(?:::|[?:+!])?=|[|@]/,punctuation:/[:;(){}]/},a.languages.objectivec=a.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete a.languages.objectivec["class-name"],a.languages.objc=a.languages.objectivec,a.languages.ocaml={comment:{pattern:/\(\*[\s\S]*?\*\)/,greedy:!0},char:{pattern:/'(?:[^\\\r\n']|\\(?:.|[ox]?[0-9a-f]{1,3}))'/i,greedy:!0},string:[{pattern:/"(?:\\(?:[\s\S]|\r\n)|[^\\\r\n"])*"/,greedy:!0},{pattern:/\{([a-z_]*)\|[\s\S]*?\|\1\}/,greedy:!0}],number:[/\b(?:0b[01][01_]*|0o[0-7][0-7_]*)\b/i,/\b0x[a-f0-9][a-f0-9_]*(?:\.[a-f0-9_]*)?(?:p[+-]?\d[\d_]*)?(?!\w)/i,/\b\d[\d_]*(?:\.[\d_]*)?(?:e[+-]?\d[\d_]*)?(?!\w)/i],directive:{pattern:/\B#\w+/,alias:"property"},label:{pattern:/\B~\w+/,alias:"property"},"type-variable":{pattern:/\B'\w+/,alias:"function"},variant:{pattern:/`\w+/,alias:"symbol"},keyword:/\b(?:as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|match|method|module|mutable|new|nonrec|object|of|open|private|rec|sig|struct|then|to|try|type|val|value|virtual|when|where|while|with)\b/,boolean:/\b(?:false|true)\b/,"operator-like-punctuation":{pattern:/\[[<>|]|[>|]\]|\{<|>\}/,alias:"punctuation"},operator:/\.[.~]|:[=>]|[=<>@^|&+\-*\/$%!?~][!$%&*+\-.\/:<=>?@^|~]*|\b(?:and|asr|land|lor|lsl|lsr|lxor|mod|or)\b/,punctuation:/;;|::|[(){}\[\].,:;#]|\b_\b/},a.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},a.languages.python["string-interpolation"].inside.interpolation.inside.rest=a.languages.python,a.languages.py=a.languages.python,a.languages.reason=a.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:asr|land|lor|lsl|lsr|lxor|mod)\b/}),a.languages.insertBefore("reason","class-name",{char:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,greedy:!0},constructor:/\b[A-Z]\w*\b(?!\s*\.)/,label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete a.languages.reason.function,function(e){e.languages.sass=e.languages.extend("css",{comment:{pattern:/^([ \t]*)\/[\/*].*(?:(?:\r?\n|\r)\1[ \t].+)*/m,lookbehind:!0,greedy:!0}}),e.languages.insertBefore("sass","atrule",{"atrule-line":{pattern:/^(?:[ \t]*)[@+=].+/m,greedy:!0,inside:{atrule:/(?:@[\w-]+|[+=])/}}}),delete e.languages.sass.atrule;var t=/\$[-\w]+|#\{\$[-\w]+\}/,n=[/[+*\/%]|[=!]=|<=?|>=?|\b(?:and|not|or)\b/,{pattern:/(\s)-(?=\s)/,lookbehind:!0}];e.languages.insertBefore("sass","property",{"variable-line":{pattern:/^[ \t]*\$.+/m,greedy:!0,inside:{punctuation:/:/,variable:t,operator:n}},"property-line":{pattern:/^[ \t]*(?:[^:\s]+ *:.*|:[^:\s].*)/m,greedy:!0,inside:{property:[/[^:\s]+(?=\s*:)/,{pattern:/(:)[^:\s]+/,lookbehind:!0}],punctuation:/:/,variable:t,operator:n,important:e.languages.sass.important}}}),delete e.languages.sass.property,delete e.languages.sass.important,e.languages.insertBefore("sass","punctuation",{selector:{pattern:/^([ \t]*)\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*(?:,(?:\r?\n|\r)\1[ \t]+\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*)*/m,lookbehind:!0,greedy:!0}})}(a),a.languages.scss=a.languages.extend("css",{comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},atrule:{pattern:/@[\w-](?:\([^()]+\)|[^()\s]|\s+(?!\s))*?(?=\s+[{;])/,inside:{rule:/@[\w-]+/}},url:/(?:[-a-z]+-)?url(?=\()/i,selector:{pattern:/(?=\S)[^@;{}()]?(?:[^@;{}()\s]|\s+(?!\s)|#\{\$[-\w]+\})+(?=\s*\{(?:\}|\s|[^}][^:{}]*[:{][^}]))/,inside:{parent:{pattern:/&/,alias:"important"},placeholder:/%[-\w]+/,variable:/\$[-\w]+|#\{\$[-\w]+\}/}},property:{pattern:/(?:[-\w]|\$[-\w]|#\{\$[-\w]+\})+(?=\s*:)/,inside:{variable:/\$[-\w]+|#\{\$[-\w]+\}/}}}),a.languages.insertBefore("scss","atrule",{keyword:[/@(?:content|debug|each|else(?: if)?|extend|for|forward|function|if|import|include|mixin|return|use|warn|while)\b/i,{pattern:/( )(?:from|through)(?= )/,lookbehind:!0}]}),a.languages.insertBefore("scss","important",{variable:/\$[-\w]+|#\{\$[-\w]+\}/}),a.languages.insertBefore("scss","function",{"module-modifier":{pattern:/\b(?:as|hide|show|with)\b/i,alias:"keyword"},placeholder:{pattern:/%[-\w]+/,alias:"selector"},statement:{pattern:/\B!(?:default|optional)\b/i,alias:"keyword"},boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"},operator:{pattern:/(\s)(?:[-+*\/%]|[=!]=|<=?|>=?|and|not|or)(?=\s)/,lookbehind:!0}}),a.languages.scss.atrule.inside.rest=a.languages.scss,function(e){var t={pattern:/(\b\d+)(?:%|[a-z]+)/,lookbehind:!0},n={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0},r={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},url:{pattern:/\burl\((["']?).*?\1\)/i,greedy:!0},string:{pattern:/("|')(?:(?!\1)[^\\\r\n]|\\(?:\r\n|[\s\S]))*\1/,greedy:!0},interpolation:null,func:null,important:/\B!(?:important|optional)\b/i,keyword:{pattern:/(^|\s+)(?:(?:else|for|if|return|unless)(?=\s|$)|@[\w-]+)/,lookbehind:!0},hexcode:/#[\da-f]{3,6}/i,color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:n,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,boolean:/\b(?:false|true)\b/,operator:[/~|[+!\/%<>?=]=?|[-:]=|\*[*=]?|\.{2,3}|&&|\|\||\B-\B|\b(?:and|in|is(?: a| defined| not|nt)?|not|or)\b/],number:n,punctuation:/[{}()\[\];:,]/};r.interpolation={pattern:/\{[^\r\n}:]+\}/,alias:"variable",inside:{delimiter:{pattern:/^\{|\}$/,alias:"punctuation"},rest:r}},r.func={pattern:/[\w-]+\([^)]*\).*/,inside:{function:/^[^(]+/,rest:r}},e.languages.stylus={"atrule-declaration":{pattern:/(^[ \t]*)@.+/m,lookbehind:!0,inside:{atrule:/^@[\w-]+/,rest:r}},"variable-declaration":{pattern:/(^[ \t]*)[\w$-]+\s*.?=[ \t]*(?:\{[^{}]*\}|\S.*|$)/m,lookbehind:!0,inside:{variable:/^\S+/,rest:r}},statement:{pattern:/(^[ \t]*)(?:else|for|if|return|unless)[ \t].+/m,lookbehind:!0,inside:{keyword:/^\S+/,rest:r}},"property-declaration":{pattern:/((?:^|\{)([ \t]*))(?:[\w-]|\{[^}\r\n]+\})+(?:\s*:\s*|[ \t]+)(?!\s)[^{\r\n]*(?:;|[^{\r\n,]$(?!(?:\r?\n|\r)(?:\{|\2[ \t])))/m,lookbehind:!0,inside:{property:{pattern:/^[^\s:]+/,inside:{interpolation:r.interpolation}},rest:r}},selector:{pattern:/(^[ \t]*)(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)(?:(?:\r?\n|\r)(?:\1(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)))*(?:,$|\{|(?=(?:\r?\n|\r)(?:\{|\1[ \t])))/m,lookbehind:!0,inside:{interpolation:r.interpolation,comment:r.comment,punctuation:/[{},]/}},func:r.func,string:r.string,comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0,greedy:!0},interpolation:r.interpolation,punctuation:/[{}()\[\];:.]/}}(a),function(e){var t=e.util.clone(e.languages.typescript);e.languages.tsx=e.languages.extend("jsx",t),delete e.languages.tsx.parameter,delete e.languages.tsx["literal-property"];var n=e.languages.tsx.tag;n.pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+n.pattern.source+")",n.pattern.flags),n.lookbehind=!0}(a),a.languages.wasm={comment:[/\(;[\s\S]*?;\)/,{pattern:/;;.*/,greedy:!0}],string:{pattern:/"(?:\\[\s\S]|[^"\\])*"/,greedy:!0},keyword:[{pattern:/\b(?:align|offset)=/,inside:{operator:/=/}},{pattern:/\b(?:(?:f32|f64|i32|i64)(?:\.(?:abs|add|and|ceil|clz|const|convert_[su]\/i(?:32|64)|copysign|ctz|demote\/f64|div(?:_[su])?|eqz?|extend_[su]\/i32|floor|ge(?:_[su])?|gt(?:_[su])?|le(?:_[su])?|load(?:(?:8|16|32)_[su])?|lt(?:_[su])?|max|min|mul|neg?|nearest|or|popcnt|promote\/f32|reinterpret\/[fi](?:32|64)|rem_[su]|rot[lr]|shl|shr_[su]|sqrt|store(?:8|16|32)?|sub|trunc(?:_[su]\/f(?:32|64))?|wrap\/i64|xor))?|memory\.(?:grow|size))\b/,inside:{punctuation:/\./}},/\b(?:anyfunc|block|br(?:_if|_table)?|call(?:_indirect)?|data|drop|elem|else|end|export|func|get_(?:global|local)|global|if|import|local|loop|memory|module|mut|nop|offset|param|result|return|select|set_(?:global|local)|start|table|tee_local|then|type|unreachable)\b/],variable:/\$[\w!#$%&'*+\-./:<=>?@\\^`|~]+/,number:/[+-]?\b(?:\d(?:_?\d)*(?:\.\d(?:_?\d)*)?(?:[eE][+-]?\d(?:_?\d)*)?|0x[\da-fA-F](?:_?[\da-fA-F])*(?:\.[\da-fA-F](?:_?[\da-fA-D])*)?(?:[pP][+-]?\d(?:_?\d)*)?)\b|\binf\b|\bnan(?::0x[\da-fA-F](?:_?[\da-fA-D])*)?\b/,punctuation:/[()]/};const o=a},9901:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:"shell",aliasTitles:{shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (Scss)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),a=n(9642),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),o.add(e)}))}i.silent=!1,e.exports=i},6726:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6726},6500:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6500},9642:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function u(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var i in a(t,o),l[t]=!0,n[t])l[i]=!0}t(s.require,u),t(s.optional,u),t(s.modify,u)}n[r]=l,o.pop()}}return function(e){var t=n[e];return t||(a(e,r),t=n[e]),t}}function a(e){for(var t in e)return!0;return!1}return function(o,i,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var a in r)if("meta"!=a){var o=r[a];t[a]="string"==typeof o?{title:o}:o}}return t}(o),u=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var a in n={},e){var o=e[a];t(o&&o.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+a+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+a+" because it is a component.");n[t]=a}))}return n[r]||r}}(s);i=i.map(u),l=(l||[]).map(u);var c=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(c[t]=!0,e(t))}))}));for(var f,p=r(s),m=c;a(m);){for(var g in f={},m){var h=s[g];t(h&&h.modify,(function(e){e in d&&(f[e]=!0)}))}for(var b in d)if(!(b in c))for(var v in p(b))if(v in c){f[b]=!0;break}for(var y in m=f)c[y]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,a){var o=a?a.series:void 0,i=a?a.parallel:e,l={},s={};function u(e){if(e in l)return l[e];s[e]=!0;var a,c=[];for(var d in t(e))d in n&&c.push(d);if(0===c.length)a=r(e);else{var f=i(c.map((function(e){var t=u(e);return delete s[e],t})));o?a=o(f,(function(){return r(e)})):r(e)}return l[e]=a}for(var c in n)u(c);var d=[];for(var f in s)d.push(l[f]);return i(d)}(p,c,t,n)}};return w}}();e.exports=t},2703:(e,t,n)=>{"use strict";var r=n(414);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},5697:(e,t,n)=>{e.exports=n(2703)()},414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:(e,t,n)=>{"use strict";var r=n(7294),a=n(7418),o=n(3840);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n