1"use strict";(self.webpackChunk_cromwell_website=self.webpackChunk_cromwell_website||[]).push([[7882],{33:function(e,t,r){r.r(t),r.d(t,{frontMatter:function(){return o},contentTitle:function(){return l},metadata:function(){return s},toc:function(){return d},default:function(){return c}});var n=r(5773),a=r(808),p=(r(7378),r(5318)),i=["components"],o={title:"PagedParamsInput"},l="Class: PagedParamsInput<T>",s={unversionedId:"api/classes/backend.PagedParamsInput",id:"api/classes/backend.PagedParamsInput",isDocsHomePage:!1,title:"PagedParamsInput",description:"backend.PagedParamsInput",source:"@site/docs/api/classes/backend.PagedParamsInput.md",sourceDirName:"api/classes",slug:"/api/classes/backend.PagedParamsInput",permalink:"/docs/api/classes/backend.PagedParamsInput",tags:[],version:"current",frontMatter:{title:"PagedParamsInput"},sidebar:"tutorialSidebar",previous:{title:"PagedOrder",permalink:"/docs/api/classes/backend.PagedOrder"},next:{title:"PagedPost",permalink:"/docs/api/classes/backend.PagedPost"}},d=[{value:"Type parameters",id:"type-parameters",children:[]},{value:"Implements",id:"implements",children:[]},{value:"Table of contents",id:"table-of-contents",children:[{value:"Constructors",id:"constructors",children:[]},{value:"Properties",id:"properties",children:[]}]},{value:"Constructors",id:"constructors-1",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties-1",children:[{value:"order",id:"order",children:[]},{value:"orderBy",id:"orderby",children:[]},{value:"pageNumber",id:"pagenumber",children:[]},{value:"pageSize",id:"pagesize",children:[]}]}],m={toc:d};function c(e){var t=e.components,r=(0,a.Z)(e,i);return(0,p.kt)("wrapper",(0,n.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("h1",{id:"class-pagedparamsinputt"},"Class: PagedParamsInput<T",">"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/docs/api/modules/backend"},"backend"),".PagedParamsInput"),(0,p.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"T"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("inlineCode",{parentName:"li"},"TPagedParams"),"<",(0,p.kt)("inlineCode",{parentName:"li"},"T"),">")),(0,p.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,p.kt)("h3",{id:"constructors"},"Constructors"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#constructor"},"constructor"))),(0,p.kt)("h3",{id:"properties"},"Properties"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#order"},"order")),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#orderby"},"orderBy")),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#pagenumber"},"pageNumber")),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#pagesize"},"pageSize"))),(0,p.kt)("h2",{id:"constructors-1"},"Constructors"),(0,p.kt)("h3",{id:"constructor"},"constructor"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"new PagedParamsInput"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"T"),">","()"),(0,p.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,p.kt)("table",null,(0,p.kt)("thead",{parentName:"table"},(0,p.kt)("tr",{parentName:"thead"},(0,p.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,p.kt)("tbody",{parentName:"table"},(0,p.kt)("tr",{parentName:"tbody"},(0,p.kt)("td",{parentName:"tr",align:"left"},(0,p.kt)("inlineCode",{parentName:"td"},"T"))))),(0,p.kt)("h2",{id:"properties-1"},"Properties"),(0,p.kt)("h3",{id:"order"},"order"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"order"),": ",(0,p.kt)("inlineCode",{parentName:"p"},'"ASC"')," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},'"DESC"')),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,"TPagedParams.order"),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/paged-params.input.ts#L17"},"system/core/backend/src/models/inputs/paged-params.input.ts:17")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"orderby"},"orderBy"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"orderBy"),": keyof ",(0,p.kt)("inlineCode",{parentName:"p"},"T")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,"TPagedParams.orderBy"),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/paged-params.input.ts#L14"},"system/core/backend/src/models/inputs/paged-params.input.ts:14")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"pagenumber"},"pageNumber"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"pageNumber"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,"TPagedParams.pageNumber"),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/paged-params.input.ts#L8"},"system/core/backend/src/models/inputs/paged-params.input.ts:8")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"pagesize"}
1,"pageSize"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"pageSize"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"number")),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,"TPagedParams.pageSize"),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/paged-params.input.ts#L11"},"system/core/backend/src/models/inputs/paged-params.input.ts:11")))}c.isMDXComponent=!0},5318:function(e,t,r){r.d(t,{Zo:function(){return d},kt:function(){return u}});var n=r(7378);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?p(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):p(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},p=Object.keys(e);for(n=0;n<p.length;n++)r=p[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n<p.length;n++)r=p[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),s=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,p=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=s(r),u=a,k=c["".concat(l,".").concat(u)]||c[u]||m[u]||p;return r?n.createElement(k,i(i({ref:t},d),{},{components:r})):n.createElement(k,i({ref:t},d))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var p=r.length,i=new Array(p);i[0]=c;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o.mdxType="string"==typeof e?e:a,i[1]=o;for(var s=2;s<p;s++)i[s]=r[s];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}c.displayName="MDXCreateElement"}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.