docs: added example of tauri.allowlist.protocol (#9726)

tauri-apps · May 9, 2024 · f1b0b00 · f1b0b00
1 parent 6bb721c
commit f1b0b00
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/tooling/api/src/tauri.ts b/tooling/api/src/tauri.ts
@@ -106,6 +106,19 @@ async function invoke<T>(cmd: string, args: InvokeArgs = {}): Promise<T> {
  *
  * Additionally, `asset` must be added to [`tauri.allowlist.protocol`](https://tauri.app/v1/api/config/#allowlistconfig.protocol)
  * in `tauri.conf.json` and its access scope must be defined on the `assetScope` array on the same `protocol` object.
+ * For example: 
+ * ```json
+ * {
+ *   "tauri": {
+ *     "allowlist": {
+ *       "protocol": {
+ *         "asset": true,
+ *         "assetScope": ["$APPDATA/assets/*"]
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
  *
  * @param  filePath The file path.
  * @param  protocol The protocol to use. Defaults to `asset`. You only need to set this when using a custom protocol.