Issue with persisting a specific store. Improve docs?

[filipescaglia]

Are you using Nuxt?

• Check this box if you encountered the issue using Nuxt and the included module.

Describe the bug

I just spent almost an hour trying to figure out why a specific store in my application wasn't being persisted. After a lot of research, including checking the issues here, I found nothing—just one person mentioning something about the influence of JSON.stringify in another issue they were facing.

I decided to test whether the data I was trying to save was being successfully converted, and I ended up discovering that one of the objects was throwing a circular structure error, as shown in the following image.

Was this a stupid mistake on my part? Probably. But I think it deserves a mention in the documentation, either in the limitations section or in the storage configuration part, since the Pinia plugin itself didn’t throw any errors, even when I forced persistence using store.$persist or make the code actually throw an error in these cases, i don't know

Reproduction

Try to store an object with circular reference. I was trying to store a laravel echo instance (not doing that anymore).

System Info

Vue 3, pinia and pinia-plugin-persistedstate

Used Package Manager

npm

Validations

• Follow our Code of Conduct
• Read the Contributing Guide.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• The provided reproduction is a minimal reproducible of the bug.