Skip to content

A Pinia plugin that can be integrated with Tauri for local storage.

License

Notifications You must be signed in to change notification settings

xiaochen0517/pinia-plugin-persistedtauri

Repository files navigation

logo

The icon are based on pinia-plugin-persistedstate and pinia

pinia-plugin-persistedtauri

npm License

English | 简体中文

✨ Quickstart

🚚 Install

# npm
npm install --save pinia-plugin-persistedtauri

# yarn
yarn add pinia-plugin-persistedtauri

🛠 Configuration

import {createPinia} from 'pinia'
import {createPersistedState} from 'pinia-plugin-persistedtauri'

const pinia = createPinia()
pinia.use(createPersistedState())

⚙️ Options

You can do nothing and the persistent save will work automatically, but you can also do some configuration.

defineStore('main', {
  state: () => ({
    count: 0,
  }),
  persist: true, // default: true
})
// use false to disable persist
persist: boolean | PersistedTauriOptions

type PersistedTauriOptions = {
  // The file name or key name of the data is stored by default, using the store ID
  name?: string,
  // Customizing storage mode, compatible with localStorage and sessionStorage
  storage?: AsyncStorage | Storage,
  // Customizing the way data is serialized and deserialized
  serializer?: StateSerializer,
}

🗝️ License

MIT LICENSE

About

A Pinia plugin that can be integrated with Tauri for local storage.

Resources

License

Stars

Watchers

Forks

Packages

No packages published