Skip to main content
Version: 0.17

Class: RecordQueryBuilder<RT, RI>

Type parameters​

NameType
RTstring
RIRecordIdentity

Constructors​

constructor​

• new RecordQueryBuilder<RT, RI>(settings?)

Type parameters​

NameType
RTstring
RIRecordIdentity

Parameters​

NameType
settingsRecordQueryBuilderSettings<RT, RI>

Defined in​

packages/@orbit/records/src/record-query-builder.ts:37

Properties​

$normalizer​

• Optional $normalizer: RecordNormalizer<RT, RI, UninitializedRecord>

Defined in​

packages/@orbit/records/src/record-query-builder.ts:34


$schema​

• Optional $schema: RecordSchema

Defined in​

packages/@orbit/records/src/record-query-builder.ts:33


$validatorFor​

• Optional $validatorFor: ValidatorForFn<StandardValidator | StandardRecordValidator>

Defined in​

packages/@orbit/records/src/record-query-builder.ts:35

Methods​

$normalizeRecordIdentity​

â–¸ $normalizeRecordIdentity(ri): RecordIdentity

Parameters​

NameType
riRI

Returns​

RecordIdentity

Defined in​

packages/@orbit/records/src/record-query-builder.ts:118


$normalizeRecordType​

â–¸ $normalizeRecordType(rt): string

Parameters​

NameType
rtRT

Returns​

string

Defined in​

packages/@orbit/records/src/record-query-builder.ts:110


findRecord​

â–¸ findRecord(record): FindRecordTerm<RT, RI>

Find a record by its identity.

Parameters​

NameType
recordRI

Returns​

FindRecordTerm<RT, RI>

Defined in​

packages/@orbit/records/src/record-query-builder.ts:55


findRecords​

â–¸ findRecords(typeOrIdentities?): FindRecordsTerm<RT, RI>

Find all records of a specific type.

If type is unspecified, find all records unfiltered by type.

Parameters​

NameType
typeOrIdentities?RT | RI[]

Returns​

FindRecordsTerm<RT, RI>

Defined in​

packages/@orbit/records/src/record-query-builder.ts:64


findRelatedRecord​

â–¸ findRelatedRecord(record, relationship): FindRelatedRecordTerm<RT, RI>

Find a record in a to-one relationship.

Parameters​

NameType
recordRI
relationshipstring

Returns​

FindRelatedRecordTerm<RT, RI>

Defined in​

packages/@orbit/records/src/record-query-builder.ts:83


findRelatedRecords​

â–¸ findRelatedRecords(record, relationship): FindRecordsTerm<RT, RI>

Find records in a to-many relationship.

Parameters​

NameType
recordRI
relationshipstring

Returns​

FindRecordsTerm<RT, RI>

Defined in​

packages/@orbit/records/src/record-query-builder.ts:97