Class: RecordTransformBuilder<RT, RI, R>

Type parameters

Name	Type
RT	string
RI	RecordIdentity
R	UninitializedRecord

Constructors

constructor

• new RecordTransformBuilder<RT, RI, R>(settings?)

Type parameters

Name	Type
RT	string
RI	RecordIdentity
R	UninitializedRecord

Parameters

Name	Type
settings	RecordTransformBuilderSettings<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:57

Properties

$normalizer

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

Defined in

packages/@orbit/records/src/record-transform-builder.ts:54

---

$schema

• Optional $schema: RecordSchema

Defined in

packages/@orbit/records/src/record-transform-builder.ts:53

---

$validatorFor

• Optional $validatorFor: ValidatorForFn<StandardValidator | StandardRecordValidator>

Defined in

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

Methods

$normalizeRecord

▸ $normalizeRecord(r): InitializedRecord

Parameters

Name	Type
r	R

Returns

InitializedRecord

Defined in

packages/@orbit/records/src/record-transform-builder.ts:214

---

$normalizeRecordIdentity

▸ $normalizeRecordIdentity(ri): RecordIdentity

Parameters

Name	Type
ri	RI

Returns

RecordIdentity

Defined in

packages/@orbit/records/src/record-transform-builder.ts:222

---

addRecord

▸ addRecord(record): AddRecordTerm<RT, RI, R>

Instantiate a new addRecord operation.

Parameters

Name	Type
record	R

Returns

AddRecordTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:100

---

addToRelatedRecords

▸ addToRelatedRecords(record, relationship, relatedRecord): AddToRelatedRecordsTerm<RT, RI, R>

Instantiate a new addToRelatedRecords operation.

Parameters

Name	Type
record	RI
relationship	string
relatedRecord	RI

Returns

AddToRelatedRecordsTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:153

---

removeFromRelatedRecords

▸ removeFromRelatedRecords(record, relationship, relatedRecord): RemoveFromRelatedRecordsTerm<RT, RI, R>

Instantiate a new removeFromRelatedRecords operation.

Parameters

Name	Type
record	RI
relationship	string
relatedRecord	RI

Returns

RemoveFromRelatedRecordsTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:169

---

removeRecord

▸ removeRecord(record): RemoveRecordTerm<RT, RI, R>

Instantiate a new removeRecord operation.

Parameters

Name	Type
record	RI

Returns

RemoveRecordTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:114

---

replaceAttribute

▸ replaceAttribute(record, attribute, value): ReplaceAttributeTerm<RT, RI, R>

Instantiate a new replaceAttribute operation.

Parameters

Name	Type
record	RI
attribute	string
value	unknown

Returns

ReplaceAttributeTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:137

---

replaceKey

▸ replaceKey(record, key, value): ReplaceKeyTerm<RT, RI, R>

Instantiate a new replaceKey operation.

Parameters

Name	Type
record	RI
key	string
value	string

Returns

ReplaceKeyTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:121

---

replaceRelatedRecord

▸ replaceRelatedRecord(record, relationship, relatedRecord): ReplaceRelatedRecordTerm<RT, RI, R>

Instantiate a new replaceRelatedRecord operation.

Parameters

Name	Type
record	RI
relationship	string
relatedRecord	null | RI

Returns

ReplaceRelatedRecordTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:201

---

replaceRelatedRecords

▸ replaceRelatedRecords(record, relationship, relatedRecords): ReplaceRelatedRecordsTerm<RT, RI, R>

Instantiate a new replaceRelatedRecords operation.

Parameters

Name	Type
record	RI
relationship	string
relatedRecords	RI[]

Returns

ReplaceRelatedRecordsTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:185

---

updateRecord

▸ updateRecord(record): UpdateRecordTerm<RT, RI, R>

Instantiate a new updateRecord operation.

Parameters

Name	Type
record	R

Returns

UpdateRecordTerm<RT, RI, R>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:107