Interface: RecordTransformBuffer

Hierarchy

• SyncRecordUpdatable<RecordCacheUpdateDetails>

• SyncRecordAccessor

  ↳ RecordTransformBuffer

Implemented by

• SimpleRecordTransformBuffer

Properties

keyMap

• Optional keyMap: RecordKeyMap

Inherited from

SyncRecordAccessor.keyMap

Defined in

record-cache/src/record-accessor.ts:21

---

name

• Optional name: string

Inherited from

SyncRecordAccessor.name

Defined in

record-cache/src/record-accessor.ts:20

---

schema

• schema: RecordSchema

Inherited from

SyncRecordAccessor.schema

Defined in

record-cache/src/record-accessor.ts:22

Methods

addInverseRelationshipsSync

▸ addInverseRelationshipsSync(relationships): void

Parameters

Name	Type
relationships	RecordRelationshipIdentity[]

Returns

void

Inherited from

SyncRecordAccessor.addInverseRelationshipsSync

Defined in

record-cache/src/record-accessor.ts:57

---

applyRecordChangesetSync

▸ applyRecordChangesetSync(changeset): void

Parameters

Name	Type
changeset	RecordChangeset

Returns

void

Inherited from

SyncRecordAccessor.applyRecordChangesetSync

Defined in

record-cache/src/record-accessor.ts:63

---

getInverseRelationshipsSync

▸ getInverseRelationshipsSync(recordIdentityOrIdentities): RecordRelationshipIdentity[]

Parameters

Name	Type
recordIdentityOrIdentities	RecordIdentity | RecordIdentity[]

Returns

RecordRelationshipIdentity[]

Inherited from

SyncRecordAccessor.getInverseRelationshipsSync

Defined in

record-cache/src/record-accessor.ts:46

---

getRecordSync

▸ getRecordSync(recordIdentity): undefined | InitializedRecord

Parameters

Name	Type
recordIdentity	RecordIdentity

Returns

undefined | InitializedRecord

Inherited from

SyncRecordAccessor.getRecordSync

Defined in

record-cache/src/record-accessor.ts:34

---

getRecordsSync

▸ getRecordsSync(typeOrIdentities?): InitializedRecord[]

Parameters

Name	Type
typeOrIdentities?	string | RecordIdentity[]

Returns

InitializedRecord[]

Inherited from

SyncRecordAccessor.getRecordsSync

Defined in

record-cache/src/record-accessor.ts:35

---

getRelatedRecordSync

▸ getRelatedRecordSync(identity, relationship): undefined | null | RecordIdentity

Parameters

Name	Type
identity	RecordIdentity
relationship	string

Returns

undefined | null | RecordIdentity

Inherited from

SyncRecordAccessor.getRelatedRecordSync

Defined in

record-cache/src/record-accessor.ts:38

---

getRelatedRecordsSync

▸ getRelatedRecordsSync(identity, relationship): undefined | RecordIdentity[]

Parameters

Name	Type
identity	RecordIdentity
relationship	string

Returns

undefined | RecordIdentity[]

Inherited from

SyncRecordAccessor.getRelatedRecordsSync

Defined in

record-cache/src/record-accessor.ts:42

---

removeInverseRelationshipsSync

▸ removeInverseRelationshipsSync(relationships): void

Parameters

Name	Type
relationships	RecordRelationshipIdentity[]

Returns

void

Inherited from

SyncRecordAccessor.removeInverseRelationshipsSync

Defined in

record-cache/src/record-accessor.ts:60

---

removeRecordSync

▸ removeRecordSync(recordIdentity): undefined | InitializedRecord

Parameters

Name	Type
recordIdentity	RecordIdentity

Returns

undefined | InitializedRecord

Inherited from

SyncRecordAccessor.removeRecordSync

Defined in

record-cache/src/record-accessor.ts:53

---

removeRecordsSync

▸ removeRecordsSync(recordIdentities): InitializedRecord[]

Parameters

Name	Type
recordIdentities	RecordIdentity[]

Returns

InitializedRecord[]

Inherited from

SyncRecordAccessor.removeRecordsSync

Defined in

record-cache/src/record-accessor.ts:56

---

resetState

▸ resetState(): void

Returns

void

Defined in

record-cache/src/record-transform-buffer.ts:8

---

setRecordSync

▸ setRecordSync(record): void

Parameters

Name	Type
record	InitializedRecord

Returns

void

Inherited from

SyncRecordAccessor.setRecordSync

Defined in

record-cache/src/record-accessor.ts:51

---

setRecordsSync

▸ setRecordsSync(records): void

Parameters

Name	Type
records	InitializedRecord[]

Returns

void

Inherited from

SyncRecordAccessor.setRecordsSync

Defined in

record-cache/src/record-accessor.ts:52

---

startTrackingChanges

▸ startTrackingChanges(): void

Returns

void

Defined in

record-cache/src/record-transform-buffer.ts:9

---

stopTrackingChanges

▸ stopTrackingChanges(): RecordChangeset

Returns

RecordChangeset

Defined in

record-cache/src/record-transform-buffer.ts:10

---

update

▸ update<RequestData>(transformOrOperations, options?, id?): RequestData

Type parameters

Name	Type
RequestData	extends RecordTransformResult<InitializedRecord> = RecordTransformResult<InitializedRecord>

Parameters

Name	Type
transformOrOperations	TransformOrOperations<RecordOperation, RecordTransformBuilder<string, RecordIdentity, UninitializedRecord>>
options?	DefaultRequestOptions<RequestOptions>
id?	string

Returns

RequestData

Inherited from

SyncRecordUpdatable.update

Defined in

data/dist/modules/updatable.d.ts:10

▸ update<RequestData, RequestDetails, RequestOperation>(transformOrOperations, options, id?): FullResponse<RequestData, RequestDetails, RequestOperation>

Type parameters

Name	Type
RequestData	extends RecordTransformResult<InitializedRecord> = RecordTransformResult<InitializedRecord>
RequestDetails	extends RecordCacheUpdateDetails = RecordCacheUpdateDetails
RequestOperation	extends RecordOperation = RecordOperation

Parameters

Name	Type
transformOrOperations	TransformOrOperations<RecordOperation, RecordTransformBuilder<string, RecordIdentity, UninitializedRecord>>
options	FullRequestOptions<RequestOptions>
id?	string

Returns

FullResponse<RequestData, RequestDetails, RequestOperation>

Inherited from

SyncRecordUpdatable.update

Defined in

data/dist/modules/updatable.d.ts:11