Skip to content

docs(persisted-scope): document protocol-asset feature #3434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MihirMohapatra wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

docs(persisted-scope): document protocol-asset feature #3434

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions plugins/persisted-scope/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,23 @@ fn main() {

Afterwards the plugin will automatically save and restore filesystem and asset scopes.

### `protocol-asset` Feature

By default, this plugin persists filesystem scope changes (`fs` plugin scope).

If your app also uses the `asset://` protocol and mutates that scope at runtime, enable
the `protocol-asset` feature so those asset scope changes are persisted and restored too.

`src-tauri/Cargo.toml`

```toml
[dependencies]
tauri-plugin-persisted-scope = { version = "2.0.0", features = ["protocol-asset"] }
```

With this feature enabled, the plugin stores asset protocol scope state in a separate file
and reapplies it on the next app start.

## Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
Expand Down
Loading