From 20f538318943a1aba4eb8fd00cb395f89ea3d927 Mon Sep 17 00:00:00 2001 From: John David Johnson II Date: Tue, 20 Feb 2024 12:01:54 -0700 Subject: [PATCH] Deploy website - based on 6b2073a197be51fe173de253d7713111b28047e0 --- 404.html | 4 +-- ...8fe2f.88802ccc.js => 0058fe2f.c13f3943.js} | 2 +- ...f5e8d.91f48d5f.js => 09bf5e8d.bc5211f0.js} | 2 +- ...12579.cb1c072c.js => 0cb12579.6989be22.js} | 2 +- assets/js/0e384e19.86b222cf.js | 1 + assets/js/0e384e19.c05a3fc3.js | 1 - assets/js/1de72b33.5cf1c32d.js | 1 + assets/js/1de72b33.b669ce99.js | 1 - ...d1479.122b0c94.js => 226d1479.13fec60c.js} | 2 +- ...08a28.cd49ab83.js => 36308a28.10232771.js} | 2 +- ...b7480.42b85899.js => 5e0b7480.9b035393.js} | 2 +- assets/js/5e8c322a.01c3c6dc.js | 1 + assets/js/5e8c322a.105b0547.js | 1 - assets/js/72daadc5.09120e37.js | 1 - assets/js/72daadc5.9a0f56fe.js | 1 + ...f2afb.dbf0c178.js => 935f2afb.6c944cb4.js} | 2 +- assets/js/a34174ca.886730a3.js | 1 + assets/js/a34174ca.9762761b.js | 1 - assets/js/f6aebfbf.3d3b8975.js | 1 + assets/js/f6aebfbf.9739d279.js | 1 - .../js/{main.43c86a0a.js => main.b6fc0b3d.js} | 4 +-- ...CENSE.txt => main.b6fc0b3d.js.LICENSE.txt} | 0 ...n.249c0926.js => runtime~main.fea508d5.js} | 2 +- blog.html | 4 +-- blog/archive.html | 4 +-- blog/first-blog-post.html | 4 +-- blog/tags.html | 4 +-- blog/tags/connections.html | 4 +-- blog/tags/relay-connections.html | 4 +-- blog/tags/relay.html | 4 +-- blog/tags/typegraphql-relay-connections.html | 4 +-- blog/tags/typegraphql.html | 4 +-- docs/Changelog.html | 14 +++++--- docs/api.html | 8 ++--- docs/api/classes/BackwardPaginationArgs.html | 8 ++--- docs/api/classes/ForwardPaginationArgs.html | 8 ++--- docs/api/classes/FullPaginationArgs.html | 12 +++---- docs/api/classes/PageInfo.html | 12 +++---- docs/api/classes/RelayConnectionType.html | 27 +++++++--------- docs/api/classes/RelayEdgeType.html | 8 ++--- docs/api/interfaces/Cursor.html | 4 +-- docs/api/modules.html | 32 +++++++++---------- docs/examples/typegraphql.html | 6 ++-- docs/intro.html | 8 ++--- docs/tutorials/custom-cursors.html | 4 +-- docs/usage/connection-type.html | 8 ++--- docs/usage/edge-type.html | 4 +-- index.html | 4 +-- lunr-index-1706112585341.json | 1 - lunr-index-1708455707505.json | 1 + lunr-index.json | 2 +- markdown-page.html | 4 +-- search-doc-1706112585341.json | 1 - search-doc-1708455707505.json | 1 + search-doc.json | 2 +- 55 files changed, 126 insertions(+), 125 deletions(-) rename assets/js/{0058fe2f.88802ccc.js => 0058fe2f.c13f3943.js} (98%) rename assets/js/{09bf5e8d.91f48d5f.js => 09bf5e8d.bc5211f0.js} (95%) rename assets/js/{0cb12579.cb1c072c.js => 0cb12579.6989be22.js} (54%) create mode 100644 assets/js/0e384e19.86b222cf.js delete mode 100644 assets/js/0e384e19.c05a3fc3.js create mode 100644 assets/js/1de72b33.5cf1c32d.js delete mode 100644 assets/js/1de72b33.b669ce99.js rename assets/js/{226d1479.122b0c94.js => 226d1479.13fec60c.js} (97%) rename assets/js/{36308a28.cd49ab83.js => 36308a28.10232771.js} (97%) rename assets/js/{5e0b7480.42b85899.js => 5e0b7480.9b035393.js} (98%) create mode 100644 assets/js/5e8c322a.01c3c6dc.js delete mode 100644 assets/js/5e8c322a.105b0547.js delete mode 100644 assets/js/72daadc5.09120e37.js create mode 100644 assets/js/72daadc5.9a0f56fe.js rename assets/js/{935f2afb.dbf0c178.js => 935f2afb.6c944cb4.js} (58%) create mode 100644 assets/js/a34174ca.886730a3.js delete mode 100644 assets/js/a34174ca.9762761b.js create mode 100644 assets/js/f6aebfbf.3d3b8975.js delete mode 100644 assets/js/f6aebfbf.9739d279.js rename assets/js/{main.43c86a0a.js => main.b6fc0b3d.js} (99%) rename assets/js/{main.43c86a0a.js.LICENSE.txt => main.b6fc0b3d.js.LICENSE.txt} (100%) rename assets/js/{runtime~main.249c0926.js => runtime~main.fea508d5.js} (89%) delete mode 100644 lunr-index-1706112585341.json create mode 100644 lunr-index-1708455707505.json delete mode 100644 search-doc-1706112585341.json create mode 100644 search-doc-1708455707505.json diff --git a/404.html b/404.html index 39627c4..e1ea3a4 100644 --- a/404.html +++ b/404.html @@ -5,8 +5,8 @@ Page Not Found | TypeGraphQL Relay Connections - - + +
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/assets/js/0058fe2f.88802ccc.js b/assets/js/0058fe2f.c13f3943.js similarity index 98% rename from assets/js/0058fe2f.88802ccc.js rename to assets/js/0058fe2f.c13f3943.js index 6a3616b..e83e2bc 100644 --- a/assets/js/0058fe2f.88802ccc.js +++ b/assets/js/0058fe2f.c13f3943.js @@ -1 +1 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[1466],{9433:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var s=r(5893),t=r(1151);const i={id:"BackwardPaginationArgs",title:"Class: BackwardPaginationArgs",sidebar_label:"BackwardPaginationArgs",sidebar_position:0,custom_edit_url:null},a=void 0,l={id:"api/classes/BackwardPaginationArgs",title:"Class: BackwardPaginationArgs",description:"Allows backward pagination of a relay connection type",source:"@site/docs/api/classes/BackwardPaginationArgs.md",sourceDirName:"api/classes",slug:"/api/classes/BackwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"BackwardPaginationArgs",title:"Class: BackwardPaginationArgs",sidebar_label:"BackwardPaginationArgs",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Exports",permalink:"/typegraphql-relay-connections/docs/api/modules"},next:{title:"ForwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs"}},c={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implemented by",id:"implemented-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"before",id:"before",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"last",id:"last",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"Allows backward pagination of a relay connection type"}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h2,{id:"implemented-by",children:"Implemented by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:(0,s.jsx)(n.code,{children:"FullPaginationArgs"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"new BackwardPaginationArgs"}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">(): ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:(0,s.jsx)(n.code,{children:"BackwardPaginationArgs"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:(0,s.jsx)(n.code,{children:"BackwardPaginationArgs"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"before",children:"before"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"before"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs records ending before the given cursor."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L42",children:"index.ts:42"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"last",children:"last"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"last"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs the last n records."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L51",children:"index.ts:51"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},1151:(e,n,r)=>{r.d(n,{Z:()=>l,a:()=>a});var s=r(7294);const t={},i=s.createContext(t);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[1466],{9433:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var s=r(5893),t=r(1151);const i={id:"BackwardPaginationArgs",title:"Class: BackwardPaginationArgs",sidebar_label:"BackwardPaginationArgs",sidebar_position:0,custom_edit_url:null},a=void 0,l={id:"api/classes/BackwardPaginationArgs",title:"Class: BackwardPaginationArgs",description:"Allows backward pagination of a relay connection type",source:"@site/docs/api/classes/BackwardPaginationArgs.md",sourceDirName:"api/classes",slug:"/api/classes/BackwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"BackwardPaginationArgs",title:"Class: BackwardPaginationArgs",sidebar_label:"BackwardPaginationArgs",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Exports",permalink:"/typegraphql-relay-connections/docs/api/modules"},next:{title:"ForwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs"}},c={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implemented by",id:"implemented-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"before",id:"before",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"last",id:"last",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"Allows backward pagination of a relay connection type"}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h2,{id:"implemented-by",children:"Implemented by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:(0,s.jsx)(n.code,{children:"FullPaginationArgs"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"new BackwardPaginationArgs"}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">(): ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:(0,s.jsx)(n.code,{children:"BackwardPaginationArgs"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:(0,s.jsx)(n.code,{children:"BackwardPaginationArgs"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"before",children:"before"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"before"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs records ending before the given cursor."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L42",children:"index.ts:42"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"last",children:"last"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"last"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs the last n records."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L51",children:"index.ts:51"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},1151:(e,n,r)=>{r.d(n,{Z:()=>l,a:()=>a});var s=r(7294);const t={},i=s.createContext(t);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/09bf5e8d.91f48d5f.js b/assets/js/09bf5e8d.bc5211f0.js similarity index 95% rename from assets/js/09bf5e8d.91f48d5f.js rename to assets/js/09bf5e8d.bc5211f0.js index d854f8c..a9d60af 100644 --- a/assets/js/09bf5e8d.91f48d5f.js +++ b/assets/js/09bf5e8d.bc5211f0.js @@ -1 +1 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[7113],{1859:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var s=r(5893),t=r(1151);const i={id:"PageInfo",title:"Class: PageInfo",sidebar_label:"PageInfo",sidebar_position:0,custom_edit_url:null},o=void 0,l={id:"api/classes/PageInfo",title:"Class: PageInfo",description:"PageInfo is information about the paging/cursoring happening on the server.",source:"@site/docs/api/classes/PageInfo.md",sourceDirName:"api/classes",slug:"/api/classes/PageInfo",permalink:"/typegraphql-relay-connections/docs/api/classes/PageInfo",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"PageInfo",title:"Class: PageInfo",sidebar_label:"PageInfo",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FullPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs"},next:{title:"RelayConnectionType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType"}},d={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"endCursor",id:"endcursor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hasNextPage",id:"hasnextpage",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"hasPreviousPage",id:"haspreviouspage",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"startCursor",id:"startcursor",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["PageInfo is information about the paging/cursoring happening on the server.\nYou can use this information to request either the next or previous pages.\nUse it in conjunction with the ",(0,s.jsx)(n.code,{children:"ForwardPaginationArgs"})," and ",(0,s.jsx)(n.code,{children:"BackwardPaginationArgs"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"new PageInfo"}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">(): ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/PageInfo",children:(0,s.jsx)(n.code,{children:"PageInfo"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/PageInfo",children:(0,s.jsx)(n.code,{children:"PageInfo"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"endcursor",children:"endCursor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"endCursor"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"The cursor representing the last record from the returned query.\nCan be used to query before or after this record."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L144",children:"index.ts:144"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hasnextpage",children:"hasNextPage"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"hasNextPage"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether the query has more records after the end cursor."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L114",children:"index.ts:114"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"haspreviouspage",children:"hasPreviousPage"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"hasPreviousPage"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether the query has more records before the start cursor."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L122",children:"index.ts:122"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"startcursor",children:"startCursor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"startCursor"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"The cursor representing the first record from the returned query.\nCan be used to query before or after this record."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L134",children:"index.ts:134"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},1151:(e,n,r)=>{r.d(n,{Z:()=>l,a:()=>o});var s=r(7294);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[7113],{1859:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var s=r(5893),t=r(1151);const i={id:"PageInfo",title:"Class: PageInfo",sidebar_label:"PageInfo",sidebar_position:0,custom_edit_url:null},o=void 0,l={id:"api/classes/PageInfo",title:"Class: PageInfo",description:"PageInfo is information about the paging/cursoring happening on the server.",source:"@site/docs/api/classes/PageInfo.md",sourceDirName:"api/classes",slug:"/api/classes/PageInfo",permalink:"/typegraphql-relay-connections/docs/api/classes/PageInfo",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"PageInfo",title:"Class: PageInfo",sidebar_label:"PageInfo",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"FullPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs"},next:{title:"RelayConnectionType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType"}},d={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"endCursor",id:"endcursor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hasNextPage",id:"hasnextpage",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"hasPreviousPage",id:"haspreviouspage",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"startCursor",id:"startcursor",level:3},{value:"Defined in",id:"defined-in-3",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.p,{children:["PageInfo is information about the paging/cursoring happening on the server.\nYou can use this information to request either the next or previous pages.\nUse it in conjunction with the ",(0,s.jsx)(n.code,{children:"ForwardPaginationArgs"})," and ",(0,s.jsx)(n.code,{children:"BackwardPaginationArgs"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"new PageInfo"}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">(): ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/PageInfo",children:(0,s.jsx)(n.code,{children:"PageInfo"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/PageInfo",children:(0,s.jsx)(n.code,{children:"PageInfo"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"endcursor",children:"endCursor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"endCursor"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"The cursor representing the last record from the returned query.\nCan be used to query before or after this record."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L144",children:"index.ts:144"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"hasnextpage",children:"hasNextPage"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"hasNextPage"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether the query has more records after the end cursor."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L114",children:"index.ts:114"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"haspreviouspage",children:"hasPreviousPage"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"hasPreviousPage"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n",(0,s.jsx)(n.p,{children:"Whether the query has more records before the start cursor."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L122",children:"index.ts:122"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"startcursor",children:"startCursor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"startCursor"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"The cursor representing the first record from the returned query.\nCan be used to query before or after this record."}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L134",children:"index.ts:134"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},1151:(e,n,r)=>{r.d(n,{Z:()=>l,a:()=>o});var s=r(7294);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0cb12579.cb1c072c.js b/assets/js/0cb12579.6989be22.js similarity index 54% rename from assets/js/0cb12579.cb1c072c.js rename to assets/js/0cb12579.6989be22.js index d8ac00e..e714d59 100644 --- a/assets/js/0cb12579.cb1c072c.js +++ b/assets/js/0cb12579.6989be22.js @@ -1 +1 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[9199],{3580:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var o=t(5893),i=t(1151);const s={sidebar_position:2},c="ConnectionType \ud83e\udd94",l={id:"usage/connection-type",title:"ConnectionType \ud83e\udd94",description:"The ConnectionType function is the slightly more complicated of the two main functions. We'll define a full example below, but if we isolate the ConnectionType by itself you'll see it looks like this:",source:"@site/docs/usage/connection-type.md",sourceDirName:"usage",slug:"/usage/connection-type",permalink:"/typegraphql-relay-connections/docs/usage/connection-type",draft:!1,unlisted:!1,editUrl:"https://github.com/johnsonjo4531/typegraphql-relay-connections/docs/blog/docs/usage/connection-type.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"EdgeType \ud83e\uddc0",permalink:"/typegraphql-relay-connections/docs/usage/edge-type"},next:{title:"Extending the Builtin Cursor \ud83d\udcc4",permalink:"/typegraphql-relay-connections/docs/tutorials/custom-cursors"}},r={},a=[];function p(e){const n={code:"code",h1:"h1",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"connectiontype-",children:"ConnectionType \ud83e\udd94"}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"ConnectionType"})," function is the slightly more complicated of the two main functions. We'll define a full example below, but if we isolate the ConnectionType by itself you'll see it looks like this:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nexport class SongConnection extends ConnectionType({\n node: Song,\n edge: SongEdge\n}) {\n // You can add additional Types to your ConnectionType that are specific to it here:\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["To have a more complete example all you need to do is create a ",(0,o.jsx)(n.code,{children:"ObjectType"})," class, ",(0,o.jsx)(n.code,{children:"EdgeType"})," class, and then plug them in to the ",(0,o.jsx)(n.code,{children:"ConnectionType"})," class:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import {ObjectType, Field} from "type-graphql";\nimport {EdgeType, ConnectionType} from "typegraphql-relay-connections";\n\n// This is our ObjectType:\n@ObjectType()\nclass Song {\n @Field()\n id!: string\n\n @Field()\n title!: string;\n}\n\n// This is the EdgeType:\n@ObjectType()\nexport class SongEdge extends EdgeType(Song) {}\n\n// This is the ConnectionType:\n@ObjectType()\nexport class SongConnection extends ConnectionType({\n node: Song,\n edge: SongEdge\n}) {}\n'})})]})}function d(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>c});var o=t(7294);const i={},s=o.createContext(i);function c(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[9199],{3580:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>a});var o=t(5893),i=t(1151);const s={sidebar_position:2},c="ConnectionType \ud83e\udd94",l={id:"usage/connection-type",title:"ConnectionType \ud83e\udd94",description:"The ConnectionType function is the slightly more complicated of the two main functions. We'll define a full example below, but if we isolate the ConnectionType by itself you'll see it looks like this:",source:"@site/docs/usage/connection-type.md",sourceDirName:"usage",slug:"/usage/connection-type",permalink:"/typegraphql-relay-connections/docs/usage/connection-type",draft:!1,unlisted:!1,editUrl:"https://github.com/johnsonjo4531/typegraphql-relay-connections/docs/blog/docs/usage/connection-type.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"EdgeType \ud83e\uddc0",permalink:"/typegraphql-relay-connections/docs/usage/edge-type"},next:{title:"Extending the Builtin Cursor \ud83d\udcc4",permalink:"/typegraphql-relay-connections/docs/tutorials/custom-cursors"}},r={},a=[];function p(e){const n={code:"code",h1:"h1",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"connectiontype-",children:"ConnectionType \ud83e\udd94"}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"ConnectionType"})," function is the slightly more complicated of the two main functions. We'll define a full example below, but if we isolate the ConnectionType by itself you'll see it looks like this:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nexport class SongConnection extends ConnectionType(SongEdge) {\n // You can add additional Types to your ConnectionType that are specific to it here:\n}\n"})}),"\n",(0,o.jsxs)(n.p,{children:["To have a more complete example all you need to do is create a ",(0,o.jsx)(n.code,{children:"ObjectType"})," class, ",(0,o.jsx)(n.code,{children:"EdgeType"})," class, and then plug them in to the ",(0,o.jsx)(n.code,{children:"ConnectionType"})," class:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:'import {ObjectType, Field} from "type-graphql";\nimport {EdgeType, ConnectionType} from "typegraphql-relay-connections";\n\n// This is our ObjectType:\n@ObjectType()\nclass Song {\n @Field()\n id!: string\n\n @Field()\n title!: string;\n}\n\n// This is the EdgeType:\n@ObjectType()\nexport class SongEdge extends EdgeType(Song) {}\n\n// This is the ConnectionType:\n@ObjectType()\nexport class SongConnection extends ConnectionType(SongEdge) {}\n'})})]})}function d(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>c});var o=t(7294);const i={},s=o.createContext(i);function c(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.86b222cf.js b/assets/js/0e384e19.86b222cf.js new file mode 100644 index 0000000..e526425 --- /dev/null +++ b/assets/js/0e384e19.86b222cf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[9671],{7876:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=o(5893),t=o(1151);const a={sidebar_position:1},s="Intro \ud83d\ude80",i={id:"intro",title:"Intro \ud83d\ude80",description:"This library provides a way to setup typings for TypeGraphQL with Relay Connection Types. Relay Connection Types are a great way to define pagination in an app. This libraries connection types follow the Relay Connection Type Server Standard. You may want to read up on relay if you're confused on what the benefits of relay connections to find out how exactly this library works. Particularly this library implements the second part of the standard, so it accomplishes: 2.) A description of how to page through connections, so you may want to check out the relevant section on connections in the relay GraphQL server standard.",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/typegraphql-relay-connections/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/johnsonjo4531/typegraphql-relay-connections/docs/blog/docs/intro.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Cursor",permalink:"/typegraphql-relay-connections/docs/api/interfaces/Cursor"},next:{title:"EdgeType \ud83e\uddc0",permalink:"/typegraphql-relay-connections/docs/usage/edge-type"}},c={},l=[{value:"Show Me Da Codez!! \ud83d\udcbb",id:"show-me-da-codez-",level:2},{value:"Peer Dependencies \ud83d\udd17",id:"peer-dependencies-",level:2},{value:"Background on TypeGraphQL \ud83d\ude0e",id:"background-on-typegraphql-",level:2},{value:"Introductory Example \ud83e\udd13",id:"introductory-example-",level:2},{value:"Using mongoose?",id:"using-mongoose",level:2}];function p(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"intro-",children:"Intro \ud83d\ude80"}),"\n",(0,r.jsxs)(n.p,{children:["This library provides a way to setup typings for ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"TypeGraphQL"})," with Relay Connection Types. Relay Connection Types are a great way to define pagination in an app. This libraries connection types follow the ",(0,r.jsx)(n.a,{href:"https://relay.dev/docs/guides/graphql-server-specification/",children:"Relay Connection Type Server Standard"}),". You may want to read up on relay if you're confused on what the benefits of relay connections to find out how exactly this library works. Particularly this library implements the second part of the standard, so it accomplishes: 2.) A description of how to page through connections, so you may want to check out the ",(0,r.jsx)(n.a,{href:"https://relay.dev/docs/guides/graphql-server-specification/#connections",children:"relevant section on connections in the relay GraphQL server standard"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"Note that though pagination types and utils are in this repo, the implementation of the paging algorithms are up to the user this is on purpose and is meant to keep this library small and maintanable."}),"\n",(0,r.jsx)(n.h2,{id:"show-me-da-codez-",children:"Show Me Da Codez!! \ud83d\udcbb"}),"\n",(0,r.jsx)(n.p,{children:"The quickest possible example to show what this library does is the following. We create two GraphQL ObjectTypes using TypeGraphQL object types."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'import {\n Field,\n ObjectType,\n} from "type-graphql";\nimport {\n ConnectionType,\n EdgeType\n} from "typegraphql-relay-connections";\n\n@ObjectType()\nclass Song {\n @Field()\n id!: string\n\n @Field()\n title!: string;\n}\n\n@ObjectType()\nexport class SongEdge extends EdgeType(Song) {}\n\n@ObjectType()\nexport class SongConnection extends ConnectionType(SongEdge) {}\n'})}),"\n",(0,r.jsxs)(n.p,{children:["The last thing we can do with this library is ",(0,r.jsx)(n.a,{href:"./tutorials/custom-cursors",children:"extend the built in Cursor"})," like so:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'declare module "typegraphql-relay-connections" {\n interface Cursor {\n id: string;\n }\n}\n'})}),"\n",(0,r.jsx)(n.h2,{id:"peer-dependencies-",children:"Peer Dependencies \ud83d\udd17"}),"\n",(0,r.jsxs)(n.p,{children:["All our peer dependencies are due to TypeGraphQL. Follow the setup section for ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"TypeGraphQL"}),"."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"yarn add graphql@15 reflect-metadata type-graphql\n"})}),"\n",(0,r.jsx)(n.h2,{id:"background-on-typegraphql-",children:"Background on TypeGraphQL \ud83d\ude0e"}),"\n",(0,r.jsx)(n.p,{children:"The idea behind TypeGraphQL is you define your GraphQL types using TypeScript. TypeGraphQL follows a code first approach rather than the schema first approach. Since TypeGraphQL's code first approach is written in TypeScript this allows you to strongly type your GraphQL server."}),"\n",(0,r.jsx)(n.h2,{id:"introductory-example-",children:"Introductory Example \ud83e\udd13"}),"\n",(0,r.jsxs)(n.p,{children:["See this intro example ",(0,r.jsx)(n.a,{href:"https://codesandbox.io/s/typegraphql-relay-connections-intro-example-66ec9o",children:"on codesandbox"})]}),"\n",(0,r.jsx)(n.p,{children:"We'll start with some imports for this (you can replace apollo-server with the graphql server you choose to use.):"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'import "reflect-metadata";\nimport { ApolloServer } from "apollo-server";\nimport {\n Field,\n ObjectType,\n Args,\n Query,\n Resolver,\n buildSchema\n} from "type-graphql";\nimport {\n ForwardPaginationArgs,\n ConnectionType,\n EdgeType,\n BackwardPaginationArgs\n} from "typegraphql-relay-connections";\n// you\'ll have to make this yourself for an example see the codesandbox\nimport * as controller from "./song.controller";\n'})}),"\n",(0,r.jsxs)(n.p,{children:["First create an object-type through ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"type-graphql"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nclass Song {\n @Field()\n id!: string\n\n @Field()\n title!: string;\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["That last part was just TypeGraphQL, but next is where this library comes in. It helps you create the Edge and Connection ObjectTypes as well as a custom cursor. Both the ",(0,r.jsx)(n.code,{children:"EdgeType"})," and ",(0,r.jsx)(n.code,{children:"ConnectionType"})," functions come from this library."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'@ObjectType()\nexport class SongEdge extends EdgeType(Song) {}\n\n@ObjectType()\nexport class SongConnection extends ConnectionType(SongEdge) {}\n\n\ndeclare module "typegraphql-relay-connections" {\n interface Cursor {\n id: string;\n }\n}\n'})}),"\n",(0,r.jsx)(n.p,{children:"The Rest is just more TypeGraphQL."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@Resolver(Song)\nexport class SongResolver {\n @Query(() => SongConnection)\n async songs(\n @Args() forwardPaging: ForwardPaginationArgs,\n @Args() backwardPaging: BackwardPaginationArgs\n ): Promise {\n // implementation up to you!\n return controller.getSongs({forwardPaging, backwardPaging});\n }\n}\n\nconst PORT = 4000;\n\nasync function bootstrap() {\n const schema = await buildSchema({\n resolvers: [SongResolver]\n });\n\n // Create the GraphQL server\n const server = new ApolloServer({\n schema\n });\n\n // Start the server\n const { url } = await server.listen(PORT);\n console.log(`Server is running, GraphQL Playground available at ${url}`);\n}\n\nbootstrap();\n"})}),"\n",(0,r.jsx)(n.h2,{id:"using-mongoose",children:"Using mongoose?"}),"\n",(0,r.jsxs)(n.p,{children:["There is a companion library available called ",(0,r.jsx)(n.a,{href:"https://www.npmjs.com/package/mongoose-relay-paginate",children:"mongoose-relay-paginate"}),"! It works great with this library."]})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},1151:(e,n,o)=>{o.d(n,{Z:()=>i,a:()=>s});var r=o(7294);const t={},a=r.createContext(t);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.c05a3fc3.js b/assets/js/0e384e19.c05a3fc3.js deleted file mode 100644 index d1f281f..0000000 --- a/assets/js/0e384e19.c05a3fc3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[9671],{7876:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=o(5893),t=o(1151);const a={sidebar_position:1},s="Intro \ud83d\ude80",i={id:"intro",title:"Intro \ud83d\ude80",description:"This library provides a way to setup typings for TypeGraphQL with Relay Connection Types. Relay Connection Types are a great way to define pagination in an app. This libraries connection types follow the Relay Connection Type Server Standard. You may want to read up on relay if you're confused on what the benefits of relay connections to find out how exactly this library works. Particularly this library implements the second part of the standard, so it accomplishes: 2.) A description of how to page through connections, so you may want to check out the relevant section on connections in the relay GraphQL server standard.",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/typegraphql-relay-connections/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/johnsonjo4531/typegraphql-relay-connections/docs/blog/docs/intro.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Cursor",permalink:"/typegraphql-relay-connections/docs/api/interfaces/Cursor"},next:{title:"EdgeType \ud83e\uddc0",permalink:"/typegraphql-relay-connections/docs/usage/edge-type"}},c={},l=[{value:"Show Me Da Codez!! \ud83d\udcbb",id:"show-me-da-codez-",level:2},{value:"Peer Dependencies \ud83d\udd17",id:"peer-dependencies-",level:2},{value:"Background on TypeGraphQL \ud83d\ude0e",id:"background-on-typegraphql-",level:2},{value:"Introductory Example \ud83e\udd13",id:"introductory-example-",level:2},{value:"Using mongoose?",id:"using-mongoose",level:2}];function p(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"intro-",children:"Intro \ud83d\ude80"}),"\n",(0,r.jsxs)(n.p,{children:["This library provides a way to setup typings for ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"TypeGraphQL"})," with Relay Connection Types. Relay Connection Types are a great way to define pagination in an app. This libraries connection types follow the ",(0,r.jsx)(n.a,{href:"https://relay.dev/docs/guides/graphql-server-specification/",children:"Relay Connection Type Server Standard"}),". You may want to read up on relay if you're confused on what the benefits of relay connections to find out how exactly this library works. Particularly this library implements the second part of the standard, so it accomplishes: 2.) A description of how to page through connections, so you may want to check out the ",(0,r.jsx)(n.a,{href:"https://relay.dev/docs/guides/graphql-server-specification/#connections",children:"relevant section on connections in the relay GraphQL server standard"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"Note that though pagination types and utils are in this repo, the implementation of the paging algorithms are up to the user this is on purpose and is meant to keep this library small and maintanable."}),"\n",(0,r.jsx)(n.h2,{id:"show-me-da-codez-",children:"Show Me Da Codez!! \ud83d\udcbb"}),"\n",(0,r.jsx)(n.p,{children:"The quickest possible example to show what this library does is the following. We create two GraphQL ObjectTypes using TypeGraphQL object types."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'import {\n Field,\n ObjectType,\n} from "type-graphql";\nimport {\n ConnectionType,\n EdgeType\n} from "typegraphql-relay-connections";\n\n@ObjectType()\nclass Song {\n @Field()\n id!: string\n\n @Field()\n title!: string;\n}\n\n@ObjectType()\nexport class SongEdge extends EdgeType(Song) {}\n\n@ObjectType()\nexport class SongConnection extends ConnectionType({\n edge: SongEdge,\n node: Song,\n}) {}\n'})}),"\n",(0,r.jsxs)(n.p,{children:["The last thing we can do with this library is ",(0,r.jsx)(n.a,{href:"./tutorials/custom-cursors",children:"extend the built in Cursor"})," like so:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'declare module "typegraphql-relay-connections" {\n interface Cursor {\n id: string;\n }\n}\n'})}),"\n",(0,r.jsx)(n.h2,{id:"peer-dependencies-",children:"Peer Dependencies \ud83d\udd17"}),"\n",(0,r.jsxs)(n.p,{children:["All our peer dependencies are due to TypeGraphQL. Follow the setup section for ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"TypeGraphQL"}),"."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"yarn add graphql@15 reflect-metadata type-graphql\n"})}),"\n",(0,r.jsx)(n.h2,{id:"background-on-typegraphql-",children:"Background on TypeGraphQL \ud83d\ude0e"}),"\n",(0,r.jsx)(n.p,{children:"The idea behind TypeGraphQL is you define your GraphQL types using TypeScript. TypeGraphQL follows a code first approach rather than the schema first approach. Since TypeGraphQL's code first approach is written in TypeScript this allows you to strongly type your GraphQL server."}),"\n",(0,r.jsx)(n.h2,{id:"introductory-example-",children:"Introductory Example \ud83e\udd13"}),"\n",(0,r.jsxs)(n.p,{children:["See this intro example ",(0,r.jsx)(n.a,{href:"https://codesandbox.io/s/typegraphql-relay-connections-intro-example-66ec9o",children:"on codesandbox"})]}),"\n",(0,r.jsx)(n.p,{children:"We'll start with some imports for this (you can replace apollo-server with the graphql server you choose to use.):"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'import "reflect-metadata";\nimport { ApolloServer } from "apollo-server";\nimport {\n Field,\n ObjectType,\n Args,\n Query,\n Resolver,\n buildSchema\n} from "type-graphql";\nimport {\n ForwardPaginationArgs,\n ConnectionType,\n EdgeType,\n BackwardPaginationArgs\n} from "typegraphql-relay-connections";\n// you\'ll have to make this yourself for an example see the codesandbox\nimport * as controller from "./song.controller";\n'})}),"\n",(0,r.jsxs)(n.p,{children:["First create an object-type through ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"type-graphql"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nclass Song {\n @Field()\n id!: string\n\n @Field()\n title!: string;\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["That last part was just TypeGraphQL, but next is where this library comes in. It helps you create the Edge and Connection ObjectTypes as well as a custom cursor. Both the ",(0,r.jsx)(n.code,{children:"EdgeType"})," and ",(0,r.jsx)(n.code,{children:"ConnectionType"})," functions come from this library."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'@ObjectType()\nexport class SongEdge extends EdgeType(Song) {}\n\n@ObjectType()\nexport class SongConnection extends ConnectionType({\n edge: SongEdge,\n node: Song,\n}) {}\n\n\ndeclare module "typegraphql-relay-connections" {\n interface Cursor {\n id: string;\n }\n}\n'})}),"\n",(0,r.jsx)(n.p,{children:"The Rest is just more TypeGraphQL."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@Resolver(Song)\nexport class SongResolver {\n @Query(() => SongConnection)\n async songs(\n @Args() forwardPaging: ForwardPaginationArgs,\n @Args() backwardPaging: BackwardPaginationArgs\n ): Promise {\n // implementation up to you!\n return controller.getSongs({forwardPaging, backwardPaging});\n }\n}\n\nconst PORT = 4000;\n\nasync function bootstrap() {\n const schema = await buildSchema({\n resolvers: [SongResolver]\n });\n\n // Create the GraphQL server\n const server = new ApolloServer({\n schema\n });\n\n // Start the server\n const { url } = await server.listen(PORT);\n console.log(`Server is running, GraphQL Playground available at ${url}`);\n}\n\nbootstrap();\n"})}),"\n",(0,r.jsx)(n.h2,{id:"using-mongoose",children:"Using mongoose?"}),"\n",(0,r.jsxs)(n.p,{children:["There is a companion library available called ",(0,r.jsx)(n.a,{href:"https://www.npmjs.com/package/mongoose-relay-paginate",children:"mongoose-relay-paginate"}),"! It works great with this library."]})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},1151:(e,n,o)=>{o.d(n,{Z:()=>i,a:()=>s});var r=o(7294);const t={},a=r.createContext(t);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1de72b33.5cf1c32d.js b/assets/js/1de72b33.5cf1c32d.js new file mode 100644 index 0000000..68b198a --- /dev/null +++ b/assets/js/1de72b33.5cf1c32d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[305],{4110:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var t=o(5893),s=o(1151);const r={},c="Changelog",i={id:"Changelog",title:"Changelog",description:"Version 2.x to 3.x",source:"@site/docs/Changelog.md",sourceDirName:".",slug:"/Changelog",permalink:"/typegraphql-relay-connections/docs/Changelog",draft:!1,unlisted:!1,editUrl:"https://github.com/johnsonjo4531/typegraphql-relay-connections/docs/blog/docs/Changelog.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f",permalink:"/typegraphql-relay-connections/docs/examples/typegraphql"}},a={},l=[{value:"Version 2.x to 3.x",id:"version-2x-to-3x",level:2},{value:"Version 1.x to 2.x",id:"version-1x-to-2x",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"changelog",children:"Changelog"}),"\n",(0,t.jsx)(n.h2,{id:"version-2x-to-3x",children:"Version 2.x to 3.x"}),"\n",(0,t.jsxs)(n.p,{children:["Removed the ",(0,t.jsx)(n.code,{children:"nodes"})," property from the ConnectionType as it is not part of the spec."]}),"\n",(0,t.jsx)(n.p,{children:"Also now the ConnectionType is called by only passing in the ItemEdge in this way:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nexport class ItemConnection extends ConnectionType(ItemEdge) {}\n"})}),"\n",(0,t.jsx)(n.p,{children:"instead of like this (passing in both the node and item edge as an object):"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nexport class ItemConnection extends ConnectionType({\n node: Item, \n edge: ItemEdge\n}) {}\n"})}),"\n",(0,t.jsx)(n.h2,{id:"version-1x-to-2x",children:"Version 1.x to 2.x"}),"\n",(0,t.jsxs)(n.p,{children:["Removed the ",(0,t.jsx)(n.code,{children:"count"})," property from ",(0,t.jsx)(n.code,{children:"PageInfo"})," as it is not part of the spec."]})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},1151:(e,n,o)=>{o.d(n,{Z:()=>i,a:()=>c});var t=o(7294);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1de72b33.b669ce99.js b/assets/js/1de72b33.b669ce99.js deleted file mode 100644 index 368ad99..0000000 --- a/assets/js/1de72b33.b669ce99.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[305],{4110:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var t=o(5893),r=o(1151);const s={},c="Changelog",a={id:"Changelog",title:"Changelog",description:"Version 1.x to 2.x",source:"@site/docs/Changelog.md",sourceDirName:".",slug:"/Changelog",permalink:"/typegraphql-relay-connections/docs/Changelog",draft:!1,unlisted:!1,editUrl:"https://github.com/johnsonjo4531/typegraphql-relay-connections/docs/blog/docs/Changelog.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f",permalink:"/typegraphql-relay-connections/docs/examples/typegraphql"}},i={},l=[{value:"Version 1.x to 2.x",id:"version-1x-to-2x",level:2}];function p(e){const n={code:"code",h1:"h1",h2:"h2",p:"p",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"changelog",children:"Changelog"}),"\n",(0,t.jsx)(n.h2,{id:"version-1x-to-2x",children:"Version 1.x to 2.x"}),"\n",(0,t.jsxs)(n.p,{children:["Removed the ",(0,t.jsx)(n.code,{children:"count"})," property from ",(0,t.jsx)(n.code,{children:"PageInfo"})," as it is not part of the spec."]})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},1151:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>c});var t=o(7294);const r={},s=t.createContext(r);function c(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/226d1479.122b0c94.js b/assets/js/226d1479.13fec60c.js similarity index 97% rename from assets/js/226d1479.122b0c94.js rename to assets/js/226d1479.13fec60c.js index 7a046eb..60cf6e6 100644 --- a/assets/js/226d1479.122b0c94.js +++ b/assets/js/226d1479.13fec60c.js @@ -1 +1 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[7175],{4284:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=n(5893),t=n(1151);const i={id:"ForwardPaginationArgs",title:"Class: ForwardPaginationArgs",sidebar_label:"ForwardPaginationArgs",sidebar_position:0,custom_edit_url:null},l=void 0,a={id:"api/classes/ForwardPaginationArgs",title:"Class: ForwardPaginationArgs",description:"Allows forward pagination of a Relay connection type",source:"@site/docs/api/classes/ForwardPaginationArgs.md",sourceDirName:"api/classes",slug:"/api/classes/ForwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ForwardPaginationArgs",title:"Class: ForwardPaginationArgs",sidebar_label:"ForwardPaginationArgs",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"BackwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs"},next:{title:"FullPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs"}},o={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implemented by",id:"implemented-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"after",id:"after",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"first",id:"first",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function c(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.p,{children:"Allows forward pagination of a Relay connection type"}),"\n",(0,s.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(r.tbody,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"CursorType"})}),(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(r.code,{children:"Cursor"})})," = ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(r.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(r.h2,{id:"implemented-by",children:"Implemented by"}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:(0,s.jsx)(r.code,{children:"FullPaginationArgs"})})}),"\n"]}),"\n",(0,s.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(r.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"new ForwardPaginationArgs"}),"<",(0,s.jsx)(r.code,{children:"CursorType"}),">(): ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:(0,s.jsx)(r.code,{children:"ForwardPaginationArgs"})}),"<",(0,s.jsx)(r.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(r.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(r.tbody,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"CursorType"})}),(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(r.code,{children:"Cursor"})})," = ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(r.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:(0,s.jsx)(r.code,{children:"ForwardPaginationArgs"})}),"<",(0,s.jsx)(r.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"after",children:"after"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"after"}),": ",(0,s.jsx)(r.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(r.p,{children:"Grabs records starting from after the given cursor."}),"\n",(0,s.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L18",children:"index.ts:18"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"first",children:"first"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"first"}),": ",(0,s.jsx)(r.code,{children:"number"})]}),"\n",(0,s.jsx)(r.p,{children:"Grabs the first n records."}),"\n",(0,s.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L27",children:"index.ts:27"})})]})}function h(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},1151:(e,r,n)=>{n.d(r,{Z:()=>a,a:()=>l});var s=n(7294);const t={},i=s.createContext(t);function l(e){const r=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),s.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[7175],{4284:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=n(5893),t=n(1151);const i={id:"ForwardPaginationArgs",title:"Class: ForwardPaginationArgs",sidebar_label:"ForwardPaginationArgs",sidebar_position:0,custom_edit_url:null},l=void 0,a={id:"api/classes/ForwardPaginationArgs",title:"Class: ForwardPaginationArgs",description:"Allows forward pagination of a Relay connection type",source:"@site/docs/api/classes/ForwardPaginationArgs.md",sourceDirName:"api/classes",slug:"/api/classes/ForwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"ForwardPaginationArgs",title:"Class: ForwardPaginationArgs",sidebar_label:"ForwardPaginationArgs",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"BackwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs"},next:{title:"FullPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs"}},o={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implemented by",id:"implemented-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"after",id:"after",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"first",id:"first",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function c(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.p,{children:"Allows forward pagination of a Relay connection type"}),"\n",(0,s.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(r.tbody,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"CursorType"})}),(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(r.code,{children:"Cursor"})})," = ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(r.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(r.h2,{id:"implemented-by",children:"Implemented by"}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:(0,s.jsx)(r.code,{children:"FullPaginationArgs"})})}),"\n"]}),"\n",(0,s.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(r.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"new ForwardPaginationArgs"}),"<",(0,s.jsx)(r.code,{children:"CursorType"}),">(): ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:(0,s.jsx)(r.code,{children:"ForwardPaginationArgs"})}),"<",(0,s.jsx)(r.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(r.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(r.tbody,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"CursorType"})}),(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(r.code,{children:"Cursor"})})," = ",(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(r.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:(0,s.jsx)(r.code,{children:"ForwardPaginationArgs"})}),"<",(0,s.jsx)(r.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"after",children:"after"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"after"}),": ",(0,s.jsx)(r.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(r.p,{children:"Grabs records starting from after the given cursor."}),"\n",(0,s.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L18",children:"index.ts:18"})}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"first",children:"first"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.code,{children:"Optional"})," ",(0,s.jsx)(r.strong,{children:"first"}),": ",(0,s.jsx)(r.code,{children:"number"})]}),"\n",(0,s.jsx)(r.p,{children:"Grabs the first n records."}),"\n",(0,s.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L27",children:"index.ts:27"})})]})}function h(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},1151:(e,r,n)=>{n.d(r,{Z:()=>a,a:()=>l});var s=n(7294);const t={},i=s.createContext(t);function l(e){const r=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),s.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/36308a28.cd49ab83.js b/assets/js/36308a28.10232771.js similarity index 97% rename from assets/js/36308a28.cd49ab83.js rename to assets/js/36308a28.10232771.js index 9fbb24f..5bfb61f 100644 --- a/assets/js/36308a28.cd49ab83.js +++ b/assets/js/36308a28.10232771.js @@ -1 +1 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[4416],{1235:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>l,metadata:()=>a,toc:()=>c});var s=r(5893),i=r(1151);const l={id:"FullPaginationArgs",title:"Class: FullPaginationArgs",sidebar_label:"FullPaginationArgs",sidebar_position:0,custom_edit_url:null},t=void 0,a={id:"api/classes/FullPaginationArgs",title:"Class: FullPaginationArgs",description:"Allows forward pagination of a Relay connection type",source:"@site/docs/api/classes/FullPaginationArgs.md",sourceDirName:"api/classes",slug:"/api/classes/FullPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"FullPaginationArgs",title:"Class: FullPaginationArgs",sidebar_label:"FullPaginationArgs",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ForwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs"},next:{title:"PageInfo",permalink:"/typegraphql-relay-connections/docs/api/classes/PageInfo"}},o={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"after",id:"after",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"before",id:"before",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"first",id:"first",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"last",id:"last",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"Allows forward pagination of a Relay connection type"}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h2,{id:"implements",children:"Implements"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:(0,s.jsx)(n.code,{children:"ForwardPaginationArgs"})}),"<",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})}),">"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:(0,s.jsx)(n.code,{children:"BackwardPaginationArgs"})}),"<",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"new FullPaginationArgs"}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">(): ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:(0,s.jsx)(n.code,{children:"FullPaginationArgs"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:(0,s.jsx)(n.code,{children:"FullPaginationArgs"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"after",children:"after"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"after"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs records starting from after the given cursor."}),"\n",(0,s.jsx)(n.h4,{id:"implementation-of",children:"Implementation of"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:"ForwardPaginationArgs"}),".",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs#after",children:"after"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L83",children:"index.ts:83"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"before",children:"before"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"before"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs records ending before the given cursor."}),"\n",(0,s.jsx)(n.h4,{id:"implementation-of-1",children:"Implementation of"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:"BackwardPaginationArgs"}),".",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs#before",children:"before"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L65",children:"index.ts:65"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"first",children:"first"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"first"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs the first n records."}),"\n",(0,s.jsx)(n.h4,{id:"implementation-of-2",children:"Implementation of"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:"ForwardPaginationArgs"}),".",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs#first",children:"first"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L92",children:"index.ts:92"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"last",children:"last"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"last"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs the last n records."}),"\n",(0,s.jsx)(n.h4,{id:"implementation-of-3",children:"Implementation of"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:"BackwardPaginationArgs"}),".",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs#last",children:"last"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L74",children:"index.ts:74"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},1151:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>t});var s=r(7294);const i={},l=s.createContext(i);function t(e){const n=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[4416],{1235:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>l,metadata:()=>a,toc:()=>c});var s=r(5893),i=r(1151);const l={id:"FullPaginationArgs",title:"Class: FullPaginationArgs",sidebar_label:"FullPaginationArgs",sidebar_position:0,custom_edit_url:null},t=void 0,a={id:"api/classes/FullPaginationArgs",title:"Class: FullPaginationArgs",description:"Allows forward pagination of a Relay connection type",source:"@site/docs/api/classes/FullPaginationArgs.md",sourceDirName:"api/classes",slug:"/api/classes/FullPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"FullPaginationArgs",title:"Class: FullPaginationArgs",sidebar_label:"FullPaginationArgs",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"ForwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs"},next:{title:"PageInfo",permalink:"/typegraphql-relay-connections/docs/api/classes/PageInfo"}},o={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Implements",id:"implements",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"after",id:"after",level:3},{value:"Implementation of",id:"implementation-of",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"before",id:"before",level:3},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"first",id:"first",level:3},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"last",id:"last",level:3},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"Allows forward pagination of a Relay connection type"}),"\n",(0,s.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h2,{id:"implements",children:"Implements"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:(0,s.jsx)(n.code,{children:"ForwardPaginationArgs"})}),"<",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})}),">"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:(0,s.jsx)(n.code,{children:"BackwardPaginationArgs"})}),"<",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,s.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"new FullPaginationArgs"}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">(): ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:(0,s.jsx)(n.code,{children:"FullPaginationArgs"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,s.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(n.tbody,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{style:{textAlign:"left"},children:(0,s.jsx)(n.code,{children:"CursorType"})}),(0,s.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})," = ",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,s.jsx)(n.code,{children:"Cursor"})})]})]})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:(0,s.jsx)(n.code,{children:"FullPaginationArgs"})}),"<",(0,s.jsx)(n.code,{children:"CursorType"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"after",children:"after"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"after"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs records starting from after the given cursor."}),"\n",(0,s.jsx)(n.h4,{id:"implementation-of",children:"Implementation of"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:"ForwardPaginationArgs"}),".",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs#after",children:"after"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L83",children:"index.ts:83"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"before",children:"before"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"before"}),": ",(0,s.jsx)(n.code,{children:"CursorType"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs records ending before the given cursor."}),"\n",(0,s.jsx)(n.h4,{id:"implementation-of-1",children:"Implementation of"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:"BackwardPaginationArgs"}),".",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs#before",children:"before"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L65",children:"index.ts:65"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"first",children:"first"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"first"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs the first n records."}),"\n",(0,s.jsx)(n.h4,{id:"implementation-of-2",children:"Implementation of"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:"ForwardPaginationArgs"}),".",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs#first",children:"first"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L92",children:"index.ts:92"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"last",children:"last"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.code,{children:"Optional"})," ",(0,s.jsx)(n.strong,{children:"last"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n",(0,s.jsx)(n.p,{children:"Grabs the last n records."}),"\n",(0,s.jsx)(n.h4,{id:"implementation-of-3",children:"Implementation of"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:"BackwardPaginationArgs"}),".",(0,s.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs#last",children:"last"})]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L74",children:"index.ts:74"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},1151:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>t});var s=r(7294);const i={},l=s.createContext(i);function t(e){const n=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e0b7480.42b85899.js b/assets/js/5e0b7480.9b035393.js similarity index 98% rename from assets/js/5e0b7480.42b85899.js rename to assets/js/5e0b7480.9b035393.js index ea6894f..18bf6a8 100644 --- a/assets/js/5e0b7480.42b85899.js +++ b/assets/js/5e0b7480.9b035393.js @@ -1 +1 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[4005],{3635:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>o});var r=n(5893),t=n(1151);const l={id:"RelayEdgeType",title:"Class: RelayEdgeType",sidebar_label:"RelayEdgeType",sidebar_position:0,custom_edit_url:null},d=void 0,i={id:"api/classes/RelayEdgeType",title:"Class: RelayEdgeType",description:"Type parameters",source:"@site/docs/api/classes/RelayEdgeType.md",sourceDirName:"api/classes",slug:"/api/classes/RelayEdgeType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"RelayEdgeType",title:"Class: RelayEdgeType",sidebar_label:"RelayEdgeType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"RelayConnectionType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType"},next:{title:"Cursor",permalink:"/typegraphql-relay-connections/docs/api/interfaces/Cursor"}},c={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"cursor",id:"cursor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"node",id:"node",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function a(e){const s={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{style:{textAlign:"left"},children:(0,r.jsx)(s.code,{children:"CursorType"})}),(0,r.jsxs)(s.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(s.code,{children:"Cursor"})})," = ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(s.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{style:{textAlign:"left"},children:(0,r.jsx)(s.code,{children:"NodeType"})}),(0,r.jsxs)(s.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/modules#nodestype",children:(0,r.jsx)(s.code,{children:"NodesType"})})," = ",(0,r.jsx)(s.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(s.h3,{id:"constructor",children:"constructor"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"new RelayEdgeType"}),"<",(0,r.jsx)(s.code,{children:"CursorType"}),", ",(0,r.jsx)(s.code,{children:"NodeType"}),">(): ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(s.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(s.code,{children:"CursorType"}),", ",(0,r.jsx)(s.code,{children:"NodeType"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{style:{textAlign:"left"},children:(0,r.jsx)(s.code,{children:"CursorType"})}),(0,r.jsxs)(s.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(s.code,{children:"Cursor"})})," = ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(s.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{style:{textAlign:"left"},children:(0,r.jsx)(s.code,{children:"NodeType"})}),(0,r.jsxs)(s.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(s.code,{children:"unknown"})," = ",(0,r.jsx)(s.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(s.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(s.code,{children:"CursorType"}),", ",(0,r.jsx)(s.code,{children:"NodeType"}),">"]}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"cursor",children:"cursor"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"cursor"}),": ",(0,r.jsx)(s.code,{children:"CursorType"})]}),"\n",(0,r.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L158",children:"index.ts:158"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"node",children:"node"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"node"}),": ",(0,r.jsx)(s.code,{children:"NodeType"})]}),"\n",(0,r.jsx)(s.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L159",children:"index.ts:159"})})]})}function h(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},1151:(e,s,n)=>{n.d(s,{Z:()=>i,a:()=>d});var r=n(7294);const t={},l=r.createContext(t);function d(e){const s=r.useContext(l);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),r.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[4005],{3635:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>o});var r=n(5893),t=n(1151);const l={id:"RelayEdgeType",title:"Class: RelayEdgeType",sidebar_label:"RelayEdgeType",sidebar_position:0,custom_edit_url:null},d=void 0,i={id:"api/classes/RelayEdgeType",title:"Class: RelayEdgeType",description:"Type parameters",source:"@site/docs/api/classes/RelayEdgeType.md",sourceDirName:"api/classes",slug:"/api/classes/RelayEdgeType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"RelayEdgeType",title:"Class: RelayEdgeType",sidebar_label:"RelayEdgeType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"RelayConnectionType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType"},next:{title:"Cursor",permalink:"/typegraphql-relay-connections/docs/api/interfaces/Cursor"}},c={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"cursor",id:"cursor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"node",id:"node",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function a(e){const s={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{style:{textAlign:"left"},children:(0,r.jsx)(s.code,{children:"CursorType"})}),(0,r.jsxs)(s.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(s.code,{children:"Cursor"})})," = ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(s.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{style:{textAlign:"left"},children:(0,r.jsx)(s.code,{children:"NodeType"})}),(0,r.jsxs)(s.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/modules#nodestype",children:(0,r.jsx)(s.code,{children:"NodesType"})})," = ",(0,r.jsx)(s.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(s.h3,{id:"constructor",children:"constructor"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"new RelayEdgeType"}),"<",(0,r.jsx)(s.code,{children:"CursorType"}),", ",(0,r.jsx)(s.code,{children:"NodeType"}),">(): ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(s.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(s.code,{children:"CursorType"}),", ",(0,r.jsx)(s.code,{children:"NodeType"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(s.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{style:{textAlign:"left"},children:(0,r.jsx)(s.code,{children:"CursorType"})}),(0,r.jsxs)(s.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(s.code,{children:"Cursor"})})," = ",(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(s.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{style:{textAlign:"left"},children:(0,r.jsx)(s.code,{children:"NodeType"})}),(0,r.jsxs)(s.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(s.code,{children:"unknown"})," = ",(0,r.jsx)(s.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(s.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(s.code,{children:"CursorType"}),", ",(0,r.jsx)(s.code,{children:"NodeType"}),">"]}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"cursor",children:"cursor"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"cursor"}),": ",(0,r.jsx)(s.code,{children:"CursorType"})]}),"\n",(0,r.jsx)(s.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L158",children:"index.ts:158"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"node",children:"node"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"node"}),": ",(0,r.jsx)(s.code,{children:"NodeType"})]}),"\n",(0,r.jsx)(s.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L159",children:"index.ts:159"})})]})}function h(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},1151:(e,s,n)=>{n.d(s,{Z:()=>i,a:()=>d});var r=n(7294);const t={},l=r.createContext(t);function d(e){const s=r.useContext(l);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),r.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e8c322a.01c3c6dc.js b/assets/js/5e8c322a.01c3c6dc.js new file mode 100644 index 0000000..55f0813 --- /dev/null +++ b/assets/js/5e8c322a.01c3c6dc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[7597],{3006:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=t(5893),s=t(1151);const o={id:"index",title:"typegraphql-relay-connections",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},a="typegraphql-relay-connections",i={id:"api/index",title:"typegraphql-relay-connections",description:"This library provides a way to setup typings for TypeGraphQL with Relay.",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/typegraphql-relay-connections/docs/api/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"index",title:"typegraphql-relay-connections",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",next:{title:"Exports",permalink:"/typegraphql-relay-connections/docs/api/modules"}},l={},c=[{value:"Using mongoose?",id:"using-mongoose",level:2},{value:"Documentation",id:"documentation",level:2},{value:"Tutorial",id:"tutorial",level:2},{value:"Example",id:"example",level:3}];function p(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("p",{align:"center",children:(0,r.jsx)("img",{src:"./docs/static/img/logo.png"})}),"\n",(0,r.jsx)(n.h1,{id:"typegraphql-relay-connections",children:"typegraphql-relay-connections"}),"\n",(0,r.jsxs)(n.p,{children:["This library provides a way to setup typings for ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"TypeGraphQL"})," with Relay."]}),"\n",(0,r.jsx)(n.p,{children:"Note that though pagination types and utils are in this repo, the implementation of the paging algorithms are up to the user this is on purpose and is meant to keep this library small and maintanable."}),"\n",(0,r.jsx)(n.h2,{id:"using-mongoose",children:"Using mongoose?"}),"\n",(0,r.jsxs)(n.p,{children:["There is a companion library available called ",(0,r.jsx)(n.a,{href:"https://www.npmjs.com/package/mongoose-relay-paginate",children:"mongoose-relay-paginate"}),"! It works great with this library."]}),"\n",(0,r.jsx)(n.h2,{id:"documentation",children:"Documentation"}),"\n",(0,r.jsxs)(n.p,{children:["For more details than below view the ",(0,r.jsx)(n.a,{href:"https://johnsonjo4531.github.io/typegraphql-relay-connections/",children:"Docs"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"tutorial",children:"Tutorial"}),"\n",(0,r.jsxs)(n.p,{children:["First create an object-type through ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"type-graphql"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nclass Item {\n @Field()\n id!: number;\n}\n"})}),"\n",(0,r.jsx)(n.p,{children:"Then add this libraries Edge and Connection types to it:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nexport class ItemEdge extends EdgeType(Item) {}\n\n@ObjectType()\nexport class ItemConnection extends ConnectionType(ItemEdge) {}\n\n@InputType()\nclass MyProjectsCursor implements Cursor {\n @Field()\n _id!: number;\n\n [key: string]: unknown;\n}\n"})}),"\n",(0,r.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,r.jsxs)(n.p,{children:["See the ",(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/main/src/__tests__/index.spec.ts",children:"tests"})," and the ",(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/tree/main/src/examples",children:"example"})," folder for more examples."]}),"\n",(0,r.jsx)(n.p,{children:"Here's a (possibly, at some point, out of date) version of the example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'import "reflect-metadata";\nimport { execute } from "graphql";\nimport gql from "graphql-tag";\nimport {\n Args,\n buildSchema,\n Field,\n InputType,\n ObjectType,\n Query,\n Resolver,\n} from "type-graphql";\nimport Cursor, {\n ForwardPaginationArgs,\n ConnectionType,\n EdgeType,\n BackwardPaginationArgs,\n serializeCursor\n} from "typegraphql-relay-connections";\n\n@ObjectType()\nclass Item {\n @Field()\n id!: number;\n}\n\n@ObjectType()\nexport class ItemEdge extends EdgeType(Item) {}\n\n@ObjectType()\nexport class ItemConnection extends ConnectionType(ItemEdge) {}\n\n@InputType()\nclass MyProjectsCursor implements Cursor {\n @Field()\n _id!: number;\n\n [key: string]: unknown;\n}\n\nexport const items = [\n {\n id: 1,\n },\n {\n id: 2,\n },\n {\n id: 3,\n },\n {\n id: 4,\n },\n];\n\n@Resolver(Item)\nexport class ItemResolver {\n @Query(() => ItemConnection)\n Items(\n @Args() forwardPaging: ForwardPaginationArgs,\n @Args() backwardPaging: BackwardPaginationArgs\n ): ItemConnection {\n return {\n edges: items.map((node) => ({\n /** You can pick off whatever properties fit your cursor or repeat the whole node */\n cursor: { id: node.id },\n node,\n })),\n pageInfo: {\n hasNextPage: false,\n hasPreviousPage: false,\n endCursor: items[items.length - 1],\n startCursor: items[0],\n },\n };\n }\n}\n(async () => {\n const schema = await buildSchema({\n resolvers: [ItemResolver],\n });\n const result = execute({\n schema,\n document: gql`\n #graphql\n query ($cursor: Cursor!) {\n Items {\n edges {\n cursor\n node {\n id\n }\n }\n pageInfo {\n hasNextPage\n hasPreviousPage\n endCursor\n startCursor\n }\n }\n }\n `,\n variableValues: {\n cursor: serializeCursor({\n id: 2,\n }),\n },\n });\n\n console.log(JSON.stringify(await result, null, 2));\n})();\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>a});var r=t(7294);const s={},o=r.createContext(s);function a(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e8c322a.105b0547.js b/assets/js/5e8c322a.105b0547.js deleted file mode 100644 index 3b499ed..0000000 --- a/assets/js/5e8c322a.105b0547.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[7597],{3006:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=t(5893),s=t(1151);const o={id:"index",title:"typegraphql-relay-connections",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},a="typegraphql-relay-connections",i={id:"api/index",title:"typegraphql-relay-connections",description:"This library provides a way to setup typings for TypeGraphQL with Relay.",source:"@site/docs/api/index.md",sourceDirName:"api",slug:"/api/",permalink:"/typegraphql-relay-connections/docs/api/",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"index",title:"typegraphql-relay-connections",sidebar_label:"Readme",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",next:{title:"Exports",permalink:"/typegraphql-relay-connections/docs/api/modules"}},l={},c=[{value:"Using mongoose?",id:"using-mongoose",level:2},{value:"Documentation",id:"documentation",level:2},{value:"Tutorial",id:"tutorial",level:2},{value:"Example",id:"example",level:3}];function p(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)("p",{align:"center",children:(0,r.jsx)("img",{src:"./docs/static/img/logo.png"})}),"\n",(0,r.jsx)(n.h1,{id:"typegraphql-relay-connections",children:"typegraphql-relay-connections"}),"\n",(0,r.jsxs)(n.p,{children:["This library provides a way to setup typings for ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"TypeGraphQL"})," with Relay."]}),"\n",(0,r.jsx)(n.p,{children:"Note that though pagination types and utils are in this repo, the implementation of the paging algorithms are up to the user this is on purpose and is meant to keep this library small and maintanable."}),"\n",(0,r.jsx)(n.h2,{id:"using-mongoose",children:"Using mongoose?"}),"\n",(0,r.jsxs)(n.p,{children:["There is a companion library available called ",(0,r.jsx)(n.a,{href:"https://www.npmjs.com/package/mongoose-relay-paginate",children:"mongoose-relay-paginate"}),"! It works great with this library."]}),"\n",(0,r.jsx)(n.h2,{id:"documentation",children:"Documentation"}),"\n",(0,r.jsxs)(n.p,{children:["For more details than below view the ",(0,r.jsx)(n.a,{href:"https://johnsonjo4531.github.io/typegraphql-relay-connections/",children:"Docs"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"tutorial",children:"Tutorial"}),"\n",(0,r.jsxs)(n.p,{children:["First create an object-type through ",(0,r.jsx)(n.a,{href:"https://typegraphql.com/",children:"type-graphql"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nclass Item {\n @Field()\n id!: number;\n}\n"})}),"\n",(0,r.jsx)(n.p,{children:"Then add this libraries Edge and Connection types to it:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nexport class ItemEdge extends EdgeType(Item) {}\n\n@ObjectType()\nexport class ItemConnection extends ConnectionType({\n edge: ItemEdge,\n node: Item,\n}) {}\n\n@InputType()\nclass MyProjectsCursor implements Cursor {\n @Field()\n _id!: number;\n\n [key: string]: unknown;\n}\n"})}),"\n",(0,r.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,r.jsxs)(n.p,{children:["See the ",(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/main/src/__tests__/index.spec.ts",children:"tests"})," and the ",(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/tree/main/src/examples",children:"example"})," folder for more examples."]}),"\n",(0,r.jsx)(n.p,{children:"Here's a (possibly, at some point, out of date) version of the example:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'import "reflect-metadata";\nimport { execute } from "graphql";\nimport gql from "graphql-tag";\nimport {\n Args,\n buildSchema,\n Field,\n InputType,\n ObjectType,\n Query,\n Resolver,\n} from "type-graphql";\nimport Cursor, {\n ForwardPaginationArgs,\n ConnectionType,\n EdgeType,\n BackwardPaginationArgs,\n serializeCursor\n} from "typegraphql-relay-connections";\n\n@ObjectType()\nclass Item {\n @Field()\n id!: number;\n}\n\n@ObjectType()\nexport class ItemEdge extends EdgeType(Item) {}\n\n@ObjectType()\nexport class ItemConnection extends ConnectionType({\n edge: ItemEdge,\n node: Item,\n}) {}\n\n@InputType()\nclass MyProjectsCursor implements Cursor {\n @Field()\n _id!: number;\n\n [key: string]: unknown;\n}\n\nexport const items = [\n {\n id: 1,\n },\n {\n id: 2,\n },\n {\n id: 3,\n },\n {\n id: 4,\n },\n];\n\n@Resolver(Item)\nexport class ItemResolver {\n @Query(() => ItemConnection)\n Items(\n @Args() forwardPaging: ForwardPaginationArgs,\n @Args() backwardPaging: BackwardPaginationArgs\n ): ItemConnection {\n return {\n edges: items.map((node) => ({\n /** You can pick off whatever properties fit your cursor or repeat the whole node */\n cursor: { id: node.id },\n node,\n })),\n nodes: items,\n pageInfo: {\n hasNextPage: false,\n hasPreviousPage: false,\n endCursor: items[items.length - 1],\n startCursor: items[0],\n },\n };\n }\n}\n(async () => {\n const schema = await buildSchema({\n resolvers: [ItemResolver],\n });\n const result = execute({\n schema,\n document: gql`\n #graphql\n query ($cursor: Cursor!) {\n Items {\n edges {\n cursor\n node {\n id\n }\n }\n nodes {\n id\n }\n pageInfo {\n hasNextPage\n hasPreviousPage\n endCursor\n startCursor\n }\n }\n }\n `,\n variableValues: {\n cursor: serializeCursor({\n id: 2,\n }),\n },\n });\n\n console.log(JSON.stringify(await result, null, 2));\n})();\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>a});var r=t(7294);const s={},o=r.createContext(s);function a(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72daadc5.09120e37.js b/assets/js/72daadc5.09120e37.js deleted file mode 100644 index 581ed85..0000000 --- a/assets/js/72daadc5.09120e37.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[9180],{8600:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=o(5893),r=o(1151);const s={},a="TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f",l={id:"examples/typegraphql",title:"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f",description:"See the tests and the example folder for more examples.",source:"@site/docs/examples/typegraphql.md",sourceDirName:"examples",slug:"/examples/typegraphql",permalink:"/typegraphql-relay-connections/docs/examples/typegraphql",draft:!1,unlisted:!1,editUrl:"https://github.com/johnsonjo4531/typegraphql-relay-connections/docs/blog/docs/examples/typegraphql.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Extending the Builtin Cursor \ud83d\udcc4",permalink:"/typegraphql-relay-connections/docs/tutorials/custom-cursors"},next:{title:"Changelog",permalink:"/typegraphql-relay-connections/docs/Changelog"}},i={},c=[];function p(e){const n={a:"a",code:"code",h1:"h1",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"typegraphql-example-\ufe0f\ufe0f",children:"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f"}),"\n",(0,t.jsxs)(n.p,{children:["See the ",(0,t.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/tree/main/src/__tests__/index.spec.ts",children:"tests"})," and the ",(0,t.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/tree/main/src/examples/index.example.ts",children:"example"})," folder for more examples."]}),"\n",(0,t.jsxs)(n.p,{children:["Here's a full-fledged typegraphql server example (",(0,t.jsx)(n.a,{href:"https://codesandbox.io/s/typegraphql-relay-connections-6wl8ck?file=/src/index.ts",children:"codesandbox link"}),"):"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import "reflect-metadata";\nimport { ApolloServer } from "apollo-server";\nimport {\n ObjectType,\n Field,\n Resolver,\n Query,\n Mutation,\n Arg,\n InputType,\n buildSchema,\n Args\n} from "type-graphql";\nimport {\n EdgeType,\n ConnectionType,\n BackwardPaginationArgs,\n ForwardPaginationArgs\n} from "typegraphql-relay-connections";\nimport { edgesToReturn } from "./pagination.example";\n\n// Setup GraphQL Schema\n@ObjectType()\nclass Book {\n @Field()\n title!: string;\n @Field()\n author!: string;\n}\n\n@InputType()\nclass NewBookInput {\n @Field()\n title!: string;\n @Field()\n author!: string;\n}\n\n// setup relay connection types\n@ObjectType()\nclass BookEdge extends EdgeType(Book) {}\n\n@ObjectType()\nclass BookConnection extends ConnectionType({\n edge: BookEdge,\n node: Book\n}) {}\n\ndeclare module "typegraphql-relay-connections" {\n interface Cursor {\n id: string;\n }\n}\n\n// usually you have some form of database this will do okay for an example\nconst books: Book[] = [\n {\n title: "Three Little Pigs",\n author: "Joseph Jacobs"\n },\n {\n title: "A Christmas Carol",\n author: "Charles Dickens"\n }\n];\n\n// Setup resolver\n@Resolver(Book)\nclass BookResolver {\n @Query((returns) => BookConnection)\n async searchBooksByTitle(\n @Args() backwardPaging: BackwardPaginationArgs,\n @Args() forwardPaging: ForwardPaginationArgs,\n @Arg("title") title: string\n ): Promise {\n const edges = edgesToReturn(\n books\n .filter((book) => book.title.includes(title))\n .map((node) => ({\n node,\n cursor: {\n id: node.title\n }\n })),\n {}\n );\n return {\n edges,\n nodes: edges.map((x) => x.node),\n pageInfo: {\n hasNextPage: false,\n hasPreviousPage: false,\n endCursor: edges[edges.length - 1].cursor,\n startCursor: edges[0].cursor,\n }\n };\n }\n\n @Query((returns) => BookConnection)\n async searchBooksByAuthor(\n @Arg("author") title: string\n ): Promise {\n const edges = edgesToReturn(\n books\n .filter((book) => book.author.includes(title))\n .map((node) => ({\n node,\n cursor: {\n id: node.title\n }\n })),\n {}\n );\n return {\n edges,\n nodes: edges.map((x) => x.node),\n pageInfo: {\n hasNextPage: false,\n hasPreviousPage: false,\n endCursor: edges[edges.length - 1].cursor,\n startCursor: edges[0].cursor,\n }\n };\n }\n\n @Query((returns) => BookConnection)\n async allBooks(): Promise {\n const edges = edgesToReturn(\n books.map((node) => ({\n node,\n cursor: {\n id: node.title\n }\n })),\n {}\n );\n return {\n edges,\n nodes: edges.map((x) => x.node),\n pageInfo: {\n hasNextPage: false,\n hasPreviousPage: false,\n endCursor: edges[edges.length - 1].cursor,\n startCursor: edges[0].cursor,\n }\n };\n }\n\n @Mutation((returns) => Book)\n async addBook(@Arg("newBookData") newBookData: NewBookInput) {\n books.push(newBookData);\n return newBookData;\n }\n}\n\nconst PORT = 4000;\n\nasync function bootstrap() {\n const schema = await buildSchema({\n resolvers: [BookResolver]\n });\n\n // Create the GraphQL server\n const server = new ApolloServer({\n schema\n });\n\n // Start the server\n const { url } = await server.listen(PORT);\n console.log(`Server is running, GraphQL Playground available at ${url}`);\n}\n\nbootstrap();\n'})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},1151:(e,n,o)=>{o.d(n,{Z:()=>l,a:()=>a});var t=o(7294);const r={},s=t.createContext(r);function a(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72daadc5.9a0f56fe.js b/assets/js/72daadc5.9a0f56fe.js new file mode 100644 index 0000000..456f394 --- /dev/null +++ b/assets/js/72daadc5.9a0f56fe.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[9180],{8600:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=o(5893),r=o(1151);const s={},a="TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f",l={id:"examples/typegraphql",title:"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f",description:"See the tests and the example folder for more examples.",source:"@site/docs/examples/typegraphql.md",sourceDirName:"examples",slug:"/examples/typegraphql",permalink:"/typegraphql-relay-connections/docs/examples/typegraphql",draft:!1,unlisted:!1,editUrl:"https://github.com/johnsonjo4531/typegraphql-relay-connections/docs/blog/docs/examples/typegraphql.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Extending the Builtin Cursor \ud83d\udcc4",permalink:"/typegraphql-relay-connections/docs/tutorials/custom-cursors"},next:{title:"Changelog",permalink:"/typegraphql-relay-connections/docs/Changelog"}},i={},c=[];function p(e){const n={a:"a",code:"code",h1:"h1",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"typegraphql-example-\ufe0f\ufe0f",children:"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f"}),"\n",(0,t.jsxs)(n.p,{children:["See the ",(0,t.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/tree/main/src/__tests__/index.spec.ts",children:"tests"})," and the ",(0,t.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/tree/main/src/examples/index.example.ts",children:"example"})," folder for more examples."]}),"\n",(0,t.jsxs)(n.p,{children:["Here's a full-fledged typegraphql server example (",(0,t.jsx)(n.a,{href:"https://codesandbox.io/s/typegraphql-relay-connections-6wl8ck?file=/src/index.ts",children:"codesandbox link"}),"):"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'import "reflect-metadata";\nimport { ApolloServer } from "apollo-server";\nimport {\n ObjectType,\n Field,\n Resolver,\n Query,\n Mutation,\n Arg,\n InputType,\n buildSchema,\n Args\n} from "type-graphql";\nimport {\n EdgeType,\n ConnectionType,\n BackwardPaginationArgs,\n ForwardPaginationArgs\n} from "typegraphql-relay-connections";\nimport { edgesToReturn } from "./pagination.example";\n\n// Setup GraphQL Schema\n@ObjectType()\nclass Book {\n @Field()\n title!: string;\n @Field()\n author!: string;\n}\n\n@InputType()\nclass NewBookInput {\n @Field()\n title!: string;\n @Field()\n author!: string;\n}\n\n// setup relay connection types\n@ObjectType()\nclass BookEdge extends EdgeType(Book) {}\n\n@ObjectType()\nclass BookConnection extends ConnectionType(BookEdge) {}\n\ndeclare module "typegraphql-relay-connections" {\n interface Cursor {\n id: string;\n }\n}\n\n// usually you have some form of database this will do okay for an example\nconst books: Book[] = [\n {\n title: "Three Little Pigs",\n author: "Joseph Jacobs"\n },\n {\n title: "A Christmas Carol",\n author: "Charles Dickens"\n }\n];\n\n// Setup resolver\n@Resolver(Book)\nclass BookResolver {\n @Query((returns) => BookConnection)\n async searchBooksByTitle(\n @Args() backwardPaging: BackwardPaginationArgs,\n @Args() forwardPaging: ForwardPaginationArgs,\n @Arg("title") title: string\n ): Promise {\n const edges = edgesToReturn(\n books\n .filter((book) => book.title.includes(title))\n .map((node) => ({\n node,\n cursor: {\n id: node.title\n }\n })),\n {}\n );\n return {\n edges,\n pageInfo: {\n hasNextPage: false,\n hasPreviousPage: false,\n endCursor: edges[edges.length - 1].cursor,\n startCursor: edges[0].cursor,\n }\n };\n }\n\n @Query((returns) => BookConnection)\n async searchBooksByAuthor(\n @Arg("author") title: string\n ): Promise {\n const edges = edgesToReturn(\n books\n .filter((book) => book.author.includes(title))\n .map((node) => ({\n node,\n cursor: {\n id: node.title\n }\n })),\n {}\n );\n return {\n edges,\n pageInfo: {\n hasNextPage: false,\n hasPreviousPage: false,\n endCursor: edges[edges.length - 1].cursor,\n startCursor: edges[0].cursor,\n }\n };\n }\n\n @Query((returns) => BookConnection)\n async allBooks(): Promise {\n const edges = edgesToReturn(\n books.map((node) => ({\n node,\n cursor: {\n id: node.title\n }\n })),\n {}\n );\n return {\n edges,\n pageInfo: {\n hasNextPage: false,\n hasPreviousPage: false,\n endCursor: edges[edges.length - 1].cursor,\n startCursor: edges[0].cursor,\n }\n };\n }\n\n @Mutation((returns) => Book)\n async addBook(@Arg("newBookData") newBookData: NewBookInput) {\n books.push(newBookData);\n return newBookData;\n }\n}\n\nconst PORT = 4000;\n\nasync function bootstrap() {\n const schema = await buildSchema({\n resolvers: [BookResolver]\n });\n\n // Create the GraphQL server\n const server = new ApolloServer({\n schema\n });\n\n // Start the server\n const { url } = await server.listen(PORT);\n console.log(`Server is running, GraphQL Playground available at ${url}`);\n}\n\nbootstrap();\n'})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},1151:(e,n,o)=>{o.d(n,{Z:()=>l,a:()=>a});var t=o(7294);const r={},s=t.createContext(r);function a(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.dbf0c178.js b/assets/js/935f2afb.6c944cb4.js similarity index 58% rename from assets/js/935f2afb.dbf0c178.js rename to assets/js/935f2afb.6c944cb4.js index d073d91..2c5a834 100644 --- a/assets/js/935f2afb.dbf0c178.js +++ b/assets/js/935f2afb.6c944cb4.js @@ -1 +1 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"category","label":"API","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/typegraphql-relay-connections/docs/api/modules","docId":"api/modules","unlisted":false},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BackwardPaginationArgs","href":"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs","docId":"api/classes/BackwardPaginationArgs","unlisted":false},{"type":"link","label":"ForwardPaginationArgs","href":"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs","docId":"api/classes/ForwardPaginationArgs","unlisted":false},{"type":"link","label":"FullPaginationArgs","href":"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs","docId":"api/classes/FullPaginationArgs","unlisted":false},{"type":"link","label":"PageInfo","href":"/typegraphql-relay-connections/docs/api/classes/PageInfo","docId":"api/classes/PageInfo","unlisted":false},{"type":"link","label":"RelayConnectionType","href":"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType","docId":"api/classes/RelayConnectionType","unlisted":false},{"type":"link","label":"RelayEdgeType","href":"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType","docId":"api/classes/RelayEdgeType","unlisted":false}]},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Cursor","href":"/typegraphql-relay-connections/docs/api/interfaces/Cursor","docId":"api/interfaces/Cursor","unlisted":false}]}],"href":"/typegraphql-relay-connections/docs/api/"},{"type":"link","label":"Intro \ud83d\ude80","href":"/typegraphql-relay-connections/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Usage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"EdgeType \ud83e\uddc0","href":"/typegraphql-relay-connections/docs/usage/edge-type","docId":"usage/edge-type","unlisted":false},{"type":"link","label":"ConnectionType \ud83e\udd94","href":"/typegraphql-relay-connections/docs/usage/connection-type","docId":"usage/connection-type","unlisted":false}]},{"type":"category","label":"Tutorials","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Extending the Builtin Cursor \ud83d\udcc4","href":"/typegraphql-relay-connections/docs/tutorials/custom-cursors","docId":"tutorials/custom-cursors","unlisted":false}]},{"type":"category","label":"Examples","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f","href":"/typegraphql-relay-connections/docs/examples/typegraphql","docId":"examples/typegraphql","unlisted":false}]},{"type":"link","label":"Changelog","href":"/typegraphql-relay-connections/docs/Changelog","docId":"Changelog","unlisted":false}]},"docs":{"api/classes/BackwardPaginationArgs":{"id":"api/classes/BackwardPaginationArgs","title":"Class: BackwardPaginationArgs","description":"Allows backward pagination of a relay connection type","sidebar":"tutorialSidebar"},"api/classes/ForwardPaginationArgs":{"id":"api/classes/ForwardPaginationArgs","title":"Class: ForwardPaginationArgs","description":"Allows forward pagination of a Relay connection type","sidebar":"tutorialSidebar"},"api/classes/FullPaginationArgs":{"id":"api/classes/FullPaginationArgs","title":"Class: FullPaginationArgs","description":"Allows forward pagination of a Relay connection type","sidebar":"tutorialSidebar"},"api/classes/PageInfo":{"id":"api/classes/PageInfo","title":"Class: PageInfo","description":"PageInfo is information about the paging/cursoring happening on the server.","sidebar":"tutorialSidebar"},"api/classes/RelayConnectionType":{"id":"api/classes/RelayConnectionType","title":"Class: RelayConnectionType","description":"Type parameters","sidebar":"tutorialSidebar"},"api/classes/RelayEdgeType":{"id":"api/classes/RelayEdgeType","title":"Class: RelayEdgeType","description":"Type parameters","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"typegraphql-relay-connections","description":"This library provides a way to setup typings for TypeGraphQL with Relay.","sidebar":"tutorialSidebar"},"api/interfaces/Cursor":{"id":"api/interfaces/Cursor","title":"Interface: Cursor","description":"The serialized Cursor","sidebar":"tutorialSidebar"},"api/modules":{"id":"api/modules","title":"typegraphql-relay-connections","description":"Classes","sidebar":"tutorialSidebar"},"Changelog":{"id":"Changelog","title":"Changelog","description":"Version 1.x to 2.x","sidebar":"tutorialSidebar"},"examples/typegraphql":{"id":"examples/typegraphql","title":"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f","description":"See the tests and the example folder for more examples.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Intro \ud83d\ude80","description":"This library provides a way to setup typings for TypeGraphQL with Relay Connection Types. Relay Connection Types are a great way to define pagination in an app. This libraries connection types follow the Relay Connection Type Server Standard. You may want to read up on relay if you\'re confused on what the benefits of relay connections to find out how exactly this library works. Particularly this library implements the second part of the standard, so it accomplishes: 2.) A description of how to page through connections, so you may want to check out the relevant section on connections in the relay GraphQL server standard.","sidebar":"tutorialSidebar"},"tutorials/custom-cursors":{"id":"tutorials/custom-cursors","title":"Extending the Builtin Cursor \ud83d\udcc4","description":"The default Cursor type allows any object value, but you may instead want to extend it with more properties and values which will allow autocomplete of those propety value pairs. You could do that like so:","sidebar":"tutorialSidebar"},"usage/connection-type":{"id":"usage/connection-type","title":"ConnectionType \ud83e\udd94","description":"The ConnectionType function is the slightly more complicated of the two main functions. We\'ll define a full example below, but if we isolate the ConnectionType by itself you\'ll see it looks like this:","sidebar":"tutorialSidebar"},"usage/edge-type":{"id":"usage/edge-type","title":"EdgeType \ud83e\uddc0","description":"The EdgeType allows you to create a GraphQL relay edge ObjectType from a base type. ObjectTypes are what you can return from any graphql resolver, see the examples for more full implementations of how to connect to resolvers. We\'ll get to a more full and complete example of EdgeTypes below, but for now here is an isolated example showing how exactly the EdgeType is used.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"category","label":"API","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Exports","href":"/typegraphql-relay-connections/docs/api/modules","docId":"api/modules","unlisted":false},{"type":"category","label":"Classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"BackwardPaginationArgs","href":"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs","docId":"api/classes/BackwardPaginationArgs","unlisted":false},{"type":"link","label":"ForwardPaginationArgs","href":"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs","docId":"api/classes/ForwardPaginationArgs","unlisted":false},{"type":"link","label":"FullPaginationArgs","href":"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs","docId":"api/classes/FullPaginationArgs","unlisted":false},{"type":"link","label":"PageInfo","href":"/typegraphql-relay-connections/docs/api/classes/PageInfo","docId":"api/classes/PageInfo","unlisted":false},{"type":"link","label":"RelayConnectionType","href":"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType","docId":"api/classes/RelayConnectionType","unlisted":false},{"type":"link","label":"RelayEdgeType","href":"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType","docId":"api/classes/RelayEdgeType","unlisted":false}]},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Cursor","href":"/typegraphql-relay-connections/docs/api/interfaces/Cursor","docId":"api/interfaces/Cursor","unlisted":false}]}],"href":"/typegraphql-relay-connections/docs/api/"},{"type":"link","label":"Intro \ud83d\ude80","href":"/typegraphql-relay-connections/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Usage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"EdgeType \ud83e\uddc0","href":"/typegraphql-relay-connections/docs/usage/edge-type","docId":"usage/edge-type","unlisted":false},{"type":"link","label":"ConnectionType \ud83e\udd94","href":"/typegraphql-relay-connections/docs/usage/connection-type","docId":"usage/connection-type","unlisted":false}]},{"type":"category","label":"Tutorials","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Extending the Builtin Cursor \ud83d\udcc4","href":"/typegraphql-relay-connections/docs/tutorials/custom-cursors","docId":"tutorials/custom-cursors","unlisted":false}]},{"type":"category","label":"Examples","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f","href":"/typegraphql-relay-connections/docs/examples/typegraphql","docId":"examples/typegraphql","unlisted":false}]},{"type":"link","label":"Changelog","href":"/typegraphql-relay-connections/docs/Changelog","docId":"Changelog","unlisted":false}]},"docs":{"api/classes/BackwardPaginationArgs":{"id":"api/classes/BackwardPaginationArgs","title":"Class: BackwardPaginationArgs","description":"Allows backward pagination of a relay connection type","sidebar":"tutorialSidebar"},"api/classes/ForwardPaginationArgs":{"id":"api/classes/ForwardPaginationArgs","title":"Class: ForwardPaginationArgs","description":"Allows forward pagination of a Relay connection type","sidebar":"tutorialSidebar"},"api/classes/FullPaginationArgs":{"id":"api/classes/FullPaginationArgs","title":"Class: FullPaginationArgs","description":"Allows forward pagination of a Relay connection type","sidebar":"tutorialSidebar"},"api/classes/PageInfo":{"id":"api/classes/PageInfo","title":"Class: PageInfo","description":"PageInfo is information about the paging/cursoring happening on the server.","sidebar":"tutorialSidebar"},"api/classes/RelayConnectionType":{"id":"api/classes/RelayConnectionType","title":"Class: RelayConnectionType","description":"Type parameters","sidebar":"tutorialSidebar"},"api/classes/RelayEdgeType":{"id":"api/classes/RelayEdgeType","title":"Class: RelayEdgeType","description":"Type parameters","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"typegraphql-relay-connections","description":"This library provides a way to setup typings for TypeGraphQL with Relay.","sidebar":"tutorialSidebar"},"api/interfaces/Cursor":{"id":"api/interfaces/Cursor","title":"Interface: Cursor","description":"The serialized Cursor","sidebar":"tutorialSidebar"},"api/modules":{"id":"api/modules","title":"typegraphql-relay-connections","description":"Classes","sidebar":"tutorialSidebar"},"Changelog":{"id":"Changelog","title":"Changelog","description":"Version 2.x to 3.x","sidebar":"tutorialSidebar"},"examples/typegraphql":{"id":"examples/typegraphql","title":"TypeGraphQL Example \ud83c\udfcb\ufe0f\u200d\u2642\ufe0f","description":"See the tests and the example folder for more examples.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Intro \ud83d\ude80","description":"This library provides a way to setup typings for TypeGraphQL with Relay Connection Types. Relay Connection Types are a great way to define pagination in an app. This libraries connection types follow the Relay Connection Type Server Standard. You may want to read up on relay if you\'re confused on what the benefits of relay connections to find out how exactly this library works. Particularly this library implements the second part of the standard, so it accomplishes: 2.) A description of how to page through connections, so you may want to check out the relevant section on connections in the relay GraphQL server standard.","sidebar":"tutorialSidebar"},"tutorials/custom-cursors":{"id":"tutorials/custom-cursors","title":"Extending the Builtin Cursor \ud83d\udcc4","description":"The default Cursor type allows any object value, but you may instead want to extend it with more properties and values which will allow autocomplete of those propety value pairs. You could do that like so:","sidebar":"tutorialSidebar"},"usage/connection-type":{"id":"usage/connection-type","title":"ConnectionType \ud83e\udd94","description":"The ConnectionType function is the slightly more complicated of the two main functions. We\'ll define a full example below, but if we isolate the ConnectionType by itself you\'ll see it looks like this:","sidebar":"tutorialSidebar"},"usage/edge-type":{"id":"usage/edge-type","title":"EdgeType \ud83e\uddc0","description":"The EdgeType allows you to create a GraphQL relay edge ObjectType from a base type. ObjectTypes are what you can return from any graphql resolver, see the examples for more full implementations of how to connect to resolvers. We\'ll get to a more full and complete example of EdgeTypes below, but for now here is an isolated example showing how exactly the EdgeType is used.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/a34174ca.886730a3.js b/assets/js/a34174ca.886730a3.js new file mode 100644 index 0000000..999db08 --- /dev/null +++ b/assets/js/a34174ca.886730a3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[4926],{325:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>l,metadata:()=>i,toc:()=>o});var r=s(5893),t=s(1151);const l={id:"RelayConnectionType",title:"Class: RelayConnectionType",sidebar_label:"RelayConnectionType",sidebar_position:0,custom_edit_url:null},c=void 0,i={id:"api/classes/RelayConnectionType",title:"Class: RelayConnectionType",description:"Type parameters",source:"@site/docs/api/classes/RelayConnectionType.md",sourceDirName:"api/classes",slug:"/api/classes/RelayConnectionType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"RelayConnectionType",title:"Class: RelayConnectionType",sidebar_label:"RelayConnectionType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PageInfo",permalink:"/typegraphql-relay-connections/docs/api/classes/PageInfo"},next:{title:"RelayEdgeType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType"}},d={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"edges",id:"edges",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"pageInfo",id:"pageinfo",level:3},{value:"Defined in",id:"defined-in-1",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"CursorType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})," = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"EdgeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),"> = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),">"]})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"new RelayConnectionType"}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),">(): ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:(0,r.jsx)(n.code,{children:"RelayConnectionType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"CursorType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})," = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"EdgeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),"> = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),">"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:(0,r.jsx)(n.code,{children:"RelayConnectionType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),">"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"edges",children:"edges"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"edges"}),": ",(0,r.jsx)(n.code,{children:"EdgeType"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L235",children:"index.ts:235"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pageinfo",children:"pageInfo"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"pageInfo"}),": ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/PageInfo",children:(0,r.jsx)(n.code,{children:"PageInfo"})}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L234",children:"index.ts:234"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>c});var r=s(7294);const t={},l=r.createContext(t);function c(e){const n=r.useContext(l);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a34174ca.9762761b.js b/assets/js/a34174ca.9762761b.js deleted file mode 100644 index 0268f37..0000000 --- a/assets/js/a34174ca.9762761b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[4926],{325:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>o});var r=s(5893),l=s(1151);const d={id:"RelayConnectionType",title:"Class: RelayConnectionType",sidebar_label:"RelayConnectionType",sidebar_position:0,custom_edit_url:null},t=void 0,c={id:"api/classes/RelayConnectionType",title:"Class: RelayConnectionType",description:"Type parameters",source:"@site/docs/api/classes/RelayConnectionType.md",sourceDirName:"api/classes",slug:"/api/classes/RelayConnectionType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"RelayConnectionType",title:"Class: RelayConnectionType",sidebar_label:"RelayConnectionType",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PageInfo",permalink:"/typegraphql-relay-connections/docs/api/classes/PageInfo"},next:{title:"RelayEdgeType",permalink:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType"}},i={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"edges",id:"edges",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"nodes",id:"nodes",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"pageInfo",id:"pageinfo",level:3},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"CursorType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})," = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"EdgeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),"> = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),">"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"NodeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/modules#nodestype",children:(0,r.jsx)(n.code,{children:"NodesType"})})," = ",(0,r.jsx)(n.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(n.h3,{id:"constructor",children:"constructor"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"new RelayConnectionType"}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">(): ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:(0,r.jsx)(n.code,{children:"RelayConnectionType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"CursorType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})," = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"EdgeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),"> = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),">"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"NodeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.code,{children:"unknown"})," = ",(0,r.jsx)(n.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:(0,r.jsx)(n.code,{children:"RelayConnectionType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"edges",children:"edges"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"edges"}),": ",(0,r.jsx)(n.code,{children:"EdgeType"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L236",children:"index.ts:236"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nodes",children:"nodes"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"nodes"}),": ",(0,r.jsx)(n.code,{children:"NodeType"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L237",children:"index.ts:237"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"pageinfo",children:"pageInfo"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"pageInfo"}),": ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/PageInfo",children:(0,r.jsx)(n.code,{children:"PageInfo"})}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L235",children:"index.ts:235"})})]})}function h(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var r=s(7294);const l={},d=r.createContext(l);function t(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:t(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6aebfbf.3d3b8975.js b/assets/js/f6aebfbf.3d3b8975.js new file mode 100644 index 0000000..502846f --- /dev/null +++ b/assets/js/f6aebfbf.3d3b8975.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[7306],{1324:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>t,toc:()=>a});var r=s(5893),l=s(1151);const i={id:"modules",title:"typegraphql-relay-connections",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},d=void 0,t={id:"api/modules",title:"typegraphql-relay-connections",description:"Classes",source:"@site/docs/api/modules.md",sourceDirName:"api",slug:"/api/modules",permalink:"/typegraphql-relay-connections/docs/api/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"typegraphql-relay-connections",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Readme",permalink:"/typegraphql-relay-connections/docs/api/"},next:{title:"BackwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs"}},c={},a=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"References",id:"references",level:2},{value:"CursorScalar",id:"cursorscalar",level:3},{value:"Type Aliases",id:"type-aliases",level:2},{value:"ClassReturnType",id:"classreturntype",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"NodesType",id:"nodestype",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"NodesTypeClass",id:"nodestypeclass",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Variables",id:"variables",level:2},{value:"Cursor",id:"cursor",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Functions",id:"functions",level:2},{value:"ConnectionType",id:"connectiontype",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"EdgeType",id:"edgetype",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"deserializeCursor",id:"deserializecursor",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"serializeCursor",id:"serializecursor",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,l.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"classes",children:"Classes"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:"BackwardPaginationArgs"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:"ForwardPaginationArgs"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:"FullPaginationArgs"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/PageInfo",children:"PageInfo"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:"RelayConnectionType"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:"RelayEdgeType"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:"Cursor"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"references",children:"References"}),"\n",(0,r.jsx)(n.h3,{id:"cursorscalar",children:"CursorScalar"}),"\n",(0,r.jsxs)(n.p,{children:["Renames and re-exports ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/modules#cursor",children:"Cursor"})]}),"\n",(0,r.jsx)(n.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsx)(n.h3,{id:"classreturntype",children:"ClassReturnType"}),"\n",(0,r.jsxs)(n.p,{children:["\u01ac ",(0,r.jsx)(n.strong,{children:"ClassReturnType"}),"<",(0,r.jsx)(n.code,{children:"T"}),">: ",(0,r.jsx)(n.code,{children:"T"})," extends ",(0,r.jsx)(n.code,{children:"ClassType"})," ? ",(0,r.jsx)(n.code,{children:"J"})," : ",(0,r.jsx)(n.code,{children:"never"})]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.code,{children:"unknown"}),">"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L149",children:"index.ts:149"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nodestype",children:"NodesType"}),"\n",(0,r.jsxs)(n.p,{children:["\u01ac ",(0,r.jsx)(n.strong,{children:"NodesType"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L147",children:"index.ts:147"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nodestypeclass",children:"NodesTypeClass"}),"\n",(0,r.jsxs)(n.p,{children:["\u01ac ",(0,r.jsx)(n.strong,{children:"NodesTypeClass"}),": ",(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/modules#nodestype",children:(0,r.jsx)(n.code,{children:"NodesType"})}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L148",children:"index.ts:148"})}),"\n",(0,r.jsx)(n.h2,{id:"variables",children:"Variables"}),"\n",(0,r.jsx)(n.h3,{id:"cursor",children:"Cursor"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"Cursor"}),": ",(0,r.jsx)(n.code,{children:"GraphQLScalarType"})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/cursor.ts#L40",children:"cursor.ts:40"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/cursor.ts#L107",children:"cursor.ts:107"})}),"\n",(0,r.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,r.jsx)(n.h3,{id:"connectiontype",children:"ConnectionType"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"ConnectionType"}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),">(",(0,r.jsx)(n.code,{children:"edge"}),"): ",(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:(0,r.jsx)(n.code,{children:"RelayConnectionType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),">>"]}),"\n",(0,r.jsx)(n.p,{children:"Setup an extensible ConnectionType"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"CursorType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})," = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"EdgeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),"> = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),">"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"edge"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.code,{children:"EdgeType"}),"> | ",(0,r.jsx)(n.code,{children:"HasConstructor"}),"<",(0,r.jsx)(n.code,{children:"EdgeType"}),">"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:(0,r.jsx)(n.code,{children:"RelayConnectionType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),">>"]}),"\n",(0,r.jsx)(n.p,{children:"A graphql object type that represents fields that can be queried."}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Example"})})}),"\n",(0,r.jsx)(n.p,{children:"Usage:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nclass Item {\n @Field()\n id!: number;\n}\n\n@ObjectType()\nexport class ItemEdge extends EdgeType(Item) {}\n\n// You must create an edge type first\n@ObjectType()\nexport class ItemConnection extends ConnectionType(ItemEdge) {}\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L262",children:"index.ts:262"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"edgetype",children:"EdgeType"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"EdgeType"}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">(",(0,r.jsx)(n.code,{children:"nodeType"}),"): ",(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">>"]}),"\n",(0,r.jsx)(n.p,{children:"Setup a extensible EdgeType"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"CursorType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})," = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"NodeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.code,{children:"unknown"})," = ",(0,r.jsx)(n.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"nodeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.code,{children:"NodeType"}),"> | ",(0,r.jsx)(n.code,{children:"HasConstructor"}),"<",(0,r.jsx)(n.code,{children:"NodeType"}),">"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">>"]}),"\n",(0,r.jsx)(n.p,{children:"A graphql object type that represents fields that can be queried."}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Example"})})}),"\n",(0,r.jsx)(n.p,{children:"Usage:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"// create an object type\n@ObjectType()\nclass Item {\n @Field()\n id!: number;\n}\n\n// Create your extensible Edge type\n@ObjectType()\nexport class ItemEdge extends EdgeType(Item) {\n // add additional properties here\n @Field(() => Date)\n createdAt: Date\n}\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/index.ts#L188",children:"index.ts:188"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"deserializecursor",children:"deserializeCursor"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"deserializeCursor"}),"(",(0,r.jsx)(n.code,{children:"externalCursor"}),"): ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]}),"\n",(0,r.jsx)(n.p,{children:"The external cursor is the value the cursor will be after it comes from the graphql client."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"externalCursor"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"The serialized cursor that most that was just received from the client."})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})}),"\n",(0,r.jsx)(n.p,{children:"The full deserialized, decoded, and parsed cursor."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/cursor.ts#L60",children:"cursor.ts:60"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serializecursor",children:"serializeCursor"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"serializeCursor"}),"(",(0,r.jsx)(n.code,{children:"internalCursor"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The serialized cursor is the value the cursor will be so it may arrive at the graphql client and be sent through a network.\nIn this case the type is an opaque base64 string."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"internalCursor"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"The full unencoded and parsed cursor."})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"The encoded cursor ready to be sent to the client."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/6b2073a/src/cursor.ts#L50",children:"cursor.ts:50"})})]})}function h(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>d});var r=s(7294);const l={},i=r.createContext(l);function d(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:d(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6aebfbf.9739d279.js b/assets/js/f6aebfbf.9739d279.js deleted file mode 100644 index c3d1824..0000000 --- a/assets/js/f6aebfbf.9739d279.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[7306],{1324:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>a,frontMatter:()=>d,metadata:()=>t,toc:()=>o});var r=s(5893),l=s(1151);const d={id:"modules",title:"typegraphql-relay-connections",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,t={id:"api/modules",title:"typegraphql-relay-connections",description:"Classes",source:"@site/docs/api/modules.md",sourceDirName:"api",slug:"/api/modules",permalink:"/typegraphql-relay-connections/docs/api/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"typegraphql-relay-connections",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Readme",permalink:"/typegraphql-relay-connections/docs/api/"},next:{title:"BackwardPaginationArgs",permalink:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs"}},c={},o=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"References",id:"references",level:2},{value:"CursorScalar",id:"cursorscalar",level:3},{value:"Type Aliases",id:"type-aliases",level:2},{value:"ClassReturnType",id:"classreturntype",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"NodesType",id:"nodestype",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"NodesTypeClass",id:"nodestypeclass",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"Variables",id:"variables",level:2},{value:"Cursor",id:"cursor",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Functions",id:"functions",level:2},{value:"ConnectionType",id:"connectiontype",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"EdgeType",id:"edgetype",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"deserializeCursor",id:"deserializecursor",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"serializeCursor",id:"serializecursor",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,l.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"classes",children:"Classes"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",children:"BackwardPaginationArgs"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",children:"ForwardPaginationArgs"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",children:"FullPaginationArgs"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/PageInfo",children:"PageInfo"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:"RelayConnectionType"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:"RelayEdgeType"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:"Cursor"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"references",children:"References"}),"\n",(0,r.jsx)(n.h3,{id:"cursorscalar",children:"CursorScalar"}),"\n",(0,r.jsxs)(n.p,{children:["Renames and re-exports ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/modules#cursor",children:"Cursor"})]}),"\n",(0,r.jsx)(n.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsx)(n.h3,{id:"classreturntype",children:"ClassReturnType"}),"\n",(0,r.jsxs)(n.p,{children:["\u01ac ",(0,r.jsx)(n.strong,{children:"ClassReturnType"}),"<",(0,r.jsx)(n.code,{children:"T"}),">: ",(0,r.jsx)(n.code,{children:"T"})," extends ",(0,r.jsx)(n.code,{children:"ClassType"})," ? ",(0,r.jsx)(n.code,{children:"J"})," : ",(0,r.jsx)(n.code,{children:"never"})]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.code,{children:"unknown"}),">"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L149",children:"index.ts:149"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nodestype",children:"NodesType"}),"\n",(0,r.jsxs)(n.p,{children:["\u01ac ",(0,r.jsx)(n.strong,{children:"NodesType"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L147",children:"index.ts:147"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"nodestypeclass",children:"NodesTypeClass"}),"\n",(0,r.jsxs)(n.p,{children:["\u01ac ",(0,r.jsx)(n.strong,{children:"NodesTypeClass"}),": ",(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/modules#nodestype",children:(0,r.jsx)(n.code,{children:"NodesType"})}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L148",children:"index.ts:148"})}),"\n",(0,r.jsx)(n.h2,{id:"variables",children:"Variables"}),"\n",(0,r.jsx)(n.h3,{id:"cursor",children:"Cursor"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"Cursor"}),": ",(0,r.jsx)(n.code,{children:"GraphQLScalarType"})]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/cursor.ts#L40",children:"cursor.ts:40"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/cursor.ts#L107",children:"cursor.ts:107"})}),"\n",(0,r.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,r.jsx)(n.h3,{id:"connectiontype",children:"ConnectionType"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"ConnectionType"}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">(",(0,r.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:(0,r.jsx)(n.code,{children:"RelayConnectionType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">>"]}),"\n",(0,r.jsx)(n.p,{children:"Setup an extensible ConnectionType"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"CursorType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})," = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"EdgeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),"> = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),">"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"NodeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.code,{children:"unknown"})," = ",(0,r.jsx)(n.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"Object"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,r.jsx)(n.code,{children:"edge"})]}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.code,{children:"EdgeType"}),"> | ",(0,r.jsx)(n.code,{children:"HasConstructor"}),"<",(0,r.jsx)(n.code,{children:"EdgeType"}),">"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,r.jsx)(n.code,{children:"node"})]}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.code,{children:"NodeType"}),"> | ",(0,r.jsx)(n.code,{children:"HasConstructor"}),"<",(0,r.jsx)(n.code,{children:"NodeType"}),">"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",children:(0,r.jsx)(n.code,{children:"RelayConnectionType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"EdgeType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">>"]}),"\n",(0,r.jsx)(n.p,{children:"A graphql object type that represents fields that can be queried."}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Example"})})}),"\n",(0,r.jsx)(n.p,{children:"Usage:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"@ObjectType()\nclass Item {\n @Field()\n id!: number;\n}\n\n@ObjectType()\nexport class ItemEdge extends EdgeType(Item) {}\n\n// You must create an edge type first\n@ObjectType()\nexport class ItemConnection extends ConnectionType({\n edge: ItemEdge,\n node: Item,\n}) {}\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L267",children:"index.ts:267"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"edgetype",children:"EdgeType"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"EdgeType"}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">(",(0,r.jsx)(n.code,{children:"nodeType"}),"): ",(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">>"]}),"\n",(0,r.jsx)(n.p,{children:"Setup a extensible EdgeType"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"CursorType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})," = ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"NodeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,r.jsx)(n.code,{children:"unknown"})," = ",(0,r.jsx)(n.code,{children:"unknown"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"nodeType"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.code,{children:"NodeType"}),"> | ",(0,r.jsx)(n.code,{children:"HasConstructor"}),"<",(0,r.jsx)(n.code,{children:"NodeType"}),">"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ClassType"}),"<",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",children:(0,r.jsx)(n.code,{children:"RelayEdgeType"})}),"<",(0,r.jsx)(n.code,{children:"CursorType"}),", ",(0,r.jsx)(n.code,{children:"NodeType"}),">>"]}),"\n",(0,r.jsx)(n.p,{children:"A graphql object type that represents fields that can be queried."}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Example"})})}),"\n",(0,r.jsx)(n.p,{children:"Usage:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"// create an object type\n@ObjectType()\nclass Item {\n @Field()\n id!: number;\n}\n\n// Create your extensible Edge type\n@ObjectType()\nexport class ItemEdge extends EdgeType(Item) {\n // add additional properties here\n @Field(() => Date)\n createdAt: Date\n}\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/index.ts#L188",children:"index.ts:188"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"deserializecursor",children:"deserializeCursor"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"deserializeCursor"}),"(",(0,r.jsx)(n.code,{children:"externalCursor"}),"): ",(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})]}),"\n",(0,r.jsx)(n.p,{children:"The external cursor is the value the cursor will be after it comes from the graphql client."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"externalCursor"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"The serialized cursor that most that was just received from the client."})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})}),"\n",(0,r.jsx)(n.p,{children:"The full deserialized, decoded, and parsed cursor."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/cursor.ts#L60",children:"cursor.ts:60"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serializecursor",children:"serializeCursor"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"serializeCursor"}),"(",(0,r.jsx)(n.code,{children:"internalCursor"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The serialized cursor is the value the cursor will be so it may arrive at the graphql client and be sent through a network.\nIn this case the type is an opaque base64 string."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"internalCursor"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.a,{href:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",children:(0,r.jsx)(n.code,{children:"Cursor"})})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:"The full unencoded and parsed cursor."})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"The encoded cursor ready to be sent to the client."}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/johnsonjo4531/typegraphql-relay-connections/blob/f7686e2/src/cursor.ts#L50",children:"cursor.ts:50"})})]})}function a(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>i});var r=s(7294);const l={},d=r.createContext(l);function i(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/main.43c86a0a.js b/assets/js/main.b6fc0b3d.js similarity index 99% rename from assets/js/main.43c86a0a.js rename to assets/js/main.b6fc0b3d.js index b7da9c7..d807ef3 100644 --- a/assets/js/main.43c86a0a.js +++ b/assets/js/main.b6fc0b3d.js @@ -1,2 +1,2 @@ -/*! For license information please see main.43c86a0a.js.LICENSE.txt */ -(self.webpackChunktypegraphql_relay_connections_docs=self.webpackChunktypegraphql_relay_connections_docs||[]).push([[179],{723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});n(7294);var r=n(8356),a=n.n(r),o=n(6887);const i={"0058fe2f":[()=>n.e(1466).then(n.bind(n,9433)),"@site/docs/api/classes/BackwardPaginationArgs.md",9433],"01a85c17":[()=>Promise.all([n.e(532),n.e(4013)]).then(n.bind(n,1223)),"@theme/BlogTagsListPage",1223],"02823e88":[()=>n.e(3873).then(n.t.bind(n,9839,19)),"~blog/default/typegraphql-relay-connections-blog-tags-relay-connections-c64.json",9839],"09bf5e8d":[()=>n.e(7113).then(n.bind(n,1859)),"@site/docs/api/classes/PageInfo.md",1859],"0be9cf94":[()=>n.e(1566).then(n.t.bind(n,1789,19)),"~blog/default/typegraphql-relay-connections-blog-tags-relay-e9d.json",1789],"0cb12579":[()=>n.e(9199).then(n.bind(n,3580)),"@site/docs/usage/connection-type.md",3580],"0e384e19":[()=>n.e(9671).then(n.bind(n,7876)),"@site/docs/intro.md",7876],"11eadd31":[()=>n.e(627).then(n.t.bind(n,4840,19)),"~blog/default/typegraphql-relay-connections-blog-tags-connections-bd6-list.json",4840],"1700d2bd":[()=>n.e(155).then(n.bind(n,6395)),"@site/docs/tutorials/custom-cursors.md",6395],17896441:[()=>Promise.all([n.e(532),n.e(9206),n.e(7918)]).then(n.bind(n,8945)),"@theme/DocItem",8945],"1a136ffc":[()=>n.e(6236).then(n.bind(n,3152)),"@site/docs/api/interfaces/Cursor.md",3152],"1de72b33":[()=>n.e(305).then(n.bind(n,4110)),"@site/docs/Changelog.md",4110],"1df93b7f":[()=>Promise.all([n.e(532),n.e(3237)]).then(n.bind(n,8391)),"@site/src/pages/index.tsx",8391],"1f391b9e":[()=>Promise.all([n.e(532),n.e(9206),n.e(3085)]).then(n.bind(n,4247)),"@theme/MDXPage",4247],"226d1479":[()=>n.e(7175).then(n.bind(n,4284)),"@site/docs/api/classes/ForwardPaginationArgs.md",4284],29697024:[()=>n.e(7195).then(n.t.bind(n,605,19)),"~blog/default/typegraphql-relay-connections-blog-tags-typegraphql-70a.json",605],"36308a28":[()=>n.e(4416).then(n.bind(n,1235)),"@site/docs/api/classes/FullPaginationArgs.md",1235],"393be207":[()=>n.e(7414).then(n.bind(n,1181)),"@site/src/pages/markdown-page.md",1181],"4de4073a":[()=>n.e(6077).then(n.t.bind(n,8327,19)),"~blog/default/typegraphql-relay-connections-blog-tags-relay-e9d-list.json",8327],"504206e9":[()=>n.e(628).then(n.t.bind(n,4469,19)),"/home/jigs/work/open-source/typegraphql-relay-connections/docs/.docusaurus/docusaurus-plugin-content-blog/default/plugin-route-context-module-100.json",4469],"54adf0a5":[()=>n.e(2929).then(n.t.bind(n,6363,19)),"~blog/default/typegraphql-relay-connections-blog-tags-typegraphql-relay-connections-133.json",6363],"5715148b":[()=>n.e(7099).then(n.t.bind(n,894,19)),"~blog/default/typegraphql-relay-connections-blog-tags-relay-connections-c64-list.json",894],"5a382e87":[()=>n.e(8402).then(n.t.bind(n,8792,19)),"~blog/default/typegraphql-relay-connections-blog-tags-typegraphql-relay-connections-133-list.json",8792],"5e0b7480":[()=>n.e(4005).then(n.bind(n,3635)),"@site/docs/api/classes/RelayEdgeType.md",3635],"5e8c322a":[()=>n.e(7597).then(n.bind(n,3006)),"@site/docs/api/index.md",3006],"5e95c892":[()=>n.e(9661).then(n.bind(n,1892)),"@theme/DocsRoot",1892],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,6809)),"@generated/docusaurus.config",6809],"628119b7":[()=>n.e(2808).then(n.t.bind(n,5745,19)),"/home/jigs/work/open-source/typegraphql-relay-connections/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",5745],"6875c492":[()=>Promise.all([n.e(532),n.e(9206),n.e(9677),n.e(8610)]).then(n.bind(n,1714)),"@theme/BlogTagsPostsPage",1714],"72daadc5":[()=>n.e(9180).then(n.bind(n,8600)),"@site/docs/examples/typegraphql.md",8600],"814f3328":[()=>n.e(2535).then(n.t.bind(n,5641,19)),"~blog/default/blog-post-list-prop-default.json",5641],"8db28ff5":[()=>n.e(4465).then(n.bind(n,6612)),"@site/blog/2022-03-14-docs-released.md?truncated=true",6612],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"9afdc237":[()=>n.e(6368).then(n.t.bind(n,2110,19)),"~blog/default/typegraphql-relay-connections-blog-tags-tags-427.json",2110],"9e4087bc":[()=>n.e(3608).then(n.bind(n,3169)),"@theme/BlogArchivePage",3169],a34174ca:[()=>n.e(4926).then(n.bind(n,325)),"@site/docs/api/classes/RelayConnectionType.md",325],a6aa9e1f:[()=>Promise.all([n.e(532),n.e(9206),n.e(9677),n.e(3089)]).then(n.bind(n,46)),"@theme/BlogListPage",46],a7bd4aaa:[()=>n.e(8518).then(n.bind(n,8564)),"@theme/DocVersionRoot",8564],a7db6169:[()=>n.e(8415).then(n.t.bind(n,9295,19)),"~blog/default/typegraphql-relay-connections-blog-tags-connections-bd6.json",9295],a94703ab:[()=>Promise.all([n.e(532),n.e(4368)]).then(n.bind(n,2674)),"@theme/DocRoot",2674],abe3ca9f:[()=>n.e(9071).then(n.t.bind(n,6642,19)),"~blog/default/typegraphql-relay-connections-blog-archive-62b.json",6642],b800e848:[()=>n.e(8387).then(n.bind(n,4172)),"@site/blog/2022-03-14-docs-released.md",4172],c34708ba:[()=>n.e(4955).then(n.t.bind(n,3391,19)),"~blog/default/typegraphql-relay-connections-blog-ccf.json",3391],c7ed8530:[()=>n.e(2133).then(n.t.bind(n,3209,19)),"~blog/default/typegraphql-relay-connections-blog-tags-typegraphql-70a-list.json",3209],ccc49370:[()=>Promise.all([n.e(532),n.e(9206),n.e(9677),n.e(6103)]).then(n.bind(n,5203)),"@theme/BlogPostPage",5203],db37a755:[()=>n.e(2187).then(n.bind(n,4053)),"@site/docs/usage/edge-type.md",4053],f2ad8411:[()=>n.e(2329).then(n.t.bind(n,3769,19)),"/home/jigs/work/open-source/typegraphql-relay-connections/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],f6aebfbf:[()=>n.e(7306).then(n.bind(n,1324)),"@site/docs/api/modules.md",1324]};var l=n(5893);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 c=n(9670),u=n(226);function d(e,t){if("*"===e)return a()({loading:s,loader:()=>n.e(1772).then(n.bind(n,1772)),modules:["@theme/NotFound"],webpack:()=>[1772],render(e,t){const n=e.default;return(0,l.jsx)(u.z,{value:{plugin:{name:"native",id:"default"}},children:(0,l.jsx)(n,{...t})})}});const r=o[`${e}-${t}`],d={},p=[],f=[],g=(0,c.Z)(r);return Object.entries(g).forEach((e=>{let[t,n]=e;const r=i[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;return delete a.__context,(0,l.jsx)(u.z,{value:i,children:(0,l.jsx)(o,{...a,...n})})}})}const p=[{path:"/typegraphql-relay-connections/blog",component:d("/typegraphql-relay-connections/blog","a3b"),exact:!0},{path:"/typegraphql-relay-connections/blog/archive",component:d("/typegraphql-relay-connections/blog/archive","d87"),exact:!0},{path:"/typegraphql-relay-connections/blog/first-blog-post",component:d("/typegraphql-relay-connections/blog/first-blog-post","684"),exact:!0},{path:"/typegraphql-relay-connections/blog/tags",component:d("/typegraphql-relay-connections/blog/tags","08b"),exact:!0},{path:"/typegraphql-relay-connections/blog/tags/connections",component:d("/typegraphql-relay-connections/blog/tags/connections","733"),exact:!0},{path:"/typegraphql-relay-connections/blog/tags/relay",component:d("/typegraphql-relay-connections/blog/tags/relay","96f"),exact:!0},{path:"/typegraphql-relay-connections/blog/tags/relay-connections",component:d("/typegraphql-relay-connections/blog/tags/relay-connections","6da"),exact:!0},{path:"/typegraphql-relay-connections/blog/tags/typegraphql",component:d("/typegraphql-relay-connections/blog/tags/typegraphql","e15"),exact:!0},{path:"/typegraphql-relay-connections/blog/tags/typegraphql-relay-connections",component:d("/typegraphql-relay-connections/blog/tags/typegraphql-relay-connections","0fb"),exact:!0},{path:"/typegraphql-relay-connections/markdown-page",component:d("/typegraphql-relay-connections/markdown-page","3b2"),exact:!0},{path:"/typegraphql-relay-connections/docs",component:d("/typegraphql-relay-connections/docs","3d3"),routes:[{path:"/typegraphql-relay-connections/docs",component:d("/typegraphql-relay-connections/docs","abf"),routes:[{path:"/typegraphql-relay-connections/docs",component:d("/typegraphql-relay-connections/docs","8f8"),routes:[{path:"/typegraphql-relay-connections/docs/api",component:d("/typegraphql-relay-connections/docs/api","a9f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs",component:d("/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs","5c5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs",component:d("/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs","268"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs",component:d("/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs","06f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/api/classes/PageInfo",component:d("/typegraphql-relay-connections/docs/api/classes/PageInfo","467"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType",component:d("/typegraphql-relay-connections/docs/api/classes/RelayConnectionType","7a7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType",component:d("/typegraphql-relay-connections/docs/api/classes/RelayEdgeType","b88"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/api/interfaces/Cursor",component:d("/typegraphql-relay-connections/docs/api/interfaces/Cursor","179"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/api/modules",component:d("/typegraphql-relay-connections/docs/api/modules","41a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/Changelog",component:d("/typegraphql-relay-connections/docs/Changelog","7ab"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/examples/typegraphql",component:d("/typegraphql-relay-connections/docs/examples/typegraphql","df1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/intro",component:d("/typegraphql-relay-connections/docs/intro","a10"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/tutorials/custom-cursors",component:d("/typegraphql-relay-connections/docs/tutorials/custom-cursors","2a3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/usage/connection-type",component:d("/typegraphql-relay-connections/docs/usage/connection-type","b3e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/typegraphql-relay-connections/docs/usage/edge-type",component:d("/typegraphql-relay-connections/docs/usage/edge-type","677"),exact:!0,sidebar:"tutorialSidebar"}]}]}]},{path:"/typegraphql-relay-connections/",component:d("/typegraphql-relay-connections/","47b"),exact:!0},{path:"*",component:d("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,t:()=>i});var r=n(7294),a=n(5893);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})}},7221:(e,t,n)=>{"use strict";var r=n(7294),a=n(745),o=n(3727),i=n(405),l=n(412);const s=[n(2497),n(3310),n(8320),n(2295)];var c=n(723),u=n(6550),d=n(8790),p=n(5893);function f(e){let{children:t}=e;return(0,p.jsx)(p.Fragment,{children:t})}var g=n(5742),h=n(2263),m=n(4996),y=n(6668),b=n(1944),v=n(4711),w=n(9727),k=n(3320),x=n(8780),S=n(197);function E(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,h.Z)(),r=(0,v.l)(),a=n[e].htmlLang,o=e=>e.replace("-","_");return(0,p.jsxs)(g.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,p.jsx)("meta",{property:"og:locale",content:o(a)}),Object.values(n).filter((e=>a!==e.htmlLang)).map((e=>(0,p.jsx)("meta",{property:"og:locale:alternate",content:o(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function C(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,h.Z)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,h.Z)(),{pathname:r}=(0,u.TH)();return e+(0,x.applyTrailingSlash)((0,m.Z)(r),{trailingSlash:n,baseUrl:t})}(),a=t?`${n}${t}`:r;return(0,p.jsxs)(g.Z,{children:[(0,p.jsx)("meta",{property:"og:url",content:a}),(0,p.jsx)("link",{rel:"canonical",href:a})]})}function _(){const{i18n:{currentLocale:e}}=(0,h.Z)(),{metadata:t,image:n}=(0,y.L)();return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsxs)(g.Z,{children:[(0,p.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,p.jsx)("body",{className:w.h})]}),n&&(0,p.jsx)(b.d,{image:n}),(0,p.jsx)(C,{}),(0,p.jsx)(E,{}),(0,p.jsx)(S.Z,{tag:k.HX,locale:e}),(0,p.jsx)(g.Z,{children:t.map(((e,t)=>(0,p.jsx)("meta",{...e},t)))})]})}const T=new Map;function j(e){if(T.has(e.pathname))return{...e,pathname:T.get(e.pathname)};if((0,d.f)(c.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return T.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return T.set(e.pathname,t),{...e,pathname:t}}var N=n(8934),A=n(8940),R=n(469);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,R.Z)((()=>{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,d.f)(c.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class I extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.Z.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,p.jsx)(P,{previousLocation:this.previousLocation,location:t,children:(0,p.jsx)(u.AW,{location:t,render:()=>e})})}}const D=I,F="__docusaurus-base-url-issue-banner-container",M="__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 = '${F}';\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(/{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 K=n(9670);const Y=new Set,X=new Set,J=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ee={prefetch(e){if(!(e=>!J()&&!X.has(e)&&!Y.has(e))(e))return!1;Y.add(e);const t=(0,d.f)(c.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(V).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,K.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Q(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!J()&&!X.has(e))(e)&&(X.add(e),O(e))},te=Object.freeze(ee),ne=Boolean(!0);if(l.Z.canUseDOM){window.docusaurus=te;const e=document.getElementById("__docusaurus"),t=(0,p.jsx)(i.B6,{children:(0,p.jsx)(o.VK,{children:(0,p.jsx)(W,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},l=()=>{if(ne)r.startTransition((()=>{a.hydrateRoot(e,t,{onRecoverableError:n})}));else{const o=a.createRoot(e,{onRecoverableError:n});r.startTransition((()=>{o.render(t)}))}};O(window.location.pathname).then(l)}},8940:(e,t,n)=>{"use strict";n.d(t,{_:()=>d,M:()=>p});var r=n(7294),a=n(6809);const o=JSON.parse('{"docusaurus-lunr-search":{"default":{"fileNames":{"searchDoc":"search-doc-1706112585341.json","lunrIndex":"lunr-index-1706112585341.json"}}},"docusaurus-plugin-content-docs":{"default":{"path":"/typegraphql-relay-connections/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/typegraphql-relay-connections/docs","mainDocId":"api/index","docs":[{"id":"api/classes/BackwardPaginationArgs","path":"/typegraphql-relay-connections/docs/api/classes/BackwardPaginationArgs","sidebar":"tutorialSidebar"},{"id":"api/classes/ForwardPaginationArgs","path":"/typegraphql-relay-connections/docs/api/classes/ForwardPaginationArgs","sidebar":"tutorialSidebar"},{"id":"api/classes/FullPaginationArgs","path":"/typegraphql-relay-connections/docs/api/classes/FullPaginationArgs","sidebar":"tutorialSidebar"},{"id":"api/classes/PageInfo","path":"/typegraphql-relay-connections/docs/api/classes/PageInfo","sidebar":"tutorialSidebar"},{"id":"api/classes/RelayConnectionType","path":"/typegraphql-relay-connections/docs/api/classes/RelayConnectionType","sidebar":"tutorialSidebar"},{"id":"api/classes/RelayEdgeType","path":"/typegraphql-relay-connections/docs/api/classes/RelayEdgeType","sidebar":"tutorialSidebar"},{"id":"api/index","path":"/typegraphql-relay-connections/docs/api/","sidebar":"tutorialSidebar"},{"id":"api/interfaces/Cursor","path":"/typegraphql-relay-connections/docs/api/interfaces/Cursor","sidebar":"tutorialSidebar"},{"id":"api/modules","path":"/typegraphql-relay-connections/docs/api/modules","sidebar":"tutorialSidebar"},{"id":"Changelog","path":"/typegraphql-relay-connections/docs/Changelog","sidebar":"tutorialSidebar"},{"id":"examples/typegraphql","path":"/typegraphql-relay-connections/docs/examples/typegraphql","sidebar":"tutorialSidebar"},{"id":"intro","path":"/typegraphql-relay-connections/docs/intro","sidebar":"tutorialSidebar"},{"id":"tutorials/custom-cursors","path":"/typegraphql-relay-connections/docs/tutorials/custom-cursors","sidebar":"tutorialSidebar"},{"id":"usage/connection-type","path":"/typegraphql-relay-connections/docs/usage/connection-type","sidebar":"tutorialSidebar"},{"id":"usage/edge-type","path":"/typegraphql-relay-connections/docs/usage/edge-type","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/typegraphql-relay-connections/docs/api/","label":"API"}}}}],"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(7529);const s=JSON.parse('{"docusaurusVersion":"3.1.0","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.1.0"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.1.0"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.1.0"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.1.0"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.1.0"},"docusaurus-lunr-search":{"type":"package","name":"docusaurus-lunr-search","version":"3.3.2"},"docusaurus-plugin-typedoc":{"type":"package","name":"docusaurus-plugin-typedoc","version":"0.22.0"}}}');var c=n(5893);const u={siteConfig:a.default,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},d=r.createContext(u);function p(e){let{children:t}=e;return(0,c.jsx)(d.Provider,{value:u,children:t})}},4763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7294),a=n(412),o=n(5742),i=n(8780),l=n(8517),s=n(5893);function c(e){let{error:t,tryAgain:n}=e;return(0,s.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,s.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,s.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,s.jsx)(u,{error:t})]})}function u(e){let{error:t}=e;const n=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,s.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function d(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)(f,{fallback:()=>(0,s.jsx)(c,{error:t,tryAgain:n}),children:[(0,s.jsx)(o.Z,{children:(0,s.jsx)("title",{children:"Page Error"})}),(0,s.jsx)(l.Z,{children:(0,s.jsx)(c,{error:t,tryAgain:n})})]})}const p=e=>(0,s.jsx)(d,{...e});class f extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??p)(e)}return e??null}}},412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5742:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7294);var r=n(405),a=n(5893);function o(e){return(0,a.jsx)(r.ql,{...e})}},3692:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7294),a=n(3727),o=n(8780),i=n(2263),l=n(3919),s=n(412),c=n(8138),u=n(4996),d=n(5893);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:g,isActive:h,"data-noBrokenLinkCheck":m,autoAddBaseUrl:y=!0,...b}=e;const{siteConfig:{trailingSlash:v,baseUrl:w}}=(0,i.Z)(),{withBaseUrl:k}=(0,u.C)(),x=(0,c.Z)(),S=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>S.current));const E=p||f;const C=(0,l.Z)(E),_=E?.replace("pathname://","");let T=void 0!==_?(j=_,y&&(e=>e.startsWith("/"))(j)?k(j):j):void 0;var j;T&&C&&(T=(0,o.applyTrailingSlash)(T,{trailingSlash:v,baseUrl:w}));const N=(0,r.useRef)(!1),A=n?a.OL:a.rU,R=s.Z.canUseIntersectionObserver,L=(0,r.useRef)(),P=()=>{N.current||null==T||(window.docusaurus.preload(T),N.current=!0)};(0,r.useEffect)((()=>(!R&&C&&null!=T&&window.docusaurus.prefetch(T),()=>{R&&L.current&&L.current.disconnect()})),[L,T,R,C]);const O=T?.startsWith("#")??!1,I=!T||!C||O;return I||m||x.collectLink(T),I?(0,d.jsx)("a",{ref:S,href:T,...E&&!C&&{target:"_blank",rel:"noopener noreferrer"},...b}):(0,d.jsx)(A,{...b,onMouseEnter:P,onTouchStart:P,innerRef:e=>{S.current=e,R&&e&&C&&(L.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(L.current.unobserve(e),L.current.disconnect(),null!=T&&window.docusaurus.prefetch(T))}))})),L.current.observe(e))},to:T,...n&&{isActive:h,activeClassName:g}})}const f=r.forwardRef(p)},5999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c,I:()=>s});var r=n(7294),a=n(5893);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(7529);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 c(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)})}},9935:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},3919:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},4996:(e,t,n)=>{"use strict";n.d(t,{C:()=>i,Z:()=>l});var r=n(7294),a=n(2263),o=n(3919);function i(){const{siteConfig:{baseUrl:e,url:t}}=(0,a.Z)(),n=(0,r.useCallback)(((n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:a=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,o.b)(n))return n;if(a)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const l=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+l:l}(t,e,n,r)),[t,e]);return{withBaseUrl:n}}function l(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},8138:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});var r=n(7294);n(5893);const a=r.createContext({collectAnchor:()=>{},collectLink:()=>{}}),o=()=>(0,r.useContext)(a);function i(){return o()}},2263:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8940);function o(){return(0,r.useContext)(a._)}},8084:(e,t,n)=>{"use strict";n.d(t,{OD:()=>o,eZ:()=>i});var r=n(2263),a=n(9935);function o(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,r.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}function i(e,t,n){void 0===t&&(t=a.m),void 0===n&&(n={});const r=o(e),i=r?.[t];if(!i&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return i}},2389:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8934);function o(){return(0,r.useContext)(a._)}},469:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});var r=n(7294);const a=n(412).Z.canUseDOM?r.useLayoutEffect:r.useEffect},9670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>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}},226:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,z:()=>i});var r=n(7294),a=n(5893);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})}},4104:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>f,gA:()=>u,_r:()=>s,Jo:()=>g,zh:()=>c,yW:()=>p,gB:()=>d});var r=n(6550),a=n(8084);const o=e=>e.versions.find((e=>e.isLast));function i(e,t){const n=function(e,t){const n=o(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),a=n?.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const l={},s=()=>(0,a.OD)("docusaurus-plugin-content-docs")??l,c=e=>(0,a.eZ)("docusaurus-plugin-content-docs",e,{failfast:!0});function u(e){void 0===e&&(e={});const t=s(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return o}(t,n,e)}function d(e){return c(e).versions}function p(e){const t=c(e);return o(t)}function f(e){const t=c(e),{pathname:n}=(0,r.TH)();return i(t,n)}function g(e){const t=c(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=o(e);return{latestDocSuggestion:i(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},8320:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(4865),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r=n(4798),a=n(6809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(6854),n(6726)(`./prism-${e}`)})),delete globalThis.Prism}(r.p1)},2503:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});n(7294);var r=n(6905),a=n(5999),o=n(6668),i=n(3692),l=n(8138);const s={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var c=n(5893);function u(e){let{as:t,id:n,...u}=e;const d=(0,l.Z)(),{navbar:{hideOnScroll:p}}=(0,o.L)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const f=(0,a.I)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,r.Z)("anchor",p?s.anchorWithHideOnScrollNavbar:s.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(i.Z,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},9471:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7294);const r={iconExternalLink:"iconExternalLink_nPIU"};var a=n(5893);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"})})}},8517:(e,t,n)=>{"use strict";n.d(t,{Z:()=>bt});var r=n(7294),a=n(6905),o=n(4763),i=n(1944),l=n(6550),s=n(5999),c=n(5936),u=n(5893);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.k6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,c.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const g=(0,s.I)({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??g,{containerRef:n,onClick:r}=f();return(0,u.jsx)("div",{ref:n,role:"region","aria-label":g,children:(0,u.jsx)("a",{...e,href:`#${d}`,onClick:r,children:t})})}var m=n(5281),y=n(9727);const b={skipToContent:"skipToContent_fXgn"};function v(){return(0,u.jsx)(h,{className:b.skipToContent})}var w=n(6668),k=n(9689);function x(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:a=1.2,className:o,...i}=e;return(0,u.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,u.jsx)("g",{stroke:r,strokeWidth:a,children:(0,u.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const S={closeButton:"closeButton_CVFx"};function E(e){return(0,u.jsx)("button",{type:"button","aria-label":(0,s.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,a.Z)("clean-btn close",S.closeButton,e.className),children:(0,u.jsx)(x,{width:14,height:14,strokeWidth:3.1})})}const C={content:"content_knG7"};function _(e){const{announcementBar:t}=(0,w.L)(),{content:n}=t;return(0,u.jsx)("div",{...e,className:(0,a.Z)(C.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const T={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function j(){const{announcementBar:e}=(0,w.L)(),{isActive:t,close:n}=(0,k.nT)();if(!t)return null;const{backgroundColor:r,textColor:a,isCloseable:o}=e;return(0,u.jsxs)("div",{className:T.announcementBar,style:{backgroundColor:r,color:a},role:"banner",children:[o&&(0,u.jsx)("div",{className:T.announcementBarPlaceholder}),(0,u.jsx)(_,{className:T.announcementBarContent}),o&&(0,u.jsx)(E,{onClick:n,className:T.announcementBarClose})]})}var N=n(2961),A=n(2466);var R=n(902),L=n(3102);const P=r.createContext(null);function O(e){let{children:t}=e;const n=function(){const e=(0,N.e)(),t=(0,L.HY)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,R.D9)(o);return(0,r.useEffect)((()=>{o&&!i&&a(!0)}),[o,i]),(0,r.useEffect)((()=>{o?e.shown||a(!0):a(!1)}),[e.shown,o]),(0,r.useMemo)((()=>[n,a]),[n])}();return(0,u.jsx)(P.Provider,{value:n,children:t})}function I(e){if(e.component){const t=e.component;return(0,u.jsx)(t,{...e.props})}}function D(){const e=(0,r.useContext)(P);if(!e)throw new R.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,L.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:I(o)})),[a,o,t])}function F(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:o}=D();return(0,u.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,u.jsxs)("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":o}),children:[(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var M=n(2949),z=n(2389);function B(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.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 q(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.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 $={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function U(e){let{className:t,buttonClassName:n,value:r,onChange:o}=e;const i=(0,z.Z)(),l=(0,s.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===r?(0,s.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,s.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,u.jsx)("div",{className:(0,a.Z)($.toggle,t),children:(0,u.jsxs)("button",{className:(0,a.Z)("clean-btn",$.toggleButton,!i&&$.toggleButtonDisabled,n),type:"button",onClick:()=>o("dark"===r?"light":"dark"),disabled:!i,title:l,"aria-label":l,"aria-live":"polite",children:[(0,u.jsx)(B,{className:(0,a.Z)($.toggleIcon,$.lightToggleIcon)}),(0,u.jsx)(q,{className:(0,a.Z)($.toggleIcon,$.darkToggleIcon)})]})})}const H=r.memo(U),Z={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function G(e){let{className:t}=e;const n=(0,w.L)().navbar.style,r=(0,w.L)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,M.I)();return r?null:(0,u.jsx)(H,{className:t,buttonClassName:"dark"===n?Z.darkNavbarColorModeToggle:void 0,value:a,onChange:o})}var W=n(1327);function V(){return(0,u.jsx)(W.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){const e=(0,N.e)();return(0,u.jsx)("button",{type:"button","aria-label":(0,s.I)({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,u.jsx)(x,{color:"var(--ifm-color-emphasis-600)"})})}function K(){return(0,u.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,u.jsx)(V,{}),(0,u.jsx)(G,{className:"margin-right--md"}),(0,u.jsx)(Q,{})]})}var Y=n(3692),X=n(4996),J=n(3919);function ee(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var te=n(9471);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:a,label:o,html:i,isDropdownLink:l,prependBaseUrlToHref:s,...c}=e;const d=(0,X.Z)(r),p=(0,X.Z)(t),f=(0,X.Z)(a,{forcePrependBaseUrl:!0}),g=o&&a&&!(0,J.Z)(a),h=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,u.jsxs)(u.Fragment,{children:[o,g&&(0,u.jsx)(te.Z,{...l&&{width:12,height:12}})]})};return a?(0,u.jsx)(Y.Z,{href:s?f:a,...c,...h}):(0,u.jsx)(Y.Z,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?ee(n,t.pathname):t.pathname.startsWith(p)},...c,...h})}function re(e){let{className:t,isDropdownItem:n=!1,...r}=e;const o=(0,u.jsx)(ne,{className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,u.jsx)("li",{children:o}):o}function ae(e){let{className:t,isDropdownItem:n,...r}=e;return(0,u.jsx)("li",{className:"menu__list-item",children:(0,u.jsx)(ne,{className:(0,a.Z)("menu__link",t),...r})})}function oe(e){let{mobile:t=!1,position:n,...r}=e;const a=t?ae:re;return(0,u.jsx)(a,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var ie=n(6043),le=n(8596),se=n(2263);const ce={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_S0Fm"};function ue(e,t){return e.some((e=>function(e,t){return!!(0,le.Mg)(e.to,t)||!!ee(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),[c,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,u.jsxs)("div",{ref:s,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":c}),children:[(0,u.jsx)(ne,{"aria-haspopup":"true","aria-expanded":c,role:"button",href:l.to?void 0:"#",className:(0,a.Z)("navbar__link",o),...l,onClick:l.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!c))},children:l.children??l.label}),(0,u.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(Ae,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:o,onClick:i,...s}=e;const c=function(){const{siteConfig:{baseUrl:e}}=(0,se.Z)(),{pathname:t}=(0,l.TH)();return t.replace(e,"/")}(),d=ue(t,c),{collapsed:p,toggleCollapsed:f,setCollapsed:g}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&g(!d)}),[c,d,g]),(0,u.jsxs)("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,u.jsx)(ne,{role:"button",className:(0,a.Z)(ce.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...s,onClick:e=>{e.preventDefault(),f()},children:s.children??s.label}),(0,u.jsx)(ie.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,r.createElement)(Ae,{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,u.jsx)(r,{...n})}var ge=n(4711);function he(e){let{width:t=20,height:n=20,...r}=e;return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,u.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 me="iconLanguage_nlXk";var ye=n(6010),be=n(8084),ve=n(813),we=n.n(ve);function ke(){const e=(0,l.TH)(),t=(0,l.k6)(),{siteConfig:{baseUrl:n}}=(0,se.Z)(),[a,o]=(0,r.useState)({wordToHighlight:"",isTitleSuggestion:!1,titleText:""});return(0,r.useEffect)((()=>{if(!e.state?.highlightState||0===e.state.highlightState.wordToHighlight.length)return;o(e.state.highlightState);const{highlightState:n,...r}=e.state;t.replace({...e,state:r})}),[e.state?.highlightState,t,e]),(0,r.useEffect)((()=>{if(0===a.wordToHighlight.length)return;const e=document.getElementsByTagName("article")[0]??document.getElementsByTagName("main")[0];if(!e)return;const t=new(we())(e),n={ignoreJoiners:!0};return t.mark(a.wordToHighlight,n),()=>t.unmark(n)}),[a,n]),null}const xe=e=>{const t=(0,r.useRef)(!1),a=(0,r.useRef)(null),[o,i]=(0,r.useState)(!1),s=(0,l.k6)(),{siteConfig:c={}}=(0,se.Z)(),d=(c.plugins||[]).find((e=>Array.isArray(e)&&"string"==typeof e[0]&&e[0].includes("docusaurus-lunr-search"))),p=(0,z.Z)(),{baseUrl:f}=c,g=d&&d[1]?.assetUrl||f,h=(0,be.eZ)("docusaurus-lunr-search"),m=()=>{t.current||(Promise.all([fetch(`${g}${h.fileNames.searchDoc}`).then((e=>e.json())),fetch(`${g}${h.fileNames.lunrIndex}`).then((e=>e.json())),Promise.all([n.e(4611),n.e(5684)]).then(n.bind(n,4734)),Promise.all([n.e(532),n.e(2572)]).then(n.bind(n,2572))]).then((e=>{let[t,n,{default:r}]=e;const{searchDocs:a,options:o}=t;a&&0!==a.length&&(((e,t,n,r)=>{new n({searchDocs:e,searchIndex:t,baseUrl:f,inputSelector:"#search_input_react",handleSelected:(e,t,n)=>{const a=n.url||"/";document.createElement("a").href=a,e.setVal(""),t.target.blur();let o="";if(r.highlightResult)try{const e=(n.text||n.subcategory||n.title).match(new RegExp("\\w*","g"));if(e&&e.length>0){const t=document.createElement("div");t.innerHTML=e[0],o=t.textContent}}catch(i){console.log(i)}s.push(a,{highlightState:{wordToHighlight:o}})},maxHits:r.maxHits})})(a,n,r,o),i(!0))})),t.current=!0)},y=(0,r.useCallback)((t=>{a.current.contains(t.target)||a.current.focus(),e.handleSearchBarToggle&&e.handleSearchBarToggle(!e.isSearchBarExpanded)}),[e.isSearchBarExpanded]);let b;return p&&(m(),b=window.navigator.platform.startsWith("Mac")?"Search \u2318+K":"Search Ctrl+K"),(0,u.jsxs)("div",{className:"navbar__search",children:[(0,u.jsx)("span",{"aria-label":"expand searchbar",role:"button",className:(0,ye.Z)("search-icon",{"search-icon-hidden":e.isSearchBarExpanded}),onClick:y,onKeyDown:y,tabIndex:0}),(0,u.jsx)("input",{id:"search_input_react",type:"search",placeholder:o?b:"Loading...","aria-label":"Search",className:(0,ye.Z)("navbar__search-input",{"search-bar-expanded":e.isSearchBarExpanded},{"search-bar":!e.isSearchBarExpanded}),onClick:m,onMouseOver:m,onFocus:y,onBlur:y,ref:a,disabled:!o}),(0,u.jsx)(ke,{})]},"search-box")},Se={navbarSearchContainer:"navbarSearchContainer_Bca1"};function Ee(e){let{children:t,className:n}=e;return(0,u.jsx)("div",{className:(0,a.Z)(n,Se.navbarSearchContainer),children:t})}var Ce=n(4104),_e=n(2802);var Te=n(373);const je=e=>e.docs.find((t=>t.id===e.mainDocId));const Ne={default:oe,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:a="",...o}=e;const{i18n:{currentLocale:i,locales:c,localeConfigs:d}}=(0,se.Z)(),p=(0,ge.l)(),{search:f,hash:g}=(0,l.TH)(),h=[...n,...c.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${g}${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],m=t?(0,s.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return(0,u.jsx)(fe,{...o,mobile:t,label:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(he,{className:me}),m]}),items:h})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,u.jsx)(Ee,{className:n,children:(0,u.jsx)(xe,{})})},dropdown:fe,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:o=!1}=e;const i=o?"li":"div";return(0,u.jsx)(i,{className:(0,a.Z)({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,Ce.Iw)(r),i=(0,_e.vY)(t,r),l=o?.path===i?.path;return null===i||i.unlisted&&!l?null:(0,u.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,Ce.Iw)(r),i=(0,_e.oz)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,u.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.lO)(r)[0],i=t??o.label,l=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(o).path;return(0,u.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:c,hash:d}=(0,l.TH)(),p=(0,Ce.Iw)(n),f=(0,Ce.gB)(n),{savePreferredVersionName:g}=(0,Te.J)(n),h=[...a,...f.map((e=>{const t=p.alternateDocVersions[e.name]??je(e);return{label:e.label,to:`${t.path}${c}${d}`,isActive:()=>e===p.activeVersion,onClick:()=>g(e.name)}})),...o],m=(0,_e.lO)(n)[0],y=t&&h.length>1?(0,s.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):m.label,b=t&&h.length>1?void 0:je(m).path;return h.length<=1?(0,u.jsx)(oe,{...i,mobile:t,label:y,to:b,isActive:r?()=>!1:void 0}):(0,u.jsx)(fe,{...i,mobile:t,label:y,to:b,items:h,isActive:r?()=>!1:void 0})}};function Ae(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),a=Ne[r];if(!a)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,u.jsx)(a,{...n})}function Re(){const e=(0,N.e)(),t=(0,w.L)().navbar.items;return(0,u.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(Ae,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function Le(e){return(0,u.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,u.jsx)(s.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Pe(){const e=0===(0,w.L)().navbar.items.length,t=D();return(0,u.jsxs)(u.Fragment,{children:[!e&&(0,u.jsx)(Le,{onClick:()=>t.hide()}),t.content]})}function Oe(){const e=(0,N.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,u.jsx)(F,{header:(0,u.jsx)(K,{}),primaryMenu:(0,u.jsx)(Re,{}),secondaryMenu:(0,u.jsx)(Pe,{})}):null}const Ie={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function De(e){return(0,u.jsx)("div",{role:"presentation",...e,className:(0,a.Z)("navbar-sidebar__backdrop",e.className)})}function Fe(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,w.L)(),i=(0,N.e)(),{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,A.RF)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=l?n(!1):i+c{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,u.jsxs)("nav",{ref:l,"aria-label":(0,s.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,a.Z)("navbar","navbar--fixed-top",n&&[Ie.navbarHideable,!d&&Ie.navbarHidden],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown}),children:[t,(0,u.jsx)(De,{onClick:i.toggle}),(0,u.jsx)(Oe,{})]})}var Me=n(8780);const ze={errorBoundaryError:"errorBoundaryError_a6uf",errorBoundaryFallback:"errorBoundaryFallback_VBag"};function Be(e){return(0,u.jsx)("button",{type:"button",...e,children:(0,u.jsx)(s.Z,{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 qe(e){let{error:t}=e;const n=(0,Me.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,u.jsx)("p",{className:ze.errorBoundaryError,children:n})}class $e extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const Ue="right";function He(e){let{width:t=30,height:n=30,className:r,...a}=e;return(0,u.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...a,children:(0,u.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function Ze(){const{toggle:e,shown:t}=(0,N.e)();return(0,u.jsx)("button",{onClick:e,"aria-label":(0,s.I)({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,u.jsx)(He,{})})}const Ge={colorModeToggle:"colorModeToggle_DEke"};function We(e){let{items:t}=e;return(0,u.jsx)(u.Fragment,{children:t.map(((e,t)=>(0,u.jsx)($e,{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,u.jsx)(Ae,{...e})},t)))})}function Ve(e){let{left:t,right:n}=e;return(0,u.jsxs)("div",{className:"navbar__inner",children:[(0,u.jsx)("div",{className:"navbar__items",children:t}),(0,u.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function Qe(){const e=(0,N.e)(),t=(0,w.L)().navbar.items,[n,r]=function(e){function t(e){return"left"===(e.position??Ue)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),a=t.find((e=>"search"===e.type));return(0,u.jsx)(Ve,{left:(0,u.jsxs)(u.Fragment,{children:[!e.disabled&&(0,u.jsx)(Ze,{}),(0,u.jsx)(V,{}),(0,u.jsx)(We,{items:n})]}),right:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(We,{items:r}),(0,u.jsx)(G,{className:Ge.colorModeToggle}),!a&&(0,u.jsx)(Ee,{children:(0,u.jsx)(xe,{})})]})})}function Ke(){return(0,u.jsx)(Fe,{children:(0,u.jsx)(Qe,{})})}function Ye(e){let{item:t}=e;const{to:n,href:r,label:a,prependBaseUrlToHref:o,...i}=t,l=(0,X.Z)(n),s=(0,X.Z)(r,{forcePrependBaseUrl:!0});return(0,u.jsxs)(Y.Z,{className:"footer__link-item",...r?{href:o?s:r}:{to:l},...i,children:[a,r&&!(0,J.Z)(r)&&(0,u.jsx)(te.Z,{})]})}function Xe(e){let{item:t}=e;return t.html?(0,u.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)("li",{className:"footer__item",children:(0,u.jsx)(Ye,{item:t})},t.href??t.to)}function Je(e){let{column:t}=e;return(0,u.jsxs)("div",{className:"col footer__col",children:[(0,u.jsx)("div",{className:"footer__title",children:t.title}),(0,u.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,u.jsx)(Xe,{item:e},t)))})]})}function et(e){let{columns:t}=e;return(0,u.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,u.jsx)(Je,{column:e},t)))})}function tt(){return(0,u.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function nt(e){let{item:t}=e;return t.html?(0,u.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)(Ye,{item:t})}function rt(e){let{links:t}=e;return(0,u.jsx)("div",{className:"footer__links text--center",children:(0,u.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,u.jsxs)(r.Fragment,{children:[(0,u.jsx)(nt,{item:e}),t.length!==n+1&&(0,u.jsx)(tt,{})]},n)))})})}function at(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,u.jsx)(et,{columns:t}):(0,u.jsx)(rt,{links:t})}var ot=n(9965);const it={footerLogoLink:"footerLogoLink_BH7S"};function lt(e){let{logo:t}=e;const{withBaseUrl:n}=(0,X.C)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,u.jsx)(ot.Z,{className:(0,a.Z)("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,u.jsx)(Y.Z,{href:t.href,className:it.footerLogoLink,target:t.target,children:(0,u.jsx)(lt,{logo:t})}):(0,u.jsx)(lt,{logo:t})}function ct(e){let{copyright:t}=e;return(0,u.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function ut(e){let{style:t,links:n,logo:r,copyright:o}=e;return(0,u.jsx)("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t}),children:(0,u.jsxs)("div",{className:"container container-fluid",children:[n,(r||o)&&(0,u.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,u.jsx)("div",{className:"margin-bottom--sm",children:r}),o]})]})})}function dt(){const{footer:e}=(0,w.L)();if(!e)return null;const{copyright:t,links:n,logo:r,style:a}=e;return(0,u.jsx)(ut,{style:a,links:n&&n.length>0&&(0,u.jsx)(at,{links:n}),logo:r&&(0,u.jsx)(st,{logo:r}),copyright:t&&(0,u.jsx)(ct,{copyright:t})})}const pt=r.memo(dt),ft=(0,R.Qc)([M.S,k.pl,A.OC,Te.L5,i.VC,function(e){let{children:t}=e;return(0,u.jsx)(L.n2,{children:(0,u.jsx)(N.M,{children:(0,u.jsx)(O,{children:t})})})}]);function gt(e){let{children:t}=e;return(0,u.jsx)(ft,{children:t})}var ht=n(2503);function mt(e){let{error:t,tryAgain:n}=e;return(0,u.jsx)("main",{className:"container margin-vert--xl",children:(0,u.jsx)("div",{className:"row",children:(0,u.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,u.jsx)(ht.Z,{as:"h1",className:"hero__title",children:(0,u.jsx)(s.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,u.jsx)("div",{className:"margin-vert--lg",children:(0,u.jsx)(Be,{onClick:n,className:"button button--primary shadow--lw"})}),(0,u.jsx)("hr",{}),(0,u.jsx)("div",{className:"margin-vert--md",children:(0,u.jsx)(qe,{error:t})})]})})})}const yt={mainWrapper:"mainWrapper_z2l0"};function bt(e){const{children:t,noFooter:n,wrapperClassName:r,title:l,description:s}=e;return(0,y.t)(),(0,u.jsxs)(gt,{children:[(0,u.jsx)(i.d,{title:l,description:s}),(0,u.jsx)(v,{}),(0,u.jsx)(j,{}),(0,u.jsx)(Ke,{}),(0,u.jsx)("div",{id:d,className:(0,a.Z)(m.k.wrapper.main,yt.mainWrapper,r),children:(0,u.jsx)(o.Z,{fallback:e=>(0,u.jsx)(mt,{...e}),children:t})}),!n&&(0,u.jsx)(pt,{})]})}},1327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});n(7294);var r=n(3692),a=n(4996),o=n(2263),i=n(6668),l=n(9965),s=n(5893);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,a.Z)(t.src),dark:(0,a.Z)(t.srcDark||t.src)},i=(0,s.jsx)(l.Z,{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 u(e){const{siteConfig:{title:t}}=(0,o.Z)(),{navbar:{title:n,logo:l}}=(0,i.L)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,a.Z)(l?.href||"/"),g=n?"":t,h=l?.alt??g;return(0,s.jsxs)(r.Z,{to:f,...p,...l?.target&&{target:l.target},children:[l&&(0,s.jsx)(c,{logo:l,alt:h,imageClassName:u}),null!=n&&(0,s.jsx)("b",{className:d,children:n})]})}},197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7294);var r=n(5742),a=n(5893);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return(0,a.jsxs)(r.Z,{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})]})}},9965:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});var r=n(7294),a=n(788),o=n(2389),i=n(2949);const l={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var s=n(5893);function c(e){let{className:t,children:n}=e;const c=(0,o.Z)(),{colorMode:u}=(0,i.I)();return(0,s.jsx)(s.Fragment,{children:(c?"dark"===u?["dark"]:["light"]:["light","dark"]).map((e=>{const o=n({theme:e,className:(0,a.Z)(t,l.themedComponent,l[`themedComponent--${e}`])});return(0,s.jsx)(r.Fragment,{children:o},e)}))})}function u(e){const{sources:t,className:n,alt:r,...a}=e;return(0,s.jsx)(c,{className:n,children:e=>{let{theme:n,className:o}=e;return(0,s.jsx)("img",{src:t[n],alt:r,className:o,...a})}})}},6043:(e,t,n)=>{"use strict";n.d(t,{u:()=>c,z:()=>y});var r=n(7294),a=n(412),o=n(469),i=n(1442),l=n(5893);const s="ease-in-out";function c(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 u={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?u: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.n)())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=u.height,e.style.overflow=u.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{l()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,a])}function g(e){if(!a.Z.canUseDOM)return e?u:d}function h(e){let{as:t="div",collapsed:n,children:a,animation:o,onCollapseTransitionEnd:i,className:s,disableSSRStyle:c}=e;const u=(0,r.useRef)(null);return f({collapsibleRef:u,collapsed:n,animation:o}),(0,l.jsx)(t,{ref:u,style:c?void 0:g(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(u.current,n),i?.(n))},className:s,children:a})}function m(e){let{collapsed:t,...n}=e;const[a,i]=(0,r.useState)(!t),[s,c]=(0,r.useState)(t);return(0,o.Z)((()=>{t||i(!0)}),[t]),(0,o.Z)((()=>{a&&c(t)}),[a,t]),a?(0,l.jsx)(h,{...n,collapsed:s}):null}function y(e){let{lazy:t,...n}=e;const r=t?m:h;return(0,l.jsx)(r,{...n})}},9689:(e,t,n)=>{"use strict";n.d(t,{nT:()=>h,pl:()=>g});var r=n(7294),a=n(2389),o=n(12),i=n(902),l=n(6668),s=n(5893);const c=(0,o.WA)("docusaurus.announcement.dismiss"),u=(0,o.WA)("docusaurus.announcement.id"),d=()=>"true"===c.get(),p=e=>c.set(String(e)),f=r.createContext(null);function g(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.L)(),t=(0,a.Z)(),[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=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.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.i6("AnnouncementBarProvider");return e}},2949:(e,t,n)=>{"use strict";n.d(t,{I:()=>y,S:()=>m});var r=n(7294),a=n(412),o=n(902),i=n(12),l=n(6668),s=n(5893);const c=r.createContext(void 0),u="theme",d=(0,i.WA)(u),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,g=e=>a.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),h=e=>{d.set(f(e))};function m(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.L)(),[a,o]=(0,r.useState)(g(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!==u)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)(c.Provider,{value:n,children:t})}function y(){const e=(0,r.useContext)(c);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},373:(e,t,n)=>{"use strict";n.d(t,{J:()=>v,L5:()=>y});var r=n(7294),a=n(4104),o=n(9935),i=n(6668),l=n(2802),s=n(902),c=n(12),u=n(5893);const d=e=>`docs-preferred-version-${e}`,p={save:(e,t,n)=>{(0,c.WA)(d(e),{persistence:t}).set(n)},read:(e,t)=>(0,c.WA)(d(e),{persistence:t}).get(),clear:(e,t)=>{(0,c.WA)(d(e),{persistence:t}).del()}},f=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const g=r.createContext(null);function h(){const e=(0,a._r)(),t=(0,i.L)().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 m(e){let{children:t}=e;const n=h();return(0,u.jsx)(g.Provider,{value:n,children:t})}function y(e){let{children:t}=e;return l.cE?(0,u.jsx)(m,{children:t}):(0,u.jsx)(u.Fragment,{children:t})}function b(){const e=(0,r.useContext)(g);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=o.m);const t=(0,a.zh)(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])}}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>c,b:()=>s});var r=n(7294),a=n(902),o=n(5893);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 c(){const e=(0,r.useContext)(l);if(e===i)throw new a.i6("DocsSidebarProvider");return e}},4477:(e,t,n)=>{"use strict";n.d(t,{E:()=>s,q:()=>l});var r=n(7294),a=n(902),o=n(5893);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.i6("DocsVersionProvider");return e}},2961:(e,t,n)=>{"use strict";n.d(t,{M:()=>f,e:()=>g});var r=n(7294),a=n(3102),o=n(7524),i=n(6550),l=n(902);function s(e){!function(e){const t=(0,i.k6)(),n=(0,l.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}var c=n(6668),u=n(5893);const d=r.createContext(void 0);function p(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,c.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[i,l]=(0,r.useState)(!1);s((()=>{if(i)return l(!1),!1}));const u=(0,r.useCallback)((()=>{l((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&l(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:i})),[e,n,u,i])}function f(e){let{children:t}=e;const n=p();return(0,u.jsx)(d.Provider,{value:n,children:t})}function g(){const e=r.useContext(d);if(void 0===e)throw new l.i6("NavbarMobileSidebarProvider");return e}},3102:(e,t,n)=>{"use strict";n.d(t,{HY:()=>s,Zo:()=>c,n2:()=>l});var r=n(7294),a=n(902),o=n(5893);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.i6("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const o=(0,r.useContext)(i);if(!o)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,l]=o,s=(0,a.Ql)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},9727:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(7294);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7524:(e,t,n)=>{"use strict";n.d(t,{i:()=>l});var r=n(7294),a=n(412);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.Z.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}},5281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",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:{}}},1442:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{n:()=>r})},2802:(e,t,n)=>{"use strict";n.d(t,{LM:()=>f,_F:()=>m,cE:()=>p,SN:()=>E,lO:()=>k,vY:()=>S,oz:()=>x,s1:()=>w,f:()=>b});var r=n(7294),a=n(6550),o=n(8790),i=n(4104),l=n(373),s=n(4477),c=n(1116);function u(e){return Array.from(new Set(e))}var d=n(8596);const p=!!i._r;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 g=(e,t)=>void 0!==e&&(0,d.Mg)(e,t),h=(e,t)=>e.some((e=>m(e,t)));function m(e,t){return"link"===e.type?g(e.href,t):"category"===e.type&&(g(e.href,t)||h(e.items,t))}function y(e,t){switch(e.type){case"category":return m(e,t)||e.items.some((e=>y(e,t)));case"link":return!e.unlisted||m(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.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,d.Mg)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function w(){const e=(0,c.V)(),{pathname:t}=(0,a.TH)(),n=(0,i.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?v({sidebarItems:e.items,pathname:t}):null}function k(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,l.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>u([t,n,a].filter(Boolean))),[t,n,a])}function 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- ${u(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function E(e){let{route:t}=e;const n=(0,a.TH)(),r=(0,s.E)(),i=t.routes,l=i.find((e=>(0,a.LX)(n.pathname,e)));if(!l)return null;const c=l.sidebar,u=c?r.docsSidebars[c]:void 0;return{docElement:(0,o.H)(i),sidebarName:c,sidebarItems:u}}},1944:(e,t,n)=>{"use strict";n.d(t,{FG:()=>f,d:()=>d,VC:()=>g});var r=n(7294),a=n(788),o=n(5742),i=n(226);function l(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(4996),c=n(2263);var u=n(5893);function d(e){let{title:t,description:n,keywords:r,image:a,children:i}=e;const l=function(e){const{siteConfig:t}=(0,c.Z)(),{title:n,titleDelimiter:r}=t;return e?.trim().length?`${e.trim()} ${r} ${n}`:n}(t),{withBaseUrl:d}=(0,s.C)(),p=a?d(a,{absolute:!0}):void 0;return(0,u.jsxs)(o.Z,{children:[t&&(0,u.jsx)("title",{children:l}),t&&(0,u.jsx)("meta",{property:"og:title",content:l}),n&&(0,u.jsx)("meta",{name:"description",content:n}),n&&(0,u.jsx)("meta",{property:"og:description",content:n}),r&&(0,u.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),p&&(0,u.jsx)("meta",{property:"og:image",content:p}),p&&(0,u.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.Z)(i,t);return(0,u.jsxs)(p.Provider,{value:l,children:[(0,u.jsx)(o.Z,{children:(0,u.jsx)("html",{className:l})}),n]})}function g(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,u.jsx)(f,{className:(0,a.Z)(r,o),children:t})}},902:(e,t,n)=>{"use strict";n.d(t,{D9:()=>l,Qc:()=>u,Ql:()=>c,i6:()=>s,zX:()=>i});var r=n(7294),a=n(469),o=n(5893);function i(e){const t=(0,r.useRef)(e);return(0,a.Z)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function l(e){const t=(0,r.useRef)();return(0,a.Z)((()=>{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 c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return(0,o.jsx)(o.Fragment,{children:e.reduceRight(((e,t)=>(0,o.jsx)(t,{children:e})),n)})}}},8596:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>l});var r=n(7294),a=n(723),o=n(2263);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function l(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>e.routes??[])))}(n)}({routes:a.Z,baseUrl:e})),[e])}},2466:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>f,OC:()=>c,RF:()=>p});var r=n(7294),a=n(412),o=n(2389),i=(n(469),n(902)),l=n(5893);const s=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,l.jsx)(s.Provider,{value:n,children:t})}function u(){const e=(0,r.useContext)(s);if(null==e)throw new i.i6("ScrollControllerProvider");return e}const d=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function p(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=u(),a=(0,r.useRef)(d()),o=(0,i.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=d();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function f(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&at&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},3320:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(2263);const r="default";function a(e,t){return`docs-${e}-${t}`}},12:(e,t,n)=>{"use strict";n.d(t,{WA:()=>s});n(7294);const r="localStorage";function a(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 o(e){if(void 0===e&&(e=r),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,i||(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),i=!0),null}var t}let i=!1;const l={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function s(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const n=o(t?.persistence);return null===n?l:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const r=n.getItem(e);n.setItem(e,t),a({key:e,oldValue:r,newValue:t,storage:n})}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),a({key:e,oldValue:t,newValue:null,storage:n})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const r=r=>{r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),()=>window.removeEventListener("storage",r)}catch(r){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,r),()=>{}}}}}},4711:(e,t,n)=>{"use strict";n.d(t,{l:()=>i});var r=n(2263),a=n(6550),o=n(8780);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:l}}=(0,r.Z)(),{pathname:s}=(0,a.TH)(),c=(0,o.applyTrailingSlash)(s,{trailingSlash:n,baseUrl:e}),u=l===i?e:e.replace(`/${l}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${u}`:`${u}${e}/`}(n)}${d}`}}}},5936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(7294),a=n(6550),o=n(902);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6668:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(2263);function a(){return(0,r.Z)().siteConfig.themeConfig}},8802:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},4143:(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]}},8780:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var a=n(8802);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}});var o=n(4143);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return o.getErrorCausalChain}})},6010:(e,t,n)=>{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,n=0,a="";n{"use strict";n.d(t,{lX:()=>w,q_:()=>_,ob:()=>f,PP:()=>j,Ep:()=>p});var r=n(7462);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;p--){var f=i[p];"."===f?o(i,p):".."===f?(o(i,p),d++):d&&(o(i,p),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&a(i[0])||i.unshift("");var g=i.join("/");return n&&"/"!==g.substr(-1)&&(g+="/"),g};var l=n(8776);function s(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(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.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function g(){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);u.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(9864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||a}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,g=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(g){var a=f(n);a&&a!==g&&e(t,a,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var l=s(t),h=s(n),m=0;m{"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 c=[n,r,a,o,i,l],u=0;(s=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},813:function(e){e.exports=function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n1&&void 0!==arguments[1])||arguments[1],a=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;t(this,e),this.ctx=n,this.iframes=r,this.exclude=a,this.iframesTimeout=o}return n(e,[{key:"getContexts",value:function(){var e=[];return(void 0!==this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(document.querySelectorAll(this.ctx)):[this.ctx]:[]).forEach((function(t){var n=e.filter((function(e){return e.contains(t)})).length>0;-1!==e.indexOf(t)||n||e.push(t)})),e}},{key:"getIframeContents",value:function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},r=void 0;try{var a=e.contentWindow;if(r=a.document,!a||!r)throw new Error("iframe inaccessible")}catch(o){n()}r&&t(r)}},{key:"isIframeBlank",value:function(e){var t="about:blank",n=e.getAttribute("src").trim();return e.contentWindow.location.href===t&&n!==t&&n}},{key:"observeIframeLoad",value:function(e,t,n){var r=this,a=!1,o=null,i=function i(){if(!a){a=!0,clearTimeout(o);try{r.isIframeBlank(e)||(e.removeEventListener("load",i),r.getIframeContents(e,t,n))}catch(l){n()}}};e.addEventListener("load",i),o=setTimeout(i,this.iframesTimeout)}},{key:"onIframeReady",value:function(e,t,n){try{"complete"===e.contentWindow.document.readyState?this.isIframeBlank(e)?this.observeIframeLoad(e,t,n):this.getIframeContents(e,t,n):this.observeIframeLoad(e,t,n)}catch(r){n()}}},{key:"waitForIframes",value:function(e,t){var n=this,r=0;this.forEachIframe(e,(function(){return!0}),(function(e){r++,n.waitForIframes(e.querySelector("html"),(function(){--r||t()}))}),(function(e){e||t()}))}},{key:"forEachIframe",value:function(t,n,r){var a=this,o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},i=t.querySelectorAll("iframe"),l=i.length,s=0;i=Array.prototype.slice.call(i);var c=function(){--l<=0&&o(s)};l||c(),i.forEach((function(t){e.matches(t,a.exclude)?c():a.onIframeReady(t,(function(e){n(t)&&(s++,r(e)),c()}),c)}))}},{key:"createIterator",value:function(e,t,n){return document.createNodeIterator(e,t,n,!1)}},{key:"createInstanceOnIframe",value:function(t){return new e(t.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(e,t,n){if(e.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_PRECEDING){if(null===t)return!0;if(t.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_FOLLOWING)return!0}return!1}},{key:"getIteratorNode",value:function(e){var t=e.previousNode();return{prevNode:t,node:(null===t||e.nextNode())&&e.nextNode()}}},{key:"checkIframeFilter",value:function(e,t,n,r){var a=!1,o=!1;return r.forEach((function(e,t){e.val===n&&(a=t,o=e.handled)})),this.compareNodeIframe(e,t,n)?(!1!==a||o?!1===a||o||(r[a].handled=!0):r.push({val:n,handled:!0}),!0):(!1===a&&r.push({val:n,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(e,t,n,r){var a=this;e.forEach((function(e){e.handled||a.getIframeContents(e.val,(function(e){a.createInstanceOnIframe(e).forEachNode(t,n,r)}))}))}},{key:"iterateThroughNodes",value:function(e,t,n,r,a){for(var o=this,i=this.createIterator(t,e,r),l=[],s=[],c=void 0,u=void 0,d=function(){var e=o.getIteratorNode(i);return u=e.prevNode,c=e.node};d();)this.iframes&&this.forEachIframe(t,(function(e){return o.checkIframeFilter(c,u,e,l)}),(function(t){o.createInstanceOnIframe(t).forEachNode(e,(function(e){return s.push(e)}),r)})),s.push(c);s.forEach((function(e){n(e)})),this.iframes&&this.handleOpenIframes(l,e,n,r),a()}},{key:"forEachNode",value:function(e,t,n){var r=this,a=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},o=this.getContexts(),i=o.length;i||a(),o.forEach((function(o){var l=function(){r.iterateThroughNodes(e,o,t,n,(function(){--i<=0&&a()}))};r.iframes?r.waitForIframes(o,l):l()}))}}],[{key:"matches",value:function(e,t){var n="string"==typeof t?[t]:t,r=e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.oMatchesSelector||e.webkitMatchesSelector;if(r){var a=!1;return n.every((function(t){return!r.call(e,t)||(a=!0,!1)})),a}return!1}}]),e}(),o=function(){function o(e){t(this,o),this.ctx=e,this.ie=!1;var n=window.navigator.userAgent;(n.indexOf("MSIE")>-1||n.indexOf("Trident")>-1)&&(this.ie=!0)}return n(o,[{key:"log",value:function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",r=this.opt.log;this.opt.debug&&"object"===(void 0===r?"undefined":e(r))&&"function"==typeof r[n]&&r[n]("mark.js: "+t)}},{key:"escapeStr",value:function(e){return e.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createRegExp",value:function(e){return"disabled"!==this.opt.wildcards&&(e=this.setupWildcardsRegExp(e)),e=this.escapeStr(e),Object.keys(this.opt.synonyms).length&&(e=this.createSynonymsRegExp(e)),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),this.opt.diacritics&&(e=this.createDiacriticsRegExp(e)),e=this.createMergedBlanksRegExp(e),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.createJoinersRegExp(e)),"disabled"!==this.opt.wildcards&&(e=this.createWildcardsRegExp(e)),e=this.createAccuracyRegExp(e)}},{key:"createSynonymsRegExp",value:function(e){var t=this.opt.synonyms,n=this.opt.caseSensitive?"":"i",r=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\0":"";for(var a in t)if(t.hasOwnProperty(a)){var o=t[a],i="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(a):this.escapeStr(a),l="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(o):this.escapeStr(o);""!==i&&""!==l&&(e=e.replace(new RegExp("("+this.escapeStr(i)+"|"+this.escapeStr(l)+")","gm"+n),r+"("+this.processSynomyms(i)+"|"+this.processSynomyms(l)+")"+r))}return e}},{key:"processSynomyms",value:function(e){return(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),e}},{key:"setupWildcardsRegExp",value:function(e){return(e=e.replace(/(?:\\)*\?/g,(function(e){return"\\"===e.charAt(0)?"?":"\x01"}))).replace(/(?:\\)*\*/g,(function(e){return"\\"===e.charAt(0)?"*":"\x02"}))}},{key:"createWildcardsRegExp",value:function(e){var t="withSpaces"===this.opt.wildcards;return e.replace(/\u0001/g,t?"[\\S\\s]?":"\\S?").replace(/\u0002/g,t?"[\\S\\s]*?":"\\S*")}},{key:"setupIgnoreJoinersRegExp",value:function(e){return e.replace(/[^(|)\\]/g,(function(e,t,n){var r=n.charAt(t+1);return/[(|)\\]/.test(r)||""===r?e:e+"\0"}))}},{key:"createJoinersRegExp",value:function(e){var t=[],n=this.opt.ignorePunctuation;return Array.isArray(n)&&n.length&&t.push(this.escapeStr(n.join(""))),this.opt.ignoreJoiners&&t.push("\\u00ad\\u200b\\u200c\\u200d"),t.length?e.split(/\u0000+/).join("["+t.join("")+"]*"):e}},{key:"createDiacriticsRegExp",value:function(e){var t=this.opt.caseSensitive?"":"i",n=this.opt.caseSensitive?["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105","A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010d","C\xc7\u0106\u010c","d\u0111\u010f","D\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119","E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012b","I\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142","L\u0141","n\xf1\u0148\u0144","N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014d","O\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159","R\u0158","s\u0161\u015b\u0219\u015f","S\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163","T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016b","U\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xff","Y\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017a","Z\u017d\u017b\u0179"]:["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010dC\xc7\u0106\u010c","d\u0111\u010fD\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012bI\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142L\u0141","n\xf1\u0148\u0144N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014dO\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159R\u0158","s\u0161\u015b\u0219\u015fS\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016bU\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xffY\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017aZ\u017d\u017b\u0179"],r=[];return e.split("").forEach((function(a){n.every((function(n){if(-1!==n.indexOf(a)){if(r.indexOf(n)>-1)return!1;e=e.replace(new RegExp("["+n+"]","gm"+t),"["+n+"]"),r.push(n)}return!0}))})),e}},{key:"createMergedBlanksRegExp",value:function(e){return e.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(e){var t=this,n="!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~\xa1\xbf",r=this.opt.accuracy,a="string"==typeof r?r:r.value,o="string"==typeof r?[]:r.limiters,i="";switch(o.forEach((function(e){i+="|"+t.escapeStr(e)})),a){case"partially":default:return"()("+e+")";case"complementary":return"()([^"+(i="\\s"+(i||this.escapeStr(n)))+"]*"+e+"[^"+i+"]*)";case"exactly":return"(^|\\s"+i+")("+e+")(?=$|\\s"+i+")"}}},{key:"getSeparatedKeywords",value:function(e){var t=this,n=[];return e.forEach((function(e){t.opt.separateWordSearch?e.split(" ").forEach((function(e){e.trim()&&-1===n.indexOf(e)&&n.push(e)})):e.trim()&&-1===n.indexOf(e)&&n.push(e)})),{keywords:n.sort((function(e,t){return t.length-e.length})),length:n.length}}},{key:"isNumeric",value:function(e){return Number(parseFloat(e))==e}},{key:"checkRanges",value:function(e){var t=this;if(!Array.isArray(e)||"[object Object]"!==Object.prototype.toString.call(e[0]))return this.log("markRanges() will only accept an array of objects"),this.opt.noMatch(e),[];var n=[],r=0;return e.sort((function(e,t){return e.start-t.start})).forEach((function(e){var a=t.callNoMatchOnInvalidRanges(e,r),o=a.start,i=a.end;a.valid&&(e.start=o,e.length=i-o,n.push(e),r=i)})),n}},{key:"callNoMatchOnInvalidRanges",value:function(e,t){var n=void 0,r=void 0,a=!1;return e&&void 0!==e.start?(r=(n=parseInt(e.start,10))+parseInt(e.length,10),this.isNumeric(e.start)&&this.isNumeric(e.length)&&r-t>0&&r-n>0?a=!0:(this.log("Ignoring invalid or overlapping range: "+JSON.stringify(e)),this.opt.noMatch(e))):(this.log("Ignoring invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:n,end:r,valid:a}}},{key:"checkWhitespaceRanges",value:function(e,t,n){var r=void 0,a=!0,o=n.length,i=t-o,l=parseInt(e.start,10)-i;return(r=(l=l>o?o:l)+parseInt(e.length,10))>o&&(r=o,this.log("End range automatically set to the max value of "+o)),l<0||r-l<0||l>o||r>o?(a=!1,this.log("Invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)):""===n.substring(l,r).replace(/\s+/g,"")&&(a=!1,this.log("Skipping whitespace only range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:l,end:r,valid:a}}},{key:"getTextNodes",value:function(e){var t=this,n="",r=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,(function(e){r.push({start:n.length,end:(n+=e.textContent).length,node:e})}),(function(e){return t.matchesExclude(e.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),(function(){e({value:n,nodes:r})}))}},{key:"matchesExclude",value:function(e){return a.matches(e,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(e,t,n){var r=this.opt.element?this.opt.element:"mark",a=e.splitText(t),o=a.splitText(n-t),i=document.createElement(r);return i.setAttribute("data-markjs","true"),this.opt.className&&i.setAttribute("class",this.opt.className),i.textContent=a.textContent,a.parentNode.replaceChild(i,a),o}},{key:"wrapRangeInMappedTextNode",value:function(e,t,n,r,a){var o=this;e.nodes.every((function(i,l){var s=e.nodes[l+1];if(void 0===s||s.start>t){if(!r(i.node))return!1;var c=t-i.start,u=(n>i.end?i.end:n)-i.start,d=e.value.substr(0,i.start),p=e.value.substr(u+i.start);if(i.node=o.wrapRangeInTextNode(i.node,c,u),e.value=d+p,e.nodes.forEach((function(t,n){n>=l&&(e.nodes[n].start>0&&n!==l&&(e.nodes[n].start-=u),e.nodes[n].end-=u)})),n-=u,a(i.node.previousSibling,i.start),!(n>i.end))return!1;t=i.end}return!0}))}},{key:"wrapMatches",value:function(e,t,n,r,a){var o=this,i=0===t?0:t+1;this.getTextNodes((function(t){t.nodes.forEach((function(t){t=t.node;for(var a=void 0;null!==(a=e.exec(t.textContent))&&""!==a[i];)if(n(a[i],t)){var l=a.index;if(0!==i)for(var s=1;s{"use strict";n.r(t)},2295:(e,t,n)=>{"use strict";n.r(t)},4865:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),c=o.querySelector(r.barSelector),u=r.speed,d=r.easing;return o.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(c,i(e,u,d)),1===e?(s(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){s(o,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),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");u(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),c=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),c!=document.body&&u(c,"nprogress-custom-parent"),c.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 c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(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)},4779:(e,t,n)=>{var r=n(5826);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="",u=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 g=e[i],h=n[2],m=n[3],y=n[4],b=n[5],v=n[6],w=n[7];l&&(r.push(l),l="");var k=null!=h&&null!=g&&g!==h,x="+"===v||"*"===v,S="?"===v||"*"===v,E=n[2]||u,C=y||b;r.push({name:m||o++,prefix:h||"",delimiter:E,optional:S,repeat:x,partial:k,asterisk:!!w,pattern:C?c(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"}}})},2885:(e,t,n)=>{const r=n(9901),a=n(9642),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),o.add(e)}))}i.silent=!1,e.exports=i},6854:()=>{!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 c=l[s];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=o[a],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),g=p.indexOf(f);if(g>-1){++a;var h=p.substring(0,g),m=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),y=p.substring(g+f.length),b=[];h&&b.push.apply(b,i([h])),b.push(m),y&&b.push.apply(b,i([y])),"string"==typeof c?l.splice.apply(l,[s,1].concat(b)):c.content=b}}else c.content&&i(c.content)}return l}(n.tokens)}}}})}(Prism)},6726:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6726},6500:(e,t,n)=>{var r={"./":2885};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=6500},9642:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function c(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,c),t(s.optional,c),t(s.modify,c)}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),c=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(c),l=(l||[]).map(c);var u=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,f=r(s),g=u;a(g);){for(var h in p={},g){var m=s[h];t(m&&m.modify,(function(e){e in d&&(p[e]=!0)}))}for(var y in d)if(!(y in u))for(var b in f(y))if(b in u){p[y]=!0;break}for(var v in g=p)u[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 c(e){if(e in l)return l[e];s[e]=!0;var a,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)a=r(e);else{var p=i(u.map((function(e){var t=c(e);return delete s[e],t})));o?a=o(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var u in n)c(u);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,u,t,n)}};return w}}();e.exports=t},2703:(e,t,n)=>{"use strict";var r=n(414);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},5697:(e,t,n)=>{e.exports=n(2703)()},414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:(e,t,n)=>{"use strict";var r=n(7294),a=n(3840);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n