charton

Appearance

charton API

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

Interface: SettingsStore ​

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

User preferences from createSettingsStore: synchronous string and JSON reads and writes, with values the app locked.

Extends ​

Methods ​

get() ​

get(key): string | null

Defined in: packages/core/src/storage/types.ts:92

Parameters ​

key ​

string

Returns ​

string | null

Inherited from ​

SettingsAdapter.get

getJSON() ​

getJSON<T>(key, fallback): T

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

A JSON value, or fallback when missing or unreadable.

Type Parameters ​

T ​

T

Parameters ​

key ​

string

fallback ​

T

Returns ​

T

isLocked() ​

isLocked(key): boolean

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

True when the app locked key.

Parameters ​

key ​

string

Returns ​

boolean

remove() ​

remove(key): void

Defined in: packages/core/src/storage/types.ts:94

Parameters ​

key ​

string

Returns ​

void

Inherited from ​

SettingsAdapter.remove

set() ​

set(key, value): void

Defined in: packages/core/src/storage/types.ts:93

Parameters ​

key ​

string

value ​

string

Returns ​

void

Inherited from ​

SettingsAdapter.set

setJSON() ​

setJSON(key, value): void

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

Parameters ​

key ​

string

value ​

unknown

Returns ​

void

values() ​

values(): Record<string, string>

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

Every value set or read so far, plus the snapshot, e.g. to send to a server. Locked values are left out.

Returns ​

Record<string, string>