Class: SyncRecordCache<QO, TO, QB, TB, QueryResponseDetails, TransformResponseDetails>

Type parameters

Name	Type
QO	extends RequestOptions = RecordCacheQueryOptions
TO	extends RequestOptions = RecordCacheTransformOptions
QB	RecordQueryBuilder
TB	RecordTransformBuilder
QueryResponseDetails	unknown
TransformResponseDetails	extends RecordCacheUpdateDetails = RecordCacheUpdateDetails

Hierarchy

• RecordCache<QO, TO, QB, TB>

  ↳ SyncRecordCache

  ↳↳ SimpleRecordTransformBuffer

Implements

• SyncRecordAccessor
• SyncRecordQueryable<QueryResponseDetails, QB, QO>
• SyncRecordUpdatable<TransformResponseDetails, TB, TO>

Constructors

constructor

• new SyncRecordCache<QO, TO, QB, TB, QueryResponseDetails, TransformResponseDetails>(settings)

Type parameters

Name	Type
QO	extends RequestOptions = RecordCacheQueryOptions
TO	extends RequestOptions = RecordCacheTransformOptions
QB	RecordQueryBuilder<string, RecordIdentity>
TB	RecordTransformBuilder<string, RecordIdentity, UninitializedRecord>
QueryResponseDetails	unknown
TransformResponseDetails	extends RecordCacheUpdateDetails = RecordCacheUpdateDetails

Parameters

Name	Type
settings	SyncRecordCacheSettings<QO, TO, QB, TB>

Overrides

RecordCache.constructor

Defined in

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

Accessors

defaultQueryOptions

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

Returns

undefined | DefaultRequestOptions<QueryOptions>

Inherited from

RecordCache.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

RecordCache.defaultQueryOptions

Defined in

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

---

defaultTransformOptions

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

Returns

undefined | DefaultRequestOptions<TransformOptions>

Inherited from

RecordCache.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

RecordCache.defaultTransformOptions

Defined in

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

---

keyMap

• get keyMap(): undefined | RecordKeyMap

Returns

undefined | RecordKeyMap

Implementation of

SyncRecordAccessor.keyMap

Inherited from

RecordCache.keyMap

Defined in

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

---

name

• get name(): undefined | string

Returns

undefined | string

Implementation of

SyncRecordAccessor.name

Inherited from

RecordCache.name

Defined in

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

---

processors

• get processors(): SyncOperationProcessor[]

Returns

SyncOperationProcessor[]

Defined in

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

---

queryBuilder

• get queryBuilder(): QueryBuilder

Returns

QueryBuilder

Inherited from

RecordCache.queryBuilder

Defined in

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

---

schema

• get schema(): RecordSchema

Returns

RecordSchema

Implementation of

SyncRecordAccessor.schema

Inherited from

RecordCache.schema

Defined in

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

---

transformBuilder

• get transformBuilder(): TransformBuilder

Returns

TransformBuilder

Inherited from

RecordCache.transformBuilder

Defined in

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

---

validatorFor

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

Returns

undefined | ValidatorForFn<StandardValidator | StandardRecordValidator>

Inherited from

RecordCache.validatorFor

Defined in

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

Methods

addInverseRelationshipsSync

▸ Abstract addInverseRelationshipsSync(relationships): void

Parameters

Name	Type
relationships	RecordRelationshipIdentity[]

Returns

void

Implementation of

SyncRecordAccessor.addInverseRelationshipsSync

Defined in

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

---

applyRecordChangesetSync

▸ applyRecordChangesetSync(changeset): void

Parameters

Name	Type
changeset	RecordChangeset

Returns

void

Implementation of

SyncRecordAccessor.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

RecordCache.emit

Defined in

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

---

getInverseRelationshipsSync

▸ Abstract getInverseRelationshipsSync(recordIdentityOrIdentities): RecordRelationshipIdentity[]

Parameters

Name	Type
recordIdentityOrIdentities	RecordIdentity | RecordIdentity[]

Returns

RecordRelationshipIdentity[]

Implementation of

SyncRecordAccessor.getInverseRelationshipsSync

Defined in

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

---

getInverseTransformOperator

▸ getInverseTransformOperator(op): SyncInverseTransformOperator

Parameters

Name	Type
op	string

Returns

SyncInverseTransformOperator

Defined in

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

---

getQueryOperator

▸ getQueryOperator(op): SyncQueryOperator

Parameters

Name	Type
op	string

Returns

