StoreValidator

See source code
Table 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

NameDescription

record

unknown

The record to validate

Returns

R

The validated record


validateUsingKnownGoodVersion

optional

Validate a record using a known good version for reference.

Parameters

NameDescription

knownGoodVersion

R

A known valid version of the record

record

unknown

The record to validate

Returns

R

The validated record


Prev
StoreValidationFailure
Next
UseSyncDemoOptions