Skip to main content
Version: 0.17

Class: SyncCacheIntegrityProcessor

An operation processor that ensures that a cache's data is consistent and doesn't contain any dead references.

This is achieved by maintaining a mapping of reverse relationships for each record. When a record is removed, any references to it can also be identified and removed.

Hierarchy​

Constructors​

constructor​

• new SyncCacheIntegrityProcessor(accessor)

Parameters​

NameType
accessorSyncRecordAccessor

Inherited from​

SyncOperationProcessor.constructor

Defined in​

record-cache/src/sync-operation-processor.ts:27

Accessors​

accessor​

• get accessor(): SyncRecordAccessor

The SyncRecordAccessor that is monitored.

Returns​

SyncRecordAccessor

Inherited from​

SyncOperationProcessor.accessor

Defined in​

record-cache/src/sync-operation-processor.ts:23

Methods​

after​

â–¸ after(operation): RecordOperation[]

Called before an operation has been applied.

Returns an array of operations to be applied AFTER the operation has been applied successfully.

Parameters​

NameType
operationRecordOperation

Returns​

RecordOperation[]

Overrides​

SyncOperationProcessor.after

Defined in​

record-cache/src/operation-processors/sync-cache-integrity-processor.ts:23


before​

â–¸ before(operation): RecordOperation[]

Called before an operation has been applied.

Returns an array of operations to be applied BEFORE the operation itself is applied.

Parameters​

NameType
operationRecordOperation

Returns​

RecordOperation[]

Inherited from​

SyncOperationProcessor.before

Defined in​

record-cache/src/sync-operation-processor.ts:54


finally​

â–¸ finally(operation): RecordOperation[]

Called after an operation and any related operations have been applied.

Returns an array of operations to be applied AFTER the operation itself and any operations returned from the after hook have been applied.

Parameters​

NameType
operationRecordOperation

Returns​

RecordOperation[]

Overrides​

SyncOperationProcessor.finally

Defined in​

record-cache/src/operation-processors/sync-cache-integrity-processor.ts:68


immediate​

â–¸ immediate(operation): void

Called immediately after an operation has been applied and before the patch event has been emitted (i.e. before any listeners have been notified that the operation was applied).

No operations may be returned.

Parameters​

NameType
operationRecordOperation

Returns​

void

Inherited from​

SyncOperationProcessor.immediate

Defined in​

record-cache/src/sync-operation-processor.ts:75


reset​

â–¸ reset(base?): void

Called when all the data in a cache has been reset.

If base is included, the cache is being reset to match a base cache.

Parameters​

NameType
base?SyncRecordAccessor

Returns​

void

Inherited from​

SyncOperationProcessor.reset

Defined in​

record-cache/src/sync-operation-processor.ts:36


upgrade​

â–¸ upgrade(): void

Allow the processor to perform an upgrade as part of a cache upgrade.

Returns​

void

Inherited from​

SyncOperationProcessor.upgrade

Defined in​

record-cache/src/sync-operation-processor.ts:41


validate​

â–¸ validate(operation): void

Validates an operation before processing it.

Parameters​

NameType
operationRecordOperation

Returns​

void

Inherited from​

SyncOperationProcessor.validate

Defined in​

record-cache/src/sync-operation-processor.ts:46