SyncQueryOperator

Defined in

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

---

getQueryOptions

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

Parameters

Name	Type
query	RecordQuery
expression?	RecordQueryExpression

Returns

undefined | QO

Inherited from

RecordCache.getQueryOptions

Defined in

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

---

getRecordSync

▸ Abstract getRecordSync(recordIdentity): undefined | InitializedRecord

Parameters

Name	Type
recordIdentity	RecordIdentity

Returns

undefined | InitializedRecord

Implementation of

SyncRecordAccessor.getRecordSync

Defined in

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

---

getRecordsSync

▸ Abstract getRecordsSync(typeOrIdentities?): InitializedRecord[]

Parameters

Name	Type
typeOrIdentities?	string | RecordIdentity[]

Returns

InitializedRecord[]

Implementation of

SyncRecordAccessor.getRecordsSync

Defined in

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

---

getRelatedRecordSync

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

Parameters

Name	Type
identity	RecordIdentity
relationship	string

Returns

undefined | null | RecordIdentity

Implementation of

SyncRecordAccessor.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

SyncRecordAccessor.getRelatedRecordsSync

Defined in

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

---

getTransformOperator

▸ getTransformOperator(op): SyncTransformOperator

Parameters

Name	Type
op	string

Returns

SyncTransformOperator

Defined in

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

---

getTransformOptions

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

Parameters

Name	Type
transform	RecordTransform
operation?	RecordOperation

Returns

undefined | TO

Inherited from

RecordCache.getTransformOptions

Defined in

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

---

listeners

▸ listeners(event): Listener[]

Parameters

Name	Type
event	Event

Returns

Listener[]

Inherited from

RecordCache.listeners

Defined in

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

---

liveQuery

▸ liveQuery(queryOrExpressions, options?, id?): SyncLiveQuery<QO, TO, QB, TB>

Parameters

Name	Type
queryOrExpressions	QueryOrExpressions<RecordQueryExpression, QB>
options?	DefaultRequestOptions<QO>
id?	string

Returns

SyncLiveQuery<QO, TO, QB, TB>

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

RecordCache.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

RecordCache.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

RecordCache.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

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, QB>
options?	DefaultRequestOptions<QO>
id?	string

Returns

RequestData

Implementation of

SyncRecordQueryable.query

Defined in

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

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

Type parameters

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

Parameters

Name	Type
queryOrExpressions	QueryOrExpressions<RecordQueryExpression, QB>
options	FullRequestOptions<QO>
id?	string

Returns

FullResponse<RequestData, QueryResponseDetails, RecordOperation>

Implementation of

SyncRecordQueryable.query

Defined in

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

---

removeInverseRelationshipsSync

▸ Abstract removeInverseRelationshipsSync(relationships): void

Parameters

Name	Type
relationships	RecordRelationshipIdentity[]

Returns

void

Implementation of

SyncRecordAccessor.removeInverseRelationshipsSync

Defined in

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

---

removeRecordSync

▸ Abstract removeRecordSync(recordIdentity): undefined | InitializedRecord

Parameters

Name	Type
recordIdentity	RecordIdentity

Returns

undefined | InitializedRecord

Implementation of

SyncRecordAccessor.removeRecordSync

Defined in

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

---

removeRecordsSync

▸ Abstract removeRecordsSync(recordIdentities): InitializedRecord[]

Parameters

Name	Type
recordIdentities	RecordIdentity[]

Returns

InitializedRecord[]

Implementation of

SyncRecordAccessor.removeRecordsSync

Defined in

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

---

setRecordSync

▸ Abstract setRecordSync(record): void

Parameters

Name	Type
record	InitializedRecord

Returns

void

Implementation of

SyncRecordAccessor.setRecordSync

Defined in

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

---

setRecordsSync

▸ Abstract setRecordsSync(records): void

Parameters

Name	Type
records	InitializedRecord[]

Returns

void

Implementation of

SyncRecordAccessor.setRecordsSync

Defined in

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

---

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, TB>
options?	DefaultRequestOptions<TO>
id?	string

Returns

RequestData

Implementation of

SyncRecordUpdatable.update

Defined in

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

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

Type parameters

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

Parameters

Name	Type
transformOrOperations	TransformOrOperations<RecordOperation, TB>
options	FullRequestOptions<TO>
id?	string

Returns

FullResponse<RequestData, TransformResponseDetails, RecordOperation>

Implementation of

SyncRecordUpdatable.update

Defined in

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