Table of contents

Public interface

Signature
interface SerializedSchemaV1 {}
Source

packages/store/src/lib/StoreSchema.ts


Properties

recordVersions

Public propertysignature

Record versions are the versions for each record type. e.g. adding a new field to a record

Signature
recordVersions: Record<
  string,
  | {
      subTypeKey: string
      subTypeVersions: Record<string, number>
      version: number
    }
  | {
      version: number
    }
>

schemaVersion

Public propertysignature

Schema version is the version for this type you're looking at right now

Signature
schemaVersion: 1

storeVersion

Public propertysignature

Store version is the version for the structure of the store. e.g. higher level structure like removing or renaming a record type.

Signature
storeVersion: number

SerializedSchemaSerializedSchemaV2