Class Store<S>

A key-value store that can sync its state with the Rust backend and persist it to disk.

Type Parameters

S extends State

Hierarchy

BaseStore<S>
- Store

Implements

TauriStoreContract

Index

Constructors

Properties

Methods

destroy get getPath has keys patch save saveAll saveAllNow saveNow set size start state stop subscribe update values

Constructors

constructor

new Store<S extends State>(
    id: string,
    state: S,
    options?: TauriStoreOptions<S>,
): Store<S>
Type Parameters
- S extends State
Parameters
- id: string
- state: S
- options: TauriStoreOptions<S> = {}
Returns Store<S>
Overrides BaseStore<S>.constructor
- Defined in tauri-store/src/store.ts:32

Properties

`Readonly`id

id: string

Store id.

Methods

`Readonly`destroy

destroy(): Promise<void>
Returns Promise<void>
Implementation of TauriStoreContract.destroy
- Defined in tauri-store/src/store.ts:210

`Readonly`get

get<K extends string | number | symbol>(key: K): S[K]
Returns the value of the given key.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns S[K]
- Defined in tauri-store/src/store.ts:128

`Readonly`getPath

getPath(): Promise<string>
Returns Promise<string>
Implementation of TauriStoreContract.getPath
- Defined in tauri-store/src/store.ts:190

`Readonly`has

has(key: string): boolean
Returns true if the given key exists in the store.
Parameters
- key: string
Returns boolean
- Defined in tauri-store/src/store.ts:163

`Readonly`keys

keys(): string[]
Returns a list of all keys in the store.

Returns string[]
- Defined in tauri-store/src/store.ts:170

`Readonly`patch

patch(state: Partial<S>): void
Updates the store with the given a partial state.
Parameters
- state: Partial<S>
Returns void
- Defined in tauri-store/src/store.ts:149

`Readonly`save

save(): Promise<void>
Returns Promise<void>
Implementation of TauriStoreContract.save
- Defined in tauri-store/src/store.ts:194

`Readonly`saveAll

saveAll(): Promise<void>
Returns Promise<void>
Implementation of TauriStoreContract.saveAll
- Defined in tauri-store/src/store.ts:198

`Readonly`saveAllNow

saveAllNow(): Promise<void>
Returns Promise<void>
Implementation of TauriStoreContract.saveAllNow
- Defined in tauri-store/src/store.ts:202

`Readonly`saveNow

saveNow(): Promise<void>
Returns Promise<void>
Implementation of TauriStoreContract.saveNow
- Defined in tauri-store/src/store.ts:206

`Readonly`set

set<K extends string | number | symbol>(key: K, value: S[K]): void
Inserts a key-value pair in the store.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
- value: S[K]
Returns void
- Defined in tauri-store/src/store.ts:135

`Readonly`size

size(): number
Returns the amount of items in the store.

Returns number
- Defined in tauri-store/src/store.ts:156

start

start(): Promise<void>
Starts the store synchronization.

Returns Promise<void>
Implementation of TauriStoreContract.start

Inherited from BaseStore.start
- Defined in shared/dist/store.d.ts:20

`Readonly`state

state(): S
Returns the current state of the store.

Returns S
- Defined in tauri-store/src/store.ts:121

stop

stop(): Promise<void>
Stops the store synchronization.

Returns Promise<void>
Implementation of TauriStoreContract.stop

Inherited from BaseStore.stop
- Defined in shared/dist/store.d.ts:22

`Readonly`subscribe

subscribe(fn: (state: S) => void): Fn
Subscribes to changes in the store.
Parameters
- fn: (state: S) => void
Returns Fn
- Defined in tauri-store/src/store.ts:186

`Readonly`update

update<K extends string | number | symbol>(
key: K,
fn: (value: S[K]) => S[K],
): void
Updates a value in the store using a function.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
- fn: (value: S[K]) => S[K]
Returns void
- Defined in tauri-store/src/store.ts:142

`Readonly`values

values(): S[keyof S][]
Returns a list of all values in the store.

Returns S[keyof S][]
- Defined in tauri-store/src/store.ts:177