charton

Appearance

charton API

charton API / @chart-on/core / index / SettingsStoreOptions

Interface: SettingsStoreOptions ​

Defined in: packages/core/src/storage/settings.ts:7

Options for createSettingsStore: where values persist, preloaded and locked values, and the version with its migration.

Properties ​

adapter? ​

optional adapter?: SettingsAdapter | null

Defined in: packages/core/src/storage/settings.ts:9

Where values are written, and read when the snapshot doesn't have them. Default none: values live for this page only.

locked? ​

optional locked?: Readonly<Record<string, string>>

Defined in: packages/core/src/storage/settings.ts:16

Values the app fixes: reads return them and writes to them are ignored.

migrate? ​

optional migrate?: (store, fromVersion) => void

Defined in: packages/core/src/storage/settings.ts:24

Upgrade settings stored by an older version (fromVersion is 0 when none was recorded): read old keys from store and write new ones. Runs once, when the store is created; the new version is saved after it.

Parameters ​

store ​

SettingsAdapter

fromVersion ​

number

Returns ​

void

snapshot? ​

optional snapshot?: Readonly<Record<string, string>>

Defined in: packages/core/src/storage/settings.ts:14

Values loaded ahead of time, e.g. fetched from your server before the chart starts, so reads stay synchronous. They win over the adapter.

version? ​

optional version?: number

Defined in: packages/core/src/storage/settings.ts:18

Version of the stored settings. Default 1.