Class: SimpleRecordTransformBuffer

Hierarchy

• SyncRecordCache

  ↳ SimpleRecordTransformBuffer

Implements

• RecordTransformBuffer

Constructors

constructor

• new SimpleRecordTransformBuffer(settings)

Parameters

Name	Type
settings	SyncRecordCacheSettings<RecordCacheQueryOptions, RecordCacheTransformOptions, RecordQueryBuilder<string, RecordIdentity>, RecordTransformBuilder<string, RecordIdentity, UninitializedRecord>>

Overrides

SyncRecordCache.constructor

Defined in

record-cache/src/simple-record-transform-buffer.ts:36

Accessors

defaultQueryOptions

• get defaultQueryOptions(): undefined | DefaultRequestOptions<QueryOptions>

Returns

undefined | DefaultRequestOptions<QueryOptions>

Inherited from

SyncRecordCache.defaultQueryOptions

Defined in

record-cache/src/record-cache.ts:187

• set defaultQueryOptions(options): void

Parameters

Name	Type
options	undefined | DefaultRequestOptions<QueryOptions>

Returns

void

Inherited from

SyncRecordCache.defaultQueryOptions

Defined in

record-cache/src/record-cache.ts:191

---

defaultTransformOptions

• get defaultTransformOptions(): undefined | DefaultRequestOptions<TransformOptions>

Returns

undefined | DefaultRequestOptions<TransformOptions>

Inherited from

SyncRecordCache.defaultTransformOptions

Defined in

record-cache/src/record-cache.ts:197

• set defaultTransformOptions(options): void

Parameters

Name	Type
options	undefined | DefaultRequestOptions<TransformOptions>

Returns

void

Inherited from

SyncRecordCache.defaultTransformOptions

Defined in

record-cache/src/record-cache.ts:203

---

keyMap

• get keyMap(): undefined | RecordKeyMap

Returns

undefined | RecordKeyMap

Implementation of

RecordTransformBuffer.keyMap

Inherited from

SyncRecordCache.keyMap

Defined in

record-cache/src/record-cache.ts:169

---

name

• get name(): undefined | string

Returns

undefined | string

Implementation of

RecordTransformBuffer.name

Inherited from

SyncRecordCache.name

Defined in

record-cache/src/record-cache.ts:161

---

processors

• get processors(): SyncOperationProcessor[]

Returns

SyncOperationProcessor[]

Inherited from

SyncRecordCache.processors

Defined in

record-cache/src/sync-record-cache.ts:131

---

queryBuilder

• get queryBuilder(): QueryBuilder

Returns

QueryBuilder

Inherited from

SyncRecordCache.queryBuilder

Defined in

record-cache/src/record-cache.ts:179

---

schema

• get schema(): RecordSchema

Returns

RecordSchema

Implementation of

RecordTransformBuffer.schema

Inherited from

SyncRecordCache.schema

Defined in

record-cache/src/record-cache.ts:165

---

transformBuilder

• get transformBuilder(): TransformBuilder

Returns

TransformBuilder

Inherited from

SyncRecordCache.transformBuilder

Defined in

record-cache/src/record-cache.ts:183

---

validatorFor

• get validatorFor(): undefined | ValidatorForFn<StandardValidator | StandardRecordValidator>

Returns

undefined | ValidatorForFn<StandardValidator | StandardRecordValidator>

Inherited from

SyncRecordCache.validatorFor

Defined in

record-cache/src/record-cache.ts:173

Methods

addInverseRelationshipsSync

▸ addInverseRelationshipsSync(relationships): void

Parameters

Name	Type
relationships	RecordRelationshipIdentity[]

Returns

void

Implementation of

RecordTransformBuffer.addInverseRelationshipsSync

Overrides

SyncRecordCache.addInverseRelationshipsSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:184

---

applyRecordChangesetSync

▸ applyRecordChangesetSync(changeset): void

Parameters

Name	Type
changeset	RecordChangeset

Returns

void

Implementation of

RecordTransformBuffer.applyRecordChangesetSync

Inherited from

SyncRecordCache.applyRecordChangesetSync

Defined in

record-cache/src/sync-record-cache.ts:174

---

emit

▸ emit(event, ...args): void

Parameters

Name	Type
event	Event
...args	unknown[]

Returns

void

Inherited from

SyncRecordCache.emit

Defined in

core/dist/modules/evented.d.ts:23

---

getInverseRelationshipsSync

▸ getInverseRelationshipsSync(recordIdentityOrIdentities): RecordRelationshipIdentity[]

Parameters

Name	Type
recordIdentityOrIdentities	RecordIdentity | RecordIdentity[]

Returns

RecordRelationshipIdentity[]

