diff --git a/404.html b/404.html index 7bc2ab8..7f79a70 100644 --- a/404.html +++ b/404.html @@ -14,8 +14,8 @@ - - + +
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.

diff --git a/__docusaurus/debug.html b/__docusaurus/debug.html index b7be4f3..e5dd77a 100644 --- a/__docusaurus/debug.html +++ b/__docusaurus/debug.html @@ -14,8 +14,8 @@ - - + +

Site config

{
title:"NestCord",
tagline:"A module for creating Discord bots using NestJS, based on Discord.js",
url:"https://nestcord.globalart.dev",
baseUrl:"/",
onBrokenLinks:"throw",
onBrokenMarkdownLinks:"warn",
favicon:"img/favicon.ico",
organizationName:"GlobalArtInc",
projectName:"nestcord",
trailingSlash:false,
presets:[
[
"classic",
{}
]
],
themeConfig:{
algolia:{
appId:"N5JRHSHB9C",
apiKey:"6597eb15c31c17ecd0d7eba39b7a3848",
indexName:"nestcord",
contextualSearch:true,
schedule:"every 1 day at 3:00 pm",
searchParameters:{},
searchPagePath:"search"
},
cname:"nestcord.globalart.dev",
announcementBar:{
content:"⭐️ If you like NestCord, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/GlobalArtInc/nestcord">GitHub</a>! ⭐️",
id:"announcement-bar",
isCloseable:true
},
metadata:[],
navbar:{
logo:{},
items:[],
hideOnScroll:false
},
colorMode:{
defaultMode:"light",
disableSwitch:false,
respectPrefersColorScheme:true
},
footer:{
copyright:"Copyright © 2003 - 2024 • Built by <a target="_blank" href="https://globalart.dev">GlobalArt Inc</a>",
style:"light",
links:[
]
},
docs:{
versionPersistence:"localStorage",
sidebar:{}
},
prism:{
additionalLanguages:[
],
theme:{},
magicComments:[
{}
]
},
tableOfContents:{
minHeadingLevel:2,
maxHeadingLevel:3
}
},
plugins:[
"docusaurus-plugin-sass",
[
"@docusaurus/plugin-pwa",
{}
]
],
baseUrlIssueBanner:true,
i18n:{
defaultLocale:"en",
path:"i18n",
locales:[
"en"
],
localeConfigs:{
}
},
future:{
experimental_storage:{
type:"localStorage",
namespace:false
},
experimental_router:"browser"
},
onBrokenAnchors:"warn",
onDuplicateRoutes:"warn",
staticDirectories:[
"static"
],
customFields:{
},
themes:[
],
scripts:[
],
headTags:[
],
stylesheets:[
],
clientModules:[
],
titleDelimiter:"|",
noIndex:false,
markdown:{
format:"mdx",
mermaid:false,
mdx1Compat:{
comments:true,
admonitions:true,
headingIds:true
},
anchors:{
maintainCase:false
}
}
}
diff --git a/__docusaurus/debug/config.html b/__docusaurus/debug/config.html index d64fd48..423b7aa 100644 --- a/__docusaurus/debug/config.html +++ b/__docusaurus/debug/config.html @@ -14,8 +14,8 @@ - - + +

Site config

{
title:"NestCord",
tagline:"A module for creating Discord bots using NestJS, based on Discord.js",
url:"https://nestcord.globalart.dev",
baseUrl:"/",
onBrokenLinks:"throw",
onBrokenMarkdownLinks:"warn",
favicon:"img/favicon.ico",
organizationName:"GlobalArtInc",
projectName:"nestcord",
trailingSlash:false,
presets:[
[
"classic",
{}
]
],
themeConfig:{
algolia:{
appId:"N5JRHSHB9C",
apiKey:"6597eb15c31c17ecd0d7eba39b7a3848",
indexName:"nestcord",
contextualSearch:true,
schedule:"every 1 day at 3:00 pm",
searchParameters:{},
searchPagePath:"search"
},
cname:"nestcord.globalart.dev",
announcementBar:{
content:"⭐️ If you like NestCord, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/GlobalArtInc/nestcord">GitHub</a>! ⭐️",
id:"announcement-bar",
isCloseable:true
},
metadata:[],
navbar:{
logo:{},
items:[],
hideOnScroll:false
},
colorMode:{
defaultMode:"light",
disableSwitch:false,
respectPrefersColorScheme:true
},
footer:{
copyright:"Copyright © 2003 - 2024 • Built by <a target="_blank" href="https://globalart.dev">GlobalArt Inc</a>",
style:"light",
links:[
]
},
docs:{
versionPersistence:"localStorage",
sidebar:{}
},
prism:{
additionalLanguages:[
],
theme:{},
magicComments:[
{}
]
},
tableOfContents:{
minHeadingLevel:2,
maxHeadingLevel:3
}
},
plugins:[
"docusaurus-plugin-sass",
[
"@docusaurus/plugin-pwa",
{}
]
],
baseUrlIssueBanner:true,
i18n:{
defaultLocale:"en",
path:"i18n",
locales:[
"en"
],
localeConfigs:{
}
},
future:{
experimental_storage:{
type:"localStorage",
namespace:false
},
experimental_router:"browser"
},
onBrokenAnchors:"warn",
onDuplicateRoutes:"warn",
staticDirectories:[
"static"
],
customFields:{
},
themes:[
],
scripts:[
],
headTags:[
],
stylesheets:[
],
clientModules:[
],
titleDelimiter:"|",
noIndex:false,
markdown:{
format:"mdx",
mermaid:false,
mdx1Compat:{
comments:true,
admonitions:true,
headingIds:true
},
anchors:{
maintainCase:false
}
}
}
diff --git a/__docusaurus/debug/content.html b/__docusaurus/debug/content.html index ce9838f..c3adeca 100644 --- a/__docusaurus/debug/content.html +++ b/__docusaurus/debug/content.html @@ -14,8 +14,8 @@ - - + +

Plugin content

docusaurus-plugin-content-docs

default
{
loadedVersions:[
{}
]
}
diff --git a/__docusaurus/debug/globalData.html b/__docusaurus/debug/globalData.html index d859c60..ffd18ec 100644 --- a/__docusaurus/debug/globalData.html +++ b/__docusaurus/debug/globalData.html @@ -14,8 +14,8 @@ - - + +

Global data

{
docusaurus-plugin-content-docs:{
default:{
path:"/",
versions:[
{}
],
breadcrumbs:true
}
}
}
diff --git a/__docusaurus/debug/metadata.html b/__docusaurus/debug/metadata.html index 315b777..ab2e7f3 100644 --- a/__docusaurus/debug/metadata.html +++ b/__docusaurus/debug/metadata.html @@ -14,8 +14,8 @@ - - + +

Site Metadata

Docusaurus Version: 3.4.0
Site Version: 0.0.0

Plugins and themes

  • 3.4.0
    docusaurus-plugin-content-docs
    Type: package
  • 3.4.0
    docusaurus-plugin-debug
    Type: package
  • 3.4.0
    docusaurus-plugin-sitemap
    Type: package
  • 3.4.0
    docusaurus-theme-classic
    Type: package
  • 3.4.0
    docusaurus-theme-search-algolia
    Type: package
  • 0.2.5
    docusaurus-plugin-sass
    Type: package
  • 3.4.0
    docusaurus-plugin-pwa
    Type: package
diff --git a/__docusaurus/debug/registry.html b/__docusaurus/debug/registry.html index cae0dc1..1916ec1 100644 --- a/__docusaurus/debug/registry.html +++ b/__docusaurus/debug/registry.html @@ -14,10 +14,10 @@ - - + + -

Registry

  • Aliased Path: @theme/DocItem
    Resolved Path: 6987
  • Aliased Path: @site/content/contributing/code-of-conduct.md
    Resolved Path: 5514
  • Aliased Path: @site/content/interactions/message-components.md
    Resolved Path: 3773
  • Aliased Path: @site/content/techniques/validation.md
    Resolved Path: 1590
  • Aliased Path: @theme/SearchPage
    Resolved Path: 953
  • Aliased Path: @generated/docusaurus-plugin-content-docs/default/p/index-466.json
    Resolved Path: 5226
  • Aliased Path: @theme/DebugConfig
    Resolved Path: 7496
  • Aliased Path: @site/content/techniques/async-configuration.md
    Resolved Path: 7134
  • Aliased Path: @generated/docusaurus-plugin-debug/default/p/docusaurus-debug-content-0d5.json
    Resolved Path: 3343
  • Aliased Path: @site/content/getting-started.md
    Resolved Path: 1161
  • Aliased Path: @site/content/contributing/funding.md
    Resolved Path: 6503
  • Aliased Path: @theme/DocsRoot
    Resolved Path: 2503
  • Aliased Path: @site/content/recipes/stat-reporter.md
    Resolved Path: 8029
  • Aliased Path: @theme/DebugRegistry
    Resolved Path: 9421
  • Aliased Path: @theme/DebugSiteMetadata
    Resolved Path: 16
  • Aliased Path: @site/content/techniques/sharding.md
    Resolved Path: 301
  • Aliased Path: @site/content/text-commands.md
    Resolved Path: 3785
  • Aliased Path: @site/content/listeners.md
    Resolved Path: 2088
  • Aliased Path: @site/content/techniques/client-providers.md
    Resolved Path: 6717
  • Aliased Path: @theme/DebugRoutes
    Resolved Path: 3476
  • Aliased Path: @site/content/interactions/context-menus.md
    Resolved Path: 5761
  • Aliased Path: @site/content/techniques/standalone-application.md
    Resolved Path: 2593
  • Aliased Path: @site/content/contributing/contribution-guide.md
    Resolved Path: 3435
  • Aliased Path: @theme/DocVersionRoot
    Resolved Path: 5322
  • Aliased Path: @site/content/interactions/slash-commands.md
    Resolved Path: 6745
  • Aliased Path: @theme/DocRoot
    Resolved Path: 6917
  • Aliased Path: @generated/docusaurus-plugin-content-docs/default/__plugin.json
    Resolved Path: 7093
  • Aliased Path: @generated/docusaurus-plugin-debug/default/__plugin.json
    Resolved Path: 4765
  • Aliased Path: @theme/DebugContent
    Resolved Path: 1248
  • Aliased Path: @site/content/recipes/pagination.md
    Resolved Path: 6157
  • Aliased Path: @generated/docusaurus-theme-search-algolia/default/__plugin.json
    Resolved Path: 936
  • Aliased Path: @site/content/interceptors/defer-interceptor.md
    Resolved Path: 3988
  • Aliased Path: @site/content/recipes/localization.md
    Resolved Path: 6584
  • Aliased Path: @site/content/interactions/modals.md
    Resolved Path: 8141
  • Aliased Path: @site/content/intro.md
    Resolved Path: 7547
  • Aliased Path: @theme/DebugGlobalData
    Resolved Path: 105
  • Aliased Path: @site/content/contributing/commit-convention.md
    Resolved Path: 2941
+

Registry

  • Aliased Path: @theme/DocItem
    Resolved Path: 6987
  • Aliased Path: @site/content/contributing/code-of-conduct.md
    Resolved Path: 5514
  • Aliased Path: @site/content/interactions/message-components.md
    Resolved Path: 3773
  • Aliased Path: @site/content/techniques/validation.md
    Resolved Path: 1590
  • Aliased Path: @theme/SearchPage
    Resolved Path: 953
  • Aliased Path: @site/content/packages/pagination.md
    Resolved Path: 2611
  • Aliased Path: @generated/docusaurus-plugin-content-docs/default/p/index-466.json
    Resolved Path: 5226
  • Aliased Path: @theme/DebugConfig
    Resolved Path: 7496
  • Aliased Path: @site/content/techniques/async-configuration.md
    Resolved Path: 7134
  • Aliased Path: @generated/docusaurus-plugin-debug/default/p/docusaurus-debug-content-0d5.json
    Resolved Path: 3343
  • Aliased Path: @site/content/getting-started.md
    Resolved Path: 1161
  • Aliased Path: @site/content/contributing/funding.md
    Resolved Path: 6503
  • Aliased Path: @theme/DocsRoot
    Resolved Path: 2503
  • Aliased Path: @site/content/packages/stat-reporter.md
    Resolved Path: 3731
  • Aliased Path: @theme/DebugRegistry
    Resolved Path: 9421
  • Aliased Path: @theme/DebugSiteMetadata
    Resolved Path: 16
  • Aliased Path: @site/content/techniques/sharding.md
    Resolved Path: 301
  • Aliased Path: @site/content/text-commands.md
    Resolved Path: 3785
  • Aliased Path: @site/content/listeners.md
    Resolved Path: 2088
  • Aliased Path: @site/content/techniques/client-providers.md
    Resolved Path: 6717
  • Aliased Path: @theme/DebugRoutes
    Resolved Path: 3476
  • Aliased Path: @site/content/interactions/context-menus.md
    Resolved Path: 5761
  • Aliased Path: @site/content/techniques/standalone-application.md
    Resolved Path: 2593
  • Aliased Path: @site/content/contributing/contribution-guide.md
    Resolved Path: 3435
  • Aliased Path: @theme/DocVersionRoot
    Resolved Path: 5322
  • Aliased Path: @site/content/interactions/slash-commands.md
    Resolved Path: 6745
  • Aliased Path: @theme/DocRoot
    Resolved Path: 6917
  • Aliased Path: @generated/docusaurus-plugin-content-docs/default/__plugin.json
    Resolved Path: 7093
  • Aliased Path: @generated/docusaurus-plugin-debug/default/__plugin.json
    Resolved Path: 4765
  • Aliased Path: @theme/DebugContent
    Resolved Path: 1248
  • Aliased Path: @generated/docusaurus-theme-search-algolia/default/__plugin.json
    Resolved Path: 936
  • Aliased Path: @site/content/interceptors/defer-interceptor.md
    Resolved Path: 3988
  • Aliased Path: @site/content/interactions/modals.md
    Resolved Path: 8141
  • Aliased Path: @site/content/packages/localization.md
    Resolved Path: 5506
  • Aliased Path: @site/content/intro.md
    Resolved Path: 7547
  • Aliased Path: @theme/DebugGlobalData
    Resolved Path: 105
  • Aliased Path: @site/content/contributing/commit-convention.md
    Resolved Path: 2941
\ No newline at end of file diff --git a/__docusaurus/debug/routes.html b/__docusaurus/debug/routes.html index f5201a2..1fa048d 100644 --- a/__docusaurus/debug/routes.html +++ b/__docusaurus/debug/routes.html @@ -14,8 +14,8 @@ - - + +

Routes

  • /__docusaurus/debug
    Is exact: true
  • /__docusaurus/debug/config
    Is exact: true
  • /__docusaurus/debug/content
    Is exact: true
  • /__docusaurus/debug/globalData
    Is exact: true
  • /__docusaurus/debug/metadata
    Is exact: true
  • /__docusaurus/debug/registry
    Is exact: true
  • /__docusaurus/debug/routes
    Is exact: true
  • /search
    Is exact: true
  • /
    Is exact: false
    Child Routes:
    [
    {}
    ]
  • *
    Is exact: false
