Skip to content
qubee
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
1.6.1
Guide
API
Drivers
Changelog
Menu
Guide
Introduction
Getting started
createQubee
Building a query
Filters and operators
Pagination
Lists & URL state
Reactivity
Errors
Bundle size
Drivers
Overview
Capability matrix
Every driver
API Platform
Directus
Django REST Framework
FastAPI
FeathersJS
JSON:API
json-server
Laravel
nestjs-paginate
@nestjsx/crud
OData v4
Payload CMS
PocketBase
PostgREST
Ransack (Rails)
Sieve
spatie/laravel-query-builder
Spring Data REST
Strapi
WordPress REST API
Extending
Writing a driver
Response strategies
API
Services
Paginator
QubeeStore
QueryBuilder
Models
ApiPlatformResponseOptions
DirectusResponseOptions
DrfResponseOptions
FastapiResponseOptions
FeathersResponseOptions
JsonApiResponseOptions
JsonServerResponseOptions
NestjsResponseOptions
NestjsxCrudResponseOptions
OdataResponseOptions
PaginatedCollection
PayloadResponseOptions
PocketbaseResponseOptions
QueryBuilderOptions
RansackResponseOptions
ResponseOptions
SieveResponseOptions
SpringResponseOptions
StrapiResponseOptions
Enums
DriverEnum
FilterOperatorEnum
PaginationModeEnum
SortEnum
Types
AriaSort
BooleanParamOptions
Config
Driver
DriverDefinition
DriverId
Embedded
EnumParamOptions
EnumValues
Fields
FilterOperator
Filters
HeaderBag
IntegerParamOptions
ListDefinition
ListInput
ListLocation
ListParam
ListParamOptions
ListParams
ListRequest
ListState
Normalized
OperatorFilter
PageRange
PageRangeInput
PageWindowItem
PageWindowOptions
PaginatedObject
PaginatedResult
PaginationConfig
PaginationMode
Params
ParamsState
Qubee
QubeeConfig
QubeeErrorCode
QueryBuilderConfig
QueryBuilderState
QueryValue
RawResponse
SearchParamsInput
Sort
SortDirection
SortParam
SortParamOptions
StrategyCapabilities
StringParamOptions
ToggleSortOptions
Errors
DuplicateListParamError
InvalidFilterOperatorValueError
InvalidLimitError
InvalidPageNumberError
InvalidResourceNameError
KeyNotFoundError
PaginationNotSyncedError
ParamCollisionError
QubeeError
UnselectableModelError
UnsupportedCapabilityError
UnsupportedEmbeddedError
UnsupportedFieldSelectionError
UnsupportedFilterError
UnsupportedFilterOperatorError
UnsupportedIncludesError
UnsupportedSearchError
UnsupportedSelectError
UnsupportedSortError
Strategies
AbstractDotPathResponseStrategy
AbstractFlatResponseStrategy
AbstractRequestStrategy
ApiPlatformRequestStrategy
ApiPlatformResponseStrategy
DirectusRequestStrategy
DirectusResponseStrategy
DrfRequestStrategy
DrfResponseStrategy
FastapiRequestStrategy
FastapiResponseStrategy
FeathersRequestStrategy
FeathersResponseStrategy
JsonApiRequestStrategy
JsonApiResponseStrategy
JsonServerRequestStrategy
JsonServerResponseStrategy
LaravelRequestStrategy
LaravelResponseStrategy
NestjsRequestStrategy
NestjsResponseStrategy
NestjsxCrudRequestStrategy
NestjsxCrudResponseStrategy
OdataRequestStrategy
OdataResponseStrategy
PayloadRequestStrategy
PayloadResponseStrategy
PocketbaseRequestStrategy
PocketbaseResponseStrategy
PostgrestRequestStrategy
PostgrestResponseStrategy
RansackRequestStrategy
RansackResponseStrategy
SieveRequestStrategy
SieveResponseStrategy
SpatieRequestStrategy
SpatieResponseStrategy
SpringRequestStrategy
SpringResponseStrategy
StrapiRequestStrategy
StrapiResponseStrategy
WordpressRequestStrategy
WordpressResponseStrategy
IRequestStrategy
IResponseStrategy
Reference
DRIVERS
booleanParam
buildListHref
buildListRequest
createQubee
defineList
enumParam
getAriaSort
getPageRange
getPageWindow
integerParam
listParam
readHeader
readListState
readNumber
readPath
readRows
readString
sortParam
stringify
stringParam
toggleSort
toSearchParams
GitHub
Select theme
Dark
Light
Auto
API
/
Fields
Fields
src/types/fields.type.ts
type
Definition
Section titled “Definition”
type
Fields
=
{ [
model
:
string
]
:
string
[] }