Skip to main content
Version: 0.17

Class: FindRecordsTerm<RT, RI>

Type parameters​

NameType
RTstring
RIRecordIdentity

Hierarchy​

Constructors​

constructor​

• new FindRecordsTerm<RT, RI>(queryBuilder, expression)

Type parameters​

NameType
RTstring
RIRecordIdentity

Parameters​

NameType
queryBuilderRecordQueryBuilder<RT, RI>
expressionFindRelatedRecords | 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​

NameType
paramFilterParam<RI>

Returns​

FilterSpecifier

Defined in​

packages/@orbit/records/src/record-query-term.ts:222


$pageParamToSpecifier​

â–¸ $pageParamToSpecifier(param): PageSpecifier

Parameters​

NameType
paramPageParam

Returns​

PageSpecifier

Defined in​

packages/@orbit/records/src/record-query-term.ts:278


$parseSortParamString​

â–¸ $parseSortParamString(sortSpecifier): AttributeSortSpecifier

Parameters​

NameType
sortSpecifierstring

Returns​

AttributeSortSpecifier

Defined in​

packages/@orbit/records/src/record-query-term.ts:324


$sortParamToSpecifier​

â–¸ $sortParamToSpecifier(param): SortSpecifier

Parameters​

NameType
paramSortParam

Returns​

SortSpecifier

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​

NameType
...paramsFilterParam<RI>[]

Returns​

FindRecordsTerm<RT, RI>

Defined in​

packages/@orbit/records/src/record-query-term.ts:214


options​

â–¸ options(options): FindRecordsTerm<RT, RI>

Parameters​

NameType
optionsRequestOptions

Returns​

FindRecordsTerm<RT, RI>

Inherited from​

BaseRecordQueryTerm.options

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​

NameType
paramPageParam

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​

NameType
...paramsSortParam[]

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

Defined in​

packages/@orbit/records/src/record-query-term.ts:105