StoreValidator
See source codeTable of contents
A validator for store records that ensures data integrity. Validators are called when records are created or updated.
interface StoreValidator<R extends UnknownRecord> {}
Example
const bookValidator: StoreValidator<Book> = {
validate(record: unknown): Book {
// Validate and return the record
if (typeof record !== 'object' || !record.title) {
throw new Error('Invalid book')
}
return record as Book
},
}
Methods
validate
Validate a record.
Parameters
Name | Description |
---|---|
|
The record to validate |
Returns
R
The validated record
validateUsingKnownGoodVersion
optional
Validate a record using a known good version for reference.
Parameters
Name | Description |
---|---|
|
A known valid version of the record |
|
The record to validate |
Returns
R
The validated record
Prev
StoreValidationFailureNext
UseSyncDemoOptions