Implementation of

RecordTransformBuffer.getInverseRelationshipsSync

Overrides

SyncRecordCache.getInverseRelationshipsSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:167

---

getInverseTransformOperator

▸ getInverseTransformOperator(op): SyncInverseTransformOperator

Parameters

Name	Type
op	string

Returns

SyncInverseTransformOperator

Inherited from

SyncRecordCache.getInverseTransformOperator

Defined in

record-cache/src/sync-record-cache.ts:143

---

getQueryOperator

▸ getQueryOperator(op): SyncQueryOperator

Parameters

Name	Type
op	string

Returns

SyncQueryOperator

Inherited from

SyncRecordCache.getQueryOperator

Defined in

record-cache/src/sync-record-cache.ts:135

---

getQueryOptions

▸ getQueryOptions(query, expression?): undefined | RecordCacheQueryOptions

Parameters

Name	Type
query	RecordQuery
expression?	RecordQueryExpression

Returns

undefined | RecordCacheQueryOptions

Inherited from

SyncRecordCache.getQueryOptions

Defined in

record-cache/src/record-cache.ts:209

---

getRecordSync

▸ getRecordSync(identity): undefined | InitializedRecord

Parameters

Name	Type
identity	RecordIdentity

Returns

undefined | InitializedRecord

Implementation of

RecordTransformBuffer.getRecordSync

Overrides

SyncRecordCache.getRecordSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:102

---

getRecordsSync

▸ getRecordsSync(typeOrIdentities?): InitializedRecord[]

Parameters

Name	Type
typeOrIdentities?	string | RecordIdentity[]

Returns

InitializedRecord[]

Implementation of

RecordTransformBuffer.getRecordsSync

Overrides

SyncRecordCache.getRecordsSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:106

---

getRelatedRecordSync

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

Parameters

Name	Type
identity	RecordIdentity
relationship	string

Returns

undefined | null | RecordIdentity

Implementation of

RecordTransformBuffer.getRelatedRecordSync

Inherited from

SyncRecordCache.getRelatedRecordSync

Defined in

record-cache/src/sync-record-cache.ts:196

---

getRelatedRecordsSync

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

Parameters

Name	Type
identity	RecordIdentity
relationship	string

Returns

undefined | RecordIdentity[]

Implementation of

RecordTransformBuffer.getRelatedRecordsSync

Inherited from

SyncRecordCache.getRelatedRecordsSync

Defined in

record-cache/src/sync-record-cache.ts:207

---

getTransformOperator

▸ getTransformOperator(op): SyncTransformOperator

Parameters

Name	Type
op	string

Returns

SyncTransformOperator

Inherited from

SyncRecordCache.getTransformOperator

Defined in

record-cache/src/sync-record-cache.ts:139

---

getTransformOptions

▸ getTransformOptions(transform, operation?): undefined | RecordCacheTransformOptions

Parameters

Name	Type
transform	RecordTransform
operation?	RecordOperation

Returns

undefined | RecordCacheTransformOptions

Inherited from

SyncRecordCache.getTransformOptions

Defined in

record-cache/src/record-cache.ts:223

---

listeners

▸ listeners(event): Listener[]

Parameters

Name	Type
event	Event

Returns

Listener[]

Inherited from

SyncRecordCache.listeners

Defined in

core/dist/modules/evented.d.ts:24

---

liveQuery

▸ liveQuery(queryOrExpressions, options?, id?): SyncLiveQuery<RecordCacheQueryOptions, RecordCacheTransformOptions, RecordQueryBuilder<string, RecordIdentity>, RecordTransformBuilder<string, RecordIdentity, UninitializedRecord>>

Parameters

Name	Type
queryOrExpressions	QueryOrExpressions<RecordQueryExpression, RecordQueryBuilder<string, RecordIdentity>>
options?	DefaultRequestOptions<RecordCacheQueryOptions>
id?	string

Returns

SyncLiveQuery<RecordCacheQueryOptions, RecordCacheTransformOptions, RecordQueryBuilder<string, RecordIdentity>, RecordTransformBuilder<string, RecordIdentity, UninitializedRecord>>

Inherited from

SyncRecordCache.liveQuery

Defined in

record-cache/src/sync-record-cache.ts:319

---

off

▸ off(event, listener?): void

Parameters

Name	Type
event	Event
listener?	Listener

Returns

void

Inherited from

SyncRecordCache.off

Defined in

core/dist/modules/evented.d.ts:21

---

on

▸ on(event, listener): () => void

Parameters

Name	Type
event	Event
listener	Listener

Returns

fn

▸ (): void

Returns

void

Inherited from

SyncRecordCache.on

Defined in

