This plugin provides an interface for storing unencrypted values on the application cache folder.
There are three general methods of installation that we can recommend.
file
protocol to ingest the sourceFor more details and usage see the example app. Please note, below in the dependencies you can also lock to a revision/tag in both the Cargo.toml
and package.json
src-tauri/Cargo.toml
[dependencies.tauri-plugin-store]
git = "https://github.com/tauri-apps/tauri-plugin-store"
tag = "v0.1.0"
#branch = "main"
Use in src-tauri/src/main.rs
:
use tauri_plugin_store::PluginBuilder;
fn main() {
tauri::Builder::default()
.plugin(PluginBuilder::default().build())
.build()
.run();
}
Install from a tagged release
npm install github:tauri-apps/tauri-plugin-store#v0.1.0
# or
yarn add github:tauri-apps/tauri-plugin-store#v0.1.0
Install from a commit
npm install github:tauri-apps/tauri-plugin-store#488558717b77d8a2bcb37acfd2eca9658aeadc8e
# or
yarn add github:tauri-apps/tauri-plugin-store#488558717b77d8a2bcb37acfd2eca9658aeadc8e
Install from a branch (dev)
npm install https://github.com/tauri-apps/tauri-plugin-store\#dev
# or
yarn add https://github.com/tauri-apps/tauri-plugin-store\#dev
package.json
"dependencies": {
"tauri-plugin-store-api": "github:tauri-apps/tauri-plugin-store#v0.1.0",
Use within your JS/TS:
import { Store } from 'tauri-plugin-store-api';
const store = new Store('.settings.dat');
await store.set('some-key', { value: 5 });
const val = await store.get('some-key');
assert(val, { value: 5 });
Generated using TypeDoc