diff --git a/assets/js/107a3993.fb6d281f.js b/assets/js/107a3993.fb6d281f.js deleted file mode 100644 index 81bf88f..0000000 --- a/assets/js/107a3993.fb6d281f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[936],{1590:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var a=n(6070),r=n(5710),s=n(8080),i=n(8208);const o={id:"validation",title:"Validation",sidebar_position:0},l=void 0,c={id:"techniques/validation",title:"Validation",description:"The ValidationPipe is a built-in pipe that can be used to validate data coming from the client. It uses class-validator package under the hood. The ValidationPipe provides a convenient approach to enforce validation rules for all incoming client payloads, where the specific rules are declared with simple annotations in DTO declarations in each module.",source:"@site/content/techniques/validation.md",sourceDirName:"techniques",slug:"/techniques/validation",permalink:"/techniques/validation",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/validation.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"validation",title:"Validation",sidebar_position:0},sidebar:"docsSidebar",previous:{title:"Stat Reporter",permalink:"/recipes/stat-reporter"},next:{title:"Sharding",permalink:"/techniques/sharding"}},d={},u=[{value:"Installation",id:"installation",level:2},{value:"Usage",id:"usage",level:2}];function p(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(t.p,{children:["The ",(0,a.jsx)(t.code,{children:"ValidationPipe"})," is a built-in pipe that can be used to validate data coming from the client. It uses ",(0,a.jsx)(t.a,{href:"https://github.com/typestack/class-validator",children:"class-validator"})," package under the hood. The ",(0,a.jsx)(t.code,{children:"ValidationPipe"})," provides a convenient approach to enforce validation rules for all incoming client payloads, where the specific rules are declared with simple annotations in DTO declarations in each module."]}),"\n",(0,a.jsx)(t.h2,{id:"installation",children:"Installation"}),"\n",(0,a.jsxs)(s.A,{groupId:"npm2yarn",children:[(0,a.jsx)(i.A,{value:"npm",children:(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"$ npm install class-validator class-transformer\n"})})}),(0,a.jsx)(i.A,{value:"yarn",label:"Yarn",children:(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"$ yarn add class-validator class-transformer\n"})})}),(0,a.jsx)(i.A,{value:"pnpm",label:"pnpm",children:(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"$ pnpm add class-validator class-transformer\n"})})})]}),"\n",(0,a.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,a.jsxs)(t.p,{children:["Now we can add a few validation rules in our ",(0,a.jsx)(t.code,{children:"CreateUserDto"}),". We do this using decorators provided by the class-validator package, described in detail ",(0,a.jsx)(t.a,{href:"https://github.com/typestack/class-validator#validation-decorators",children:"here"}),". In this fashion, any route that uses the ",(0,a.jsx)(t.code,{children:"CreateUserDto"})," will automatically enforce these validation rules."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-typescript",metastring:'title="src/users/dto/create-user.dto.ts"',children:"import { IsNotEmpty, IsString, IsEmail } from 'class-validator';\n\nexport class CreateUserDto {\n @StringOption({\n name: 'name',\n description: 'Your name',\n required: true\n })\n name: string;\n\n @IsEmail()\n @StringOption({\n name: 'text',\n description: 'Your email',\n required: false\n })\n email: string;\n}\n"})}),"\n",(0,a.jsxs)(t.admonition,{type:"tip",children:[(0,a.jsxs)(t.p,{children:["Also you can use ",(0,a.jsx)(t.code,{children:"ValidationPipe"})," for transforming and validating the payload of a request."]}),(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://docs.nestjs.com/techniques/validation#transform-payload-objects",children:"Read more about transforming"})})]}),"\n",(0,a.jsxs)(t.p,{children:["Now, we can use the ",(0,a.jsx)(t.code,{children:"ValidationPipe"})," in our ",(0,a.jsx)(t.code,{children:"UsersCommands"})," to enforce the validation rules we just defined."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-typescript",metastring:'title="src/users/users.commands.ts"',children:"import { Injectable } from '@nestjs/common';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class UsersCommands {\n @SlashCommand({\n name: 'create',\n description: 'Create a new user'\n })\n public async onCreateUser(\n @Context() [interaction]: SlashCommandContext,\n @Options(new ValidationPipe({ validateCustomDecorators: true })) createUserDto: CreateUserDto\n ) {\n return interaction.reply({ content: `User created: ${createUserDto.name}` });\n }\n}\n"})}),"\n",(0,a.jsxs)(t.p,{children:["Now, if we try to use the ",(0,a.jsx)(t.code,{children:"create"})," command without providing a name or email, we will get an error message."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:'{"statusCode":400,"message":["email should not be empty"],"error":"Bad Request"}\n'})}),"\n",(0,a.jsx)(t.p,{children:"You can create snippet for validated options decorator:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-typescript",metastring:'title="src/decorators/validated-options.decorator.ts"',children:"import { ValidationPipe, PipeTransform } from '@nestjs/common';\n\nexport const ValidatedOptions = (...dataOrPipes: PipeTransform[] | string) => {\n return Options(...dataOrPipes, new ValidationPipe());\n};\n"})}),"\n",(0,a.jsxs)(t.admonition,{type:"tip",children:[(0,a.jsx)(t.p,{children:"You can create filters to handle and response validation errors."}),(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://docs.nestjs.com/exception-filters#exception-filters",children:"See Exception Filters for more information"})})]})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},8208:(e,t,n)=>{n.d(t,{A:()=>i});n(758);var a=n(3526);const r={tabItem:"tabItem_r0H8"};var s=n(6070);function i(e){let{children:t,hidden:n,className:i}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,a.A)(r.tabItem,i),hidden:n,children:t})}},8080:(e,t,n)=>{n.d(t,{A:()=>w});var a=n(758),r=n(3526),s=n(4727),i=n(5557),o=n(8708),l=n(4232),c=n(2553),d=n(9465);function u(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function p(e){const{values:t,children:n}=e;return(0,a.useMemo)((()=>{const e=t??function(e){return u(e).map((e=>{let{props:{value:t,label:n,attributes:a,default:r}}=e;return{value:t,label:n,attributes:a,default:r}}))}(n);return function(e){const t=(0,c.X)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function h(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function m(e){let{queryString:t=!1,groupId:n}=e;const r=(0,i.W6)(),s=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,l.aZ)(s),(0,a.useCallback)((e=>{if(!s)return;const t=new URLSearchParams(r.location.search);t.set(s,e),r.replace({...r.location,search:t.toString()})}),[s,r])]}function f(e){const{defaultValue:t,queryString:n=!1,groupId:r}=e,s=p(e),[i,l]=(0,a.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!h({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const a=n.find((e=>e.default))??n[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:t,tabValues:s}))),[c,u]=m({queryString:n,groupId:r}),[f,v]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[r,s]=(0,d.Dv)(n);return[r,(0,a.useCallback)((e=>{n&&s.set(e)}),[n,s])]}({groupId:r}),b=(()=>{const e=c??f;return h({value:e,tabValues:s})?e:null})();(0,o.A)((()=>{b&&l(b)}),[b]);return{selectedValue:i,selectValue:(0,a.useCallback)((e=>{if(!h({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);l(e),u(e),v(e)}),[u,v,s]),tabValues:s}}var v=n(9536);const b={tabList:"tabList_m2iM",tabItem:"tabItem_yoA2"};var g=n(6070);function x(e){let{className:t,block:n,selectedValue:a,selectValue:i,tabValues:o}=e;const l=[],{blockElementScrollPositionUntilNextRender:c}=(0,s.a_)(),d=e=>{const t=e.currentTarget,n=l.indexOf(t),r=o[n].value;r!==a&&(c(t),i(r))},u=e=>{let t=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":{const n=l.indexOf(e.currentTarget)+1;t=l[n]??l[0];break}case"ArrowLeft":{const n=l.indexOf(e.currentTarget)-1;t=l[n]??l[l.length-1];break}}t?.focus()};return(0,g.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.A)("tabs",{"tabs--block":n},t),children:o.map((e=>{let{value:t,label:n,attributes:s}=e;return(0,g.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>l.push(e),onKeyDown:u,onClick:d,...s,className:(0,r.A)("tabs__item",b.tabItem,s?.className,{"tabs__item--active":a===t}),children:n??t},t)}))})}function j(e){let{lazy:t,children:n,selectedValue:r}=e;const s=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){const e=s.find((e=>e.props.value===r));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,g.jsx)("div",{className:"margin-top--md",children:s.map(((e,t)=>(0,a.cloneElement)(e,{key:t,hidden:e.props.value!==r})))})}function y(e){const t=f(e);return(0,g.jsxs)("div",{className:(0,r.A)("tabs-container",b.tabList),children:[(0,g.jsx)(x,{...t,...e}),(0,g.jsx)(j,{...t,...e})]})}function w(e){const t=(0,v.A)();return(0,g.jsx)(y,{...e,children:u(e.children)},String(t))}},5710:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>o});var a=n(758);const r={},s=a.createContext(r);function i(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/107a3993.ffa1b29a.js b/assets/js/107a3993.ffa1b29a.js new file mode 100644 index 0000000..2ad3ab6 --- /dev/null +++ b/assets/js/107a3993.ffa1b29a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[936],{1590:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var a=n(6070),r=n(5710),s=n(8080),i=n(8208);const o={id:"validation",title:"Validation",sidebar_position:0},l=void 0,c={id:"techniques/validation",title:"Validation",description:"The ValidationPipe is a built-in pipe that can be used to validate data coming from the client. It uses class-validator package under the hood. The ValidationPipe provides a convenient approach to enforce validation rules for all incoming client payloads, where the specific rules are declared with simple annotations in DTO declarations in each module.",source:"@site/content/techniques/validation.md",sourceDirName:"techniques",slug:"/techniques/validation",permalink:"/techniques/validation",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/validation.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"validation",title:"Validation",sidebar_position:0},sidebar:"docsSidebar",previous:{title:"Stat Reporter",permalink:"/packages/stat-reporter"},next:{title:"Sharding",permalink:"/techniques/sharding"}},d={},u=[{value:"Installation",id:"installation",level:2},{value:"Usage",id:"usage",level:2}];function p(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(t.p,{children:["The ",(0,a.jsx)(t.code,{children:"ValidationPipe"})," is a built-in pipe that can be used to validate data coming from the client. It uses ",(0,a.jsx)(t.a,{href:"https://github.com/typestack/class-validator",children:"class-validator"})," package under the hood. The ",(0,a.jsx)(t.code,{children:"ValidationPipe"})," provides a convenient approach to enforce validation rules for all incoming client payloads, where the specific rules are declared with simple annotations in DTO declarations in each module."]}),"\n",(0,a.jsx)(t.h2,{id:"installation",children:"Installation"}),"\n",(0,a.jsxs)(s.A,{groupId:"npm2yarn",children:[(0,a.jsx)(i.A,{value:"npm",children:(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"$ npm install class-validator class-transformer\n"})})}),(0,a.jsx)(i.A,{value:"yarn",label:"Yarn",children:(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"$ yarn add class-validator class-transformer\n"})})}),(0,a.jsx)(i.A,{value:"pnpm",label:"pnpm",children:(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"$ pnpm add class-validator class-transformer\n"})})})]}),"\n",(0,a.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,a.jsxs)(t.p,{children:["Now we can add a few validation rules in our ",(0,a.jsx)(t.code,{children:"CreateUserDto"}),". We do this using decorators provided by the class-validator package, described in detail ",(0,a.jsx)(t.a,{href:"https://github.com/typestack/class-validator#validation-decorators",children:"here"}),". In this fashion, any route that uses the ",(0,a.jsx)(t.code,{children:"CreateUserDto"})," will automatically enforce these validation rules."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-typescript",metastring:'title="src/users/dto/create-user.dto.ts"',children:"import { IsNotEmpty, IsString, IsEmail } from 'class-validator';\n\nexport class CreateUserDto {\n @StringOption({\n name: 'name',\n description: 'Your name',\n required: true\n })\n name: string;\n\n @IsEmail()\n @StringOption({\n name: 'text',\n description: 'Your email',\n required: false\n })\n email: string;\n}\n"})}),"\n",(0,a.jsxs)(t.admonition,{type:"tip",children:[(0,a.jsxs)(t.p,{children:["Also you can use ",(0,a.jsx)(t.code,{children:"ValidationPipe"})," for transforming and validating the payload of a request."]}),(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://docs.nestjs.com/techniques/validation#transform-payload-objects",children:"Read more about transforming"})})]}),"\n",(0,a.jsxs)(t.p,{children:["Now, we can use the ",(0,a.jsx)(t.code,{children:"ValidationPipe"})," in our ",(0,a.jsx)(t.code,{children:"UsersCommands"})," to enforce the validation rules we just defined."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-typescript",metastring:'title="src/users/users.commands.ts"',children:"import { Injectable } from '@nestjs/common';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class UsersCommands {\n @SlashCommand({\n name: 'create',\n description: 'Create a new user'\n })\n public async onCreateUser(\n @Context() [interaction]: SlashCommandContext,\n @Options(new ValidationPipe({ validateCustomDecorators: true })) createUserDto: CreateUserDto\n ) {\n return interaction.reply({ content: `User created: ${createUserDto.name}` });\n }\n}\n"})}),"\n",(0,a.jsxs)(t.p,{children:["Now, if we try to use the ",(0,a.jsx)(t.code,{children:"create"})," command without providing a name or email, we will get an error message."]}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:'{"statusCode":400,"message":["email should not be empty"],"error":"Bad Request"}\n'})}),"\n",(0,a.jsx)(t.p,{children:"You can create snippet for validated options decorator:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-typescript",metastring:'title="src/decorators/validated-options.decorator.ts"',children:"import { ValidationPipe, PipeTransform } from '@nestjs/common';\n\nexport const ValidatedOptions = (...dataOrPipes: PipeTransform[] | string) => {\n return Options(...dataOrPipes, new ValidationPipe());\n};\n"})}),"\n",(0,a.jsxs)(t.admonition,{type:"tip",children:[(0,a.jsx)(t.p,{children:"You can create filters to handle and response validation errors."}),(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://docs.nestjs.com/exception-filters#exception-filters",children:"See Exception Filters for more information"})})]})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},8208:(e,t,n)=>{n.d(t,{A:()=>i});n(758);var a=n(3526);const r={tabItem:"tabItem_r0H8"};var s=n(6070);function i(e){let{children:t,hidden:n,className:i}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,a.A)(r.tabItem,i),hidden:n,children:t})}},8080:(e,t,n)=>{n.d(t,{A:()=>w});var a=n(758),r=n(3526),s=n(4727),i=n(5557),o=n(8708),l=n(4232),c=n(2553),d=n(9465);function u(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function p(e){const{values:t,children:n}=e;return(0,a.useMemo)((()=>{const e=t??function(e){return u(e).map((e=>{let{props:{value:t,label:n,attributes:a,default:r}}=e;return{value:t,label:n,attributes:a,default:r}}))}(n);return function(e){const t=(0,c.X)(e,((e,t)=>e.value===t.value));if(t.length>0)throw new Error(`Docusaurus error: Duplicate values "${t.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[t,n])}function h(e){let{value:t,tabValues:n}=e;return n.some((e=>e.value===t))}function m(e){let{queryString:t=!1,groupId:n}=e;const r=(0,i.W6)(),s=function(e){let{queryString:t=!1,groupId:n}=e;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!n)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:t,groupId:n});return[(0,l.aZ)(s),(0,a.useCallback)((e=>{if(!s)return;const t=new URLSearchParams(r.location.search);t.set(s,e),r.replace({...r.location,search:t.toString()})}),[s,r])]}function f(e){const{defaultValue:t,queryString:n=!1,groupId:r}=e,s=p(e),[i,l]=(0,a.useState)((()=>function(e){let{defaultValue:t,tabValues:n}=e;if(0===n.length)throw new Error("Docusaurus error: the component requires at least one children component");if(t){if(!h({value:t,tabValues:n}))throw new Error(`Docusaurus error: The has a defaultValue "${t}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return t}const a=n.find((e=>e.default))??n[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:t,tabValues:s}))),[c,u]=m({queryString:n,groupId:r}),[f,v]=function(e){let{groupId:t}=e;const n=function(e){return e?`docusaurus.tab.${e}`:null}(t),[r,s]=(0,d.Dv)(n);return[r,(0,a.useCallback)((e=>{n&&s.set(e)}),[n,s])]}({groupId:r}),b=(()=>{const e=c??f;return h({value:e,tabValues:s})?e:null})();(0,o.A)((()=>{b&&l(b)}),[b]);return{selectedValue:i,selectValue:(0,a.useCallback)((e=>{if(!h({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);l(e),u(e),v(e)}),[u,v,s]),tabValues:s}}var v=n(9536);const b={tabList:"tabList_m2iM",tabItem:"tabItem_yoA2"};var g=n(6070);function x(e){let{className:t,block:n,selectedValue:a,selectValue:i,tabValues:o}=e;const l=[],{blockElementScrollPositionUntilNextRender:c}=(0,s.a_)(),d=e=>{const t=e.currentTarget,n=l.indexOf(t),r=o[n].value;r!==a&&(c(t),i(r))},u=e=>{let t=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":{const n=l.indexOf(e.currentTarget)+1;t=l[n]??l[0];break}case"ArrowLeft":{const n=l.indexOf(e.currentTarget)-1;t=l[n]??l[l.length-1];break}}t?.focus()};return(0,g.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.A)("tabs",{"tabs--block":n},t),children:o.map((e=>{let{value:t,label:n,attributes:s}=e;return(0,g.jsx)("li",{role:"tab",tabIndex:a===t?0:-1,"aria-selected":a===t,ref:e=>l.push(e),onKeyDown:u,onClick:d,...s,className:(0,r.A)("tabs__item",b.tabItem,s?.className,{"tabs__item--active":a===t}),children:n??t},t)}))})}function j(e){let{lazy:t,children:n,selectedValue:r}=e;const s=(Array.isArray(n)?n:[n]).filter(Boolean);if(t){const e=s.find((e=>e.props.value===r));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,g.jsx)("div",{className:"margin-top--md",children:s.map(((e,t)=>(0,a.cloneElement)(e,{key:t,hidden:e.props.value!==r})))})}function y(e){const t=f(e);return(0,g.jsxs)("div",{className:(0,r.A)("tabs-container",b.tabList),children:[(0,g.jsx)(x,{...t,...e}),(0,g.jsx)(j,{...t,...e})]})}function w(e){const t=(0,v.A)();return(0,g.jsx)(y,{...e,children:u(e.children)},String(t))}},5710:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>o});var a=n(758);const r={},s=a.createContext(r);function i(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1d02dd36.7a6f267a.js b/assets/js/1d02dd36.7a6f267a.js new file mode 100644 index 0000000..f34060e --- /dev/null +++ b/assets/js/1d02dd36.7a6f267a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[753],{2611:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var a=t(6070),o=t(5710);const i={id:"pagination",title:"Pagination",sidebar_position:1},s=void 0,r={id:"packages/pagination",title:"Pagination",description:"Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured and",source:"@site/content/packages/pagination.md",sourceDirName:"packages",slug:"/packages/pagination",permalink:"/packages/pagination",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/packages/pagination.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"pagination",title:"Pagination",sidebar_position:1},sidebar:"docsSidebar",previous:{title:"Defer command",permalink:"/interceptors/defer-interceptor"},next:{title:"Localization",permalink:"/packages/localization"}},c={},l=[{value:"Usage",id:"usage",level:2}];function d(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.p,{children:"Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured and\nmanageable way. When dealing with substantial volumes of data, such as search results, articles, or product listings, presenting it all at\nonce can overwhelm users and lead to a poor user experience. Pagination allows you to divide the information into smaller, organized chunks,\nenhancing user engagement and ease of navigation. This module allows you to create a pagination with a few lines of code."}),"\n",(0,a.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,a.jsxs)(n.p,{children:["Once the installation process is complete, we can import the ",(0,a.jsx)(n.code,{children:"NestCordPaginationModule"})," with your ",(0,a.jsx)(n.code,{children:"NestCordModule"})," into the root ",(0,a.jsx)(n.code,{children:"AppModule"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-typescript",children:"import { NestCordModule } from '@globalart/nestcord';\nimport { Module } from '@nestjs/common';\nimport { NestCordPaginationModule } from '@globalart/nestcord';\nimport { AppService } from './app.service';\n\n@Module({\n imports: [\n NestCordModule.forRoot({\n token: 'DISCORD_BOT_TOKEN',\n intents: ['Guilds', 'GuildMessages', 'DirectMessages']\n }),\n NestCordPaginationModule.forRoot({\n // Change your buttons appearance\n buttons: {},\n // Add buttons for skip to first and last page\n allowSkip: true,\n // Add buttons for search page\n allowTraversal: true\n })\n ],\n providers: [AppService]\n})\nexport class AppModule {}\n"})}),"\n",(0,a.jsxs)(n.p,{children:["Then, we can inject the ",(0,a.jsx)(n.code,{children:"PaginationService"})," into our service and register a pagination handler:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-typescript",children:"import { OnModuleInit, Injectable } from '@nestjs/common';\nimport { NestCordPaginationService, PageBuilder } from '@globalart/nestcord/pagination';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService implements OnModuleInit {\n public constructor(private readonly paginationService: NestCordPaginationService) {\n }\n\n public onModuleInit(): void {\n return this.paginationService.register(builder =>\n builder\n // Required, need for search your builder\n .setCustomId('test')\n // First way to set pages\n .setPages([\n new PageBuilder().setContent('Page 1'),\n new PageBuilder().setContent('Page 2'),\n new PageBuilder().setContent('Page 3'),\n new PageBuilder().setContent('Page 4'),\n new PageBuilder().setContent('Page 5')\n ])\n // Second way, you can manually set pages using `setPages` method\n .setPagesFactory(page => new PageBuilder().setContent(`Page ${page}`))\n // Optional, only if you want to use pages factory\n .setMaxPages(5)\n );\n }\n\n @SlashCommand({ name: 'pagination', description: 'Test pagination' })\n public async onPagination(@Context() [interaction]: SlashCommandContext) {\n const pagination = this.paginationService.get('test');\n const page = await pagination.build();\n\n return interaction.reply(page);\n }\n}\n"})}),"\n",(0,a.jsxs)(n.p,{children:["Congratulations! You have successfully created your first pagination!\nJust use ",(0,a.jsx)(n.code,{children:"pagination"})," command and you will see your pagination!"]})]})}function p(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},5710:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>r});var a=t(758);const o={},i=a.createContext(o);function s(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/22dd74f7.0628027a.js b/assets/js/22dd74f7.0628027a.js deleted file mode 100644 index c5e8bae..0000000 --- a/assets/js/22dd74f7.0628027a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[567],{5226:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docsSidebar":[{"type":"link","label":"Introduction","href":"/","docId":"intro","unlisted":false},{"type":"link","label":"Getting Started","href":"/start","docId":"start","unlisted":false},{"type":"link","label":"Listeners","href":"/listeners","docId":"listeners","unlisted":false},{"type":"category","label":"Interactions","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Slash Commands","href":"/interactions/slash-commands","docId":"interactions/slash-commands","unlisted":false},{"type":"link","label":"Context Menus","href":"/interactions/context-menus","docId":"interactions/context-menus","unlisted":false},{"type":"link","label":"Message Components","href":"/interactions/message-components","docId":"interactions/message-components","unlisted":false},{"type":"link","label":"Modals","href":"/interactions/modals","docId":"interactions/modals","unlisted":false}]},{"type":"link","label":"Text Commands","href":"/text-commands","docId":"text-commands","unlisted":false},{"type":"category","label":"Interceptors","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Defer command","href":"/interceptors/defer-interceptor","docId":"interceptors/defer-interceptor","unlisted":false}]},{"type":"category","label":"Recipes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Pagination","href":"/recipes/pagination","docId":"recipes/pagination","unlisted":false},{"type":"link","label":"Localization","href":"/recipes/localization","docId":"recipes/localization","unlisted":false},{"type":"link","label":"Stat Reporter","href":"/recipes/stat-reporter","docId":"recipes/stat-reporter","unlisted":false}]},{"type":"category","label":"Techniques","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Validation","href":"/techniques/validation","docId":"techniques/validation","unlisted":false},{"type":"link","label":"Sharding","href":"/techniques/sharding","docId":"techniques/sharding","unlisted":false},{"type":"link","label":"Async Configuration","href":"/techniques/async-configuration","docId":"techniques/async-configuration","unlisted":false},{"type":"link","label":"Standalone application","href":"/techniques/standalone-application","docId":"techniques/standalone-application","unlisted":false},{"type":"link","label":"Client Providers","href":"/techniques/client-providers","docId":"techniques/client-providers","unlisted":false}]},{"type":"category","label":"Contributing","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Contribution Guide","href":"/contributing/contribution-guide","docId":"contributing/contribution-guide","unlisted":false},{"type":"link","label":"Code of Conduct","href":"/contributing/code-of-conduct","docId":"contributing/code-of-conduct","unlisted":false},{"type":"link","label":"Commit convention","href":"/contributing/commit-convention","docId":"contributing/commit-convention","unlisted":false},{"type":"link","label":"Funding","href":"/contributing/funding","docId":"contributing/funding","unlisted":false}]}]},"docs":{"contributing/code-of-conduct":{"id":"contributing/code-of-conduct","title":"Code of Conduct","description":"Our Pledge","sidebar":"docsSidebar"},"contributing/commit-convention":{"id":"contributing/commit-convention","title":"Commit convention","description":"Git Commit Message Convention","sidebar":"docsSidebar"},"contributing/contribution-guide":{"id":"contributing/contribution-guide","title":"Contribution Guide","description":"If you wish to contribute to the nestcord codebase or documentation, feel free to fork the repository and submit a","sidebar":"docsSidebar"},"contributing/funding":{"id":"contributing/funding","title":"Funding","description":"NestCord is an open source project with its ongoing development made possible thanks to the support by the community.","sidebar":"docsSidebar"},"interactions/context-menus":{"id":"interactions/context-menus","title":"Context Menus","description":"User commands and message commands are now live! These commands appear on context menus for users and messages, with more to come in the future.","sidebar":"docsSidebar"},"interactions/message-components":{"id":"interactions/message-components","title":"Message Components","description":"Message components \u2014 we\'ll call them \\"components\\" moving forward\u2014are a framework for adding interactive elements to the messages your app or bot sends. They\'re accessible, customizable, and easy to use.","sidebar":"docsSidebar"},"interactions/modals":{"id":"interactions/modals","title":"Modals","description":"With modals you can create pop-up forms that allow users to provide you with formatted inputs through submissions. We\'ll cover how to create, show, and receive modal forms using nestcord","sidebar":"docsSidebar"},"interactions/slash-commands":{"id":"interactions/slash-commands","title":"Slash Commands","description":"Slash Commands are the new, exciting way to build and interact with bots on Discord. With Slash Commands, all you have to do is","sidebar":"docsSidebar"},"interceptors/defer-interceptor":{"id":"interceptors/defer-interceptor","title":"Defer command","description":"Interceptor added interaction.deferReply() to the beiginning of the code","sidebar":"docsSidebar"},"intro":{"id":"intro","title":"Introduction","description":"A module for creating Discord bots using NestJS, based on Discord.js.","sidebar":"docsSidebar"},"listeners":{"id":"listeners","title":"Listeners","description":"Listeners are used to listen to events emitted by Discord. They are used to listen to events like `messageCreate`, `interactionCreate`, `guildMemberAdd`, etc.","sidebar":"docsSidebar"},"recipes/localization":{"id":"recipes/localization","title":"Localization","description":"Is a lightweight localization module for NestCord. It allows you to easily localize your bot\'s","sidebar":"docsSidebar"},"recipes/pagination":{"id":"recipes/pagination","title":"Pagination","description":"Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured and","sidebar":"docsSidebar"},"recipes/stat-reporter":{"id":"recipes/stat-reporter","title":"Stat Reporter","description":"Is a lightweight stat reporter module for NestCord. This module sends data from your bot to different monitoring bot services.","sidebar":"docsSidebar"},"start":{"id":"start","title":"Getting Started","description":"Are you ready to get started with nestcord? This guide will help you get started with nestcord, and will show you how to create your first bot!","sidebar":"docsSidebar"},"techniques/async-configuration":{"id":"techniques/async-configuration","title":"Async Configuration","description":"When you need to pass module options asynchronously instead of statically, use the .forRootAsync() method. As with most dynamic modules, Nest provides several techniques to deal with async configuration.","sidebar":"docsSidebar"},"techniques/client-providers":{"id":"techniques/client-providers","title":"Client Providers","description":"NestCord have snippets to access the client and its properties in your application.","sidebar":"docsSidebar"},"techniques/sharding":{"id":"techniques/sharding","title":"Sharding","description":"Discord prevents your bot application from logging in without sharding once you hit a scale of 2,500 guilds. If you are not planning to create a public bot application, then you can go ahead and ignore this section. However, if you are creating a public bot application, it would be wise to keep sharding in mind as it can increase the complexity of your application due to how a sharded process works.","sidebar":"docsSidebar"},"techniques/standalone-application":{"id":"techniques/standalone-application","title":"Standalone application","description":"If you initialized your application with the Nest CLI, Express framework will be installed by default along with Nest. Nest and NestCord does not require Express for work. So if you you don\'t need a web server, you can remove Express.","sidebar":"docsSidebar"},"techniques/validation":{"id":"techniques/validation","title":"Validation","description":"The ValidationPipe is a built-in pipe that can be used to validate data coming from the client. It uses class-validator package under the hood. The ValidationPipe provides a convenient approach to enforce validation rules for all incoming client payloads, where the specific rules are declared with simple annotations in DTO declarations in each module.","sidebar":"docsSidebar"},"text-commands":{"id":"text-commands","title":"Text Commands","description":"Text commands are the most common type of command. They are used to send a message to the channel.","sidebar":"docsSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/22dd74f7.aa312007.js b/assets/js/22dd74f7.aa312007.js new file mode 100644 index 0000000..fdd1382 --- /dev/null +++ b/assets/js/22dd74f7.aa312007.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[567],{5226:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docsSidebar":[{"type":"link","label":"Introduction","href":"/","docId":"intro","unlisted":false},{"type":"link","label":"Getting Started","href":"/start","docId":"start","unlisted":false},{"type":"link","label":"Listeners","href":"/listeners","docId":"listeners","unlisted":false},{"type":"category","label":"Interactions","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Slash Commands","href":"/interactions/slash-commands","docId":"interactions/slash-commands","unlisted":false},{"type":"link","label":"Context Menus","href":"/interactions/context-menus","docId":"interactions/context-menus","unlisted":false},{"type":"link","label":"Message Components","href":"/interactions/message-components","docId":"interactions/message-components","unlisted":false},{"type":"link","label":"Modals","href":"/interactions/modals","docId":"interactions/modals","unlisted":false}]},{"type":"link","label":"Text Commands","href":"/text-commands","docId":"text-commands","unlisted":false},{"type":"category","label":"Interceptors","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Defer command","href":"/interceptors/defer-interceptor","docId":"interceptors/defer-interceptor","unlisted":false}]},{"type":"category","label":"Packages","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Pagination","href":"/packages/pagination","docId":"packages/pagination","unlisted":false},{"type":"link","label":"Localization","href":"/packages/localization","docId":"packages/localization","unlisted":false},{"type":"link","label":"Stat Reporter","href":"/packages/stat-reporter","docId":"packages/stat-reporter","unlisted":false}]},{"type":"category","label":"Techniques","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Validation","href":"/techniques/validation","docId":"techniques/validation","unlisted":false},{"type":"link","label":"Sharding","href":"/techniques/sharding","docId":"techniques/sharding","unlisted":false},{"type":"link","label":"Async Configuration","href":"/techniques/async-configuration","docId":"techniques/async-configuration","unlisted":false},{"type":"link","label":"Standalone application","href":"/techniques/standalone-application","docId":"techniques/standalone-application","unlisted":false},{"type":"link","label":"Client Providers","href":"/techniques/client-providers","docId":"techniques/client-providers","unlisted":false}]},{"type":"category","label":"Contributing","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Contribution Guide","href":"/contributing/contribution-guide","docId":"contributing/contribution-guide","unlisted":false},{"type":"link","label":"Code of Conduct","href":"/contributing/code-of-conduct","docId":"contributing/code-of-conduct","unlisted":false},{"type":"link","label":"Commit convention","href":"/contributing/commit-convention","docId":"contributing/commit-convention","unlisted":false},{"type":"link","label":"Funding","href":"/contributing/funding","docId":"contributing/funding","unlisted":false}]}]},"docs":{"contributing/code-of-conduct":{"id":"contributing/code-of-conduct","title":"Code of Conduct","description":"Our Pledge","sidebar":"docsSidebar"},"contributing/commit-convention":{"id":"contributing/commit-convention","title":"Commit convention","description":"Git Commit Message Convention","sidebar":"docsSidebar"},"contributing/contribution-guide":{"id":"contributing/contribution-guide","title":"Contribution Guide","description":"If you wish to contribute to the nestcord codebase or documentation, feel free to fork the repository and submit a","sidebar":"docsSidebar"},"contributing/funding":{"id":"contributing/funding","title":"Funding","description":"NestCord is an open source project with its ongoing development made possible thanks to the support by the community.","sidebar":"docsSidebar"},"interactions/context-menus":{"id":"interactions/context-menus","title":"Context Menus","description":"User commands and message commands are now live! These commands appear on context menus for users and messages, with more to come in the future.","sidebar":"docsSidebar"},"interactions/message-components":{"id":"interactions/message-components","title":"Message Components","description":"Message components \u2014 we\'ll call them \\"components\\" moving forward\u2014are a framework for adding interactive elements to the messages your app or bot sends. They\'re accessible, customizable, and easy to use.","sidebar":"docsSidebar"},"interactions/modals":{"id":"interactions/modals","title":"Modals","description":"With modals you can create pop-up forms that allow users to provide you with formatted inputs through submissions. We\'ll cover how to create, show, and receive modal forms using nestcord","sidebar":"docsSidebar"},"interactions/slash-commands":{"id":"interactions/slash-commands","title":"Slash Commands","description":"Slash Commands are the new, exciting way to build and interact with bots on Discord. With Slash Commands, all you have to do is","sidebar":"docsSidebar"},"interceptors/defer-interceptor":{"id":"interceptors/defer-interceptor","title":"Defer command","description":"Interceptor added interaction.deferReply() to the beiginning of the code","sidebar":"docsSidebar"},"intro":{"id":"intro","title":"Introduction","description":"A module for creating Discord bots using NestJS, based on Discord.js.","sidebar":"docsSidebar"},"listeners":{"id":"listeners","title":"Listeners","description":"Listeners are used to listen to events emitted by Discord. They are used to listen to events like `messageCreate`, `interactionCreate`, `guildMemberAdd`, etc.","sidebar":"docsSidebar"},"packages/localization":{"id":"packages/localization","title":"Localization","description":"Is a lightweight localization module for NestCord. It allows you to easily localize your bot\'s","sidebar":"docsSidebar"},"packages/pagination":{"id":"packages/pagination","title":"Pagination","description":"Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured and","sidebar":"docsSidebar"},"packages/stat-reporter":{"id":"packages/stat-reporter","title":"Stat Reporter","description":"Is a lightweight stat reporter module for NestCord. This module sends data from your bot to different monitoring bot services.","sidebar":"docsSidebar"},"start":{"id":"start","title":"Getting Started","description":"Are you ready to get started with nestcord? This guide will help you get started with nestcord, and will show you how to create your first bot!","sidebar":"docsSidebar"},"techniques/async-configuration":{"id":"techniques/async-configuration","title":"Async Configuration","description":"When you need to pass module options asynchronously instead of statically, use the .forRootAsync() method. As with most dynamic modules, Nest provides several techniques to deal with async configuration.","sidebar":"docsSidebar"},"techniques/client-providers":{"id":"techniques/client-providers","title":"Client Providers","description":"NestCord have snippets to access the client and its properties in your application.","sidebar":"docsSidebar"},"techniques/sharding":{"id":"techniques/sharding","title":"Sharding","description":"Discord prevents your bot application from logging in without sharding once you hit a scale of 2,500 guilds. If you are not planning to create a public bot application, then you can go ahead and ignore this section. However, if you are creating a public bot application, it would be wise to keep sharding in mind as it can increase the complexity of your application due to how a sharded process works.","sidebar":"docsSidebar"},"techniques/standalone-application":{"id":"techniques/standalone-application","title":"Standalone application","description":"If you initialized your application with the Nest CLI, Express framework will be installed by default along with Nest. Nest and NestCord does not require Express for work. So if you you don\'t need a web server, you can remove Express.","sidebar":"docsSidebar"},"techniques/validation":{"id":"techniques/validation","title":"Validation","description":"The ValidationPipe is a built-in pipe that can be used to validate data coming from the client. It uses class-validator package under the hood. The ValidationPipe provides a convenient approach to enforce validation rules for all incoming client payloads, where the specific rules are declared with simple annotations in DTO declarations in each module.","sidebar":"docsSidebar"},"text-commands":{"id":"text-commands","title":"Text Commands","description":"Text commands are the most common type of command. They are used to send a message to the channel.","sidebar":"docsSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/3c0a97de.6a5c3fdb.js b/assets/js/3c0a97de.6a5c3fdb.js new file mode 100644 index 0000000..370d6fb --- /dev/null +++ b/assets/js/3c0a97de.6a5c3fdb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[597],{3343:t=>{t.exports=JSON.parse('{"allContent":{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","path":"/","tagsPath":"/tags","editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content","editUrlLocalized":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/i18n/en/docusaurus-plugin-content-docs/current","isLast":true,"routePriority":-1,"sidebarFilePath":"/workspaces/nestcord/docs/sidebars.js","contentPath":"/workspaces/nestcord/docs/content","contentPathLocalized":"/workspaces/nestcord/docs/i18n/en/docusaurus-plugin-content-docs/current","docs":[{"id":"contributing/code-of-conduct","title":"Code of Conduct","description":"Our Pledge","source":"@site/content/contributing/code-of-conduct.md","sourceDirName":"contributing","slug":"/contributing/code-of-conduct","permalink":"/contributing/code-of-conduct","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/contributing/code-of-conduct.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"code-of-conduct","title":"Code of Conduct","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Contribution Guide","permalink":"/contributing/contribution-guide"},"next":{"title":"Commit convention","permalink":"/contributing/commit-convention"}},{"id":"contributing/commit-convention","title":"Commit convention","description":"Git Commit Message Convention","source":"@site/content/contributing/commit-convention.md","sourceDirName":"contributing","slug":"/contributing/commit-convention","permalink":"/contributing/commit-convention","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/contributing/commit-convention.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"id":"commit-convention","title":"Commit convention","sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Code of Conduct","permalink":"/contributing/code-of-conduct"},"next":{"title":"Funding","permalink":"/contributing/funding"}},{"id":"contributing/contribution-guide","title":"Contribution Guide","description":"If you wish to contribute to the nestcord codebase or documentation, feel free to fork the repository and submit a","source":"@site/content/contributing/contribution-guide.md","sourceDirName":"contributing","slug":"/contributing/contribution-guide","permalink":"/contributing/contribution-guide","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/contributing/contribution-guide.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"contribution-guide","title":"Contribution Guide","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Client Providers","permalink":"/techniques/client-providers"},"next":{"title":"Code of Conduct","permalink":"/contributing/code-of-conduct"}},{"id":"contributing/funding","title":"Funding","description":"NestCord is an open source project with its ongoing development made possible thanks to the support by the community.","source":"@site/content/contributing/funding.md","sourceDirName":"contributing","slug":"/contributing/funding","permalink":"/contributing/funding","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/contributing/funding.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"id":"funding","title":"Funding","sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"Commit convention","permalink":"/contributing/commit-convention"}},{"id":"interactions/context-menus","title":"Context Menus","description":"User commands and message commands are now live! These commands appear on context menus for users and messages, with more to come in the future.","source":"@site/content/interactions/context-menus.md","sourceDirName":"interactions","slug":"/interactions/context-menus","permalink":"/interactions/context-menus","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interactions/context-menus.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"context-menus","title":"Context Menus","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Slash Commands","permalink":"/interactions/slash-commands"},"next":{"title":"Message Components","permalink":"/interactions/message-components"}},{"id":"interactions/message-components","title":"Message Components","description":"Message components \u2014 we\'ll call them \\"components\\" moving forward\u2014are a framework for adding interactive elements to the messages your app or bot sends. They\'re accessible, customizable, and easy to use.","source":"@site/content/interactions/message-components.md","sourceDirName":"interactions","slug":"/interactions/message-components","permalink":"/interactions/message-components","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interactions/message-components.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"id":"message-components","title":"Message Components","sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Context Menus","permalink":"/interactions/context-menus"},"next":{"title":"Modals","permalink":"/interactions/modals"}},{"id":"interactions/modals","title":"Modals","description":"With modals you can create pop-up forms that allow users to provide you with formatted inputs through submissions. We\'ll cover how to create, show, and receive modal forms using nestcord","source":"@site/content/interactions/modals.md","sourceDirName":"interactions","slug":"/interactions/modals","permalink":"/interactions/modals","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interactions/modals.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"id":"modals","title":"Modals","sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"Message Components","permalink":"/interactions/message-components"},"next":{"title":"Text Commands","permalink":"/text-commands"}},{"id":"interactions/slash-commands","title":"Slash Commands","description":"Slash Commands are the new, exciting way to build and interact with bots on Discord. With Slash Commands, all you have to do is","source":"@site/content/interactions/slash-commands.md","sourceDirName":"interactions","slug":"/interactions/slash-commands","permalink":"/interactions/slash-commands","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interactions/slash-commands.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"slash-commands","title":"Slash Commands","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Listeners","permalink":"/listeners"},"next":{"title":"Context Menus","permalink":"/interactions/context-menus"}},{"id":"interceptors/defer-interceptor","title":"Defer command","description":"Interceptor added interaction.deferReply() to the beiginning of the code","source":"@site/content/interceptors/defer-interceptor.md","sourceDirName":"interceptors","slug":"/interceptors/defer-interceptor","permalink":"/interceptors/defer-interceptor","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interceptors/defer-interceptor.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"defer-interceptor","title":"Defer command","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Text Commands","permalink":"/text-commands"},"next":{"title":"Pagination","permalink":"/packages/pagination"}},{"id":"intro","title":"Introduction","description":"A module for creating Discord bots using NestJS, based on Discord.js.","source":"@site/content/intro.md","sourceDirName":".","slug":"/","permalink":"/","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/intro.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"intro","slug":"/","title":"Introduction","description":"A module for creating Discord bots using NestJS, based on Discord.js.","sidebar_position":1},"sidebar":"docsSidebar","next":{"title":"Getting Started","permalink":"/start"}},{"id":"listeners","title":"Listeners","description":"Listeners are used to listen to events emitted by Discord. They are used to listen to events like `messageCreate`, `interactionCreate`, `guildMemberAdd`, etc.","source":"@site/content/listeners.md","sourceDirName":".","slug":"/listeners","permalink":"/listeners","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/listeners.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"id":"listeners","slug":"listeners","title":"Listeners","description":"Listeners are used to listen to events emitted by Discord. They are used to listen to events like `messageCreate`, `interactionCreate`, `guildMemberAdd`, etc.","sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Getting Started","permalink":"/start"},"next":{"title":"Slash Commands","permalink":"/interactions/slash-commands"}},{"id":"packages/localization","title":"Localization","description":"Is a lightweight localization module for NestCord. It allows you to easily localize your bot\'s","source":"@site/content/packages/localization.md","sourceDirName":"packages","slug":"/packages/localization","permalink":"/packages/localization","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/packages/localization.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"localization","title":"Localization","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Pagination","permalink":"/packages/pagination"},"next":{"title":"Stat Reporter","permalink":"/packages/stat-reporter"}},{"id":"packages/pagination","title":"Pagination","description":"Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured and","source":"@site/content/packages/pagination.md","sourceDirName":"packages","slug":"/packages/pagination","permalink":"/packages/pagination","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/packages/pagination.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"pagination","title":"Pagination","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Defer command","permalink":"/interceptors/defer-interceptor"},"next":{"title":"Localization","permalink":"/packages/localization"}},{"id":"packages/stat-reporter","title":"Stat Reporter","description":"Is a lightweight stat reporter module for NestCord. This module sends data from your bot to different monitoring bot services.","source":"@site/content/packages/stat-reporter.md","sourceDirName":"packages","slug":"/packages/stat-reporter","permalink":"/packages/stat-reporter","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/packages/stat-reporter.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"stat-reporter","title":"Stat Reporter","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Localization","permalink":"/packages/localization"},"next":{"title":"Validation","permalink":"/techniques/validation"}},{"id":"start","title":"Getting Started","description":"Are you ready to get started with nestcord? This guide will help you get started with nestcord, and will show you how to create your first bot!","source":"@site/content/getting-started.md","sourceDirName":".","slug":"/start","permalink":"/start","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/getting-started.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"start","slug":"start","title":"Getting Started","description":"Are you ready to get started with nestcord? This guide will help you get started with nestcord, and will show you how to create your first bot!","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Introduction","permalink":"/"},"next":{"title":"Listeners","permalink":"/listeners"}},{"id":"techniques/async-configuration","title":"Async Configuration","description":"When you need to pass module options asynchronously instead of statically, use the .forRootAsync() method. As with most dynamic modules, Nest provides several techniques to deal with async configuration.","source":"@site/content/techniques/async-configuration.md","sourceDirName":"techniques","slug":"/techniques/async-configuration","permalink":"/techniques/async-configuration","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/async-configuration.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"async-configuration","title":"Async Configuration","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Sharding","permalink":"/techniques/sharding"},"next":{"title":"Standalone application","permalink":"/techniques/standalone-application"}},{"id":"techniques/client-providers","title":"Client Providers","description":"NestCord have snippets to access the client and its properties in your application.","source":"@site/content/techniques/client-providers.md","sourceDirName":"techniques","slug":"/techniques/client-providers","permalink":"/techniques/client-providers","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/client-providers.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"id":"client-providers","title":"Client Providers","sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"Standalone application","permalink":"/techniques/standalone-application"},"next":{"title":"Contribution Guide","permalink":"/contributing/contribution-guide"}},{"id":"techniques/sharding","title":"Sharding","description":"Discord prevents your bot application from logging in without sharding once you hit a scale of 2,500 guilds. If you are not planning to create a public bot application, then you can go ahead and ignore this section. However, if you are creating a public bot application, it would be wise to keep sharding in mind as it can increase the complexity of your application due to how a sharded process works.","source":"@site/content/techniques/sharding.md","sourceDirName":"techniques","slug":"/techniques/sharding","permalink":"/techniques/sharding","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/sharding.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"sharding","title":"Sharding","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Validation","permalink":"/techniques/validation"},"next":{"title":"Async Configuration","permalink":"/techniques/async-configuration"}},{"id":"techniques/standalone-application","title":"Standalone application","description":"If you initialized your application with the Nest CLI, Express framework will be installed by default along with Nest. Nest and NestCord does not require Express for work. So if you you don\'t need a web server, you can remove Express.","source":"@site/content/techniques/standalone-application.md","sourceDirName":"techniques","slug":"/techniques/standalone-application","permalink":"/techniques/standalone-application","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/standalone-application.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"id":"standalone-application","title":"Standalone application","sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Async Configuration","permalink":"/techniques/async-configuration"},"next":{"title":"Client Providers","permalink":"/techniques/client-providers"}},{"id":"techniques/validation","title":"Validation","description":"The ValidationPipe is a built-in pipe that can be used to validate data coming from the client. It uses class-validator package under the hood. The ValidationPipe provides a convenient approach to enforce validation rules for all incoming client payloads, where the specific rules are declared with simple annotations in DTO declarations in each module.","source":"@site/content/techniques/validation.md","sourceDirName":"techniques","slug":"/techniques/validation","permalink":"/techniques/validation","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/validation.md","tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"validation","title":"Validation","sidebar_position":0},"sidebar":"docsSidebar","previous":{"title":"Stat Reporter","permalink":"/packages/stat-reporter"},"next":{"title":"Sharding","permalink":"/techniques/sharding"}},{"id":"text-commands","title":"Text Commands","description":"Text commands are the most common type of command. They are used to send a message to the channel.","source":"@site/content/text-commands.md","sourceDirName":".","slug":"/text-commands","permalink":"/text-commands","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/text-commands.md","tags":[],"version":"current","sidebarPosition":5,"frontMatter":{"id":"text-commands","slug":"text-commands","title":"Text Commands","description":"Text commands are the most common type of command. They are used to send a message to the channel.","sidebar_position":5},"sidebar":"docsSidebar","previous":{"title":"Modals","permalink":"/interactions/modals"},"next":{"title":"Defer command","permalink":"/interceptors/defer-interceptor"}}],"drafts":[],"sidebars":{"docsSidebar":[{"type":"doc","id":"intro"},{"type":"doc","id":"start"},{"type":"doc","id":"listeners"},{"type":"category","label":"Interactions","collapsible":true,"collapsed":false,"items":[{"type":"doc","id":"interactions/slash-commands"},{"type":"doc","id":"interactions/context-menus"},{"type":"doc","id":"interactions/message-components"},{"type":"doc","id":"interactions/modals"}]},{"type":"doc","id":"text-commands"},{"type":"category","label":"Interceptors","collapsible":true,"collapsed":true,"items":[{"type":"doc","id":"interceptors/defer-interceptor"}]},{"type":"category","label":"Packages","collapsible":true,"collapsed":true,"items":[{"type":"doc","id":"packages/pagination"},{"type":"doc","id":"packages/localization"},{"type":"doc","id":"packages/stat-reporter"}]},{"type":"category","label":"Techniques","collapsible":true,"collapsed":true,"items":[{"type":"doc","id":"techniques/validation"},{"type":"doc","id":"techniques/sharding"},{"type":"doc","id":"techniques/async-configuration"},{"type":"doc","id":"techniques/standalone-application"},{"type":"doc","id":"techniques/client-providers"}]},{"type":"category","label":"Contributing","collapsible":true,"collapsed":false,"items":[{"type":"doc","id":"contributing/contribution-guide"},{"type":"doc","id":"contributing/code-of-conduct"},{"type":"doc","id":"contributing/commit-convention"},{"type":"doc","id":"contributing/funding"}]}]}}]}},"docusaurus-plugin-debug":{},"docusaurus-plugin-sitemap":{},"docusaurus-theme-classic":{},"docusaurus-theme-search-algolia":{},"docusaurus-plugin-sass":{},"docusaurus-plugin-pwa":{},"docusaurus-bootstrap-plugin":{},"docusaurus-mdx-fallback-plugin":{}}}')}}]); \ No newline at end of file diff --git a/assets/js/3c0a97de.751b9c63.js b/assets/js/3c0a97de.751b9c63.js deleted file mode 100644 index fd51275..0000000 --- a/assets/js/3c0a97de.751b9c63.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[597],{3343:t=>{t.exports=JSON.parse('{"allContent":{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","path":"/","tagsPath":"/tags","editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content","editUrlLocalized":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/i18n/en/docusaurus-plugin-content-docs/current","isLast":true,"routePriority":-1,"sidebarFilePath":"/workspaces/nestcord/docs/sidebars.js","contentPath":"/workspaces/nestcord/docs/content","contentPathLocalized":"/workspaces/nestcord/docs/i18n/en/docusaurus-plugin-content-docs/current","docs":[{"id":"contributing/code-of-conduct","title":"Code of Conduct","description":"Our Pledge","source":"@site/content/contributing/code-of-conduct.md","sourceDirName":"contributing","slug":"/contributing/code-of-conduct","permalink":"/contributing/code-of-conduct","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/contributing/code-of-conduct.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"code-of-conduct","title":"Code of Conduct","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Contribution Guide","permalink":"/contributing/contribution-guide"},"next":{"title":"Commit convention","permalink":"/contributing/commit-convention"}},{"id":"contributing/commit-convention","title":"Commit convention","description":"Git Commit Message Convention","source":"@site/content/contributing/commit-convention.md","sourceDirName":"contributing","slug":"/contributing/commit-convention","permalink":"/contributing/commit-convention","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/contributing/commit-convention.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"id":"commit-convention","title":"Commit convention","sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Code of Conduct","permalink":"/contributing/code-of-conduct"},"next":{"title":"Funding","permalink":"/contributing/funding"}},{"id":"contributing/contribution-guide","title":"Contribution Guide","description":"If you wish to contribute to the nestcord codebase or documentation, feel free to fork the repository and submit a","source":"@site/content/contributing/contribution-guide.md","sourceDirName":"contributing","slug":"/contributing/contribution-guide","permalink":"/contributing/contribution-guide","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/contributing/contribution-guide.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"contribution-guide","title":"Contribution Guide","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Client Providers","permalink":"/techniques/client-providers"},"next":{"title":"Code of Conduct","permalink":"/contributing/code-of-conduct"}},{"id":"contributing/funding","title":"Funding","description":"NestCord is an open source project with its ongoing development made possible thanks to the support by the community.","source":"@site/content/contributing/funding.md","sourceDirName":"contributing","slug":"/contributing/funding","permalink":"/contributing/funding","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/contributing/funding.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"id":"funding","title":"Funding","sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"Commit convention","permalink":"/contributing/commit-convention"}},{"id":"interactions/context-menus","title":"Context Menus","description":"User commands and message commands are now live! These commands appear on context menus for users and messages, with more to come in the future.","source":"@site/content/interactions/context-menus.md","sourceDirName":"interactions","slug":"/interactions/context-menus","permalink":"/interactions/context-menus","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interactions/context-menus.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"context-menus","title":"Context Menus","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Slash Commands","permalink":"/interactions/slash-commands"},"next":{"title":"Message Components","permalink":"/interactions/message-components"}},{"id":"interactions/message-components","title":"Message Components","description":"Message components \u2014 we\'ll call them \\"components\\" moving forward\u2014are a framework for adding interactive elements to the messages your app or bot sends. They\'re accessible, customizable, and easy to use.","source":"@site/content/interactions/message-components.md","sourceDirName":"interactions","slug":"/interactions/message-components","permalink":"/interactions/message-components","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interactions/message-components.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"id":"message-components","title":"Message Components","sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Context Menus","permalink":"/interactions/context-menus"},"next":{"title":"Modals","permalink":"/interactions/modals"}},{"id":"interactions/modals","title":"Modals","description":"With modals you can create pop-up forms that allow users to provide you with formatted inputs through submissions. We\'ll cover how to create, show, and receive modal forms using nestcord","source":"@site/content/interactions/modals.md","sourceDirName":"interactions","slug":"/interactions/modals","permalink":"/interactions/modals","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interactions/modals.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"id":"modals","title":"Modals","sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"Message Components","permalink":"/interactions/message-components"},"next":{"title":"Text Commands","permalink":"/text-commands"}},{"id":"interactions/slash-commands","title":"Slash Commands","description":"Slash Commands are the new, exciting way to build and interact with bots on Discord. With Slash Commands, all you have to do is","source":"@site/content/interactions/slash-commands.md","sourceDirName":"interactions","slug":"/interactions/slash-commands","permalink":"/interactions/slash-commands","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interactions/slash-commands.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"slash-commands","title":"Slash Commands","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Listeners","permalink":"/listeners"},"next":{"title":"Context Menus","permalink":"/interactions/context-menus"}},{"id":"interceptors/defer-interceptor","title":"Defer command","description":"Interceptor added interaction.deferReply() to the beiginning of the code","source":"@site/content/interceptors/defer-interceptor.md","sourceDirName":"interceptors","slug":"/interceptors/defer-interceptor","permalink":"/interceptors/defer-interceptor","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interceptors/defer-interceptor.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"defer-interceptor","title":"Defer command","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Text Commands","permalink":"/text-commands"},"next":{"title":"Pagination","permalink":"/recipes/pagination"}},{"id":"intro","title":"Introduction","description":"A module for creating Discord bots using NestJS, based on Discord.js.","source":"@site/content/intro.md","sourceDirName":".","slug":"/","permalink":"/","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/intro.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"intro","slug":"/","title":"Introduction","description":"A module for creating Discord bots using NestJS, based on Discord.js.","sidebar_position":1},"sidebar":"docsSidebar","next":{"title":"Getting Started","permalink":"/start"}},{"id":"listeners","title":"Listeners","description":"Listeners are used to listen to events emitted by Discord. They are used to listen to events like `messageCreate`, `interactionCreate`, `guildMemberAdd`, etc.","source":"@site/content/listeners.md","sourceDirName":".","slug":"/listeners","permalink":"/listeners","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/listeners.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"id":"listeners","slug":"listeners","title":"Listeners","description":"Listeners are used to listen to events emitted by Discord. They are used to listen to events like `messageCreate`, `interactionCreate`, `guildMemberAdd`, etc.","sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Getting Started","permalink":"/start"},"next":{"title":"Slash Commands","permalink":"/interactions/slash-commands"}},{"id":"recipes/localization","title":"Localization","description":"Is a lightweight localization module for NestCord. It allows you to easily localize your bot\'s","source":"@site/content/recipes/localization.md","sourceDirName":"recipes","slug":"/recipes/localization","permalink":"/recipes/localization","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/recipes/localization.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"localization","title":"Localization","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Pagination","permalink":"/recipes/pagination"},"next":{"title":"Stat Reporter","permalink":"/recipes/stat-reporter"}},{"id":"recipes/pagination","title":"Pagination","description":"Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured and","source":"@site/content/recipes/pagination.md","sourceDirName":"recipes","slug":"/recipes/pagination","permalink":"/recipes/pagination","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/recipes/pagination.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"pagination","title":"Pagination","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Defer command","permalink":"/interceptors/defer-interceptor"},"next":{"title":"Localization","permalink":"/recipes/localization"}},{"id":"recipes/stat-reporter","title":"Stat Reporter","description":"Is a lightweight stat reporter module for NestCord. This module sends data from your bot to different monitoring bot services.","source":"@site/content/recipes/stat-reporter.md","sourceDirName":"recipes","slug":"/recipes/stat-reporter","permalink":"/recipes/stat-reporter","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/recipes/stat-reporter.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"stat-reporter","title":"Stat Reporter","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Localization","permalink":"/recipes/localization"},"next":{"title":"Validation","permalink":"/techniques/validation"}},{"id":"start","title":"Getting Started","description":"Are you ready to get started with nestcord? This guide will help you get started with nestcord, and will show you how to create your first bot!","source":"@site/content/getting-started.md","sourceDirName":".","slug":"/start","permalink":"/start","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/getting-started.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"start","slug":"start","title":"Getting Started","description":"Are you ready to get started with nestcord? This guide will help you get started with nestcord, and will show you how to create your first bot!","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Introduction","permalink":"/"},"next":{"title":"Listeners","permalink":"/listeners"}},{"id":"techniques/async-configuration","title":"Async Configuration","description":"When you need to pass module options asynchronously instead of statically, use the .forRootAsync() method. As with most dynamic modules, Nest provides several techniques to deal with async configuration.","source":"@site/content/techniques/async-configuration.md","sourceDirName":"techniques","slug":"/techniques/async-configuration","permalink":"/techniques/async-configuration","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/async-configuration.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"id":"async-configuration","title":"Async Configuration","sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Sharding","permalink":"/techniques/sharding"},"next":{"title":"Standalone application","permalink":"/techniques/standalone-application"}},{"id":"techniques/client-providers","title":"Client Providers","description":"NestCord have snippets to access the client and its properties in your application.","source":"@site/content/techniques/client-providers.md","sourceDirName":"techniques","slug":"/techniques/client-providers","permalink":"/techniques/client-providers","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/client-providers.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"id":"client-providers","title":"Client Providers","sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"Standalone application","permalink":"/techniques/standalone-application"},"next":{"title":"Contribution Guide","permalink":"/contributing/contribution-guide"}},{"id":"techniques/sharding","title":"Sharding","description":"Discord prevents your bot application from logging in without sharding once you hit a scale of 2,500 guilds. If you are not planning to create a public bot application, then you can go ahead and ignore this section. However, if you are creating a public bot application, it would be wise to keep sharding in mind as it can increase the complexity of your application due to how a sharded process works.","source":"@site/content/techniques/sharding.md","sourceDirName":"techniques","slug":"/techniques/sharding","permalink":"/techniques/sharding","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/sharding.md","tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"id":"sharding","title":"Sharding","sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Validation","permalink":"/techniques/validation"},"next":{"title":"Async Configuration","permalink":"/techniques/async-configuration"}},{"id":"techniques/standalone-application","title":"Standalone application","description":"If you initialized your application with the Nest CLI, Express framework will be installed by default along with Nest. Nest and NestCord does not require Express for work. So if you you don\'t need a web server, you can remove Express.","source":"@site/content/techniques/standalone-application.md","sourceDirName":"techniques","slug":"/techniques/standalone-application","permalink":"/techniques/standalone-application","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/standalone-application.md","tags":[],"version":"current","sidebarPosition":3,"frontMatter":{"id":"standalone-application","title":"Standalone application","sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Async Configuration","permalink":"/techniques/async-configuration"},"next":{"title":"Client Providers","permalink":"/techniques/client-providers"}},{"id":"techniques/validation","title":"Validation","description":"The ValidationPipe is a built-in pipe that can be used to validate data coming from the client. It uses class-validator package under the hood. The ValidationPipe provides a convenient approach to enforce validation rules for all incoming client payloads, where the specific rules are declared with simple annotations in DTO declarations in each module.","source":"@site/content/techniques/validation.md","sourceDirName":"techniques","slug":"/techniques/validation","permalink":"/techniques/validation","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/techniques/validation.md","tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"validation","title":"Validation","sidebar_position":0},"sidebar":"docsSidebar","previous":{"title":"Stat Reporter","permalink":"/recipes/stat-reporter"},"next":{"title":"Sharding","permalink":"/techniques/sharding"}},{"id":"text-commands","title":"Text Commands","description":"Text commands are the most common type of command. They are used to send a message to the channel.","source":"@site/content/text-commands.md","sourceDirName":".","slug":"/text-commands","permalink":"/text-commands","draft":false,"unlisted":false,"editUrl":"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/text-commands.md","tags":[],"version":"current","sidebarPosition":5,"frontMatter":{"id":"text-commands","slug":"text-commands","title":"Text Commands","description":"Text commands are the most common type of command. They are used to send a message to the channel.","sidebar_position":5},"sidebar":"docsSidebar","previous":{"title":"Modals","permalink":"/interactions/modals"},"next":{"title":"Defer command","permalink":"/interceptors/defer-interceptor"}}],"drafts":[],"sidebars":{"docsSidebar":[{"type":"doc","id":"intro"},{"type":"doc","id":"start"},{"type":"doc","id":"listeners"},{"type":"category","label":"Interactions","collapsible":true,"collapsed":false,"items":[{"type":"doc","id":"interactions/slash-commands"},{"type":"doc","id":"interactions/context-menus"},{"type":"doc","id":"interactions/message-components"},{"type":"doc","id":"interactions/modals"}]},{"type":"doc","id":"text-commands"},{"type":"category","label":"Interceptors","collapsible":true,"collapsed":true,"items":[{"type":"doc","id":"interceptors/defer-interceptor"}]},{"type":"category","label":"Recipes","collapsible":true,"collapsed":true,"items":[{"type":"doc","id":"recipes/pagination"},{"type":"doc","id":"recipes/localization"},{"type":"doc","id":"recipes/stat-reporter"}]},{"type":"category","label":"Techniques","collapsible":true,"collapsed":true,"items":[{"type":"doc","id":"techniques/validation"},{"type":"doc","id":"techniques/sharding"},{"type":"doc","id":"techniques/async-configuration"},{"type":"doc","id":"techniques/standalone-application"},{"type":"doc","id":"techniques/client-providers"}]},{"type":"category","label":"Contributing","collapsible":true,"collapsed":false,"items":[{"type":"doc","id":"contributing/contribution-guide"},{"type":"doc","id":"contributing/code-of-conduct"},{"type":"doc","id":"contributing/commit-convention"},{"type":"doc","id":"contributing/funding"}]}]}}]}},"docusaurus-plugin-debug":{},"docusaurus-plugin-sitemap":{},"docusaurus-theme-classic":{},"docusaurus-theme-search-algolia":{},"docusaurus-plugin-sass":{},"docusaurus-plugin-pwa":{},"docusaurus-bootstrap-plugin":{},"docusaurus-mdx-fallback-plugin":{}}}')}}]); \ No newline at end of file diff --git a/assets/js/63e38a2b.86c96c09.js b/assets/js/63e38a2b.86c96c09.js deleted file mode 100644 index 76adebd..0000000 --- a/assets/js/63e38a2b.86c96c09.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[123],{8029:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var r=o(6070),n=o(5710);const s={id:"stat-reporter",title:"Stat Reporter",sidebar_position:2},i=void 0,a={id:"recipes/stat-reporter",title:"Stat Reporter",description:"Is a lightweight stat reporter module for NestCord. This module sends data from your bot to different monitoring bot services.",source:"@site/content/recipes/stat-reporter.md",sourceDirName:"recipes",slug:"/recipes/stat-reporter",permalink:"/recipes/stat-reporter",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/recipes/stat-reporter.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"stat-reporter",title:"Stat Reporter",sidebar_position:2},sidebar:"docsSidebar",previous:{title:"Localization",permalink:"/recipes/localization"},next:{title:"Validation",permalink:"/techniques/validation"}},d={},c=[{value:"Usage",id:"usage",level:2}];function l(e){const t={code:"code",h2:"h2",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Is a lightweight stat reporter module for NestCord. This module sends data from your bot to different monitoring bot services."}),"\n",(0,r.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,r.jsxs)(t.p,{children:["Once the installation process is complete, we can import the ",(0,r.jsx)(t.code,{children:"NestCordStatReporterModule"})," with your ",(0,r.jsx)(t.code,{children:"NestCordModule"})," into the root ",(0,r.jsx)(t.code,{children:"AppModule"}),":"]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",children:"import { Module } from '@nestjs/common';\nimport { AppService } from './app.service';\nimport { NestCordModule, \n NestCordStatReporterModule, \n StatCronExpression, \n NestCordLocalizationModule, \n DefaultLocalizationAdapter, \n UserResolver \n} from '@globalart/nestcord';\n\n@Module({\n imports: [\n NestCordModule.forRoot({\n token: process.env.DISCORD_TOKEN,\n intents: [\n IntentsBitField.Flags.Guilds,\n IntentsBitField.Flags.DirectMessages,\n IntentsBitField.Flags.GuildMembers,\n IntentsBitField.Flags.GuildMessages,\n IntentsBitField.Flags.MessageContent\n ],\n prefix: '!',\n development: [process.env.DISCORD_TEST_GUILD]\n }),\n NestCordStatReporterModule.forRoot({\n services: [\n {\n name: 'top.gg',\n url: 'https://top.gg/bots/:bot_id/stats',\n bodyData: { server_count: '{{serverCount}}', shard_count: '{{shardCount}}' },\n headerData: { Authorization: process.env.TOP_GG_TOKEN },\n schedule: StatCronExpression.EVERY_5_MINUTES // or you can use crontab expression like */1 * * * * ,\n },\n ],\n }),\n ],\n providers: [AppService]\n})\nexport class AppModule {\n}\n"})}),"\n",(0,r.jsxs)(t.p,{children:["In ",(0,r.jsx)(t.code,{children:"services"}),", all the services on which the bot is monitored should be listed, and the request body should be passed. ",(0,r.jsx)(t.code,{children:"{{serverCount}}"})," and ",(0,r.jsx)(t.code,{children:"{{shardCount}}"})," will be automatically replaced."]}),"\n",(0,r.jsx)(t.p,{children:"Congratulations! You have successfully register cronjob with NestCord!"})]})}function p(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},5710:(e,t,o)=>{o.d(t,{R:()=>i,x:()=>a});var r=o(758);const n={},s=r.createContext(n);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/66d9f3df.c421a468.js b/assets/js/66d9f3df.c421a468.js new file mode 100644 index 0000000..0137ff3 --- /dev/null +++ b/assets/js/66d9f3df.c421a468.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[329],{3731:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var n=o(6070),r=o(5710);const s={id:"stat-reporter",title:"Stat Reporter",sidebar_position:2},i=void 0,a={id:"packages/stat-reporter",title:"Stat Reporter",description:"Is a lightweight stat reporter module for NestCord. This module sends data from your bot to different monitoring bot services.",source:"@site/content/packages/stat-reporter.md",sourceDirName:"packages",slug:"/packages/stat-reporter",permalink:"/packages/stat-reporter",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/packages/stat-reporter.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"stat-reporter",title:"Stat Reporter",sidebar_position:2},sidebar:"docsSidebar",previous:{title:"Localization",permalink:"/packages/localization"},next:{title:"Validation",permalink:"/techniques/validation"}},d={},c=[{value:"Usage",id:"usage",level:2}];function l(e){const t={code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Is a lightweight stat reporter module for NestCord. This module sends data from your bot to different monitoring bot services."}),"\n",(0,n.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,n.jsxs)(t.p,{children:["Once the installation process is complete, we can import the ",(0,n.jsx)(t.code,{children:"NestCordStatReporterModule"})," with your ",(0,n.jsx)(t.code,{children:"NestCordModule"})," into the root ",(0,n.jsx)(t.code,{children:"AppModule"}),":"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-typescript",children:"import { Module } from '@nestjs/common';\nimport { AppService } from './app.service';\nimport { NestCordModule, \n NestCordStatReporterModule, \n StatCronExpression, \n NestCordLocalizationModule, \n DefaultLocalizationAdapter, \n UserResolver \n} from '@globalart/nestcord';\n\n@Module({\n imports: [\n NestCordModule.forRoot({\n token: process.env.DISCORD_TOKEN,\n intents: [\n IntentsBitField.Flags.Guilds,\n IntentsBitField.Flags.DirectMessages,\n IntentsBitField.Flags.GuildMembers,\n IntentsBitField.Flags.GuildMessages,\n IntentsBitField.Flags.MessageContent\n ],\n prefix: '!',\n development: [process.env.DISCORD_TEST_GUILD]\n }),\n NestCordStatReporterModule.forRoot({\n services: [\n {\n name: 'top.gg',\n url: 'https://top.gg/bots/:bot_id/stats',\n bodyData: { server_count: '{{serverCount}}', shard_count: '{{shardCount}}' },\n headerData: { Authorization: process.env.TOP_GG_TOKEN },\n schedule: StatCronExpression.EVERY_5_MINUTES // or you can use crontab expression like */1 * * * * ,\n },\n ],\n }),\n ],\n providers: [AppService]\n})\nexport class AppModule {\n}\n"})}),"\n",(0,n.jsxs)(t.p,{children:["In ",(0,n.jsx)(t.code,{children:"services"}),", all the services on which the bot is monitored should be listed, and the request body should be passed. ",(0,n.jsx)(t.code,{children:"{{serverCount}}"})," and ",(0,n.jsx)(t.code,{children:"{{shardCount}}"})," will be automatically replaced."]}),"\n",(0,n.jsx)(t.p,{children:"Congratulations! You have successfully register cronjob with NestCord!"})]})}function p(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},5710:(e,t,o)=>{o.d(t,{R:()=>i,x:()=>a});var n=o(758);const r={},s=n.createContext(r);function i(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bf4f2dd0.5153520f.js b/assets/js/bf4f2dd0.5153520f.js deleted file mode 100644 index fb7b648..0000000 --- a/assets/js/bf4f2dd0.5153520f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[179],{6157:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=t(6070),a=t(5710);const i={id:"pagination",title:"Pagination",sidebar_position:1},r=void 0,s={id:"recipes/pagination",title:"Pagination",description:"Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured and",source:"@site/content/recipes/pagination.md",sourceDirName:"recipes",slug:"/recipes/pagination",permalink:"/recipes/pagination",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/recipes/pagination.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"pagination",title:"Pagination",sidebar_position:1},sidebar:"docsSidebar",previous:{title:"Defer command",permalink:"/interceptors/defer-interceptor"},next:{title:"Localization",permalink:"/recipes/localization"}},c={},l=[{value:"Usage",id:"usage",level:2}];function d(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:"Certainly! Pagination is a useful technique employed in user interfaces to present large amounts of information in a structured and\nmanageable way. When dealing with substantial volumes of data, such as search results, articles, or product listings, presenting it all at\nonce can overwhelm users and lead to a poor user experience. Pagination allows you to divide the information into smaller, organized chunks,\nenhancing user engagement and ease of navigation. This module allows you to create a pagination with a few lines of code."}),"\n",(0,o.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,o.jsxs)(n.p,{children:["Once the installation process is complete, we can import the ",(0,o.jsx)(n.code,{children:"NestCordPaginationModule"})," with your ",(0,o.jsx)(n.code,{children:"NestCordModule"})," into the root ",(0,o.jsx)(n.code,{children:"AppModule"}),":"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-typescript",children:"import { NestCordModule } from '@globalart/nestcord';\nimport { Module } from '@nestjs/common';\nimport { NestCordPaginationModule } from '@globalart/nestcord';\nimport { AppService } from './app.service';\n\n@Module({\n imports: [\n NestCordModule.forRoot({\n token: 'DISCORD_BOT_TOKEN',\n intents: ['Guilds', 'GuildMessages', 'DirectMessages']\n }),\n NestCordPaginationModule.forRoot({\n // Change your buttons appearance\n buttons: {},\n // Add buttons for skip to first and last page\n allowSkip: true,\n // Add buttons for search page\n allowTraversal: true\n })\n ],\n providers: [AppService]\n})\nexport class AppModule {}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Then, we can inject the ",(0,o.jsx)(n.code,{children:"PaginationService"})," into our service and register a pagination handler:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-typescript",children:"import { OnModuleInit, Injectable } from '@nestjs/common';\nimport { NestCordPaginationService, PageBuilder } from '@globalart/nestcord/pagination';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService implements OnModuleInit {\n public constructor(private readonly paginationService: NestCordPaginationService) {\n }\n\n public onModuleInit(): void {\n return this.paginationService.register(builder =>\n builder\n // Required, need for search your builder\n .setCustomId('test')\n // First way to set pages\n .setPages([\n new PageBuilder().setContent('Page 1'),\n new PageBuilder().setContent('Page 2'),\n new PageBuilder().setContent('Page 3'),\n new PageBuilder().setContent('Page 4'),\n new PageBuilder().setContent('Page 5')\n ])\n // Second way, you can manually set pages using `setPages` method\n .setPagesFactory(page => new PageBuilder().setContent(`Page ${page}`))\n // Optional, only if you want to use pages factory\n .setMaxPages(5)\n );\n }\n\n @SlashCommand({ name: 'pagination', description: 'Test pagination' })\n public async onPagination(@Context() [interaction]: SlashCommandContext) {\n const pagination = this.paginationService.get('test');\n const page = await pagination.build();\n\n return interaction.reply(page);\n }\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Congratulations! You have successfully created your first pagination!\nJust use ",(0,o.jsx)(n.code,{children:"pagination"})," command and you will see your pagination!"]})]})}function p(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},5710:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>s});var o=t(758);const a={},i=o.createContext(a);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d291a071.4e06f95c.js b/assets/js/d291a071.4e06f95c.js new file mode 100644 index 0000000..ff389dd --- /dev/null +++ b/assets/js/d291a071.4e06f95c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[504],{3988:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=n(6070),o=n(5710);const i={id:"defer-interceptor",title:"Defer command",sidebar_position:1},c=void 0,s={id:"interceptors/defer-interceptor",title:"Defer command",description:"Interceptor added interaction.deferReply() to the beiginning of the code",source:"@site/content/interceptors/defer-interceptor.md",sourceDirName:"interceptors",slug:"/interceptors/defer-interceptor",permalink:"/interceptors/defer-interceptor",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interceptors/defer-interceptor.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"defer-interceptor",title:"Defer command",sidebar_position:1},sidebar:"docsSidebar",previous:{title:"Text Commands",permalink:"/text-commands"},next:{title:"Pagination",permalink:"/packages/pagination"}},a={},d=[{value:"Usage",id:"usage",level:2}];function p(e){const t={code:"code",h2:"h2",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(t.p,{children:["Interceptor added ",(0,r.jsx)(t.code,{children:"interaction.deferReply()"})," to the beiginning of the code"]}),"\n",(0,r.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",metastring:'title="src/app.service.ts"',children:"import {\n Context,\n SlashCommand,\n SlashCommandContext,\n DeferCommandInterceptor,\n} from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService {\n @UseInterceptors(DeferCommandInterceptor)\n @SlashCommand({\n name: 'ping',\n description: 'pong',\n })\n async execute(@Context() [interaction]: SlashCommandContext) {\n setTimeout(() => interaction.followUp({ content: 'Pong!' }), 5000);\n }\n}\n\n"})})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},5710:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>s});var r=n(758);const o={},i=r.createContext(o);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d291a071.4e1a6eb6.js b/assets/js/d291a071.4e1a6eb6.js deleted file mode 100644 index b5487e4..0000000 --- a/assets/js/d291a071.4e1a6eb6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[504],{3988:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=n(6070),o=n(5710);const i={id:"defer-interceptor",title:"Defer command",sidebar_position:1},c=void 0,s={id:"interceptors/defer-interceptor",title:"Defer command",description:"Interceptor added interaction.deferReply() to the beiginning of the code",source:"@site/content/interceptors/defer-interceptor.md",sourceDirName:"interceptors",slug:"/interceptors/defer-interceptor",permalink:"/interceptors/defer-interceptor",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/interceptors/defer-interceptor.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"defer-interceptor",title:"Defer command",sidebar_position:1},sidebar:"docsSidebar",previous:{title:"Text Commands",permalink:"/text-commands"},next:{title:"Pagination",permalink:"/recipes/pagination"}},a={},d=[{value:"Usage",id:"usage",level:2}];function p(e){const t={code:"code",h2:"h2",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(t.p,{children:["Interceptor added ",(0,r.jsx)(t.code,{children:"interaction.deferReply()"})," to the beiginning of the code"]}),"\n",(0,r.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-typescript",metastring:'title="src/app.service.ts"',children:"import {\n Context,\n SlashCommand,\n SlashCommandContext,\n DeferCommandInterceptor,\n} from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService {\n @UseInterceptors(DeferCommandInterceptor)\n @SlashCommand({\n name: 'ping',\n description: 'pong',\n })\n async execute(@Context() [interaction]: SlashCommandContext) {\n setTimeout(() => interaction.followUp({ content: 'Pong!' }), 5000);\n }\n}\n\n"})})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},5710:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>s});var r=n(758);const o={},i=r.createContext(o);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d347213b.e5485d6a.js b/assets/js/d347213b.e5485d6a.js deleted file mode 100644 index 92c79b5..0000000 --- a/assets/js/d347213b.e5485d6a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[467],{6584:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var t=o(6070),a=o(5710);const i={id:"localization",title:"Localization",sidebar_position:2},s=void 0,l={id:"recipes/localization",title:"Localization",description:"Is a lightweight localization module for NestCord. It allows you to easily localize your bot's",source:"@site/content/recipes/localization.md",sourceDirName:"recipes",slug:"/recipes/localization",permalink:"/recipes/localization",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/recipes/localization.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"localization",title:"Localization",sidebar_position:2},sidebar:"docsSidebar",previous:{title:"Pagination",permalink:"/recipes/pagination"},next:{title:"Stat Reporter",permalink:"/recipes/stat-reporter"}},r={},c=[{value:"Usage",id:"usage",level:2},{value:"Adapters",id:"adapters",level:2},{value:"Custom Adapters",id:"custom-adapters",level:4},{value:"Resolvers",id:"resolvers",level:2},{value:"Custom Resolvers",id:"custom-resolvers",level:4},{value:"Localization",id:"localization",level:2},{value:"Setting up localized commands",id:"setting-up-localized-commands",level:4}];function d(n){const e={a:"a",admonition:"admonition",code:"code",h2:"h2",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,a.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(e.p,{children:["Is a lightweight localization module for ",(0,t.jsx)(e.a,{href:"https://nestcord.globalart.dev/",children:"NestCord"}),". It allows you to easily localize your bot's\ncommands and messages. The module provides a simple API for managing locales and translations, as well as a powerful localization adapter\nsystem."]}),"\n",(0,t.jsx)(e.h2,{id:"usage",children:"Usage"}),"\n",(0,t.jsxs)(e.p,{children:["Once the installation process is complete, we can import the ",(0,t.jsx)(e.code,{children:"NestCordLocalizationModule"})," with your ",(0,t.jsx)(e.code,{children:"NestCordModule"})," into the root ",(0,t.jsx)(e.code,{children:"AppModule"}),":"]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",children:"import { NestCordModule } from '@globalart/nestcord';\nimport { Module } from '@nestjs/common';\nimport { NestCordLocalizationModule, DefaultLocalizationAdapter, UserResolver } from '@globalart/nestcord';\nimport { AppService } from './app.service';\n\n@Module({\n imports: [\n NestCordModule.forRoot({\n token: process.env.DISCORD_TOKEN,\n intents: [\n IntentsBitField.Flags.Guilds,\n IntentsBitField.Flags.DirectMessages,\n IntentsBitField.Flags.GuildMembers,\n IntentsBitField.Flags.GuildMessages,\n IntentsBitField.Flags.MessageContent\n ],\n prefix: '!',\n development: [process.env.DISCORD_TEST_GUILD]\n }),\n NestCordLocalizationModule.forRoot({\n resolvers: UserResolver,\n // Also you can provide class for support injection by @Inject\n adapter: new DefaultLocalizationAdapter({\n fallbackLocale: 'en-US',\n locales: {\n 'en-US': {\n 'commands.ping.name': 'ping',\n 'commands.ping.description': 'Pong!'\n },\n ru: {\n 'commands.ping.name': '\u043f\u0438\u043d\u0433',\n 'commands.ping.description': '\u041f\u043e\u043d\u0433!'\n }\n }\n })\n })\n ],\n providers: [AppService]\n})\nexport class AppModule {\n}\n"})}),"\n",(0,t.jsx)(e.h2,{id:"adapters",children:"Adapters"}),"\n",(0,t.jsxs)(e.p,{children:["The ",(0,t.jsx)(e.code,{children:"DefaultLocalizationAdapter"})," is a simple adapter that allows you to provide a map of locales and translations."]}),"\n",(0,t.jsxs)(e.p,{children:["Also you can use the ",(0,t.jsx)(e.code,{children:"NestedLocalizationAdapter"})," that allows you to organize translation keys into objects"]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",children:"import { NestCordLocalizationModule, NestedLocalizationAdapter, UserResolver } from '@globalart/nestcord/localization';\n\nNestCordLocalizationModule.forRoot({\n resolvers: UserResolver,\n adapter: new NestedLocalizationAdapter({\n fallbackLocale: 'en-US',\n locales: {\n 'en-US': {\n 'commands': {\n 'ping': {\n 'name': 'ping',\n 'description': 'Pong!'\n }\n }\n },\n ru: {\n 'commands': {\n 'ping': {\n 'name': '\u043f\u0438\u043d\u0433',\n 'description': '\u041f\u043e\u043d\u0433!'\n }\n }\n }\n }\n })\n})\n\n"})}),"\n",(0,t.jsx)(e.admonition,{type:"info",children:(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"DefaultLocalizationAdapter"})," and ",(0,t.jsx)(e.code,{children:"NestedLocalizationAdapter"})," can translate your localization strings and placeholders (e.g ",(0,t.jsx)(e.code,{children:"{{username}}"}),")"]})}),"\n",(0,t.jsx)(e.h4,{id:"custom-adapters",children:"Custom Adapters"}),"\n",(0,t.jsxs)(e.p,{children:["Also, you can create your own localization adapter. Just implement the ",(0,t.jsx)(e.code,{children:"BaseLocalizationAdapter"})," interface:"]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",children:"import { BaseLocalizationAdapter } from '@globalart/nestcord/localization';\n\ninterface CustomLocalizationOptions {\n fallbackLocale: string;\n locales: Record>;\n}\n\nexport class CustomLocalizationAdapter extends BaseLocalizationAdapter {\n public getTranslation(key: string, locale: string, ...args: any[]): string {\n return `${key} by ${locale}`;\n }\n}\n"})}),"\n",(0,t.jsx)(e.h2,{id:"resolvers",children:"Resolvers"}),"\n",(0,t.jsxs)(e.p,{children:["Resolvers are used to get the locale for translation. By default, NestCord provides two resolvers: ",(0,t.jsx)(e.code,{children:"UserResolver"})," and ",(0,t.jsx)(e.code,{children:"GuildResolver"}),"."]}),"\n",(0,t.jsxs)(e.table,{children:[(0,t.jsx)(e.thead,{children:(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.th,{children:"Resolver"}),(0,t.jsx)(e.th,{children:"Description"})]})}),(0,t.jsxs)(e.tbody,{children:[(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.td,{children:"UserResolver"}),(0,t.jsxs)(e.td,{children:["Gets the locale from the user's locale property (",(0,t.jsx)(e.code,{children:"interaction.locale"}),")"]})]}),(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.td,{children:"GuildResolver"}),(0,t.jsxs)(e.td,{children:["Gets the locale from the guild's locale property (",(0,t.jsx)(e.code,{children:"interaction.guildLocale"}),")"]})]})]})]}),"\n",(0,t.jsx)(e.h4,{id:"custom-resolvers",children:"Custom Resolvers"}),"\n",(0,t.jsxs)(e.p,{children:["Also, you can create your own Resolver. Just implement the ",(0,t.jsx)(e.code,{children:"LocaleResolver"})," interface:"]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",children:"import { CommandContext, LocaleResolver } from '@globalart/nestcord';\nimport { ExecutionContext, Injectable } from '@nestjs/common';\nimport { NestCordExecutionContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class GuildResolver implements LocaleResolver {\n resolve(context: ExecutionContext): string | string[] | undefined {\n const nestcordContext = NestCordExecutionContext.create(context);\n const [interaction] = nestcordContext.getContext();\n\n return interaction.guildLocale;\n }\n}\n"})}),"\n",(0,t.jsx)(e.h2,{id:"localization",children:"Localization"}),"\n",(0,t.jsxs)(e.p,{children:["We can inject the ",(0,t.jsx)(e.code,{children:"LOCALIZATION_ADAPTER"})," into our service and use it to localize our commands and messages:"]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",metastring:'title="src/app.gateway.ts"',children:"import { Injectable, Inject, OnModuleInit } from '@nestjs/common';\nimport { DefaultLocalizationAdapter, localizationMapByKey, LOCALIZATION_ADAPTER } from '@globalart/nestcord';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService implements OnModuleInit {\n public constructor(\n @Inject(LOCALIZATION_ADAPTER)\n private readonly localizationAdapter: DefaultLocalizationAdapter\n ) {\n }\n\n @SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: localizationMapByKey('commands.ping.name'),\n descriptionLocalizations: localizationMapByKey('commands.ping.name')\n })\n public ping(@Context() [interaction]: SlashCommandContext) {\n const message = this.localizationAdapter.getTranslation(\n 'commands.ping.description',\n interaction.locale\n );\n return interaction.reply(message);\n }\n}\n"})}),"\n",(0,t.jsxs)(e.p,{children:["Or you can use ",(0,t.jsx)(e.code,{children:"translate"})," function from the localization adapter:"]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",metastring:'title="src/app.gateway.ts"',children:"import { Injectable, Inject, OnModuleInit } from '@nestjs/common';\nimport { DefaultLocalizationAdapter, localizationMapByKey, LOCALIZATION_ADAPTER } from '@globalart/nestcord';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService implements OnModuleInit {\n public constructor(\n @Inject(LOCALIZATION_ADAPTER)\n private readonly localizationAdapter: DefaultLocalizationAdapter\n ) {\n }\n\n @SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: localizationMapByKey('commands.ping.name'),\n descriptionLocalizations: localizationMapByKey('commands.ping.name')\n })\n public ping(@Context() [interaction]: SlashCommandContext) {\n const message = this.localizationAdapter.translate(\n 'commands.ping.description',\n );\n return interaction.reply(message);\n }\n}\n"})}),"\n",(0,t.jsxs)(e.p,{children:["Or you can use ",(0,t.jsx)(e.code,{children:"@CurrentTranslate"})," decorator to get the current translation from context:"]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",children:"import { Injectable, Inject, OnModuleInit } from '@nestjs/common';\nimport { DefaultLocalizationAdapter, CurrentTranslate, localizationMapByKey, TranslationFn } from '@globalart/nestcord/localization';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService implements OnModuleInit {\n @SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: localizationMapByKey('commands.ping.name'),\n descriptionLocalizations: localizationMapByKey('commands.ping.name')\n })\n public ping(\n @Context() [interaction]: SlashCommandContext,\n @CurrentTranslate() t: TranslationFn\n ) {\n const message = t('commands.ping.description');\n return interaction.reply(message);\n }\n}\n"})}),"\n",(0,t.jsx)(e.admonition,{type:"info",children:(0,t.jsxs)(e.p,{children:["Function ",(0,t.jsx)(e.code,{children:"localizationMapByKey"})," are used to localize the command name and description. You pass the translation key or localization map as\nan argument to the function."]})}),"\n",(0,t.jsx)(e.h4,{id:"setting-up-localized-commands",children:"Setting up localized commands"}),"\n",(0,t.jsx)(e.p,{children:"You can set what locales the command will be localized"}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",children:"@SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: localizationMapByKey('commands.ping.name', ['en', 'ru']),\n descriptionLocalizations: localizationMapByKey('commands.ping.name', ['en', 'ru'])\n})\n"})}),"\n",(0,t.jsxs)(e.p,{children:["Or just pass a localization object with the location id and translation key to the ",(0,t.jsx)(e.code,{children:"nameLocalization"})," and ",(0,t.jsx)(e.code,{children:"descriptionLocalizations"}),"\nproperties"]}),"\n",(0,t.jsx)(e.pre,{children:(0,t.jsx)(e.code,{className:"language-typescript",children:"@SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: {\n en: 'command.ping.name',\n ru: 'command.ping.name'\n },\n descriptionLocalizations: {\n en: 'command.ping.description',\n ru: 'command.ping.description'\n }\n})\n"})}),"\n",(0,t.jsx)(e.p,{children:"Congratulations! You have successfully created your first localized command with NestCord!"})]})}function p(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(d,{...n})}):d(n)}},5710:(n,e,o)=>{o.d(e,{R:()=>s,x:()=>l});var t=o(758);const a={},i=t.createContext(a);function s(n){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function l(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),t.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/ebd218ab.e0e7ca1c.js b/assets/js/ebd218ab.e0e7ca1c.js new file mode 100644 index 0000000..ff31e69 --- /dev/null +++ b/assets/js/ebd218ab.e0e7ca1c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[793],{5506:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var o=t(6070),a=t(5710);const i={id:"localization",title:"Localization",sidebar_position:2},s=void 0,l={id:"packages/localization",title:"Localization",description:"Is a lightweight localization module for NestCord. It allows you to easily localize your bot's",source:"@site/content/packages/localization.md",sourceDirName:"packages",slug:"/packages/localization",permalink:"/packages/localization",draft:!1,unlisted:!1,editUrl:"https://github.com/GlobalArtInc/nestcord/tree/master/docs/content/packages/localization.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"localization",title:"Localization",sidebar_position:2},sidebar:"docsSidebar",previous:{title:"Pagination",permalink:"/packages/pagination"},next:{title:"Stat Reporter",permalink:"/packages/stat-reporter"}},r={},c=[{value:"Usage",id:"usage",level:2},{value:"Adapters",id:"adapters",level:2},{value:"Custom Adapters",id:"custom-adapters",level:4},{value:"Resolvers",id:"resolvers",level:2},{value:"Custom Resolvers",id:"custom-resolvers",level:4},{value:"Localization",id:"localization",level:2},{value:"Setting up localized commands",id:"setting-up-localized-commands",level:4},{value:"Update localization without restarting the app",id:"update-localization-without-restarting-the-app",level:2}];function d(n){const e={a:"a",admonition:"admonition",code:"code",h2:"h2",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,a.R)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(e.p,{children:["Is a lightweight localization module for ",(0,o.jsx)(e.a,{href:"https://nestcord.globalart.dev/",children:"NestCord"}),". It allows you to easily localize your bot's\ncommands and messages. The module provides a simple API for managing locales and translations, as well as a powerful localization adapter\nsystem."]}),"\n",(0,o.jsx)(e.h2,{id:"usage",children:"Usage"}),"\n",(0,o.jsxs)(e.p,{children:["Once the installation process is complete, we can import the ",(0,o.jsx)(e.code,{children:"NestCordLocalizationModule"})," with your ",(0,o.jsx)(e.code,{children:"NestCordModule"})," into the root ",(0,o.jsx)(e.code,{children:"AppModule"}),":"]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",children:"import { NestCordModule } from '@globalart/nestcord';\nimport { Module } from '@nestjs/common';\nimport { NestCordLocalizationModule, DefaultLocalizationAdapter, UserResolver } from '@globalart/nestcord';\nimport { AppService } from './app.service';\n\n@Module({\n imports: [\n NestCordModule.forRoot({\n token: process.env.DISCORD_TOKEN,\n intents: [\n IntentsBitField.Flags.Guilds,\n IntentsBitField.Flags.DirectMessages,\n IntentsBitField.Flags.GuildMembers,\n IntentsBitField.Flags.GuildMessages,\n IntentsBitField.Flags.MessageContent\n ],\n prefix: '!',\n development: [process.env.DISCORD_TEST_GUILD]\n }),\n NestCordLocalizationModule.forRoot({\n resolvers: UserResolver,\n // Also you can provide class for support injection by @Inject\n adapter: new DefaultLocalizationAdapter({\n fallbackLocale: 'en-US',\n locales: {\n 'en-US': {\n 'commands.ping.name': 'ping',\n 'commands.ping.description': 'Pong!'\n },\n ru: {\n 'commands.ping.name': '\u043f\u0438\u043d\u0433',\n 'commands.ping.description': '\u041f\u043e\u043d\u0433!'\n }\n }\n })\n })\n ],\n providers: [AppService]\n})\nexport class AppModule {\n}\n"})}),"\n",(0,o.jsx)(e.h2,{id:"adapters",children:"Adapters"}),"\n",(0,o.jsxs)(e.p,{children:["The ",(0,o.jsx)(e.code,{children:"DefaultLocalizationAdapter"})," is a simple adapter that allows you to provide a map of locales and translations."]}),"\n",(0,o.jsxs)(e.p,{children:["Also you can use the ",(0,o.jsx)(e.code,{children:"NestedLocalizationAdapter"})," that allows you to organize translation keys into objects"]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",children:"import { NestCordLocalizationModule, NestedLocalizationAdapter, UserResolver } from '@globalart/nestcord/localization';\n\nNestCordLocalizationModule.forRoot({\n resolvers: UserResolver,\n adapter: new NestedLocalizationAdapter({\n fallbackLocale: 'en-US',\n locales: {\n 'en-US': {\n 'commands': {\n 'ping': {\n 'name': 'ping',\n 'description': 'Pong!'\n }\n }\n },\n ru: {\n 'commands': {\n 'ping': {\n 'name': '\u043f\u0438\u043d\u0433',\n 'description': '\u041f\u043e\u043d\u0433!'\n }\n }\n }\n }\n })\n})\n\n"})}),"\n",(0,o.jsx)(e.admonition,{type:"info",children:(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"DefaultLocalizationAdapter"})," and ",(0,o.jsx)(e.code,{children:"NestedLocalizationAdapter"})," can translate your localization strings and placeholders (e.g ",(0,o.jsx)(e.code,{children:"{{username}}"}),")"]})}),"\n",(0,o.jsx)(e.h4,{id:"custom-adapters",children:"Custom Adapters"}),"\n",(0,o.jsxs)(e.p,{children:["Also, you can create your own localization adapter. Just implement the ",(0,o.jsx)(e.code,{children:"BaseLocalizationAdapter"})," interface:"]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",children:"import { BaseLocalizationAdapter } from '@globalart/nestcord/localization';\n\ninterface CustomLocalizationOptions {\n fallbackLocale: string;\n locales: Record>;\n}\n\nexport class CustomLocalizationAdapter extends BaseLocalizationAdapter {\n public getTranslation(key: string, locale: string, ...args: unknown[]): string {\n return `${key} by ${locale}`;\n }\n}\n"})}),"\n",(0,o.jsx)(e.h2,{id:"resolvers",children:"Resolvers"}),"\n",(0,o.jsxs)(e.p,{children:["Resolvers are used to get the locale for translation. By default, NestCord provides two resolvers: ",(0,o.jsx)(e.code,{children:"UserResolver"})," and ",(0,o.jsx)(e.code,{children:"GuildResolver"}),"."]}),"\n",(0,o.jsxs)(e.table,{children:[(0,o.jsx)(e.thead,{children:(0,o.jsxs)(e.tr,{children:[(0,o.jsx)(e.th,{children:"Resolver"}),(0,o.jsx)(e.th,{children:"Description"})]})}),(0,o.jsxs)(e.tbody,{children:[(0,o.jsxs)(e.tr,{children:[(0,o.jsx)(e.td,{children:"UserResolver"}),(0,o.jsxs)(e.td,{children:["Gets the locale from the user's locale property (",(0,o.jsx)(e.code,{children:"interaction.locale"}),")"]})]}),(0,o.jsxs)(e.tr,{children:[(0,o.jsx)(e.td,{children:"GuildResolver"}),(0,o.jsxs)(e.td,{children:["Gets the locale from the guild's locale property (",(0,o.jsx)(e.code,{children:"interaction.guildLocale"}),")"]})]})]})]}),"\n",(0,o.jsx)(e.h4,{id:"custom-resolvers",children:"Custom Resolvers"}),"\n",(0,o.jsxs)(e.p,{children:["Also, you can create your own Resolver. Just implement the ",(0,o.jsx)(e.code,{children:"LocaleResolver"})," interface:"]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",children:"import { CommandContext, LocaleResolver } from '@globalart/nestcord';\nimport { ExecutionContext, Injectable } from '@nestjs/common';\nimport { NestCordExecutionContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class GuildResolver implements LocaleResolver {\n resolve(context: ExecutionContext): string | string[] | undefined {\n const nestcordContext = NestCordExecutionContext.create(context);\n const [interaction] = nestcordContext.getContext();\n\n return interaction.guildLocale;\n }\n}\n"})}),"\n",(0,o.jsx)(e.h2,{id:"localization",children:"Localization"}),"\n",(0,o.jsxs)(e.p,{children:["We can inject the ",(0,o.jsx)(e.code,{children:"LOCALIZATION_ADAPTER"})," into our service and use it to localize our commands and messages:"]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",metastring:'title="src/app.gateway.ts"',children:"import { Injectable, Inject, OnModuleInit } from '@nestjs/common';\nimport { DefaultLocalizationAdapter, localizationMapByKey, LOCALIZATION_ADAPTER } from '@globalart/nestcord';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService implements OnModuleInit {\n public constructor(\n @Inject(LOCALIZATION_ADAPTER)\n private readonly localizationAdapter: DefaultLocalizationAdapter\n ) {\n }\n\n @SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: localizationMapByKey('commands.ping.name'),\n descriptionLocalizations: localizationMapByKey('commands.ping.name')\n })\n public ping(@Context() [interaction]: SlashCommandContext) {\n const message = this.localizationAdapter.getTranslation(\n 'commands.ping.description',\n interaction.locale\n );\n return interaction.reply(message);\n }\n}\n"})}),"\n",(0,o.jsxs)(e.p,{children:["Or you can use ",(0,o.jsx)(e.code,{children:"translate"})," function from the localization adapter:"]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",metastring:'title="src/app.gateway.ts"',children:"import { Injectable, Inject, OnModuleInit } from '@nestjs/common';\nimport { DefaultLocalizationAdapter, localizationMapByKey, LOCALIZATION_ADAPTER } from '@globalart/nestcord';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService implements OnModuleInit {\n public constructor(\n @Inject(LOCALIZATION_ADAPTER)\n private readonly localizationAdapter: DefaultLocalizationAdapter\n ) {\n }\n\n @SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: localizationMapByKey('commands.ping.name'),\n descriptionLocalizations: localizationMapByKey('commands.ping.name')\n })\n public ping(@Context() [interaction]: SlashCommandContext) {\n const message = this.localizationAdapter.translate(\n 'commands.ping.description',\n );\n return interaction.reply(message);\n }\n}\n"})}),"\n",(0,o.jsxs)(e.p,{children:["Or you can use ",(0,o.jsx)(e.code,{children:"@CurrentTranslate"})," decorator to get the current translation from context:"]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",children:"import { Injectable, Inject, OnModuleInit } from '@nestjs/common';\nimport { DefaultLocalizationAdapter, CurrentTranslate, localizationMapByKey, TranslationFn } from '@globalart/nestcord/localization';\nimport { Context, SlashCommand, SlashCommandContext } from '@globalart/nestcord';\n\n@Injectable()\nexport class AppService implements OnModuleInit {\n @SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: localizationMapByKey('commands.ping.name'),\n descriptionLocalizations: localizationMapByKey('commands.ping.name')\n })\n public ping(\n @Context() [interaction]: SlashCommandContext,\n @CurrentTranslate() t: TranslationFn\n ) {\n const message = t('commands.ping.description');\n return interaction.reply(message);\n }\n}\n"})}),"\n",(0,o.jsx)(e.admonition,{type:"info",children:(0,o.jsxs)(e.p,{children:["Function ",(0,o.jsx)(e.code,{children:"localizationMapByKey"})," are used to localize the command name and description. You pass the translation key or localization map as\nan argument to the function."]})}),"\n",(0,o.jsx)(e.h4,{id:"setting-up-localized-commands",children:"Setting up localized commands"}),"\n",(0,o.jsx)(e.p,{children:"You can set what locales the command will be localized"}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",children:"@SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: localizationMapByKey('commands.ping.name', ['en', 'ru']),\n descriptionLocalizations: localizationMapByKey('commands.ping.name', ['en', 'ru'])\n})\n"})}),"\n",(0,o.jsxs)(e.p,{children:["Or just pass a localization object with the location id and translation key to the ",(0,o.jsx)(e.code,{children:"nameLocalization"})," and ",(0,o.jsx)(e.code,{children:"descriptionLocalizations"}),"\nproperties"]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",children:"@SlashCommand({\n name: 'ping',\n description: 'Pong!',\n nameLocalizations: {\n en: 'command.ping.name',\n ru: 'command.ping.name'\n },\n descriptionLocalizations: {\n en: 'command.ping.description',\n ru: 'command.ping.description'\n }\n})\n"})}),"\n",(0,o.jsx)(e.h2,{id:"update-localization-without-restarting-the-app",children:"Update localization without restarting the app"}),"\n",(0,o.jsxs)(e.p,{children:["If you get translations from the external API, for example, crowdin, weblate, or another translation services.\nYou can update it just call the ",(0,o.jsx)(e.code,{children:"localizationService"})]}),"\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{className:"language-typescript",children:"import {\n Context,\n NestCordLocalizationService,\n SlashCommand,\n SlashCommandContext,\n} from '@globalart/nestcord';\n\nexport class AppService {\n constructor(\n private readonly nestCordLocalizationService: NestCordLocalizationService,\n ) {}\n\n @SlashCommand({\n name: 'update_translations',\n description: 'Update translations',\n })\n updateTranslations(@Context() [interaction]: SlashCommandContext) {\n // Get translations logic\n this.nestCordLocalizationService.updateLocales({\n // or you can put it from API\n 'en-US': {\n 'commands.ping.description': 'My new translation',\n },\n });\n\n return interaction.reply({ content: \"Updated successful\" });\n }\n}\n"})}),"\n",(0,o.jsx)(e.p,{children:"Congratulations! You have successfully created your first localized command with NestCord!"})]})}function p(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(d,{...n})}):d(n)}},5710:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>l});var o=t(758);const a={},i=o.createContext(a);function s(n){const e=o.useContext(i);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function l(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),o.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/ede3a018.f855efc6.js b/assets/js/ede3a018.3bb38c40.js similarity index 98% rename from assets/js/ede3a018.f855efc6.js rename to assets/js/ede3a018.3bb38c40.js index a9720c4..0702d2a 100644 --- a/assets/js/ede3a018.f855efc6.js +++ b/assets/js/ede3a018.3bb38c40.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[361],{105:(e,a,n)=>{n.r(a),n.d(a,{default:()=>c});n(758);var l=n(2909),t=n(3531),o=n(893),s=n(6070);function c(){const e=(0,l.Ay)();return(0,s.jsxs)(t.A,{children:[(0,s.jsx)("h2",{children:"Global data"}),(0,s.jsx)(o.A,{src:e,collapseDepth:3})]})}},893:(e,a,n)=>{n.d(a,{A:()=>M});var l=n(758);const t=e=>"boolean"==typeof e||e instanceof Boolean,o=e=>"number"==typeof e||e instanceof Number,s=e=>"bigint"==typeof e||e instanceof BigInt,c=e=>!!e&&e instanceof Date,r=e=>"string"==typeof e||e instanceof String,u=e=>Array.isArray(e),i=e=>e instanceof Object&&null!==e;let d=1;const p=()=>d++;function m(e){let{field:a,value:n,data:t,lastElement:o,openBracket:s,closeBracket:c,level:r,style:u,shouldExpandNode:i,clickToExpandNode:d}=e;const m=(0,l.useRef)(!1),[b,_,x]=function(e){const[a,n]=(0,l.useState)(e());return[a,()=>n((e=>!e)),n]}((()=>i(r,n,a)));(0,l.useEffect)((()=>{m.current?x(i(r,n,a)):m.current=!0}),[i]);const E=b?u.collapseIcon:u.expandIcon,f=b?"collapse JSON":"expand JSON",h=function(){const e=(0,l.useRef)();return void 0===e.current&&(e.current=`:jsnvw:${p()}:`),e.current}(),N=r+1,g=t.length-1,y=e=>{" "===e.key&&(e.preventDefault(),_())};return(0,l.createElement)("div",{className:u.basicChildStyle,role:"list"},(0,l.createElement)("span",{className:E,onClick:_,onKeyDown:y,role:"button",tabIndex:0,"aria-label":f,"aria-expanded":b,"aria-controls":b?h:void 0}),a&&(d?(0,l.createElement)("span",{className:u.clickableLabel,onClick:_,onKeyDown:y,role:"button",tabIndex:-1},a,":"):(0,l.createElement)("span",{className:u.label},a,":")),(0,l.createElement)("span",{className:u.punctuation},s),b?(0,l.createElement)("div",{id:h},t.map(((e,a)=>(0,l.createElement)(v,{key:e[0]||a,field:e[0],value:e[1],style:u,lastElement:a===g,level:N,shouldExpandNode:i,clickToExpandNode:d})))):(0,l.createElement)("span",{className:u.collapsedContent,onClick:_,onKeyDown:y,role:"button",tabIndex:-1,"aria-hidden":!0,"aria-label":f,"aria-expanded":b}),(0,l.createElement)("span",{className:u.punctuation},c),!o&&(0,l.createElement)("span",{className:u.punctuation},","))}function b(e){let{field:a,value:n,style:l,lastElement:t,shouldExpandNode:o,clickToExpandNode:s,level:c}=e;return m({field:a,value:n,lastElement:t||!1,level:c,openBracket:"{",closeBracket:"}",style:l,shouldExpandNode:o,clickToExpandNode:s,data:Object.keys(n).map((e=>[e,n[e]]))})}function _(e){let{field:a,value:n,style:l,lastElement:t,level:o,shouldExpandNode:s,clickToExpandNode:c}=e;return m({field:a,value:n,lastElement:t||!1,level:o,openBracket:"[",closeBracket:"]",style:l,shouldExpandNode:s,clickToExpandNode:c,data:n.map((e=>[void 0,e]))})}function x(e){let{field:a,value:n,style:u,lastElement:i}=e,d=n,p=u.otherValue;return null===n?(d="null",p=u.nullValue):void 0===n?(d="undefined",p=u.undefinedValue):r(n)?(d=u.noQuotesForStringValues?n:`"${n}"`,p=u.stringValue):t(n)?(d=n?"true":"false",p=u.booleanValue):o(n)?(d=n.toString(),p=u.numberValue):s(n)?(d=`${n.toString()}n`,p=u.numberValue):d=c(n)?n.toISOString():n.toString(),""===a&&(a='""'),(0,l.createElement)("div",{className:u.basicChildStyle,role:"listitem"},a&&(0,l.createElement)("span",{className:u.label},a,":"),(0,l.createElement)("span",{className:p},d),!i&&(0,l.createElement)("span",{className:u.punctuation},","))}function v(e){const a=e.value;return u(a)?(0,l.createElement)(_,Object.assign({},e)):i(a)&&!c(a)?(0,l.createElement)(b,Object.assign({},e)):(0,l.createElement)(x,Object.assign({},e))}var E="_2bkNM";const f={container:"_2IvMF _GzYRV",basicChildStyle:E,label:"_1MGIk",clickableLabel:"_2YKJg _1MGIk _1MFti",nullValue:"_2T6PJ",undefinedValue:"_1Gho6",stringValue:"_vGjyY",booleanValue:"_3zQKs",numberValue:"_1bQdo",otherValue:"_1xvuR",punctuation:"_3uHL6 _3eOF8",collapseIcon:"_oLqym _f10Tu _1MFti _1LId0",expandIcon:"_2AXVT _f10Tu _1MFti _1UmXx",collapsedContent:"_2KJWg _1pNG9 _1MFti",noQuotesForStringValues:!1},h=()=>!0,N=e=>{let{data:a,style:n=f,shouldExpandNode:t=h,clickToExpandNode:o=!1}=e;return(0,l.createElement)("div",{className:n.container},(0,l.createElement)(v,{value:a,style:n,lastElement:!0,level:0,shouldExpandNode:t,clickToExpandNode:o}))},g="containerParaiso_jgBV",y="basicElementParaiso_SW3X",k="labelParaiso_DUc9",V="nullValueParaiso_VWbb",j="undefinedValueParaiso_D8iR",I="stringValueParaiso_yRY9",S="booleanValueParaiso_yFdn",C="numberValueParaiso_PlgG",P="otherValueParaiso_aoD5",T="punctuationParaiso_T3yT",A="expandIconParaiso_LpAZ",D="collapseIconParaiso_HgdB",F="collapseContentParaiso_Kx6x";var B=n(6070);const G={container:g,basicChildStyle:y,label:k,nullValue:V,undefinedValue:j,stringValue:I,booleanValue:S,numberValue:C,otherValue:P,punctuation:T,collapseIcon:D,expandIcon:A,collapsedContent:F};function M(e){let{src:a,collapseDepth:n}=e;return(0,B.jsx)(N,{data:a,shouldExpandNode:(e,a)=>Array.isArray(a)?a.length<5:void 0!==n&&e{n.d(a,{A:()=>r});n(758);var l=n(2871),t=n(977);const o={container:"container_jrgN",nav:"nav_Y2UF",navlink:"navlink_ueN0",active:"active_toc_"};var s=n(6070);function c(e){let{to:a,children:n}=e;return(0,s.jsx)(t.A,{className:o.navlink,isNavLink:!0,to:a,exact:!0,activeStyle:{backgroundColor:"#363739"},children:n})}function r(e){let{children:a}=e;return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(l.A,{children:[(0,s.jsx)("html",{lang:"en"}),(0,s.jsx)("title",{children:"Docusaurus debug panel"}),(0,s.jsx)("meta",{name:"robots",content:"noindex"})]}),(0,s.jsxs)("div",{children:[(0,s.jsxs)("nav",{className:o.nav,children:[(0,s.jsx)(c,{to:"/__docusaurus/debug",children:"Config"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/metadata",children:"Metadata"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/registry",children:"Registry"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/routes",children:"Routes"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/content",children:"Content"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/globalData",children:"Global data"})]}),(0,s.jsx)("main",{className:o.container,children:a})]})]})}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[123],{105:(e,a,n)=>{n.r(a),n.d(a,{default:()=>c});n(758);var l=n(2909),t=n(3531),o=n(893),s=n(6070);function c(){const e=(0,l.Ay)();return(0,s.jsxs)(t.A,{children:[(0,s.jsx)("h2",{children:"Global data"}),(0,s.jsx)(o.A,{src:e,collapseDepth:3})]})}},893:(e,a,n)=>{n.d(a,{A:()=>M});var l=n(758);const t=e=>"boolean"==typeof e||e instanceof Boolean,o=e=>"number"==typeof e||e instanceof Number,s=e=>"bigint"==typeof e||e instanceof BigInt,c=e=>!!e&&e instanceof Date,r=e=>"string"==typeof e||e instanceof String,u=e=>Array.isArray(e),i=e=>e instanceof Object&&null!==e;let d=1;const p=()=>d++;function m(e){let{field:a,value:n,data:t,lastElement:o,openBracket:s,closeBracket:c,level:r,style:u,shouldExpandNode:i,clickToExpandNode:d}=e;const m=(0,l.useRef)(!1),[b,_,x]=function(e){const[a,n]=(0,l.useState)(e());return[a,()=>n((e=>!e)),n]}((()=>i(r,n,a)));(0,l.useEffect)((()=>{m.current?x(i(r,n,a)):m.current=!0}),[i]);const E=b?u.collapseIcon:u.expandIcon,f=b?"collapse JSON":"expand JSON",h=function(){const e=(0,l.useRef)();return void 0===e.current&&(e.current=`:jsnvw:${p()}:`),e.current}(),N=r+1,g=t.length-1,y=e=>{" "===e.key&&(e.preventDefault(),_())};return(0,l.createElement)("div",{className:u.basicChildStyle,role:"list"},(0,l.createElement)("span",{className:E,onClick:_,onKeyDown:y,role:"button",tabIndex:0,"aria-label":f,"aria-expanded":b,"aria-controls":b?h:void 0}),a&&(d?(0,l.createElement)("span",{className:u.clickableLabel,onClick:_,onKeyDown:y,role:"button",tabIndex:-1},a,":"):(0,l.createElement)("span",{className:u.label},a,":")),(0,l.createElement)("span",{className:u.punctuation},s),b?(0,l.createElement)("div",{id:h},t.map(((e,a)=>(0,l.createElement)(v,{key:e[0]||a,field:e[0],value:e[1],style:u,lastElement:a===g,level:N,shouldExpandNode:i,clickToExpandNode:d})))):(0,l.createElement)("span",{className:u.collapsedContent,onClick:_,onKeyDown:y,role:"button",tabIndex:-1,"aria-hidden":!0,"aria-label":f,"aria-expanded":b}),(0,l.createElement)("span",{className:u.punctuation},c),!o&&(0,l.createElement)("span",{className:u.punctuation},","))}function b(e){let{field:a,value:n,style:l,lastElement:t,shouldExpandNode:o,clickToExpandNode:s,level:c}=e;return m({field:a,value:n,lastElement:t||!1,level:c,openBracket:"{",closeBracket:"}",style:l,shouldExpandNode:o,clickToExpandNode:s,data:Object.keys(n).map((e=>[e,n[e]]))})}function _(e){let{field:a,value:n,style:l,lastElement:t,level:o,shouldExpandNode:s,clickToExpandNode:c}=e;return m({field:a,value:n,lastElement:t||!1,level:o,openBracket:"[",closeBracket:"]",style:l,shouldExpandNode:s,clickToExpandNode:c,data:n.map((e=>[void 0,e]))})}function x(e){let{field:a,value:n,style:u,lastElement:i}=e,d=n,p=u.otherValue;return null===n?(d="null",p=u.nullValue):void 0===n?(d="undefined",p=u.undefinedValue):r(n)?(d=u.noQuotesForStringValues?n:`"${n}"`,p=u.stringValue):t(n)?(d=n?"true":"false",p=u.booleanValue):o(n)?(d=n.toString(),p=u.numberValue):s(n)?(d=`${n.toString()}n`,p=u.numberValue):d=c(n)?n.toISOString():n.toString(),""===a&&(a='""'),(0,l.createElement)("div",{className:u.basicChildStyle,role:"listitem"},a&&(0,l.createElement)("span",{className:u.label},a,":"),(0,l.createElement)("span",{className:p},d),!i&&(0,l.createElement)("span",{className:u.punctuation},","))}function v(e){const a=e.value;return u(a)?(0,l.createElement)(_,Object.assign({},e)):i(a)&&!c(a)?(0,l.createElement)(b,Object.assign({},e)):(0,l.createElement)(x,Object.assign({},e))}var E="_2bkNM";const f={container:"_2IvMF _GzYRV",basicChildStyle:E,label:"_1MGIk",clickableLabel:"_2YKJg _1MGIk _1MFti",nullValue:"_2T6PJ",undefinedValue:"_1Gho6",stringValue:"_vGjyY",booleanValue:"_3zQKs",numberValue:"_1bQdo",otherValue:"_1xvuR",punctuation:"_3uHL6 _3eOF8",collapseIcon:"_oLqym _f10Tu _1MFti _1LId0",expandIcon:"_2AXVT _f10Tu _1MFti _1UmXx",collapsedContent:"_2KJWg _1pNG9 _1MFti",noQuotesForStringValues:!1},h=()=>!0,N=e=>{let{data:a,style:n=f,shouldExpandNode:t=h,clickToExpandNode:o=!1}=e;return(0,l.createElement)("div",{className:n.container},(0,l.createElement)(v,{value:a,style:n,lastElement:!0,level:0,shouldExpandNode:t,clickToExpandNode:o}))},g="containerParaiso_jgBV",y="basicElementParaiso_SW3X",k="labelParaiso_DUc9",V="nullValueParaiso_VWbb",j="undefinedValueParaiso_D8iR",I="stringValueParaiso_yRY9",S="booleanValueParaiso_yFdn",C="numberValueParaiso_PlgG",P="otherValueParaiso_aoD5",T="punctuationParaiso_T3yT",A="expandIconParaiso_LpAZ",D="collapseIconParaiso_HgdB",F="collapseContentParaiso_Kx6x";var B=n(6070);const G={container:g,basicChildStyle:y,label:k,nullValue:V,undefinedValue:j,stringValue:I,booleanValue:S,numberValue:C,otherValue:P,punctuation:T,collapseIcon:D,expandIcon:A,collapsedContent:F};function M(e){let{src:a,collapseDepth:n}=e;return(0,B.jsx)(N,{data:a,shouldExpandNode:(e,a)=>Array.isArray(a)?a.length<5:void 0!==n&&e{n.d(a,{A:()=>r});n(758);var l=n(2871),t=n(977);const o={container:"container_jrgN",nav:"nav_Y2UF",navlink:"navlink_ueN0",active:"active_toc_"};var s=n(6070);function c(e){let{to:a,children:n}=e;return(0,s.jsx)(t.A,{className:o.navlink,isNavLink:!0,to:a,exact:!0,activeStyle:{backgroundColor:"#363739"},children:n})}function r(e){let{children:a}=e;return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(l.A,{children:[(0,s.jsx)("html",{lang:"en"}),(0,s.jsx)("title",{children:"Docusaurus debug panel"}),(0,s.jsx)("meta",{name:"robots",content:"noindex"})]}),(0,s.jsxs)("div",{children:[(0,s.jsxs)("nav",{className:o.nav,children:[(0,s.jsx)(c,{to:"/__docusaurus/debug",children:"Config"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/metadata",children:"Metadata"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/registry",children:"Registry"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/routes",children:"Routes"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/content",children:"Content"}),(0,s.jsx)(c,{to:"/__docusaurus/debug/globalData",children:"Global data"})]}),(0,s.jsx)("main",{className:o.container,children:a})]})]})}}}]); \ No newline at end of file diff --git a/assets/js/main.427c2bb1.js b/assets/js/main.427c2bb1.js deleted file mode 100644 index c9c1ac3..0000000 --- a/assets/js/main.427c2bb1.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! For license information please see main.427c2bb1.js.LICENSE.txt */ -(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[792],{7158:(e,t,n)=>{"use strict";n.d(t,{W:()=>a});var r=n(758);function a(){return r.createElement("svg",{width:"20",height:"20",className:"DocSearch-Search-Icon",viewBox:"0 0 20 20","aria-hidden":"true"},r.createElement("path",{d:"M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z",stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinecap:"round",strokeLinejoin:"round"}))}},4207:(e,t,n)=>{var r={"./":6532};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=4207},8244:(e,t,n)=>{"use strict";n.d(t,{A:()=>r});const r={"003b49f9":[()=>n.e(506).then(n.bind(n,5514)),"@site/content/contributing/code-of-conduct.md",5514],"0b6bdc6b":[()=>n.e(886).then(n.bind(n,3773)),"@site/content/interactions/message-components.md",3773],"107a3993":[()=>Promise.all([n.e(869),n.e(936)]).then(n.bind(n,1590)),"@site/content/techniques/validation.md",1590],17896441:[()=>Promise.all([n.e(869),n.e(401)]).then(n.bind(n,1490)),"@theme/DocItem",1490],"1a4e3797":[()=>Promise.all([n.e(869),n.e(138)]).then(n.bind(n,2766)),"@theme/SearchPage",2766],"22dd74f7":[()=>n.e(567).then(n.t.bind(n,5226,19)),"@generated/docusaurus-plugin-content-docs/default/p/index-466.json",5226],"23abe487":[()=>Promise.all([n.e(869),n.e(911)]).then(n.bind(n,7496)),"@theme/DebugConfig",7496],"393eff57":[()=>n.e(531).then(n.bind(n,7134)),"@site/content/techniques/async-configuration.md",7134],"3c0a97de":[()=>n.e(597).then(n.t.bind(n,3343,19)),"@generated/docusaurus-plugin-debug/default/p/docusaurus-debug-content-0d5.json",3343],"5aea931f":[()=>Promise.all([n.e(869),n.e(174)]).then(n.bind(n,1161)),"@site/content/getting-started.md",1161],"5ca74542":[()=>n.e(984).then(n.bind(n,6503)),"@site/content/contributing/funding.md",6503],"5e95c892":[()=>n.e(647).then(n.bind(n,2503)),"@theme/DocsRoot",2503],"63e38a2b":[()=>n.e(123).then(n.bind(n,8029)),"@site/content/recipes/stat-reporter.md",8029],"6794d4cd":[()=>Promise.all([n.e(869),n.e(680)]).then(n.bind(n,7971)),"@theme/DebugRegistry",7971],"68e633d4":[()=>Promise.all([n.e(869),n.e(254)]).then(n.bind(n,3872)),"@theme/DebugSiteMetadata",3872],"6c4d718c":[()=>n.e(713).then(n.bind(n,301)),"@site/content/techniques/sharding.md",301],"717a4525":[()=>n.e(365).then(n.bind(n,3785)),"@site/content/text-commands.md",3785],"7d07d949":[()=>n.e(981).then(n.bind(n,2088)),"@site/content/listeners.md",2088],"7eb5a8bf":[()=>n.e(539).then(n.bind(n,6717)),"@site/content/techniques/client-providers.md",6717],"946bd85a":[()=>Promise.all([n.e(869),n.e(610)]).then(n.bind(n,7884)),"@theme/DebugRoutes",7884],"9ce5ed71":[()=>n.e(810).then(n.bind(n,5761)),"@site/content/interactions/context-menus.md",5761],"9eb1dac9":[()=>n.e(315).then(n.bind(n,2593)),"@site/content/techniques/standalone-application.md",2593],a4b529fe:[()=>n.e(399).then(n.bind(n,3435)),"@site/content/contributing/contribution-guide.md",3435],a7bd4aaa:[()=>n.e(98).then(n.bind(n,5322)),"@theme/DocVersionRoot",5322],a7f4de78:[()=>n.e(978).then(n.bind(n,6745)),"@site/content/interactions/slash-commands.md",6745],a94703ab:[()=>Promise.all([n.e(869),n.e(48)]).then(n.bind(n,4675)),"@theme/DocRoot",4675],aba21aa0:[()=>n.e(742).then(n.t.bind(n,7093,19)),"@generated/docusaurus-plugin-content-docs/default/__plugin.json",7093],b38399eb:[()=>n.e(222).then(n.t.bind(n,4765,19)),"@generated/docusaurus-plugin-debug/default/__plugin.json",4765],ba8b3534:[()=>Promise.all([n.e(869),n.e(815)]).then(n.bind(n,1248)),"@theme/DebugContent",1248],bf4f2dd0:[()=>n.e(179).then(n.bind(n,6157)),"@site/content/recipes/pagination.md",6157],c141421f:[()=>n.e(957).then(n.t.bind(n,936,19)),"@generated/docusaurus-theme-search-algolia/default/__plugin.json",936],d291a071:[()=>n.e(504).then(n.bind(n,3988)),"@site/content/interceptors/defer-interceptor.md",3988],d347213b:[()=>n.e(467).then(n.bind(n,6584)),"@site/content/recipes/localization.md",6584],e7393073:[()=>n.e(140).then(n.bind(n,8141)),"@site/content/interactions/modals.md",8141],ec3f407b:[()=>Promise.all([n.e(869),n.e(931)]).then(n.bind(n,7547)),"@site/content/intro.md",7547],ede3a018:[()=>Promise.all([n.e(869),n.e(361)]).then(n.bind(n,105)),"@theme/DebugGlobalData",105],f217256c:[()=>n.e(497).then(n.bind(n,2941)),"@site/content/contributing/commit-convention.md",2941]}},8607:(e,t,n)=>{"use strict";n.d(t,{A:()=>p});n(758);var r=n(8959),a=n.n(r),o=n(4054),i=n(8244),l=n(6070);function s(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,l.jsxs)("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%"},children:[(0,l.jsx)("p",{children:String(t)}),(0,l.jsx)("div",{children:(0,l.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,l.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,l.jsx)("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",children:(0,l.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,l.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var u=n(3786),c=n(6737);function d(e,t){if("*"===e)return a()({loading:s,loader:()=>n.e(431).then(n.bind(n,431)),modules:["@theme/NotFound"],webpack:()=>[431],render(e,t){const n=e.default;return(0,l.jsx)(c.W,{value:{plugin:{name:"native",id:"default"}},children:(0,l.jsx)(n,{...t})})}});const r=o[`${e}-${t}`],d={},p=[],f=[],m=(0,u.A)(r);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=i.A[n];r&&(d[t]=r[0],p.push(r[1]),f.push(r[2]))})),a().Map({loading:s,loader:d,modules:p,webpack:()=>f,render(t,n){const a=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const o=r.default;if(!o)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 o&&"function"!=typeof o||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{o[e]=r[e]}));let i=a;const l=n.split(".");l.slice(0,-1).forEach((e=>{i=i[e]})),i[l[l.length-1]]=o}));const o=a.__comp;delete a.__comp;const i=a.__context;delete a.__context;const s=a.__props;return delete a.__props,(0,l.jsx)(c.W,{value:i,children:(0,l.jsx)(o,{...a,...s,...n})})}})}const p=[{path:"/__docusaurus/debug",component:d("/__docusaurus/debug","5ff"),exact:!0},{path:"/__docusaurus/debug/config",component:d("/__docusaurus/debug/config","5ba"),exact:!0},{path:"/__docusaurus/debug/content",component:d("/__docusaurus/debug/content","a2b"),exact:!0},{path:"/__docusaurus/debug/globalData",component:d("/__docusaurus/debug/globalData","c3c"),exact:!0},{path:"/__docusaurus/debug/metadata",component:d("/__docusaurus/debug/metadata","156"),exact:!0},{path:"/__docusaurus/debug/registry",component:d("/__docusaurus/debug/registry","88c"),exact:!0},{path:"/__docusaurus/debug/routes",component:d("/__docusaurus/debug/routes","000"),exact:!0},{path:"/search",component:d("/search","5de"),exact:!0},{path:"/",component:d("/","d1b"),routes:[{path:"/",component:d("/","dab"),routes:[{path:"/",component:d("/","e98"),routes:[{path:"/contributing/code-of-conduct",component:d("/contributing/code-of-conduct","a63"),exact:!0,sidebar:"docsSidebar"},{path:"/contributing/commit-convention",component:d("/contributing/commit-convention","31a"),exact:!0,sidebar:"docsSidebar"},{path:"/contributing/contribution-guide",component:d("/contributing/contribution-guide","622"),exact:!0,sidebar:"docsSidebar"},{path:"/contributing/funding",component:d("/contributing/funding","bdf"),exact:!0,sidebar:"docsSidebar"},{path:"/interactions/context-menus",component:d("/interactions/context-menus","de5"),exact:!0,sidebar:"docsSidebar"},{path:"/interactions/message-components",component:d("/interactions/message-components","a2a"),exact:!0,sidebar:"docsSidebar"},{path:"/interactions/modals",component:d("/interactions/modals","554"),exact:!0,sidebar:"docsSidebar"},{path:"/interactions/slash-commands",component:d("/interactions/slash-commands","fa5"),exact:!0,sidebar:"docsSidebar"},{path:"/interceptors/defer-interceptor",component:d("/interceptors/defer-interceptor","402"),exact:!0,sidebar:"docsSidebar"},{path:"/listeners",component:d("/listeners","c9e"),exact:!0,sidebar:"docsSidebar"},{path:"/recipes/localization",component:d("/recipes/localization","bda"),exact:!0,sidebar:"docsSidebar"},{path:"/recipes/pagination",component:d("/recipes/pagination","f4a"),exact:!0,sidebar:"docsSidebar"},{path:"/recipes/stat-reporter",component:d("/recipes/stat-reporter","75e"),exact:!0,sidebar:"docsSidebar"},{path:"/start",component:d("/start","42a"),exact:!0,sidebar:"docsSidebar"},{path:"/techniques/async-configuration",component:d("/techniques/async-configuration","c3c"),exact:!0,sidebar:"docsSidebar"},{path:"/techniques/client-providers",component:d("/techniques/client-providers","e05"),exact:!0,sidebar:"docsSidebar"},{path:"/techniques/sharding",component:d("/techniques/sharding","765"),exact:!0,sidebar:"docsSidebar"},{path:"/techniques/standalone-application",component:d("/techniques/standalone-application","d4c"),exact:!0,sidebar:"docsSidebar"},{path:"/techniques/validation",component:d("/techniques/validation","40b"),exact:!0,sidebar:"docsSidebar"},{path:"/text-commands",component:d("/text-commands","1a5"),exact:!0,sidebar:"docsSidebar"},{path:"/",component:d("/","651"),exact:!0,sidebar:"docsSidebar"}]}]}]},{path:"*",component:d("*")}]},7838:(e,t,n)=>{"use strict";n.d(t,{o:()=>o,x:()=>i});var r=n(758),a=n(6070);const o=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,a.jsx)(o.Provider,{value:n,children:t})}},307:(e,t,n)=>{"use strict";var r=n(758),a=n(9576),o=n(248),i=n(1742),l=n(4784),s=n(878);const u=[n(57),n(5066),n(552),n(6389),n(5667)];var c=n(8607),d=n(5557),p=n(389),f=n(6070);function m(e){let{children:t}=e;return(0,f.jsx)(f.Fragment,{children:t})}var h=n(2871),g=n(2477),y=n(7126),b=n(7231),v=n(1332),w=n(9564),k=n(7978),x=n(7600),S=n(5785),E=n(5289);function C(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,g.A)(),r=(0,w.o)(),a=n[e].htmlLang,o=e=>e.replace("-","_");return(0,f.jsxs)(h.A,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:o(a)}),Object.values(n).filter((e=>a!==e.htmlLang)).map((e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:o(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function _(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,g.A)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,g.A)(),{pathname:r}=(0,d.zy)();return e+(0,S.applyTrailingSlash)((0,y.Ay)(r),{trailingSlash:n,baseUrl:t})}(),a=t?`${n}${t}`:r;return(0,f.jsxs)(h.A,{children:[(0,f.jsx)("meta",{property:"og:url",content:a}),(0,f.jsx)("link",{rel:"canonical",href:a})]})}function T(){const{i18n:{currentLocale:e}}=(0,g.A)(),{metadata:t,image:n}=(0,b.p)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(h.A,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:k.w})]}),n&&(0,f.jsx)(v.be,{image:n}),(0,f.jsx)(_,{}),(0,f.jsx)(C,{}),(0,f.jsx)(E.A,{tag:x.Cy,locale:e}),(0,f.jsx)(h.A,{children:t.map(((e,t)=>(0,f.jsx)("meta",{...e},t)))})]})}const A=new Map;var j=n(7838),R=n(8040),N=n(8708);function L(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>a.forEach((e=>e?.()))}const P=function(e){let{children:t,location:n,previousLocation:r}=e;return(0,N.A)((()=>{r!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,a=t.hash===n.hash,o=t.search===n.search;if(r&&a&&!o)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:r}),L("onRouteDidUpdate",{previousLocation:r,location:n}))}),[r,n]),t};function O(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,p.u)(c.A,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class D extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=s.A.canUseDOM?L("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=L("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),O(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(0,f.jsx)(P,{previousLocation:this.previousLocation,location:t,children:(0,f.jsx)(d.qh,{location:t,render:()=>e})})}}const I=D,M="__docusaurus-base-url-issue-banner-container",F="__docusaurus-base-url-issue-banner",z="__docusaurus-base-url-issue-banner-suggestion-container";function B(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${M}';\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(/{let{route:t}=e;return!0===t.exact})))return A.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return A.set(e.pathname,t),{...e,pathname:t}}((0,d.zy)());return(0,f.jsx)(I,{location:e,children:V})}function Q(){return(0,f.jsx)(H.A,{children:(0,f.jsx)(R.l,{children:(0,f.jsxs)(j.x,{children:[(0,f.jsxs)(m,{children:[(0,f.jsx)(q,{}),(0,f.jsx)(T,{}),(0,f.jsx)(U,{}),(0,f.jsx)(K,{})]}),(0,f.jsx)(W,{})]})})})}var Y=n(4054);const Z=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const a=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;a?.appendChild(r)}))}: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 X=n(3786);const J=new Set,ee=new Set,te=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ne={prefetch:e=>{if(!(e=>!te()&&!ee.has(e)&&!J.has(e))(e))return!1;J.add(e);const t=(0,p.u)(c.A,e).flatMap((e=>{return t=e.route.path,Object.entries(Y).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,X.A)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Z(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!te()&&!ee.has(e))(e)&&(ee.add(e),O(e))},re=Object.freeze(ne);function ae(e){let{children:t}=e;return"hash"===l.A.future.experimental_router?(0,f.jsx)(i.I9,{children:t}):(0,f.jsx)(i.Kd,{children:t})}const oe=Boolean(!0);if(s.A.canUseDOM){window.docusaurus=re;const e=document.getElementById("__docusaurus"),t=(0,f.jsx)(o.vd,{children:(0,f.jsx)(ae,{children:(0,f.jsx)(Q,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},i=()=>{if(window.docusaurusRoot)window.docusaurusRoot.render(t);else if(oe)window.docusaurusRoot=a.hydrateRoot(e,t,{onRecoverableError:n});else{const r=a.createRoot(e,{onRecoverableError:n});r.render(t),window.docusaurusRoot=r}};O(window.location.pathname).then((()=>{(0,r.startTransition)(i)}))}},8040:(e,t,n)=>{"use strict";n.d(t,{o:()=>d,l:()=>p});var r=n(758),a=n(4784);const o=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/","versions":[{"name":"current","label":"Next","isLast":true,"path":"/","mainDocId":"intro","docs":[{"id":"contributing/code-of-conduct","path":"/contributing/code-of-conduct","sidebar":"docsSidebar"},{"id":"contributing/commit-convention","path":"/contributing/commit-convention","sidebar":"docsSidebar"},{"id":"contributing/contribution-guide","path":"/contributing/contribution-guide","sidebar":"docsSidebar"},{"id":"contributing/funding","path":"/contributing/funding","sidebar":"docsSidebar"},{"id":"interactions/context-menus","path":"/interactions/context-menus","sidebar":"docsSidebar"},{"id":"interactions/message-components","path":"/interactions/message-components","sidebar":"docsSidebar"},{"id":"interactions/modals","path":"/interactions/modals","sidebar":"docsSidebar"},{"id":"interactions/slash-commands","path":"/interactions/slash-commands","sidebar":"docsSidebar"},{"id":"interceptors/defer-interceptor","path":"/interceptors/defer-interceptor","sidebar":"docsSidebar"},{"id":"intro","path":"/","sidebar":"docsSidebar"},{"id":"listeners","path":"/listeners","sidebar":"docsSidebar"},{"id":"recipes/localization","path":"/recipes/localization","sidebar":"docsSidebar"},{"id":"recipes/pagination","path":"/recipes/pagination","sidebar":"docsSidebar"},{"id":"recipes/stat-reporter","path":"/recipes/stat-reporter","sidebar":"docsSidebar"},{"id":"start","path":"/start","sidebar":"docsSidebar"},{"id":"techniques/async-configuration","path":"/techniques/async-configuration","sidebar":"docsSidebar"},{"id":"techniques/client-providers","path":"/techniques/client-providers","sidebar":"docsSidebar"},{"id":"techniques/sharding","path":"/techniques/sharding","sidebar":"docsSidebar"},{"id":"techniques/standalone-application","path":"/techniques/standalone-application","sidebar":"docsSidebar"},{"id":"techniques/validation","path":"/techniques/validation","sidebar":"docsSidebar"},{"id":"text-commands","path":"/text-commands","sidebar":"docsSidebar"}],"draftIds":[],"sidebars":{"docsSidebar":{"link":{"path":"/","label":"intro"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var l=n(2654);const s=JSON.parse('{"docusaurusVersion":"3.4.0","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.4.0"},"docusaurus-plugin-debug":{"type":"package","name":"@docusaurus/plugin-debug","version":"3.4.0"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.4.0"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.4.0"},"docusaurus-theme-search-algolia":{"type":"package","name":"@docusaurus/theme-search-algolia","version":"3.4.0"},"docusaurus-plugin-sass":{"type":"package","name":"docusaurus-plugin-sass","version":"0.2.5"},"docusaurus-plugin-pwa":{"type":"package","name":"@docusaurus/plugin-pwa","version":"3.4.0"}}}');var u=n(6070);const c={siteConfig:a.A,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},d=r.createContext(c);function p(e){let{children:t}=e;return(0,u.jsx)(d.Provider,{value:c,children:t})}},9333:(e,t,n)=>{"use strict";n.d(t,{A:()=>h});var r=n(758),a=n(878),o=n(2871),i=n(5785),l=n(123),s=n(6737),u=n(6070);function c(e){let{error:t,tryAgain:n}=e;return(0,u.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,u.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,u.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,u.jsx)(d,{error:t})]})}function d(e){let{error:t}=e;const n=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,u.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function p(e){let{children:t}=e;return(0,u.jsx)(s.W,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:t})}function f(e){let{error:t,tryAgain:n}=e;return(0,u.jsx)(p,{children:(0,u.jsxs)(h,{fallback:()=>(0,u.jsx)(c,{error:t,tryAgain:n}),children:[(0,u.jsx)(o.A,{children:(0,u.jsx)("title",{children:"Page Error"})}),(0,u.jsx)(l.A,{children:(0,u.jsx)(c,{error:t,tryAgain:n})})]})})}const m=e=>(0,u.jsx)(f,{...e});class h extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.A.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??m)(e)}return e??null}}},878:(e,t,n)=>{"use strict";n.d(t,{A:()=>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}},2871:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});n(758);var r=n(248),a=n(6070);function o(e){return(0,a.jsx)(r.mg,{...e})}},977:(e,t,n)=>{"use strict";n.d(t,{A:()=>f});var r=n(758),a=n(1742),o=n(5785),i=n(2477),l=n(7607),s=n(878),u=n(3726),c=n(7126),d=n(6070);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:m,isActive:h,"data-noBrokenLinkCheck":g,autoAddBaseUrl:y=!0,...b}=e;const{siteConfig:v}=(0,i.A)(),{trailingSlash:w,baseUrl:k}=v,x=v.future.experimental_router,{withBaseUrl:S}=(0,c.hH)(),E=(0,u.A)(),C=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>C.current));const _=p||f;const T=(0,l.A)(_),A=_?.replace("pathname://","");let j=void 0!==A?(R=A,y&&(e=>e.startsWith("/"))(R)?S(R):R):void 0;var R;"hash"===x&&j?.startsWith("./")&&(j=j?.slice(1)),j&&T&&(j=(0,o.applyTrailingSlash)(j,{trailingSlash:w,baseUrl:k}));const N=(0,r.useRef)(!1),L=n?a.k2:a.N_,P=s.A.canUseIntersectionObserver,O=(0,r.useRef)(),D=()=>{N.current||null==j||(window.docusaurus.preload(j),N.current=!0)};(0,r.useEffect)((()=>(!P&&T&&null!=j&&window.docusaurus.prefetch(j),()=>{P&&O.current&&O.current.disconnect()})),[O,j,P,T]);const I=j?.startsWith("#")??!1,M=!b.target||"_self"===b.target,F=!j||!T||!M;return g||!I&&F||E.collectLink(j),b.id&&E.collectAnchor(b.id),F?(0,d.jsx)("a",{ref:C,href:j,..._&&!T&&{target:"_blank",rel:"noopener noreferrer"},...b}):(0,d.jsx)(L,{...b,onMouseEnter:D,onTouchStart:D,innerRef:e=>{C.current=e,P&&e&&T&&(O.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(O.current.unobserve(e),O.current.disconnect(),null!=j&&window.docusaurus.prefetch(j))}))})),O.current.observe(e))},to:j,...n&&{isActive:h,activeClassName:m}})}const f=r.forwardRef(p)},5235:(e,t,n)=>{"use strict";n.d(t,{A:()=>u,T:()=>s});var r=n(758),a=n(6070);function o(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=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 i=n(2654);function l(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??n]??n??t}function s(e,t){let{message:n,id:r}=e;return o(l({message:n,id:r}),t)}function u(e){let{children:t,id:n,values:r}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const i=l({message:t,id:n});return(0,a.jsx)(a.Fragment,{children:o(i,r)})}},4636:(e,t,n)=>{"use strict";n.d(t,{W:()=>r});const r="default"},7607:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{A:()=>a,z:()=>r})},7126:(e,t,n)=>{"use strict";n.d(t,{Ay:()=>l,hH:()=>i});var r=n(758),a=n(2477),o=n(7607);function i(){const{siteConfig:e}=(0,a.A)(),{baseUrl:t,url:n}=e,i=e.future.experimental_router,l=(0,r.useCallback)(((e,r)=>function(e){let{siteUrl:t,baseUrl:n,url:r,options:{forcePrependBaseUrl:a=!1,absolute:i=!1}={},router:l}=e;if(!r||r.startsWith("#")||(0,o.z)(r))return r;if("hash"===l)return r.startsWith("/")?`.${r}`:`./${r}`;if(a)return n+r.replace(/^\//,"");if(r===n.replace(/\/$/,""))return n;const s=r.startsWith(n)?r:n+r.replace(/^\//,"");return i?t+s:s}({siteUrl:n,baseUrl:t,url:e,options:r,router:i})),[n,t,i]);return{withBaseUrl:l}}function l(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},3726:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});var r=n(758);n(6070);const a=r.createContext({collectAnchor:()=>{},collectLink:()=>{}}),o=()=>(0,r.useContext)(a);function i(){return o()}},2477:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});var r=n(758),a=n(8040);function o(){return(0,r.useContext)(a.o)}},2909:(e,t,n)=>{"use strict";n.d(t,{Ay:()=>o,P_:()=>l,kh:()=>i});var r=n(2477),a=n(4636);function o(){const{globalData:e}=(0,r.A)();return e}function i(e,t){void 0===t&&(t={});const n=o()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}function l(e,t,n){void 0===t&&(t=a.W),void 0===n&&(n={});const r=i(e),o=r?.[t];if(!o&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return o}},9536:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});var r=n(758),a=n(7838);function o(){return(0,r.useContext)(a.o)}},8708:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(758);const a=n(878).A.canUseDOM?r.useLayoutEffect:r.useEffect},3786:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function a(e){const t={};return function e(n,a){Object.entries(n).forEach((n=>{let[o,i]=n;const l=a?`${a}.${o}`:o;r(i)?e(i,l):t[l]=i}))}(e),t}},6737:(e,t,n)=>{"use strict";n.d(t,{W:()=>i,o:()=>o});var r=n(758),a=n(6070);const o=r.createContext(null);function i(e){let{children:t,value:n}=e;const i=r.useContext(o),l=(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,...n?.data};return{plugin:t.plugin,data:r}}({parent:i,value:n})),[i,n]);return(0,a.jsx)(o.Provider,{value:l,children:t})}},5889:(e,t,n)=>{"use strict";n.d(t,{zK:()=>h,vT:()=>d,gk:()=>p,Gy:()=>u,HW:()=>g,ht:()=>c,r7:()=>m,jh:()=>f});var r=n(5557),a=n(2909);const o=e=>e.versions.find((e=>e.isLast));function i(e,t){const n=o(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.B6)(t,{path:e.path,exact:!1,strict:!1})))}function l(e,t){const n=i(e,t),a=n?.docs.find((e=>!!(0,r.B6)(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 s={},u=()=>(0,a.kh)("docusaurus-plugin-content-docs")??s,c=e=>{try{return(0,a.P_)("docusaurus-plugin-content-docs",e,{failfast:!0})}catch(t){throw new Error("You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled"+("Default"===e?"":` (pluginId=${e}`),{cause:t})}};function d(e){void 0===e&&(e={});const t=u(),{pathname:n}=(0,r.zy)();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.B6)(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){void 0===e&&(e={});const t=d(e),{pathname:n}=(0,r.zy)();if(!t)return;return{activePlugin:t,activeVersion:i(t.pluginData,n)}}function f(e){return c(e).versions}function m(e){const t=c(e);return o(t)}function h(e){const t=c(e),{pathname:n}=(0,r.zy)();return l(t,n)}function g(e){const t=c(e),{pathname:n}=(0,r.zy)();return function(e,t){const n=o(e);return{latestDocSuggestion:l(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},5667:(e,t,n)=>{"use strict";n.r(t);var r=n(878),a=n(9465);const o="/sw.js",i=["appInstalled","standalone","queryString"],l=!0,s=(0,a.Wf)("docusaurus.pwa.event.appInstalled.fired");function u(e,t){l&&(void 0===t?console.log(`[Docusaurus-PWA][registerSw]: ${e}`):console.log(`[Docusaurus-PWA][registerSw]: ${e}`,t))}async function c(){const e=await navigator.serviceWorker.getRegistrations();u("will unregister all service workers",{registrations:e}),await Promise.all(e.map((e=>e.unregister().then((t=>u("unregister service worker",{registration:e,result:t})))))),u("unregistered all service workers",{registrations:e}),window.location.reload()}const d={always:()=>!0,mobile:()=>window.innerWidth<=996,saveData:()=>!!navigator.connection?.saveData,appInstalled:()=>"true"===s.get()||async function(){if(!("getInstalledRelatedApps"in window.navigator))return!1;try{return(await navigator.getInstalledRelatedApps()).some((e=>"webapp"===e.platform))}catch(e){return!1}}(),standalone:()=>window.matchMedia("(display-mode: standalone)").matches,queryString:()=>"true"===new URLSearchParams(window.location.search).get("offlineMode")};async function p(){const e=await async function(){return(await Promise.all(i.map((e=>Promise.resolve(d[e]()).then((t=>t?e:void 0)))))).filter(Boolean)}(),t=e.length>0;return u(t?"offline mode enabled, because of activation strategies":"offline mode disabled, because none of the offlineModeActivationStrategies could be used",{activeStrategies:e,availableStrategies:i}),t}r.A.canUseDOM&&(u("debug mode enabled"),"serviceWorker"in navigator&&(u("addLegacyAppInstalledEventsListeners"),window.addEventListener("appinstalled",(e=>{u("event appinstalled",{event:e}),s.set("true"),u("AppInstalledEventFiredStorage.set('true')"),c()})),window.addEventListener("beforeinstallprompt",(e=>{u("event beforeinstallprompt",{event:e});const t=s.get();u("AppInstalledEventFiredStorage.get()",{appInstalledEventFired:t}),t&&(s.del(),u("AppInstalledEventFiredStorage.del()"),c())})),u("legacy appinstalled and beforeinstallprompt event listeners installed"),async function(){const[{Workbox:e},t]=await Promise.all([n.e(935).then(n.bind(n,935)),p()]),r=new e(function(e){const t=JSON.stringify(e),n=`${o}?params=${encodeURIComponent(t)}`;return u("service worker url",{url:n,params:e}),n}({offlineMode:t,debug:l})),a=()=>r.messageSW({type:"SKIP_WAITING"}),i=()=>(u("handleServiceWorkerWaiting"),t?n.e(795).then(n.bind(n,3795)).then((e=>{let{renderReloadPopup:t}=e;return t({onReload(){r.addEventListener("controlling",(()=>{window.location.reload()})),a()}})})):a());r.addEventListener("waiting",(e=>{u("event waiting",{event:e}),i()})),r.addEventListener("externalwaiting",(e=>{u("event externalwaiting",{event:e}),i()}));const s=await r.register();s&&(s.active&&u("registration.active",{registration:s}),s.installing&&u("registration.installing",{registration:s}),s.waiting&&(u("registration.waiting",{registration:s}),await i()))}().catch((e=>console.error("registerSW failed",e)))))},8959:(e,t,n)=>{"use strict";function r(e,t){e.prototype=Object.create(t.prototype),e.prototype.constructor=e,e.__proto__=t}function a(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}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 i(){return i=Object.assign||function(e){for(var t=1;t{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(8744),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()}}},5066:(e,t,n)=>{"use strict";n.r(t);var r=n(3477),a=n(4784);!function(e){const{themeConfig:{prism:t}}=a.A,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(1274),n(4207)(`./prism-${e}`)})),delete globalThis.Prism}(r.My)},4182:(e,t,n)=>{"use strict";n.d(t,{A:()=>c});n(758);var r=n(3526),a=n(5235),o=n(7231),i=n(977),l=n(3726);const s={anchorWithStickyNavbar:"anchorWithStickyNavbar_s992",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_JF87"};var u=n(6070);function c(e){let{as:t,id:n,...c}=e;const d=(0,l.A)(),{navbar:{hideOnScroll:p}}=(0,o.p)();if("h1"===t||!n)return(0,u.jsx)(t,{...c,id:void 0});d.collectAnchor(n);const f=(0,a.T)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof c.children?c.children:n});return(0,u.jsxs)(t,{...c,className:(0,r.A)("anchor",p?s.anchorWithHideOnScrollNavbar:s.anchorWithStickyNavbar,c.className),id:n,children:[c.children,(0,u.jsx)(i.A,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},5699:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});n(758);const r={iconExternalLink:"iconExternalLink_RZxO"};var a=n(6070);function o(e){let{width:t=13.5,height:n=13.5}=e;return(0,a.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,a.jsx)("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"})})}},123:(e,t,n)=>{"use strict";n.d(t,{A:()=>Pt});var r=n(758),a=n(3526),o=n(9333),i=n(1332),l=n(5557),s=n(5235),u=n(6289),c=n(6070);const d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,l.W6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,u.$)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const m=(0,s.T)({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",message:"Skip to main content"});function h(e){const t=e.children??m,{containerRef:n,onClick:r}=f();return(0,c.jsx)("div",{ref:n,role:"region","aria-label":m,children:(0,c.jsx)("a",{...e,href:`#${d}`,onClick:r,children:t})})}var g=n(9960),y=n(7978);const b={skipToContent:"skipToContent_Z2Yq"};function v(){return(0,c.jsx)(h,{className:b.skipToContent})}var w=n(7231),k=n(8264);function x(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:a=1.2,className:o,...i}=e;return(0,c.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,c.jsx)("g",{stroke:r,strokeWidth:a,children:(0,c.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const S={closeButton:"closeButton_Xp9G"};function E(e){return(0,c.jsx)("button",{type:"button","aria-label":(0,s.T)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,a.A)("clean-btn close",S.closeButton,e.className),children:(0,c.jsx)(x,{width:14,height:14,strokeWidth:3.1})})}const C={content:"content_xp6c"};function _(e){const{announcementBar:t}=(0,w.p)(),{content:n}=t;return(0,c.jsx)("div",{...e,className:(0,a.A)(C.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const T={announcementBar:"announcementBar_KUxK",announcementBarPlaceholder:"announcementBarPlaceholder_WR14",announcementBarClose:"announcementBarClose_h8tA",announcementBarContent:"announcementBarContent_z0bg"};function A(){const{announcementBar:e}=(0,w.p)(),{isActive:t,close:n}=(0,k.M)();if(!t)return null;const{backgroundColor:r,textColor:a,isCloseable:o}=e;return(0,c.jsxs)("div",{className:T.announcementBar,style:{backgroundColor:r,color:a},role:"banner",children:[o&&(0,c.jsx)("div",{className:T.announcementBarPlaceholder}),(0,c.jsx)(_,{className:T.announcementBarContent}),o&&(0,c.jsx)(E,{onClick:n,className:T.announcementBarClose})]})}var j=n(844),R=n(4727);var N=n(7853),L=n(5765);const P=r.createContext(null);function O(e){let{children:t}=e;const n=function(){const e=(0,j.M)(),t=(0,L.YL)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,N.ZC)(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(0,c.jsx)(P.Provider,{value:n,children:t})}function D(e){if(e.component){const t=e.component;return(0,c.jsx)(t,{...e.props})}}function I(){const e=(0,r.useContext)(P);if(!e)throw new N.dV("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,L.YL)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:D(o)})),[a,o,t])}function M(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:o}=I();return(0,c.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,c.jsxs)("div",{className:(0,a.A)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":o}),children:[(0,c.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,c.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var F=n(3776),z=n(9536);function B(e){return(0,c.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,c.jsx)("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 $(e){return(0,c.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,c.jsx)("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 U={toggle:"toggle__d4q",toggleButton:"toggleButton_gjdH",darkToggleIcon:"darkToggleIcon_hrXT",lightToggleIcon:"lightToggleIcon_Ne1b",toggleButtonDisabled:"toggleButtonDisabled_CH3w"};function q(e){let{className:t,buttonClassName:n,value:r,onChange:o}=e;const i=(0,z.A)(),l=(0,s.T)({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"===r?(0,s.T)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,s.T)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,c.jsx)("div",{className:(0,a.A)(U.toggle,t),children:(0,c.jsxs)("button",{className:(0,a.A)("clean-btn",U.toggleButton,!i&&U.toggleButtonDisabled,n),type:"button",onClick:()=>o("dark"===r?"light":"dark"),disabled:!i,title:l,"aria-label":l,"aria-live":"polite",children:[(0,c.jsx)(B,{className:(0,a.A)(U.toggleIcon,U.lightToggleIcon)}),(0,c.jsx)($,{className:(0,a.A)(U.toggleIcon,U.darkToggleIcon)})]})})}const H=r.memo(q),G={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_W4Wv"};function W(e){let{className:t}=e;const n=(0,w.p)().navbar.style,r=(0,w.p)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,F.G)();return r?null:(0,c.jsx)(H,{className:t,buttonClassName:"dark"===n?G.darkNavbarColorModeToggle:void 0,value:a,onChange:o})}var V=n(8867);function K(){return(0,c.jsx)(V.A,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){const e=(0,j.M)();return(0,c.jsx)("button",{type:"button","aria-label":(0,s.T)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,c.jsx)(x,{color:"var(--ifm-color-emphasis-600)"})})}function Y(){return(0,c.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,c.jsx)(K,{}),(0,c.jsx)(W,{className:"margin-right--md"}),(0,c.jsx)(Q,{})]})}var Z=n(977),X=n(7126),J=n(7607),ee=n(1739),te=n(5699);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:a,label:o,html:i,isDropdownLink:l,prependBaseUrlToHref:s,...u}=e;const d=(0,X.Ay)(r),p=(0,X.Ay)(t),f=(0,X.Ay)(a,{forcePrependBaseUrl:!0}),m=o&&a&&!(0,J.A)(a),h=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,c.jsxs)(c.Fragment,{children:[o,m&&(0,c.jsx)(te.A,{...l&&{width:12,height:12}})]})};return a?(0,c.jsx)(Z.A,{href:s?f:a,...u,...h}):(0,c.jsx)(Z.A,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?(0,ee.G)(n,t.pathname):t.pathname.startsWith(p)},...u,...h})}function re(e){let{className:t,isDropdownItem:n=!1,...r}=e;const o=(0,c.jsx)(ne,{className:(0,a.A)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,c.jsx)("li",{children:o}):o}function ae(e){let{className:t,isDropdownItem:n,...r}=e;return(0,c.jsx)("li",{className:"menu__list-item",children:(0,c.jsx)(ne,{className:(0,a.A)("menu__link",t),...r})})}function oe(e){let{mobile:t=!1,position:n,...r}=e;const a=t?ae:re;return(0,c.jsx)(a,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var ie=n(4315),le=n(1098),se=n(2477);const ue={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_i3Gq"};function ce(e,t){return e.some((e=>function(e,t){return!!(0,le.ys)(e.to,t)||!!(0,ee.G)(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function de(e){let{items:t,position:n,className:o,onClick:i,...l}=e;const s=(0,r.useRef)(null),[u,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{s.current&&!s.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[s]),(0,c.jsxs)("div",{ref:s,className:(0,a.A)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":u}),children:[(0,c.jsx)(ne,{"aria-haspopup":"true","aria-expanded":u,role:"button",href:l.to?void 0:"#",className:(0,a.A)("navbar__link",o),...l,onClick:l.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!u))},children:l.children??l.label}),(0,c.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(Ge,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:o,onClick:i,...s}=e;const u=function(){const{siteConfig:{baseUrl:e}}=(0,se.A)(),{pathname:t}=(0,l.zy)();return t.replace(e,"/")}(),d=ce(t,u),{collapsed:p,toggleCollapsed:f,setCollapsed:m}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&m(!d)}),[u,d,m]),(0,c.jsxs)("li",{className:(0,a.A)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,c.jsx)(ne,{role:"button",className:(0,a.A)(ue.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...s,onClick:e=>{e.preventDefault(),f()},children:s.children??s.label}),(0,c.jsx)(ie.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,r.createElement)(Ge,{mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active",...e,key:t})))})]})}function fe(e){let{mobile:t=!1,...n}=e;const r=t?pe:de;return(0,c.jsx)(r,{...n})}var me=n(9564);function he(e){let{width:t=20,height:n=20,...r}=e;return(0,c.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,c.jsx)("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 ge="iconLanguage_wXKr";var ye=n(8143);function be(){return r.createElement("svg",{width:"15",height:"15",className:"DocSearch-Control-Key-Icon"},r.createElement("path",{d:"M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953",strokeWidth:"1.2",stroke:"currentColor",fill:"none",strokeLinecap:"square"}))}var ve=n(7158),we=["translations"];function ke(){return ke=Object.assign||function(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,r=new Array(t);n=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 Ce="Ctrl";var _e=r.forwardRef((function(e,t){var n=e.translations,a=void 0===n?{}:n,o=Ee(e,we),i=a.buttonText,l=void 0===i?"Search":i,s=a.buttonAriaLabel,u=void 0===s?"Search":s,c=xe((0,r.useState)(null),2),d=c[0],p=c[1];return(0,r.useEffect)((function(){"undefined"!=typeof navigator&&(/(Mac|iPhone|iPod|iPad)/i.test(navigator.platform)?p("\u2318"):p(Ce))}),[]),r.createElement("button",ke({type:"button",className:"DocSearch DocSearch-Button","aria-label":u},o,{ref:t}),r.createElement("span",{className:"DocSearch-Button-Container"},r.createElement(ve.W,null),r.createElement("span",{className:"DocSearch-Button-Placeholder"},l)),r.createElement("span",{className:"DocSearch-Button-Keys"},null!==d&&r.createElement(r.Fragment,null,r.createElement(Te,{reactsToKey:d===Ce?Ce:"Meta"},d===Ce?r.createElement(be,null):d),r.createElement(Te,{reactsToKey:"k"},"K"))))}));function Te(e){var t=e.reactsToKey,n=e.children,a=xe((0,r.useState)(!1),2),o=a[0],i=a[1];return(0,r.useEffect)((function(){if(t)return window.addEventListener("keydown",e),window.addEventListener("keyup",n),function(){window.removeEventListener("keydown",e),window.removeEventListener("keyup",n)};function e(e){e.key===t&&i(!0)}function n(e){e.key!==t&&"Meta"!==e.key||i(!1)}}),[t]),r.createElement("kbd",{className:o?"DocSearch-Button-Key DocSearch-Button-Key--pressed":"DocSearch-Button-Key"},n)}var Ae=n(2871),je=n(3668),Re=n(4584),Ne=n(7600);const Le={button:{buttonText:(0,s.T)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"}),buttonAriaLabel:(0,s.T)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"})},modal:{searchBox:{resetButtonTitle:(0,s.T)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),resetButtonAriaLabel:(0,s.T)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),cancelButtonText:(0,s.T)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"}),cancelButtonAriaLabel:(0,s.T)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"})},startScreen:{recentSearchesTitle:(0,s.T)({id:"theme.SearchModal.startScreen.recentSearchesTitle",message:"Recent",description:"The title for recent searches"}),noRecentSearchesText:(0,s.T)({id:"theme.SearchModal.startScreen.noRecentSearchesText",message:"No recent searches",description:"The text when no recent searches"}),saveRecentSearchButtonTitle:(0,s.T)({id:"theme.SearchModal.startScreen.saveRecentSearchButtonTitle",message:"Save this search",description:"The label for save recent search button"}),removeRecentSearchButtonTitle:(0,s.T)({id:"theme.SearchModal.startScreen.removeRecentSearchButtonTitle",message:"Remove this search from history",description:"The label for remove recent search button"}),favoriteSearchesTitle:(0,s.T)({id:"theme.SearchModal.startScreen.favoriteSearchesTitle",message:"Favorite",description:"The title for favorite searches"}),removeFavoriteSearchButtonTitle:(0,s.T)({id:"theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle",message:"Remove this search from favorites",description:"The label for remove favorite search button"})},errorScreen:{titleText:(0,s.T)({id:"theme.SearchModal.errorScreen.titleText",message:"Unable to fetch results",description:"The title for error screen of search modal"}),helpText:(0,s.T)({id:"theme.SearchModal.errorScreen.helpText",message:"You might want to check your network connection.",description:"The help text for error screen of search modal"})},footer:{selectText:(0,s.T)({id:"theme.SearchModal.footer.selectText",message:"to select",description:"The explanatory text of the action for the enter key"}),selectKeyAriaLabel:(0,s.T)({id:"theme.SearchModal.footer.selectKeyAriaLabel",message:"Enter key",description:"The ARIA label for the Enter key button that makes the selection"}),navigateText:(0,s.T)({id:"theme.SearchModal.footer.navigateText",message:"to navigate",description:"The explanatory text of the action for the Arrow up and Arrow down key"}),navigateUpKeyAriaLabel:(0,s.T)({id:"theme.SearchModal.footer.navigateUpKeyAriaLabel",message:"Arrow up",description:"The ARIA label for the Arrow up key button that makes the navigation"}),navigateDownKeyAriaLabel:(0,s.T)({id:"theme.SearchModal.footer.navigateDownKeyAriaLabel",message:"Arrow down",description:"The ARIA label for the Arrow down key button that makes the navigation"}),closeText:(0,s.T)({id:"theme.SearchModal.footer.closeText",message:"to close",description:"The explanatory text of the action for Escape key"}),closeKeyAriaLabel:(0,s.T)({id:"theme.SearchModal.footer.closeKeyAriaLabel",message:"Escape key",description:"The ARIA label for the Escape key button that close the modal"}),searchByText:(0,s.T)({id:"theme.SearchModal.footer.searchByText",message:"Search by",description:"The text explain that the search is making by Algolia"})},noResultsScreen:{noResultsText:(0,s.T)({id:"theme.SearchModal.noResultsScreen.noResultsText",message:"No results for",description:"The text explains that there are no results for the following search"}),suggestedQueryText:(0,s.T)({id:"theme.SearchModal.noResultsScreen.suggestedQueryText",message:"Try searching for",description:"The text for the suggested query when no results are found for the following search"}),reportMissingResultsText:(0,s.T)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsText",message:"Believe this query should return results?",description:"The text for the question where the user thinks there are missing results"}),reportMissingResultsLinkText:(0,s.T)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsLinkText",message:"Let us know.",description:"The text for the link to report missing results"})}},placeholder:(0,s.T)({id:"theme.SearchModal.placeholder",message:"Search docs",description:"The placeholder of the input of the DocSearch pop-up modal"})};let Pe=null;function Oe(e){let{hit:t,children:n}=e;return(0,c.jsx)(Z.A,{to:t.url,children:n})}function De(e){let{state:t,onClose:n}=e;const r=(0,je.w)();return(0,c.jsx)(Z.A,{to:r(t.query),onClick:n,children:(0,c.jsx)(s.A,{id:"theme.SearchBar.seeAll",values:{count:t.context.nbHits},children:"See all {count} results"})})}function Ie(e){let{contextualSearch:t,externalUrlRegex:a,...o}=e;const{siteMetadata:i}=(0,se.A)(),s=(0,Re.C)(),u=function(){const{locale:e,tags:t}=(0,Ne.af)();return[`language:${e}`,t.map((e=>`docusaurus_tag:${e}`))]}(),d=o.searchParameters?.facetFilters??[],p=t?function(e,t){const n=e=>"string"==typeof e?[e]:e;return[...n(e),...n(t)]}(u,d):d,f={...o.searchParameters,facetFilters:p},m=(0,l.W6)(),h=(0,r.useRef)(null),g=(0,r.useRef)(null),[y,b]=(0,r.useState)(!1),[v,w]=(0,r.useState)(void 0),k=(0,r.useCallback)((()=>Pe?Promise.resolve():Promise.all([n.e(873).then(n.bind(n,2254)),Promise.all([n.e(869),n.e(43)]).then(n.bind(n,4043)),Promise.all([n.e(869),n.e(994)]).then(n.bind(n,7994))]).then((e=>{let[{DocSearchModal:t}]=e;Pe=t}))),[]),x=(0,r.useCallback)((()=>{if(!h.current){const e=document.createElement("div");h.current=e,document.body.insertBefore(e,document.body.firstChild)}}),[]),S=(0,r.useCallback)((()=>{x(),k().then((()=>b(!0)))}),[k,x]),E=(0,r.useCallback)((()=>{b(!1),g.current?.focus()}),[]),C=(0,r.useCallback)((e=>{e.preventDefault(),w(e.key),S()}),[S]),_=(0,r.useRef)({navigate(e){let{itemUrl:t}=e;(0,ee.G)(a,t)?window.location.href=t:m.push(t)}}).current,T=(0,r.useRef)((e=>o.transformItems?o.transformItems(e):e.map((e=>({...e,url:s(e.url)}))))).current,A=(0,r.useMemo)((()=>e=>(0,c.jsx)(De,{...e,onClose:E})),[E]),j=(0,r.useCallback)((e=>(e.addAlgoliaAgent("docusaurus",i.docusaurusVersion),e)),[i.docusaurusVersion]);return function(e){var t=e.isOpen,n=e.onOpen,a=e.onClose,o=e.onInput,i=e.searchButtonRef;r.useEffect((function(){function e(e){var r;(27===e.keyCode&&t||"k"===(null===(r=e.key)||void 0===r?void 0:r.toLowerCase())&&(e.metaKey||e.ctrlKey)||!function(e){var t=e.target,n=t.tagName;return t.isContentEditable||"INPUT"===n||"SELECT"===n||"TEXTAREA"===n}(e)&&"/"===e.key&&!t)&&(e.preventDefault(),t?a():document.body.classList.contains("DocSearch--active")||document.body.classList.contains("DocSearch--active")||n()),i&&i.current===document.activeElement&&o&&/[a-zA-Z0-9]/.test(String.fromCharCode(e.keyCode))&&o(e)}return window.addEventListener("keydown",e),function(){window.removeEventListener("keydown",e)}}),[t,n,a,o,i])}({isOpen:y,onOpen:S,onClose:E,onInput:C,searchButtonRef:g}),(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(Ae.A,{children:(0,c.jsx)("link",{rel:"preconnect",href:`https://${o.appId}-dsn.algolia.net`,crossOrigin:"anonymous"})}),(0,c.jsx)(_e,{onTouchStart:k,onFocus:k,onMouseOver:k,onClick:S,ref:g,translations:Le.button}),y&&Pe&&h.current&&(0,ye.createPortal)((0,c.jsx)(Pe,{onClose:E,initialScrollY:window.scrollY,initialQuery:v,navigator:_,transformItems:T,hitComponent:Oe,transformSearchClient:j,...o.searchPagePath&&{resultsFooterComponent:A},...o,searchParameters:f,placeholder:Le.placeholder,translations:Le.modal}),h.current)]})}function Me(){const{siteConfig:e}=(0,se.A)();return(0,c.jsx)(Ie,{...e.themeConfig.algolia})}const Fe={navbarSearchContainer:"navbarSearchContainer__wvR"};function ze(e){let{children:t,className:n}=e;return(0,c.jsx)("div",{className:(0,a.A)(n,Fe.navbarSearchContainer),children:t})}var Be=n(5889),$e=n(237);var Ue=n(5438);const qe=e=>e.docs.find((t=>t.id===e.mainDocId));const He={default:oe,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:a="",...o}=e;const{i18n:{currentLocale:i,locales:u,localeConfigs:d}}=(0,se.A)(),p=(0,me.o)(),{search:f,hash:m}=(0,l.zy)(),h=[...n,...u.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${m}${a}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...r],g=t?(0,s.T)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return(0,c.jsx)(fe,{...o,mobile:t,label:(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(he,{className:ge}),g]}),items:h})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,c.jsx)(ze,{className:n,children:(0,c.jsx)(Me,{})})},dropdown:fe,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:o=!1}=e;const i=o?"li":"div";return(0,c.jsx)(i,{className:(0,a.A)({navbar__item:!r&&!o,"menu__list-item":r},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:r,...a}=e;const{activeDoc:o}=(0,Be.zK)(r),i=(0,$e.QB)(t,r),l=o?.path===i?.path;return null===i||i.unlisted&&!l?null:(0,c.jsx)(oe,{exact:!0,...a,isActive:()=>l||!!o?.sidebar&&o.sidebar===i.sidebar,label:n??i.id,to:i.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:r,...a}=e;const{activeDoc:o}=(0,Be.zK)(r),i=(0,$e.fW)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,c.jsx)(oe,{exact:!0,...a,isActive:()=>o?.sidebar===t,label:n??i.label,to:i.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:r,...a}=e;const o=(0,$e.Vd)(r)[0],i=t??o.label,l=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(o).path;return(0,c.jsx)(oe,{...a,label:i,to:l})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:r,dropdownItemsBefore:a,dropdownItemsAfter:o,...i}=e;const{search:u,hash:d}=(0,l.zy)(),p=(0,Be.zK)(n),f=(0,Be.jh)(n),{savePreferredVersionName:m}=(0,Ue.g1)(n),h=[...a,...f.map((e=>{const t=p.alternateDocVersions[e.name]??qe(e);return{label:e.label,to:`${t.path}${u}${d}`,isActive:()=>e===p.activeVersion,onClick:()=>m(e.name)}})),...o],g=(0,$e.Vd)(n)[0],y=t&&h.length>1?(0,s.T)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):g.label,b=t&&h.length>1?void 0:qe(g).path;return h.length<=1?(0,c.jsx)(oe,{...i,mobile:t,label:y,to:b,isActive:r?()=>!1:void 0}):(0,c.jsx)(fe,{...i,mobile:t,label:y,to:b,items:h,isActive:r?()=>!1:void 0})}};function Ge(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),a=He[r];if(!a)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,c.jsx)(a,{...n})}function We(){const e=(0,j.M)(),t=(0,w.p)().navbar.items;return(0,c.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(Ge,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function Ve(e){return(0,c.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,c.jsx)(s.A,{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)",children:"\u2190 Back to main menu"})})}function Ke(){const e=0===(0,w.p)().navbar.items.length,t=I();return(0,c.jsxs)(c.Fragment,{children:[!e&&(0,c.jsx)(Ve,{onClick:()=>t.hide()}),t.content]})}function Qe(){const e=(0,j.M)();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?(0,c.jsx)(M,{header:(0,c.jsx)(Y,{}),primaryMenu:(0,c.jsx)(We,{}),secondaryMenu:(0,c.jsx)(Ke,{})}):null}const Ye={navbarHideable:"navbarHideable_n_Qk",navbarHidden:"navbarHidden_KuZm"};function Ze(e){return(0,c.jsx)("div",{role:"presentation",...e,className:(0,a.A)("navbar-sidebar__backdrop",e.className)})}function Xe(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,w.p)(),i=(0,j.M)(),{navbarRef:l,isNavbarVisible:d}=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,R.Mq)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=l?n(!1):i+u{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return a.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return(0,c.jsxs)("nav",{ref:l,"aria-label":(0,s.T)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,a.A)("navbar","navbar--fixed-top",n&&[Ye.navbarHideable,!d&&Ye.navbarHidden],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown}),children:[t,(0,c.jsx)(Ze,{onClick:i.toggle}),(0,c.jsx)(Qe,{})]})}var Je=n(5785);const et={errorBoundaryError:"errorBoundaryError_peHz",errorBoundaryFallback:"errorBoundaryFallback_UTTJ"};function tt(e){return(0,c.jsx)("button",{type:"button",...e,children:(0,c.jsx)(s.A,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function nt(e){let{error:t}=e;const n=(0,Je.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,c.jsx)("p",{className:et.errorBoundaryError,children:n})}class rt extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const at="right";function ot(e){let{width:t=30,height:n=30,className:r,...a}=e;return(0,c.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...a,children:(0,c.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function it(){const{toggle:e,shown:t}=(0,j.M)();return(0,c.jsx)("button",{onClick:e,"aria-label":(0,s.T)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,c.jsx)(ot,{})})}const lt={colorModeToggle:"colorModeToggle_cdjb"};function st(e){let{items:t}=e;return(0,c.jsx)(c.Fragment,{children:t.map(((e,t)=>(0,c.jsx)(rt,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,c.jsx)(Ge,{...e})},t)))})}function ut(e){let{left:t,right:n}=e;return(0,c.jsxs)("div",{className:"navbar__inner",children:[(0,c.jsx)("div",{className:"navbar__items",children:t}),(0,c.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function ct(){const e=(0,j.M)(),t=(0,w.p)().navbar.items,[n,r]=function(e){function t(e){return"left"===(e.position??at)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),a=t.find((e=>"search"===e.type));return(0,c.jsx)(ut,{left:(0,c.jsxs)(c.Fragment,{children:[!e.disabled&&(0,c.jsx)(it,{}),(0,c.jsx)(K,{}),(0,c.jsx)(st,{items:n})]}),right:(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(st,{items:r}),(0,c.jsx)(W,{className:lt.colorModeToggle}),!a&&(0,c.jsx)(ze,{children:(0,c.jsx)(Me,{})})]})})}function dt(){return(0,c.jsx)(Xe,{children:(0,c.jsx)(ct,{})})}function pt(e){let{item:t}=e;const{to:n,href:r,label:a,prependBaseUrlToHref:o,...i}=t,l=(0,X.Ay)(n),s=(0,X.Ay)(r,{forcePrependBaseUrl:!0});return(0,c.jsxs)(Z.A,{className:"footer__link-item",...r?{href:o?s:r}:{to:l},...i,children:[a,r&&!(0,J.A)(r)&&(0,c.jsx)(te.A,{})]})}function ft(e){let{item:t}=e;return t.html?(0,c.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,c.jsx)("li",{className:"footer__item",children:(0,c.jsx)(pt,{item:t})},t.href??t.to)}function mt(e){let{column:t}=e;return(0,c.jsxs)("div",{className:"col footer__col",children:[(0,c.jsx)("div",{className:"footer__title",children:t.title}),(0,c.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,c.jsx)(ft,{item:e},t)))})]})}function ht(e){let{columns:t}=e;return(0,c.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,c.jsx)(mt,{column:e},t)))})}function gt(){return(0,c.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function yt(e){let{item:t}=e;return t.html?(0,c.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,c.jsx)(pt,{item:t})}function bt(e){let{links:t}=e;return(0,c.jsx)("div",{className:"footer__links text--center",children:(0,c.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,c.jsxs)(r.Fragment,{children:[(0,c.jsx)(yt,{item:e}),t.length!==n+1&&(0,c.jsx)(gt,{})]},n)))})})}function vt(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,c.jsx)(ht,{columns:t}):(0,c.jsx)(bt,{links:t})}var wt=n(7818);const kt={footerLogoLink:"footerLogoLink_Z2l7"};function xt(e){let{logo:t}=e;const{withBaseUrl:n}=(0,X.hH)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,c.jsx)(wt.A,{className:(0,a.A)("footer__logo",t.className),alt:t.alt,sources:r,width:t.width,height:t.height,style:t.style})}function St(e){let{logo:t}=e;return t.href?(0,c.jsx)(Z.A,{href:t.href,className:kt.footerLogoLink,target:t.target,children:(0,c.jsx)(xt,{logo:t})}):(0,c.jsx)(xt,{logo:t})}function Et(e){let{copyright:t}=e;return(0,c.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function Ct(e){let{style:t,links:n,logo:r,copyright:o}=e;return(0,c.jsx)("footer",{className:(0,a.A)("footer",{"footer--dark":"dark"===t}),children:(0,c.jsxs)("div",{className:"container container-fluid",children:[n,(r||o)&&(0,c.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,c.jsx)("div",{className:"margin-bottom--sm",children:r}),o]})]})})}function _t(){const{footer:e}=(0,w.p)();if(!e)return null;const{copyright:t,links:n,logo:r,style:a}=e;return(0,c.jsx)(Ct,{style:a,links:n&&n.length>0&&(0,c.jsx)(vt,{links:n}),logo:r&&(0,c.jsx)(St,{logo:r}),copyright:t&&(0,c.jsx)(Et,{copyright:t})})}const Tt=r.memo(_t),At=(0,N.fM)([F.a,k.o,R.Tv,Ue.VQ,i.Jx,function(e){let{children:t}=e;return(0,c.jsx)(L.y_,{children:(0,c.jsx)(j.e,{children:(0,c.jsx)(O,{children:t})})})}]);function jt(e){let{children:t}=e;return(0,c.jsx)(At,{children:t})}var Rt=n(4182);function Nt(e){let{error:t,tryAgain:n}=e;return(0,c.jsx)("main",{className:"container margin-vert--xl",children:(0,c.jsx)("div",{className:"row",children:(0,c.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,c.jsx)(Rt.A,{as:"h1",className:"hero__title",children:(0,c.jsx)(s.A,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,c.jsx)("div",{className:"margin-vert--lg",children:(0,c.jsx)(tt,{onClick:n,className:"button button--primary shadow--lw"})}),(0,c.jsx)("hr",{}),(0,c.jsx)("div",{className:"margin-vert--md",children:(0,c.jsx)(nt,{error:t})})]})})})}const Lt={mainWrapper:"mainWrapper_InnT"};function Pt(e){const{children:t,noFooter:n,wrapperClassName:r,title:l,description:s}=e;return(0,y.J)(),(0,c.jsxs)(jt,{children:[(0,c.jsx)(i.be,{title:l,description:s}),(0,c.jsx)(v,{}),(0,c.jsx)(A,{}),(0,c.jsx)(dt,{}),(0,c.jsx)("div",{id:d,className:(0,a.A)(g.G.wrapper.main,Lt.mainWrapper,r),children:(0,c.jsx)(o.A,{fallback:e=>(0,c.jsx)(Nt,{...e}),children:t})}),!n&&(0,c.jsx)(Tt,{})]})}},8867:(e,t,n)=>{"use strict";n.d(t,{A:()=>c});n(758);var r=n(977),a=n(7126),o=n(2477),i=n(7231),l=n(7818),s=n(6070);function u(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,a.Ay)(t.src),dark:(0,a.Ay)(t.srcDark||t.src)},i=(0,s.jsx)(l.A,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,s.jsx)("div",{className:r,children:i}):i}function c(e){const{siteConfig:{title:t}}=(0,o.A)(),{navbar:{title:n,logo:l}}=(0,i.p)(),{imageClassName:c,titleClassName:d,...p}=e,f=(0,a.Ay)(l?.href||"/"),m=n?"":t,h=l?.alt??m;return(0,s.jsxs)(r.A,{to:f,...p,...l?.target&&{target:l.target},children:[l&&(0,s.jsx)(u,{logo:l,alt:h,imageClassName:c}),null!=n&&(0,s.jsx)("b",{className:d,children:n})]})}},5289:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});n(758);var r=n(2871),a=n(6070);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return(0,a.jsxs)(r.A,{children:[t&&(0,a.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,a.jsx)("meta",{name:"docusaurus_version",content:n}),o&&(0,a.jsx)("meta",{name:"docusaurus_tag",content:o}),i&&(0,a.jsx)("meta",{name:"docsearch:language",content:i}),n&&(0,a.jsx)("meta",{name:"docsearch:version",content:n}),o&&(0,a.jsx)("meta",{name:"docsearch:docusaurus_tag",content:o})]})}},7818:(e,t,n)=>{"use strict";n.d(t,{A:()=>c});var r=n(758),a=n(3526),o=n(9536),i=n(3776);const l={themedComponent:"themedComponent_jhL8","themedComponent--light":"themedComponent--light_eGQp","themedComponent--dark":"themedComponent--dark_WiuS"};var s=n(6070);function u(e){let{className:t,children:n}=e;const u=(0,o.A)(),{colorMode:c}=(0,i.G)();return(0,s.jsx)(s.Fragment,{children:(u?"dark"===c?["dark"]:["light"]:["light","dark"]).map((e=>{const o=n({theme:e,className:(0,a.A)(t,l.themedComponent,l[`themedComponent--${e}`])});return(0,s.jsx)(r.Fragment,{children:o},e)}))})}function c(e){const{sources:t,className:n,alt:r,...a}=e;return(0,s.jsx)(u,{className:n,children:e=>{let{theme:n,className:o}=e;return(0,s.jsx)("img",{src:t[n],alt:r,className:o,...a})}})}},4315:(e,t,n)=>{"use strict";n.d(t,{N:()=>y,u:()=>u});var r=n(758),a=n(878),o=n(8708),i=n(7824),l=n(6070);const s="ease-in-out";function u(e){let{initialState:t}=e;const[n,a]=(0,r.useState)(t??!1),o=(0,r.useCallback)((()=>{a((e=>!e))}),[]);return{collapsed:n,setCollapsed:a,toggleCollapsed:o}}const c={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?c:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function f(e){let{collapsibleRef:t,collapsed:n,animation:a}=e;const o=(0,r.useRef)(!1);(0,r.useEffect)((()=>{const e=t.current;function r(){const t=e.scrollHeight,n=a?.duration??function(e){if((0,i.O)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${a?.easing??s}`,height:`${t}px`}}function l(){const t=r();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return p(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(l(),requestAnimationFrame((()=>{e.style.height=c.height,e.style.overflow=c.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{l()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,a])}function m(e){if(!a.A.canUseDOM)return e?c:d}function h(e){let{as:t="div",collapsed:n,children:a,animation:o,onCollapseTransitionEnd:i,className:s,disableSSRStyle:u}=e;const c=(0,r.useRef)(null);return f({collapsibleRef:c,collapsed:n,animation:o}),(0,l.jsx)(t,{ref:c,style:u?void 0:m(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(c.current,n),i?.(n))},className:s,children:a})}function g(e){let{collapsed:t,...n}=e;const[a,i]=(0,r.useState)(!t),[s,u]=(0,r.useState)(t);return(0,o.A)((()=>{t||i(!0)}),[t]),(0,o.A)((()=>{a&&u(t)}),[a,t]),a?(0,l.jsx)(h,{...n,collapsed:s}):null}function y(e){let{lazy:t,...n}=e;const r=t?g:h;return(0,l.jsx)(r,{...n})}},8264:(e,t,n)=>{"use strict";n.d(t,{M:()=>h,o:()=>m});var r=n(758),a=n(9536),o=n(9465),i=n(7853),l=n(7231),s=n(6070);const u=(0,o.Wf)("docusaurus.announcement.dismiss"),c=(0,o.Wf)("docusaurus.announcement.id"),d=()=>"true"===u.get(),p=e=>u.set(String(e)),f=r.createContext(null);function m(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.p)(),t=(0,a.A)(),[n,o]=(0,r.useState)((()=>!!t&&d()));(0,r.useEffect)((()=>{o(d())}),[]);const i=(0,r.useCallback)((()=>{p(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=c.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;c.set(t),r&&p(!1),!r&&d()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return(0,s.jsx)(f.Provider,{value:n,children:t})}function h(){const e=(0,r.useContext)(f);if(!e)throw new i.dV("AnnouncementBarProvider");return e}},3776:(e,t,n)=>{"use strict";n.d(t,{G:()=>y,a:()=>g});var r=n(758),a=n(878),o=n(7853),i=n(9465),l=n(7231),s=n(6070);const u=r.createContext(void 0),c="theme",d=(0,i.Wf)(c),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,m=e=>a.A.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),h=e=>{d.set(f(e))};function g(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.p)(),[a,o]=(0,r.useState)(m(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(o(t),a&&h(t)):(o(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(a))}),[a]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==c)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const s=(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||s.current?s.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:a,setColorMode:i,get isDarkTheme(){return a===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[a,i])}();return(0,s.jsx)(u.Provider,{value:n,children:t})}function y(){const e=(0,r.useContext)(u);if(null==e)throw new o.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},5438:(e,t,n)=>{"use strict";n.d(t,{VQ:()=>y,XK:()=>w,g1:()=>v});var r=n(758),a=n(5889),o=n(4636),i=n(7231),l=n(237),s=n(7853),u=n(9465),c=n(6070);const d=e=>`docs-preferred-version-${e}`,p={save:(e,t,n)=>{(0,u.Wf)(d(e),{persistence:t}).set(n)},read:(e,t)=>(0,u.Wf)(d(e),{persistence:t}).get(),clear:(e,t)=>{(0,u.Wf)(d(e),{persistence:t}).del()}},f=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const m=r.createContext(null);function h(){const e=(0,a.Gy)(),t=(0,i.p)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,l]=(0,r.useState)((()=>f(n)));(0,r.useEffect)((()=>{l(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=p.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p.clear(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){p.save(e,t,n),l((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function g(e){let{children:t}=e;const n=h();return(0,c.jsx)(m.Provider,{value:n,children:t})}function y(e){let{children:t}=e;return l.C5?(0,c.jsx)(g,{children:t}):(0,c.jsx)(c.Fragment,{children:t})}function b(){const e=(0,r.useContext)(m);if(!e)throw new s.dV("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=o.W);const t=(0,a.ht)(e),[n,i]=b(),{preferredVersionName:l}=n[e];return{preferredVersion:t.versions.find((e=>e.name===l))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}function w(){const e=(0,a.Gy)(),[t]=b();function n(n){const r=e[n],{preferredVersionName:a}=t[n];return r.versions.find((e=>e.name===a))??null}const r=Object.keys(e);return Object.fromEntries(r.map((e=>[e,n(e)])))}},7889:(e,t,n)=>{"use strict";n.d(t,{V:()=>s,t:()=>u});var r=n(758),a=n(7853),o=n(6070);const i=Symbol("EmptyContext"),l=r.createContext(i);function s(e){let{children:t,name:n,items:a}=e;const i=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return(0,o.jsx)(l.Provider,{value:i,children:t})}function u(){const e=(0,r.useContext)(l);if(e===i)throw new a.dV("DocsSidebarProvider");return e}},3377:(e,t,n)=>{"use strict";n.d(t,{n:()=>l,r:()=>s});var r=n(758),a=n(7853),o=n(6070);const i=r.createContext(null);function l(e){let{children:t,version:n}=e;return(0,o.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(null===e)throw new a.dV("DocsVersionProvider");return e}},844:(e,t,n)=>{"use strict";n.d(t,{M:()=>f,e:()=>p});var r=n(758),a=n(5765),o=n(4542),i=n(4232),l=n(7231),s=n(7853),u=n(6070);const c=r.createContext(void 0);function d(){const e=function(){const e=(0,a.YL)(),{items:t}=(0,l.p)().navbar;return 0===t.length&&!e.component}(),t=(0,o.l)(),n=!e&&"mobile"===t,[s,u]=(0,r.useState)(!1);(0,i.$Z)((()=>{if(s)return u(!1),!1}));const c=(0,r.useCallback)((()=>{u((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&u(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:c,shown:s})),[e,n,c,s])}function p(e){let{children:t}=e;const n=d();return(0,u.jsx)(c.Provider,{value:n,children:t})}function f(){const e=r.useContext(c);if(void 0===e)throw new s.dV("NavbarMobileSidebarProvider");return e}},5765:(e,t,n)=>{"use strict";n.d(t,{GX:()=>u,YL:()=>s,y_:()=>l});var r=n(758),a=n(7853),o=n(6070);const i=r.createContext(null);function l(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return(0,o.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(!e)throw new a.dV("NavbarSecondaryMenuContentProvider");return e[0]}function u(e){let{component:t,props:n}=e;const o=(0,r.useContext)(i);if(!o)throw new a.dV("NavbarSecondaryMenuContentProvider");const[,l]=o,s=(0,a.Be)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},7978:(e,t,n)=>{"use strict";n.d(t,{w:()=>a,J:()=>o});var r=n(758);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)}}),[])}},3668:(e,t,n)=>{"use strict";n.d(t,{b:()=>l,w:()=>s});var r=n(758),a=n(2477),o=n(4232);const i="q";function l(){return(0,o.l)(i)}function s(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,a.A)(),{algolia:{searchPagePath:n}}=t;return(0,r.useCallback)((t=>`${e}${n}?${i}=${encodeURIComponent(t)}`),[e,n])}},4542:(e,t,n)=>{"use strict";n.d(t,{l:()=>l});var r=n(758),a=n(878);const o={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function l(e){let{desktopBreakpoint:t=i}=void 0===e?{}:e;const[n,l]=(0,r.useState)((()=>"ssr"));return(0,r.useEffect)((()=>{function e(){l(function(e){if(!a.A.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?o.desktop:o.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),n}},9960:(e,t,n)=>{"use strict";n.d(t,{G:()=>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",unlistedBanner:"theme-unlisted-banner",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:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},7824:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{O:()=>r})},237:(e,t,n)=>{"use strict";n.d(t,{B5:()=>E,C5:()=>p,Nr:()=>f,OF:()=>w,QB:()=>S,Vd:()=>k,Y:()=>b,fW:()=>x,w8:()=>g});var r=n(758),a=n(5557),o=n(389),i=n(5889),l=n(5438),s=n(3377),u=n(7889),c=n(2553),d=n(1098);const p=!!i.Gy;function f(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=f(t);if(e)return e}}(e):void 0:e.href}const m=(e,t)=>void 0!==e&&(0,d.ys)(e,t),h=(e,t)=>e.some((e=>g(e,t)));function g(e,t){return"link"===e.type?m(e.href,t):"category"===e.type&&(m(e.href,t)||h(e.items,t))}function y(e,t){switch(e.type){case"category":return g(e,t)||e.items.some((e=>y(e,t)));case"link":return!e.unlisted||g(e,t);default:return!0}}function b(e,t){return(0,r.useMemo)((()=>e.filter((e=>y(e,t)))),[e,t])}function v(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const a=[];return function e(t){for(const o of t)if("category"===o.type&&((0,d.ys)(o.href,n)||e(o.items))||"link"===o.type&&(0,d.ys)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function w(){const e=(0,u.t)(),{pathname:t}=(0,a.zy)(),n=(0,i.vT)()?.pluginData.breadcrumbs;return!1!==n&&e?v({sidebarItems:e.items,pathname:t}):null}function k(e){const{activeVersion:t}=(0,i.zK)(e),{preferredVersion:n}=(0,l.g1)(e),a=(0,i.r7)(e);return(0,r.useMemo)((()=>(0,c.s)([t,n,a].filter(Boolean))),[t,n,a])}function x(e,t){const n=k(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(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function S(e,t){const n=k(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(`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- ${(0,c.s)(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function E(e){let{route:t}=e;const n=(0,a.zy)(),r=(0,s.r)(),i=t.routes,l=i.find((e=>(0,a.B6)(n.pathname,e)));if(!l)return null;const u=l.sidebar,c=u?r.docsSidebars[u]:void 0;return{docElement:(0,o.v)(i),sidebarName:u,sidebarItems:c}}},9328:(e,t,n)=>{"use strict";n.d(t,{s:()=>a});var r=n(2477);function a(e){const{siteConfig:t}=(0,r.A)(),{title:n,titleDelimiter:a}=t;return e?.trim().length?`${e.trim()} ${a} ${n}`:n}},4232:(e,t,n)=>{"use strict";n.d(t,{$Z:()=>i,aZ:()=>s,l:()=>u});var r=n(758),a=n(5557),o=n(7853);function i(e){!function(e){const t=(0,a.W6)(),n=(0,o._q)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function l(e){const t=(0,a.W6)();return(0,r.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}function s(e){return l((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}function u(e){const t=s(e)??"",n=function(e){const t=(0,a.W6)();return(0,r.useCallback)(((n,r)=>{const a=new URLSearchParams(t.location.search);n?a.set(e,n):a.delete(e),(r?.push?t.push:t.replace)({search:a.toString()})}),[e,t])}(e);return[t,n]}},2553:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function a(e){return Array.from(new Set(e))}n.d(t,{X:()=>r,s:()=>a})},1332:(e,t,n)=>{"use strict";n.d(t,{e3:()=>f,be:()=>d,Jx:()=>m});var r=n(758),a=n(3526),o=n(2871),i=n(6737);function l(){const e=r.useContext(i.o);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(7126),u=n(9328),c=n(6070);function d(e){let{title:t,description:n,keywords:r,image:a,children:i}=e;const l=(0,u.s)(t),{withBaseUrl:d}=(0,s.hH)(),p=a?d(a,{absolute:!0}):void 0;return(0,c.jsxs)(o.A,{children:[t&&(0,c.jsx)("title",{children:l}),t&&(0,c.jsx)("meta",{property:"og:title",content:l}),n&&(0,c.jsx)("meta",{name:"description",content:n}),n&&(0,c.jsx)("meta",{property:"og:description",content:n}),r&&(0,c.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),p&&(0,c.jsx)("meta",{property:"og:image",content:p}),p&&(0,c.jsx)("meta",{name:"twitter:image",content:p}),i]})}const p=r.createContext(void 0);function f(e){let{className:t,children:n}=e;const i=r.useContext(p),l=(0,a.A)(i,t);return(0,c.jsxs)(p.Provider,{value:l,children:[(0,c.jsx)(o.A,{children:(0,c.jsx)("html",{className:l})}),n]})}function m(e){let{children:t}=e;const n=l(),r=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const o=`plugin-id-${n.plugin.id}`;return(0,c.jsx)(f,{className:(0,a.A)(r,o),children:t})}},7853:(e,t,n)=>{"use strict";n.d(t,{Be:()=>u,ZC:()=>l,_q:()=>i,dV:()=>s,fM:()=>c});var r=n(758),a=n(8708),o=n(6070);function i(e){const t=(0,r.useRef)(e);return(0,a.A)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function l(e){const t=(0,r.useRef)();return(0,a.A)((()=>{t.current=e})),t.current}class s extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function u(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function c(e){return t=>{let{children:n}=t;return(0,o.jsx)(o.Fragment,{children:e.reduceRight(((e,t)=>(0,o.jsx)(t,{children:e})),n)})}}},1739:(e,t,n)=>{"use strict";function r(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}n.d(t,{G:()=>r})},1098:(e,t,n)=>{"use strict";n.d(t,{Dt:()=>l,ys:()=>i});var r=n(758),a=n(8607),o=n(2477);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function l(){const{baseUrl:e}=(0,o.A)().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=>e.routes??[])))}(n)}({routes:a.A,baseUrl:e})),[e])}},4727:(e,t,n)=>{"use strict";n.d(t,{Mq:()=>f,Tv:()=>c,a_:()=>m,gk:()=>h});var r=n(758),a=n(878),o=n(9536),i=n(8708),l=n(7853),s=n(6070);const u=r.createContext(void 0);function c(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(0,s.jsx)(u.Provider,{value:n,children:t})}function d(){const e=(0,r.useContext)(u);if(null==e)throw new l.dV("ScrollControllerProvider");return e}const p=()=>a.A.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=d(),a=(0,r.useRef)(p()),o=(0,l._q)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();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 m(){const e=d(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}}),[]);return(0,r.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,r.useRef)(void 0),a=(0,r.useCallback)((r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,i.A)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:a}}function h(){const e=(0,r.useRef)(null),t=(0,o.A)()&&"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:()=>e.current?.()}}},7600:(e,t,n)=>{"use strict";n.d(t,{Cy:()=>i,af:()=>s,tU:()=>l});var r=n(5889),a=n(2477),o=n(5438);const i="default";function l(e,t){return`docs-${e}-${t}`}function s(){const{i18n:e}=(0,a.A)(),t=(0,r.Gy)(),n=(0,r.gk)(),s=(0,o.XK)();const u=[i,...Object.keys(t).map((function(e){const r=n?.activePlugin.pluginId===e?n.activeVersion:void 0,a=s[e],o=t[e].versions.find((e=>e.isLast));return l(e,(r??a??o).name)}))];return{locale:e.currentLocale,tags:u}}},9465:(e,t,n)=>{"use strict";n.d(t,{Wf:()=>c,Dv:()=>d});var r=n(758);const a=JSON.parse('{"N":"localStorage","M":""}'),o=a.N;function i(e){let{key:t,oldValue:n,newValue:r,storage:a}=e;if(n===r)return;const o=document.createEvent("StorageEvent");o.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,a),window.dispatchEvent(o)}function l(e){if(void 0===e&&(e=o),"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,s||(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),s=!0),null}var t}let s=!1;const u={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function c(e,t){const n=`${e}${a.M}`;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,listen:t}}(n);const r=l(t?.persistence);return null===r?u:{get:()=>{try{return r.getItem(n)}catch(e){return console.error(`Docusaurus storage error, can't get key=${n}`,e),null}},set:e=>{try{const t=r.getItem(n);r.setItem(n,e),i({key:n,oldValue:t,newValue:e,storage:r})}catch(t){console.error(`Docusaurus storage error, can't set ${n}=${e}`,t)}},del:()=>{try{const e=r.getItem(n);r.removeItem(n),i({key:n,oldValue:e,newValue:null,storage:r})}catch(e){console.error(`Docusaurus storage error, can't delete key=${n}`,e)}},listen:e=>{try{const t=t=>{t.storageArea===r&&t.key===n&&e(t)};return window.addEventListener("storage",t),()=>window.removeEventListener("storage",t)}catch(t){return console.error(`Docusaurus storage error, can't listen for changes of key=${n}`,t),()=>{}}}}}function d(e,t){const n=(0,r.useRef)((()=>null===e?u:c(e,t))).current(),a=(0,r.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,r.useSyncExternalStore)(a,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}},9564:(e,t,n)=>{"use strict";n.d(t,{o:()=>i});var r=n(2477),a=n(5557),o=n(5785);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:l}}=(0,r.A)(),{pathname:s}=(0,a.zy)(),u=(0,o.applyTrailingSlash)(s,{trailingSlash:n,baseUrl:e}),c=l===i?e:e.replace(`/${l}/`,"/"),d=u.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${c}`:`${c}${e}/`}(n)}${d}`}}}},6289:(e,t,n)=>{"use strict";n.d(t,{$:()=>i});var r=n(758),a=n(5557),o=n(7853);function i(e){const t=(0,a.zy)(),n=(0,o.ZC)(t),i=(0,o._q)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},7231:(e,t,n)=>{"use strict";n.d(t,{p:()=>a});var r=n(2477);function a(){return(0,r.A)().siteConfig.themeConfig}},1328:(e,t,n)=>{"use strict";n.d(t,{c:()=>a});var r=n(2477);function a(){const{siteConfig:{themeConfig:e}}=(0,r.A)();return e}},4584:(e,t,n)=>{"use strict";n.d(t,{C:()=>l});var r=n(758),a=n(1739),o=n(7126),i=n(1328);function l(){const{withBaseUrl:e}=(0,o.hH)(),{algolia:{externalUrlRegex:t,replaceSearchResultPathname:n}}=(0,i.c)();return(0,r.useCallback)((r=>{const o=new URL(r);if((0,a.G)(t,o.href))return r;const i=`${o.pathname+o.hash}`;return e(function(e,t){return t?e.replaceAll(new RegExp(t.from,"g"),t.to):e}(i,n))}),[e,t,n])}},6316:(e,t,n)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.removeTrailingSlash=t.addLeadingSlash=t.addTrailingSlash=void 0;const r=n(4507);function a(e){return e.endsWith("/")?e:`${e}/`}function o(e){return(0,r.removeSuffix)(e,"/")}t.addTrailingSlash=a,t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[i]=e.split(/[#?]/),l="/"===i||i===r?i:(s=i,n?a(s):o(s));var s;return e.replace(i,l)},t.addLeadingSlash=function(e){return(0,r.addPrefix)(e,"/")},t.removeTrailingSlash=o},7370:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},5785: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.getErrorCausalChain=t.removePrefix=t.addSuffix=t.removeSuffix=t.addPrefix=t.removeTrailingSlash=t.addLeadingSlash=t.addTrailingSlash=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var a=n(6316);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}}),Object.defineProperty(t,"addTrailingSlash",{enumerable:!0,get:function(){return a.addTrailingSlash}}),Object.defineProperty(t,"addLeadingSlash",{enumerable:!0,get:function(){return a.addLeadingSlash}}),Object.defineProperty(t,"removeTrailingSlash",{enumerable:!0,get:function(){return a.removeTrailingSlash}});var o=n(4507);Object.defineProperty(t,"addPrefix",{enumerable:!0,get:function(){return o.addPrefix}}),Object.defineProperty(t,"removeSuffix",{enumerable:!0,get:function(){return o.removeSuffix}}),Object.defineProperty(t,"addSuffix",{enumerable:!0,get:function(){return o.addSuffix}}),Object.defineProperty(t,"removePrefix",{enumerable:!0,get:function(){return o.removePrefix}});var i=n(7370);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return i.getErrorCausalChain}})},4507:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.removePrefix=t.addSuffix=t.removeSuffix=t.addPrefix=void 0,t.addPrefix=function(e,t){return e.startsWith(t)?e:`${t}${e}`},t.removeSuffix=function(e,t){return""===t?e:e.endsWith(t)?e.slice(0,-t.length):e},t.addSuffix=function(e,t){return e.endsWith(t)?e:`${e}${t}`},t.removePrefix=function(e,t){return e.startsWith(t)?e.slice(t.length):e}},3332:(e,t,n)=>{"use strict";n.d(t,{zR:()=>w,TM:()=>_,yJ:()=>f,sC:()=>A,AO:()=>p});var r=n(4454);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;p--){var f=i[p];"."===f?o(i,p):".."===f?(o(i,p),d++):d&&(o(i,p),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(5385);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 p(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 f(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.A)({},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=f(e,t,h(),w.location);c.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(5959),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,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var a=f(n);a&&a!==m&&e(t,a,r)}var i=c(n);d&&(i=i.concat(d(n)));for(var l=s(t),h=s(n),g=0;g{"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}}},5526:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},57:(e,t,n)=>{"use strict";n.r(t)},6389:(e,t,n)=>{"use strict";n.r(t)},8744: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))&&f(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&&f(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:p(e)).indexOf(" "+t+" ")>=0}function c(e,t){var n=p(e),r=n+t;u(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);u(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(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)},6150:(e,t,n)=>{var r=n(5526);e.exports=f,e.exports.parse=o,e.exports.compile=function(e,t){return l(o(e,t),t)},e.exports.tokensToFunction=l,e.exports.tokensToRegExp=p;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],p=n[1],f=n.index;if(l+=e.slice(i,f),i=f+d.length,p)l+=p[1];else{var m=e[i],h=n[2],g=n[3],y=n[4],b=n[5],v=n[6],w=n[7];l&&(r.push(l),l="");var k=null!=h&&null!=m&&m!==h,x="+"===v||"*"===v,S="?"===v||"*"===v,E=n[2]||c,C=y||b;r.push({name:g||o++,prefix:h||"",delimiter:E,optional:S,repeat:x,partial:k,asterisk:!!w,pattern:C?u(C):w?".*":"[^"+s(E)+"]+?"})}}return i{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:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},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"},bqn:{title:"BQN",owner:"yewscion"},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"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},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"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},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"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},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"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},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"}}})},6532:(e,t,n)=>{const r=n(9227),a=n(9670),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(7507).resolve(t)],delete Prism.languages[e],n(7507)(t),o.add(e)}))}i.silent=!1,e.exports=i},1274:()=>{!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],p="string"==typeof u?u:u.content,f=t(r,c),m=p.indexOf(f);if(m>-1){++a;var h=p.substring(0,m),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),y=p.substring(m+f.length),b=[];h&&b.push.apply(b,i([h])),b.push(g),y&&b.push.apply(b,i([y])),"string"==typeof u?l.splice.apply(l,[s,1].concat(b)):u.content=b}}else u.content&&i(u.content)}return l}(n.tokens)}}}})}(Prism)},7507:(e,t,n)=>{var r={"./":6532};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=7507},9670: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 p,f=r(s),m=c;a(m);){for(var h in p={},m){var g=s[h];t(g&&g.modify,(function(e){e in d&&(p[e]=!0)}))}for(var y in d)if(!(y in c))for(var b in f(y))if(b in c){p[y]=!0;break}for(var v in m=p)c[v]=!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 p=i(c.map((function(e){var t=u(e);return delete s[e],t})));o?a=o(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var c in n)u(c);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,c,t,n)}};return w}}();e.exports=t},6186:(e,t,n)=>{"use strict";var r=n(2985);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}},2736:(e,t,n)=>{e.exports=n(6186)()},2985:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},9481:(e,t,n)=>{"use strict";var r=n(758),a=n(1896);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n