Class: FindRecordsTerm<RT, RI>
Type parameters​
| Name | Type |
|---|---|
RT | string |
RI | RecordIdentity |
Hierarchy​
BaseRecordQueryTerm<FindRecords|FindRelatedRecords,RT,RI>↳
FindRecordsTerm
Constructors​
constructor​
• new FindRecordsTerm<RT, RI>(queryBuilder, expression)
Type parameters​
| Name | Type |
|---|---|
RT | string |
RI | RecordIdentity |
Parameters​
| Name | Type |
|---|---|
queryBuilder | RecordQueryBuilder<RT, RI> |
expression | FindRelatedRecords | FindRecords |
Inherited from​
BaseRecordQueryTerm.constructor
Defined in​
packages/@orbit/records/src/record-query-term.ts:100
Properties​
$queryBuilder​
• $queryBuilder: RecordQueryBuilder<RT, RI>
Inherited from​
BaseRecordQueryTerm.$queryBuilder
Defined in​
packages/@orbit/records/src/record-query-term.ts:98
Methods​
$filterParamToSpecifier​
â–¸ $filterParamToSpecifier(param): FilterSpecifier
Parameters​
| Name | Type |
|---|---|
param | FilterParam<RI> |
Returns​
Defined in​
packages/@orbit/records/src/record-query-term.ts:222
$pageParamToSpecifier​
â–¸ $pageParamToSpecifier(param): PageSpecifier
Parameters​
| Name | Type |
|---|---|
param | PageParam |
Returns​
Defined in​
packages/@orbit/records/src/record-query-term.ts:278
$parseSortParamString​
â–¸ $parseSortParamString(sortSpecifier): AttributeSortSpecifier
Parameters​
| Name | Type |
|---|---|
sortSpecifier | string |
Returns​
Defined in​
packages/@orbit/records/src/record-query-term.ts:324
$sortParamToSpecifier​
â–¸ $sortParamToSpecifier(param): SortSpecifier
Parameters​
| Name | Type |
|---|---|
param | SortParam |
Returns​
Defined in​
packages/@orbit/records/src/record-query-term.ts:298
filter​
â–¸ filter(...params): FindRecordsTerm<RT, RI>
Apply a filter expression.
For example:
oqb
.records('planet')
.filter({ attribute: 'atmosphere', value: true },
{ attribute: 'classification', value: 'terrestrial' });
Parameters​
| Name | Type |
|---|---|
...params | FilterParam<RI>[] |
Returns​
FindRecordsTerm<RT, RI>
Defined in​
packages/@orbit/records/src/record-query-term.ts:214
options​
â–¸ options(options): FindRecordsTerm<RT, RI>
Parameters​
| Name | Type |
|---|---|
options | RequestOptions |
Returns​
FindRecordsTerm<RT, RI>
Inherited from​
Defined in​
packages/@orbit/data/dist/modules/query-term.d.ts:11
page​
â–¸ page(param): FindRecordsTerm<RT, RI>
Applies pagination to a collection query.
Parameters​
| Name | Type |
|---|---|
param | PageParam |
Returns​
FindRecordsTerm<RT, RI>
Defined in​
packages/@orbit/records/src/record-query-term.ts:197
sort​
â–¸ sort(...params): FindRecordsTerm<RT, RI>
Applies sorting to a collection query.
Sort specifiers can be expressed in object form, like:
{ attribute: 'name', order: 'descending' }
{ attribute: 'name', order: 'ascending' }
Or in string form, like:
'-name' // descending order
'name' // ascending order
Parameters​
| Name | Type |
|---|---|
...params | SortParam[] |
Returns​
FindRecordsTerm<RT, RI>
Defined in​
packages/@orbit/records/src/record-query-term.ts:188
toQueryExpression​
â–¸ toQueryExpression(): FindRelatedRecords | FindRecords
Returns​
FindRelatedRecords | FindRecords
Inherited from​
BaseRecordQueryTerm.toQueryExpression