SmartNgRX Documentation

Home
Using Smart NgRX
Intro Effects Service Injection Token Entity Definitions Global Registration Entity Registration ChildDefinition Smart Selector
Mark and Delete
Introduction MarkAndDeleteInit Global Mark and Delete Entity Mark and Delete
Child Fields
CRUD Support
Retrieving Rows Virtual IDs Updates Create (Add) a Row Delete a Row
Using With Existing Selectors WebSockets Error Handling
Demo Walkthrough
Introduction Database Structure Retrieving Data Setup Client Side Effects Services Selectors Tree Component Updating Fields Adding Rows Deleting Rows Processing WebSocket Messages
API
Public API Internal API
Using Smart NgRX Mark and Delete MarkAndDeleteInit

MarkAndDeleteInit

The core interface for the Mark and Delete feature is the MarkAndDeleteInit interface. This interface is used to configure the Mark and Delete feature for a given entity.

The MarkAndDeleteInit interface has the following properties:

markDirtyTime

The time in milliseconds to wait before marking a row as dirty. When a row is marked as dirty, and it is being used it will re-retrieve the row if markDirtyFetchesNew is true. If markDirtyFetchesNew is false, it will just reset the isDirty flag in the row. This is how we know the row is still in use, or not.

If markDirtyTime is set to -1, then the row will never be marked as dirty, and removeTime will be ignored. However, when the API we have for processing websocket messages marks the row as dirty, it will request new data from the server, regardless of what you set this value to. This allows us to use the same mechanism to refresh data for automated refreshes and manual refreshes in response to websocket notification.

If markAndDelete is not set, it will default to 15 minutes.

markDirtyFetchesNew

As mentioned above, if this is set to true, than any time a row is marked as dirty, the system will retrieve a new value from the server. Otherwise, it will just reset the dirty timeout internally.

If markDirtyFetchesNew is not set, it will default to true.

removeTime

The time in milliseconds to wait before removing a row from the store. removeTime must be greater than markDirtyTime. If it is not, it will automatically set to twice markDirtyTime.

If removeTime is not set, it will default to 30 minutes.

runInterval

The time in milliseconds that determines how often the system looks at the rows to see if they need to be marked dirty or removed. If this is not set, it will default to one minute.

runInterval is only recognized at the global level. If you want to change it, you must change it at the global level.

Previous
Introduction
Next
Global Mark and Delete