c893a02878
Highlighter is autolocked, so we shouldn't show the lock icon ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [ ] Unit Tests - [ ] End to end tests ### Release Notes - We no longer show the tool lock option for highlighter - it didn't do anything anyway
90 lines
1.4 KiB
Text
90 lines
1.4 KiB
Text
---
|
|
title: SerializedSchema
|
|
status: published
|
|
category: store
|
|
group: Interface
|
|
author: api
|
|
date: 06/23/2023
|
|
order: 24
|
|
---<Small>Public Interface</Small>
|
|
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
- [Properties](#properties)
|
|
- [recordVersions](#SerializedSchema-recordVersions-member)
|
|
- [schemaVersion](#SerializedSchema-schemaVersion-member)
|
|
- [storeVersion](#SerializedSchema-storeVersion-member)
|
|
</details>
|
|
|
|
|
|
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
interface SerializedSchema {}
|
|
```
|
|
|
|
---
|
|
|
|
## Properties
|
|
|
|
### `recordVersions` \{#SerializedSchema-recordVersions-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
Record versions are the versions for each record type. e.g. adding a new field to a record
|
|
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
recordVersions: Record<
|
|
string,
|
|
| {
|
|
version: number
|
|
subTypeVersions: Record<string, number>
|
|
subTypeKey: string
|
|
}
|
|
| {
|
|
version: number
|
|
}
|
|
>
|
|
```
|
|
|
|
---
|
|
|
|
### `schemaVersion` \{#SerializedSchema-schemaVersion-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
Schema version is the version for this type you're looking at right now
|
|
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
schemaVersion: number
|
|
```
|
|
|
|
---
|
|
|
|
### `storeVersion` \{#SerializedSchema-storeVersion-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
Store version is the version for the structure of the store. e.g. higher level structure like removing or renaming a record type.
|
|
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
storeVersion: number
|
|
```
|
|
|
|
---
|
|
|