Flarum (v2.0.0-beta.6)
Preparing search index...
flarum
common/states/PaginatedListState
PaginatedListRequestParams
Interface PaginatedListRequestParams
interface
PaginatedListRequestParams
{
fields
?:
string
[]
;
filter
?:
Record
<
string
,
any
>
|
{
q
:
string
}
;
include
?:
string
|
string
[]
;
meta
?:
MetaInformation
;
page
?:
{
limit
?:
number
;
near
?:
number
;
number
?:
number
;
offset
?:
number
;
size
?:
number
;
}
;
sort
?:
string
;
}
Hierarchy
Omit
<
ApiQueryParamsPlural
,
"include"
>
PaginatedListRequestParams
Index
Properties
fields?
filter?
include?
meta?
page?
sort?
Properties
Optional
fields
fields
?:
string
[]
Optional
filter
filter
?:
Record
<
string
,
any
>
|
{
q
:
string
}
Optional
include
include
?:
string
|
string
[]
Optional
meta
meta
?:
MetaInformation
Optional
page
page
?:
{
limit
?:
number
;
near
?:
number
;
number
?:
number
;
offset
?:
number
;
size
?:
number
;
}
Optional
sort
sort
?:
string
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
fields
filter
include
meta
page
sort
Flarum (v2.0.0-beta.6)
Loading...