mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-07-24 17:20:51 +02:00
docs(fs): Fix scope example in js inline docs (#2034)
This commit is contained in:
File diff suppressed because one or more lines are too long
@@ -14,16 +14,29 @@
|
||||
*
|
||||
* The API has a scope configuration that forces you to restrict the paths that can be accessed using glob patterns.
|
||||
*
|
||||
* The scope configuration is an array of glob patterns describing folder paths that are allowed.
|
||||
* For instance, this scope configuration only allows accessing files on the
|
||||
* *databases* folder of the {@link https://v2.tauri.app/reference/javascript/api/namespacepath/#appdatadir | `$APPDATA` directory}:
|
||||
* The scope configuration is an array of glob patterns describing file/directory paths that are allowed.
|
||||
* For instance, this scope configuration allows **all** enabled `fs` APIs to (only) access files in the
|
||||
* *databases* directory of the {@link https://v2.tauri.app/reference/javascript/api/namespacepath/#appdatadir | `$APPDATA` directory}:
|
||||
* ```json
|
||||
* {
|
||||
* "plugins": {
|
||||
* "fs": {
|
||||
* "scope": ["$APPDATA/databases/*"]
|
||||
* "permissions": [
|
||||
* {
|
||||
* "identifier": "fs:scope",
|
||||
* "allow": [{ "path": "$APPDATA/databases/*" }]
|
||||
* }
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* Scopes can also be applied to specific `fs` APIs by using the API's identifier instead of `fs:scope`:
|
||||
* ```json
|
||||
* {
|
||||
* "permissions": [
|
||||
* {
|
||||
* "identifier": "fs:allow-exists",
|
||||
* "allow": [{ "path": "$APPDATA/databases/*" }]
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
@@ -56,8 +69,6 @@
|
||||
*
|
||||
* Trying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.
|
||||
*
|
||||
* Note that this scope applies to **all** APIs on this module.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user