Class: AsyncOperationProcessor
Operation processors are used to identify operations that should be performed
together to ensure that a Cache
or other container of data remains
consistent and correct.
OperationProcessor
is an abstract base class to be extended by specific
operation processors.
Hierarchy​
AsyncOperationProcessor
↳
AsyncCacheIntegrityProcessor
Constructors​
constructor​
• new AsyncOperationProcessor(accessor
)
Parameters​
Name | Type |
---|---|
accessor | AsyncRecordAccessor |
Defined in​
record-cache/src/async-operation-processor.ts:27
Accessors​
accessor​
• get
accessor(): AsyncRecordAccessor
The AsyncRecordAccessor
that is monitored.
Returns​
Defined in​
record-cache/src/async-operation-processor.ts:23
Methods​
after​
â–¸ after(operation
): Promise
<RecordOperation
[]>
Called before an operation
has been applied.
Returns an array of operations to be applied AFTER the operation
has been applied successfully.
Parameters​
Name | Type |
---|---|
operation | RecordOperation |
Returns​
Promise
<RecordOperation
[]>
Defined in​
record-cache/src/async-operation-processor.ts:70
before​
â–¸ before(operation
): Promise
<RecordOperation
[]>
Called before an operation
has been applied.
Returns an array of operations to be applied BEFORE the operation
itself is applied.
Parameters​
Name | Type |
---|---|
operation | RecordOperation |
Returns​
Promise
<RecordOperation
[]>
Defined in​
record-cache/src/async-operation-processor.ts:60
finally​
â–¸ finally(operation
): Promise
<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​
Name | Type |
---|---|
operation | RecordOperation |
Returns​
Promise
<RecordOperation
[]>
Defined in​
record-cache/src/async-operation-processor.ts:91
immediate​
â–¸ immediate(operation
): Promise
<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​
Name | Type |
---|---|
operation | RecordOperation |
Returns​
Promise
<void
>
Defined in​
record-cache/src/async-operation-processor.ts:81
reset​
â–¸ reset(base?
): Promise
<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​
Name | Type |
---|---|
base? | AsyncRecordAccessor |
Returns​
Promise
<void
>
Defined in​
record-cache/src/async-operation-processor.ts:36
upgrade​
â–¸ upgrade(): Promise
<void
>
Allow the processor to perform an upgrade as part of a cache upgrade.
Returns​
Promise
<void
>
Defined in​
record-cache/src/async-operation-processor.ts:43
validate​
â–¸ validate(operation
): Promise
<void
>
Validates an operation before processing it.
Parameters​
Name | Type |
---|---|
operation | RecordOperation |
Returns​
Promise
<void
>