core/dist/modules/evented.d.ts:20

---

one

▸ one(event, listener): () => void

Parameters

Name	Type
event	Event
listener	Listener

Returns

fn

▸ (): void

Returns

void

Inherited from

SyncRecordCache.one

Defined in

core/dist/modules/evented.d.ts:22

---

patch

▸ patch(operationOrOperations): PatchResult

Patches the cache with an operation or operations.

deprecated since v0.17

Parameters

Name	Type
operationOrOperations	RecordOperation | RecordOperation[] | RecordTransformBuilderFunc | RecordOperationTerm<string, RecordIdentity, UninitializedRecord> | RecordOperationTerm<string, RecordIdentity, UninitializedRecord>[]

Returns

PatchResult

Inherited from

SyncRecordCache.patch

Defined in

record-cache/src/sync-record-cache.ts:295

---

query

▸ query<RequestData>(queryOrExpressions, options?, id?): RequestData

Queries the cache.

Type parameters

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

Parameters

Name	Type
queryOrExpressions	QueryOrExpressions<RecordQueryExpression, RecordQueryBuilder<string, RecordIdentity>>
options?	DefaultRequestOptions<RecordCacheQueryOptions>
id?	string

Returns

RequestData

Inherited from

SyncRecordCache.query

Defined in

record-cache/src/sync-record-cache.ts:221

▸ query<RequestData>(queryOrExpressions, options, id?): FullResponse<RequestData, unknown, RecordOperation>

Type parameters

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

Parameters

Name	Type
queryOrExpressions	QueryOrExpressions<RecordQueryExpression, RecordQueryBuilder<string, RecordIdentity>>
options	FullRequestOptions<RecordCacheQueryOptions>
id?	string

Returns

FullResponse<RequestData, unknown, RecordOperation>

Inherited from

SyncRecordCache.query

Defined in

record-cache/src/sync-record-cache.ts:226

---

removeInverseRelationshipsSync

▸ removeInverseRelationshipsSync(relationships): void

Parameters

Name	Type
relationships	RecordRelationshipIdentity[]

Returns

void

Implementation of

RecordTransformBuffer.removeInverseRelationshipsSync

Overrides

SyncRecordCache.removeInverseRelationshipsSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:201

---

removeRecordSync

▸ removeRecordSync(recordIdentity): undefined | InitializedRecord

Parameters

Name	Type
recordIdentity	RecordIdentity

Returns

undefined | InitializedRecord

Implementation of

RecordTransformBuffer.removeRecordSync

Overrides

SyncRecordCache.removeRecordSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:137

---

removeRecordsSync

▸ removeRecordsSync(recordIdentities): InitializedRecord[]

Parameters

Name	Type
recordIdentities	RecordIdentity[]

Returns

InitializedRecord[]

Implementation of

RecordTransformBuffer.removeRecordsSync

Overrides

SyncRecordCache.removeRecordsSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:152

---

resetState

▸ resetState(): void

Returns

void

Implementation of

RecordTransformBuffer.resetState

Defined in

record-cache/src/simple-record-transform-buffer.ts:41

---

setRecordSync

▸ setRecordSync(record): void

Parameters

Name	Type
record	InitializedRecord

Returns

void

Implementation of

RecordTransformBuffer.setRecordSync

Overrides

SyncRecordCache.setRecordSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:126

---

setRecordsSync

▸ setRecordsSync(records): void

Parameters

Name	Type
records	InitializedRecord[]

Returns

void

Implementation of

RecordTransformBuffer.setRecordsSync

Overrides

SyncRecordCache.setRecordsSync

Defined in

record-cache/src/simple-record-transform-buffer.ts:133

---

startTrackingChanges

▸ startTrackingChanges(): void

Returns

void

Implementation of

RecordTransformBuffer.startTrackingChanges

Defined in

record-cache/src/simple-record-transform-buffer.ts:48

---

stopTrackingChanges

▸ stopTrackingChanges(): RecordChangeset

Returns

RecordChangeset

Implementation of

RecordTransformBuffer.stopTrackingChanges

Defined in

record-cache/src/simple-record-transform-buffer.ts:55

---

update

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

Updates the cache.

Type parameters

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

Parameters

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

Returns

RequestData

Implementation of

RecordTransformBuffer.update

Inherited from

SyncRecordCache.update

Defined in

record-cache/src/sync-record-cache.ts:257

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

Type parameters

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

Parameters

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

Returns

FullResponse<RequestData, RecordCacheUpdateDetails, RecordOperation>

Implementation of

RecordTransformBuffer.update

Inherited from

SyncRecordCache.update

Defined in

record-cache/src/sync-record-cache.ts:262