tauri-pinia
This is a small utility that brings persistance to pinia for tauri apps
Installation is pretty simple
const app = createApp(YourApp)
app.use(await tauriPinia())
app.mount('#app')
It requires await during initialisation however because the module will do a first read from fs before initialisation.
Some configuration is available (given as argument to tauriPinia()
):
singleFile
: If we do use single file for storage or one file per storestoreFilename
: (whensingleFile = false
) A store name to file name conversion, should you need it (e.g.{'myStore': 'storageFileForMyStore.json'}
) it is not mandatoryfilename
: (whensingleFile = true
) The name of the file to save inlogger
: A function, the same type asconsole.log
for those who want more info what's happeningexcludeStore
: List of stores to exclude completely from persisting
Non-persistant attributes
tauri-pinia now allows for non persistant attributes. In order to do it, a new property has been added in StoreConfig
: ignoreProps
.
In order to use it, simply do the following:
import { acceptHMRUpdate, defineStore } from 'pinia'
export const useCredentialStore = defineStore('credential', () => {
const username = ref<string>()
const password = ref<string>()
const userId = ref<string>()
const withDefault = ref<string>('default_value')
const ignored = ref<number>(0)
return { username, password, jiraUrl, userId, withDefault, ignored }
}, {
ignoreProps: ['ignored'],
})
if (import.meta.hot)
import.meta.hot.accept(acceptHMRUpdate(useCredentialStore as any, import.meta.hot))
In this example, the property ignored won't be written to disk nor loaded from disk.