Class: RecordQueryBuilder<RT, RI>
Type parameters​
| Name | Type |
|---|---|
RT | string |
RI | RecordIdentity |
Constructors​
constructor​
• new RecordQueryBuilder<RT, RI>(settings?)
Type parameters​
| Name | Type |
|---|---|
RT | string |
RI | RecordIdentity |
Parameters​
| Name | Type |
|---|---|
settings | RecordQueryBuilderSettings<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​
| Name | Type |
|---|---|
ri | RI |
Returns​
Defined in​
packages/@orbit/records/src/record-query-builder.ts:118
$normalizeRecordType​
â–¸ $normalizeRecordType(rt): string
Parameters​
| Name | Type |
|---|---|
rt | RT |
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​
| Name | Type |
|---|---|
record | RI |
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​
| Name | Type |
|---|---|
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​
| Name | Type |
|---|---|
record | RI |
relationship | string |
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​
| Name | Type |
|---|---|
record | RI |
relationship | string |
Returns​
FindRecordsTerm<RT, RI>