From b7d559983620f39ef0fb0a5089c03ee3b4265e04 Mon Sep 17 00:00:00 2001 From: Lucas Nogueira Date: Thu, 7 Sep 2023 16:42:46 -0300 Subject: [PATCH 1/6] refactor(core): custom protocol on Windows now uses the http scheme --- .changes/fix-windows-custom-protocol-url.md | 6 + core/tauri/CHANGELOG.md | 2 +- core/tauri/scripts/core.js | 2 +- core/tauri/src/manager.rs | 6 +- .../test/fixture/src-tauri/tauri.conf.json | 2 +- examples/api/src-tauri/tauri.conf.json | 6 +- examples/commands/tauri.conf.json | 2 +- examples/helloworld/tauri.conf.json | 2 +- examples/isolation/tauri.conf.json | 2 +- examples/multiwindow/tauri.conf.json | 2 +- examples/navigation/tauri.conf.json | 2 +- examples/parent-window/tauri.conf.json | 2 +- examples/resources/src-tauri/tauri.conf.json | 2 +- examples/splashscreen/tauri.conf.json | 2 +- examples/state/tauri.conf.json | 2 +- examples/streaming/tauri.conf.json | 16 +- .../src-tauri/tauri.conf.json | 2 +- tooling/api/CHANGELOG.md | 2 +- tooling/api/docs/js-api.json | 8033 ++++++++++++++++- tooling/api/src/tauri.ts | 4 +- .../cpu_intensive/src-tauri/tauri.conf.json | 2 +- .../files_transfer/src-tauri/tauri.conf.json | 2 +- .../helloworld/src-tauri/tauri.conf.json | 2 +- tooling/cli/src/migrate/config.rs | 16 +- .../vanilla/src-tauri/tauri.conf.json | 2 +- 25 files changed, 8083 insertions(+), 40 deletions(-) create mode 100644 .changes/fix-windows-custom-protocol-url.md diff --git a/.changes/fix-windows-custom-protocol-url.md b/.changes/fix-windows-custom-protocol-url.md new file mode 100644 index 000000000000..a5fb28aa4b01 --- /dev/null +++ b/.changes/fix-windows-custom-protocol-url.md @@ -0,0 +1,6 @@ +--- +"tauri": patch:breaking +"@tauri-apps/api": patch:breaking +--- + +The custom protocol on Windows now uses the `http` scheme instead of `https`. diff --git a/core/tauri/CHANGELOG.md b/core/tauri/CHANGELOG.md index 6943b861541a..f3e783931e09 100644 --- a/core/tauri/CHANGELOG.md +++ b/core/tauri/CHANGELOG.md @@ -1171,7 +1171,7 @@ Here is the logic flow that determines if JSON or JSON5 will be used to parse th ## \[1.0.0-beta.8] -- Fix missing asset protocol path.Now the protocol is `https://asset.localhost/path/to/file` on Windows. Lunix and macOS +- Fix missing asset protocol path.Now the protocol is `http://asset.localhost/path/to/file` on Windows. Lunix and macOS is still `asset://path/to/file`. - [994b5325](https://www.github.com/tauri-apps/tauri/commit/994b5325dd385f564b37fe1530c5d798dc925fff) fix: missing asset protocol path ([#2484](https://www.github.com/tauri-apps/tauri/pull/2484)) on 2021-08-23 - **Breaking change:** Removed `register_uri_scheme_protocol` from the `WebviewAttributes` struct and renamed `register_global_uri_scheme_protocol` to `register_uri_scheme_protocol` on the `Builder` struct, which now takes a `Fn(&AppHandle, &http::Request) -> http::Response` closure. diff --git a/core/tauri/scripts/core.js b/core/tauri/scripts/core.js index 61bdf1d672ba..62ac1d1d2416 100644 --- a/core/tauri/scripts/core.js +++ b/core/tauri/scripts/core.js @@ -18,7 +18,7 @@ window.__TAURI__.convertFileSrc = function convertFileSrc(filePath, protocol = 'asset') { const path = encodeURIComponent(filePath) return osName === 'windows' || osName === 'android' - ? `https://${protocol}.localhost/${path}` + ? `http://${protocol}.localhost/${path}` : `${protocol}://localhost/${path}` } diff --git a/core/tauri/src/manager.rs b/core/tauri/src/manager.rs index 60686b5be1ef..f86ca2e452a0 100644 --- a/core/tauri/src/manager.rs +++ b/core/tauri/src/manager.rs @@ -507,7 +507,7 @@ impl WindowManager { pub(crate) fn protocol_url(&self) -> Cow<'_, Url> { #[cfg(any(windows, target_os = "android"))] - return Cow::Owned(Url::parse("https://tauri.localhost").unwrap()); + return Cow::Owned(Url::parse("http://tauri.localhost").unwrap()); #[cfg(not(any(windows, target_os = "android")))] Cow::Owned(Url::parse("tauri://localhost").unwrap()) } @@ -612,7 +612,7 @@ impl WindowManager { let window_origin = if window_url.scheme() == "data" { "null".into() } else if cfg!(windows) && window_url.scheme() != "http" && window_url.scheme() != "https" { - format!("https://{}.localhost", window_url.scheme()) + format!("http://{}.localhost", window_url.scheme()) } else { format!( "{}://{}{}", @@ -876,7 +876,7 @@ mod test { assert_eq!( manager.get_url().to_string(), if cfg!(windows) { - "https://tauri.localhost/" + "http://tauri.localhost/" } else { "tauri://localhost" } diff --git a/core/tauri/test/fixture/src-tauri/tauri.conf.json b/core/tauri/test/fixture/src-tauri/tauri.conf.json index facec1a219b4..ecb5e3cecad0 100644 --- a/core/tauri/test/fixture/src-tauri/tauri.conf.json +++ b/core/tauri/test/fixture/src-tauri/tauri.conf.json @@ -15,7 +15,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/api/src-tauri/tauri.conf.json b/examples/api/src-tauri/tauri.conf.json index 784733dd675f..20bf653403b7 100644 --- a/examples/api/src-tauri/tauri.conf.json +++ b/examples/api/src-tauri/tauri.conf.json @@ -92,11 +92,11 @@ "security": { "csp": { "default-src": "'self' customprotocol: asset:", - "connect-src": "ipc: https://ipc.localhost", + "connect-src": "ipc: http://ipc.localhost", "font-src": [ "https://fonts.gstatic.com" ], - "img-src": "'self' asset: https://asset.localhost blob: data:", + "img-src": "'self' asset: http://asset.localhost blob: data:", "style-src": "'unsafe-inline' 'self' https://fonts.googleapis.com" }, "freezePrototype": true, @@ -114,4 +114,4 @@ } } } -} +} \ No newline at end of file diff --git a/examples/commands/tauri.conf.json b/examples/commands/tauri.conf.json index e618bd5472ab..223643a7e16c 100644 --- a/examples/commands/tauri.conf.json +++ b/examples/commands/tauri.conf.json @@ -51,7 +51,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/helloworld/tauri.conf.json b/examples/helloworld/tauri.conf.json index 47869b636288..b9cafb3ea9fe 100644 --- a/examples/helloworld/tauri.conf.json +++ b/examples/helloworld/tauri.conf.json @@ -50,7 +50,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/isolation/tauri.conf.json b/examples/isolation/tauri.conf.json index 4187fb3c6036..6da027907089 100644 --- a/examples/isolation/tauri.conf.json +++ b/examples/isolation/tauri.conf.json @@ -60,7 +60,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/multiwindow/tauri.conf.json b/examples/multiwindow/tauri.conf.json index 533ea9af644d..607aea31d9c0 100644 --- a/examples/multiwindow/tauri.conf.json +++ b/examples/multiwindow/tauri.conf.json @@ -47,7 +47,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/navigation/tauri.conf.json b/examples/navigation/tauri.conf.json index c8a352404028..82e00b902a3f 100644 --- a/examples/navigation/tauri.conf.json +++ b/examples/navigation/tauri.conf.json @@ -47,7 +47,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/parent-window/tauri.conf.json b/examples/parent-window/tauri.conf.json index b19c511f00c6..c0f698b0e303 100644 --- a/examples/parent-window/tauri.conf.json +++ b/examples/parent-window/tauri.conf.json @@ -31,7 +31,7 @@ "category": "DeveloperTool" }, "security": { - "csp": "default-src 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/resources/src-tauri/tauri.conf.json b/examples/resources/src-tauri/tauri.conf.json index 85777f4273a3..be4e9d98b21f 100644 --- a/examples/resources/src-tauri/tauri.conf.json +++ b/examples/resources/src-tauri/tauri.conf.json @@ -53,7 +53,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/splashscreen/tauri.conf.json b/examples/splashscreen/tauri.conf.json index 69b17a36e3a3..1429e78d1e2f 100644 --- a/examples/splashscreen/tauri.conf.json +++ b/examples/splashscreen/tauri.conf.json @@ -44,7 +44,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/state/tauri.conf.json b/examples/state/tauri.conf.json index d09175aaeb50..06018b37aa60 100644 --- a/examples/state/tauri.conf.json +++ b/examples/state/tauri.conf.json @@ -51,7 +51,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/streaming/tauri.conf.json b/examples/streaming/tauri.conf.json index 970f5760ebd5..78f315249107 100644 --- a/examples/streaming/tauri.conf.json +++ b/examples/streaming/tauri.conf.json @@ -1,8 +1,12 @@ { "$schema": "../../core/tauri-config-schema/schema.json", "build": { - "distDir": ["index.html"], - "devPath": ["index.html"], + "distDir": [ + "index.html" + ], + "devPath": [ + "index.html" + ], "beforeDevCommand": "", "beforeBuildCommand": "", "withGlobalTauri": true @@ -47,10 +51,12 @@ } ], "security": { - "csp": "default-src 'self' ipc:; media-src stream: https://stream.localhost asset: https://asset.localhost", + "csp": "default-src 'self' ipc:; media-src stream: http://stream.localhost asset: http://asset.localhost", "assetProtocol": { - "scope": ["**/test_video.mp4"] + "scope": [ + "**/test_video.mp4" + ] } } } -} +} \ No newline at end of file diff --git a/examples/tauri-dynamic-lib/src-tauri/tauri.conf.json b/examples/tauri-dynamic-lib/src-tauri/tauri.conf.json index a7d9b6a090d7..0f597d700571 100644 --- a/examples/tauri-dynamic-lib/src-tauri/tauri.conf.json +++ b/examples/tauri-dynamic-lib/src-tauri/tauri.conf.json @@ -50,7 +50,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/tooling/api/CHANGELOG.md b/tooling/api/CHANGELOG.md index d94f5664e3b5..fab4e51b659d 100644 --- a/tooling/api/CHANGELOG.md +++ b/tooling/api/CHANGELOG.md @@ -281,7 +281,7 @@ ## \[1.0.0-beta.7] -- Fix missing asset protocol path.Now the protocol is `https://asset.localhost/path/to/file` on Windows. Linux and macOS +- Fix missing asset protocol path.Now the protocol is `http://asset.localhost/path/to/file` on Windows. Linux and macOS is still `asset://path/to/file`. - [994b5325](https://www.github.com/tauri-apps/tauri/commit/994b5325dd385f564b37fe1530c5d798dc925fff) fix: missing asset protocol path ([#2484](https://www.github.com/tauri-apps/tauri/pull/2484)) on 2021-08-23 diff --git a/tooling/api/docs/js-api.json b/tooling/api/docs/js-api.json index 8429ed2cd95c..04ceade5b332 100644 --- a/tooling/api/docs/js-api.json +++ b/tooling/api/docs/js-api.json @@ -1 +1,8032 @@ -{"id":0,"name":"@tauri-apps/api","variant":"project","kind":1,"flags":{},"children":[{"id":1,"name":"event","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"The event system allows you to emit events to the backend and listen to events from it.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.event`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":36,"name":"TauriEvent","variant":"declaration","kind":8,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"children":[{"id":49,"name":"MENU","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":59,"character":2}],"type":{"type":"literal","value":"tauri://menu"}},{"id":43,"name":"WINDOW_BLUR","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":53,"character":2}],"type":{"type":"literal","value":"tauri://blur"}},{"id":39,"name":"WINDOW_CLOSE_REQUESTED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":49,"character":2}],"type":{"type":"literal","value":"tauri://close-requested"}},{"id":40,"name":"WINDOW_CREATED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":50,"character":2}],"type":{"type":"literal","value":"tauri://window-created"}},{"id":41,"name":"WINDOW_DESTROYED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":51,"character":2}],"type":{"type":"literal","value":"tauri://destroyed"}},{"id":46,"name":"WINDOW_FILE_DROP","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":56,"character":2}],"type":{"type":"literal","value":"tauri://file-drop"}},{"id":48,"name":"WINDOW_FILE_DROP_CANCELLED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":58,"character":2}],"type":{"type":"literal","value":"tauri://file-drop-cancelled"}},{"id":47,"name":"WINDOW_FILE_DROP_HOVER","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":57,"character":2}],"type":{"type":"literal","value":"tauri://file-drop-hover"}},{"id":42,"name":"WINDOW_FOCUS","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":52,"character":2}],"type":{"type":"literal","value":"tauri://focus"}},{"id":38,"name":"WINDOW_MOVED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":48,"character":2}],"type":{"type":"literal","value":"tauri://move"}},{"id":37,"name":"WINDOW_RESIZED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":47,"character":2}],"type":{"type":"literal","value":"tauri://resize"}},{"id":44,"name":"WINDOW_SCALE_FACTOR_CHANGED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":54,"character":2}],"type":{"type":"literal","value":"tauri://scale-change"}},{"id":45,"name":"WINDOW_THEME_CHANGED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":55,"character":2}],"type":{"type":"literal","value":"tauri://theme-changed"}}],"groups":[{"title":"Enumeration Members","children":[49,43,39,40,41,46,48,47,42,38,37,44,45]}],"sources":[{"fileName":"event.ts","line":46,"character":5}]},{"id":2,"name":"Event","variant":"declaration","kind":256,"flags":{},"children":[{"id":3,"name":"event","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name"}]},"sources":[{"fileName":"event.ts","line":16,"character":2}],"type":{"type":"reference","target":16,"name":"EventName","package":"@tauri-apps/api"}},{"id":5,"name":"id","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event identifier used to unlisten"}]},"sources":[{"fileName":"event.ts","line":20,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":6,"name":"payload","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event payload"}]},"sources":[{"fileName":"event.ts","line":22,"character":2}],"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}},{"id":4,"name":"windowLabel","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The label of the window that emitted this event."}]},"sources":[{"fileName":"event.ts","line":18,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[3,5,6,4]}],"sources":[{"fileName":"event.ts","line":14,"character":10}],"typeParameters":[{"id":7,"name":"T","variant":"typeParam","kind":131072,"flags":{}}]},{"id":17,"name":"Options","variant":"declaration","kind":256,"flags":{},"children":[{"id":18,"name":"target","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label of the window the function targets.\n\nWhen listening to events and using this value,\nonly events triggered by the window with the given label are received.\n\nWhen emitting events, only the window with the given label will receive it."}]},"sources":[{"fileName":"event.ts","line":40,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[18]}],"sources":[{"fileName":"event.ts","line":31,"character":10}]},{"id":8,"name":"EventCallback","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"event.ts","line":25,"character":5}],"typeParameters":[{"id":12,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":9,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"event.ts","line":25,"character":24}],"signatures":[{"id":10,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":11,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Event","package":"@tauri-apps/api"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":16,"name":"EventName","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"event.ts","line":29,"character":5}],"type":{"type":"union","types":[{"type":"templateLiteral","head":"","tail":[[{"type":"reference","target":36,"name":"TauriEvent","package":"@tauri-apps/api"},""]]},{"type":"intersection","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"never"},{"type":"intrinsic","name":"never"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}]}]}},{"id":13,"name":"UnlistenFn","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"event.ts","line":27,"character":5}],"type":{"type":"reflection","declaration":{"id":14,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"event.ts","line":27,"character":18}],"signatures":[{"id":15,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":31,"name":"emit","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":164,"character":15}],"signatures":[{"id":32,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Emits an event to the backend and all Tauri windows."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { emit } from '@tauri-apps/api/event';\nawait emit('frontend-loaded', { loggedIn: true, token: 'authToken' });\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":164,"character":0}],"parameters":[{"id":33,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":34,"name":"payload","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}},{"id":35,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":17,"name":"Options","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":19,"name":"listen","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":99,"character":15}],"signatures":[{"id":20,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an event. The event can be either global or window-specific.\nSee "},{"kind":"inline-tag","tag":"@link","text":"windowLabel","target":4,"tsLinkText":""},{"kind":"text","text":" to check the event source."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { listen } from '@tauri-apps/api/event';\nconst unlisten = await listen('error', (event) => {\n console.log(`Got error in window ${event.windowLabel}, payload: ${event.payload}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":99,"character":0}],"typeParameter":[{"id":21,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":22,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"reference","target":16,"name":"EventName","package":"@tauri-apps/api"}},{"id":23,"name":"handler","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler callback."}]},"type":{"type":"reference","target":8,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"EventCallback","package":"@tauri-apps/api"}},{"id":24,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":17,"name":"Options","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":13,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":25,"name":"once","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":137,"character":15}],"signatures":[{"id":26,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an one-off event. See "},{"kind":"inline-tag","tag":"@link","text":"listen","target":19,"tsLinkText":""},{"kind":"text","text":" for more information."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { once } from '@tauri-apps/api/event';\ninterface LoadedPayload {\n loggedIn: boolean,\n token: string\n}\nconst unlisten = await once('loaded', (event) => {\n console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":137,"character":0}],"typeParameter":[{"id":27,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":28,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"reference","target":16,"name":"EventName","package":"@tauri-apps/api"}},{"id":29,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":8,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"EventCallback","package":"@tauri-apps/api"}},{"id":30,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":17,"name":"Options","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":13,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Enumerations","children":[36]},{"title":"Interfaces","children":[2,17]},{"title":"Type Aliases","children":[8,16,13]},{"title":"Functions","children":[31,19,25]}],"sources":[{"fileName":"event.ts","line":1,"character":0}]},{"id":50,"name":"mocks","variant":"declaration","kind":2,"flags":{},"children":[{"id":62,"name":"clearMocks","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":178,"character":16}],"signatures":[{"id":63,"name":"clearMocks","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clears mocked functions/data injected by the other functions in this module.\nWhen using a test runner that doesn't provide a fresh window object for each test, calling this function will reset tauri specific properties.\n\n# Example\n\n"},{"kind":"code","text":"```js\nimport { mockWindows, clearMocks } from \"@tauri-apps/api/mocks\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked windows\", () => {\n mockWindows(\"main\", \"second\", \"third\");\n\n expect(window).toHaveProperty(\"__TAURI_METADATA__\")\n})\n\ntest(\"no mocked windows\", () => {\n expect(window).not.toHaveProperty(\"__TAURI_METADATA__\")\n})\n```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":178,"character":0}],"type":{"type":"intrinsic","name":"void"}}]},{"id":51,"name":"mockIPC","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":80,"character":16}],"signatures":[{"id":52,"name":"mockIPC","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Intercepts all IPC requests with the given mock handler.\n\nThis function can be used when testing tauri frontend applications or when running the frontend in a Node.js context during static site generation.\n\n# Examples\n\nTesting setup using vitest:\n"},{"kind":"code","text":"```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, payload) => {\n switch (cmd) {\n case \"add\":\n return (payload.a as number) + (payload.b as number);\n default:\n break;\n }\n });\n\n expect(invoke('add', { a: 12, b: 15 })).resolves.toBe(27);\n})\n```"},{"kind":"text","text":"\n\nThe callback function can also return a Promise:\n"},{"kind":"code","text":"```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, payload) => {\n if(cmd === \"get_data\") {\n return fetch(\"https://example.com/data.json\")\n .then((response) => response.json())\n }\n });\n\n expect(invoke('get_data')).resolves.toBe({ foo: 'bar' });\n})\n```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":80,"character":0}],"parameters":[{"id":53,"name":"cb","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":54,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"mocks.ts","line":81,"character":6}],"signatures":[{"id":55,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"mocks.ts","line":81,"character":6}],"parameters":[{"id":56,"name":"cmd","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":57,"name":"payload","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}}],"type":{"type":"intrinsic","name":"any"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":58,"name":"mockWindows","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":142,"character":16}],"signatures":[{"id":59,"name":"mockWindows","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mocks one or many window labels.\nIn non-tauri context it is required to call this function *before* using the "},{"kind":"code","text":"`@tauri-apps/api/window`"},{"kind":"text","text":" module.\n\nThis function only mocks the *presence* of windows,\nwindow properties (e.g. width and height) can be mocked like regular IPC calls using the "},{"kind":"code","text":"`mockIPC`"},{"kind":"text","text":" function.\n\n# Examples\n\n"},{"kind":"code","text":"```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\nimport { getCurrent } from \"@tauri-apps/api/window\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nconst win = getCurrent();\n\nwin.label // \"main\"\n```"},{"kind":"text","text":"\n\n"},{"kind":"code","text":"```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nmockIPC((cmd, args) => {\n if (cmd === \"plugin:event|emit\") {\n console.log('emit event', args?.event, args?.payload);\n }\n});\n\nconst { emit } = await import(\"@tauri-apps/api/event\");\nawait emit('loaded'); // this will cause the mocked IPC handler to log to the console.\n```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":142,"character":0}],"parameters":[{"id":60,"name":"current","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label of window this JavaScript context is running in."}]},"type":{"type":"intrinsic","name":"string"}},{"id":61,"name":"additionalWindows","variant":"param","kind":32768,"flags":{"isRest":true},"comment":{"summary":[{"kind":"text","text":"Label of additional windows the app has."}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Functions","children":[62,51,58]}],"sources":[{"fileName":"mocks.ts","line":1,"character":0}]},{"id":64,"name":"path","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"The path module provides utilities for working with file and directory paths.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.path`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":65,"name":"BaseDirectory","variant":"declaration","kind":8,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"children":[{"id":81,"name":"AppCache","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":35,"character":2}],"type":{"type":"literal","value":16}},{"id":78,"name":"AppConfig","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":32,"character":2}],"type":{"type":"literal","value":13}},{"id":79,"name":"AppData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":33,"character":2}],"type":{"type":"literal","value":14}},{"id":80,"name":"AppLocalData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":34,"character":2}],"type":{"type":"literal","value":15}},{"id":82,"name":"AppLog","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":36,"character":2}],"type":{"type":"literal","value":17}},{"id":66,"name":"Audio","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":20,"character":2}],"type":{"type":"literal","value":1}},{"id":67,"name":"Cache","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":21,"character":2}],"type":{"type":"literal","value":2}},{"id":68,"name":"Config","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":22,"character":2}],"type":{"type":"literal","value":3}},{"id":69,"name":"Data","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":23,"character":2}],"type":{"type":"literal","value":4}},{"id":83,"name":"Desktop","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":38,"character":2}],"type":{"type":"literal","value":18}},{"id":71,"name":"Document","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":25,"character":2}],"type":{"type":"literal","value":6}},{"id":72,"name":"Download","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":26,"character":2}],"type":{"type":"literal","value":7}},{"id":84,"name":"Executable","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":39,"character":2}],"type":{"type":"literal","value":19}},{"id":85,"name":"Font","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":40,"character":2}],"type":{"type":"literal","value":20}},{"id":86,"name":"Home","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":41,"character":2}],"type":{"type":"literal","value":21}},{"id":70,"name":"LocalData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":24,"character":2}],"type":{"type":"literal","value":5}},{"id":73,"name":"Picture","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":27,"character":2}],"type":{"type":"literal","value":8}},{"id":74,"name":"Public","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":28,"character":2}],"type":{"type":"literal","value":9}},{"id":76,"name":"Resource","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":30,"character":2}],"type":{"type":"literal","value":11}},{"id":87,"name":"Runtime","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":42,"character":2}],"type":{"type":"literal","value":22}},{"id":77,"name":"Temp","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":31,"character":2}],"type":{"type":"literal","value":12}},{"id":88,"name":"Template","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":43,"character":2}],"type":{"type":"literal","value":23}},{"id":75,"name":"Video","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":29,"character":2}],"type":{"type":"literal","value":10}}],"groups":[{"title":"Enumeration Members","children":[81,78,79,80,82,66,67,68,69,83,71,72,84,85,86,70,73,74,76,87,77,88,75]}],"sources":[{"fileName":"path.ts","line":19,"character":5}]},{"id":95,"name":"appCacheDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":108,"character":15}],"signatures":[{"id":96,"name":"appCacheDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's cache files.\nResolves to "},{"kind":"code","text":"`${cacheDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appCacheDir } from '@tauri-apps/api/path';\nconst appCacheDirPath = await appCacheDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":108,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":89,"name":"appConfigDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":57,"character":15}],"signatures":[{"id":90,"name":"appConfigDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's config files.\nResolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appConfigDir } from '@tauri-apps/api/path';\nconst appConfigDirPath = await appConfigDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":57,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":91,"name":"appDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":74,"character":15}],"signatures":[{"id":92,"name":"appDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's data files.\nResolves to "},{"kind":"code","text":"`${dataDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":74,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":93,"name":"appLocalDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":91,"character":15}],"signatures":[{"id":94,"name":"appLocalDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's local data files.\nResolves to "},{"kind":"code","text":"`${localDataDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appLocalDataDir } from '@tauri-apps/api/path';\nconst appLocalDataDirPath = await appLocalDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":91,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":97,"name":"appLogDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":520,"character":15}],"signatures":[{"id":98,"name":"appLogDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's log files.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}/logs`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`${homeDir}/Library/Logs/{bundleIdentifier}`"},{"kind":"text","text":"\n- **Windows:** Resolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}/logs`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appLogDir } from '@tauri-apps/api/path';\nconst appLogDirPath = await appLogDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":520,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":99,"name":"audioDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":130,"character":15}],"signatures":[{"id":100,"name":"audioDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's audio directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_MUSIC_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Music`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Music}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { audioDir } from '@tauri-apps/api/path';\nconst audioDirPath = await audioDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":130,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":155,"name":"basename","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":653,"character":15}],"signatures":[{"id":156,"name":"basename","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the last portion of a "},{"kind":"code","text":"`path`"},{"kind":"text","text":". Trailing directory separators are ignored."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { basename, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst base = await basename(resourcePath);\nassert(base === 'app.conf');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":653,"character":0}],"parameters":[{"id":157,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":158,"name":"ext","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional file extension to be removed from the returned path."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":101,"name":"cacheDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":152,"character":15}],"signatures":[{"id":102,"name":"cacheDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's cache directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_CACHE_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.cache`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Caches`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_LocalAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { cacheDir } from '@tauri-apps/api/path';\nconst cacheDirPath = await cacheDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":152,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":103,"name":"configDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":174,"character":15}],"signatures":[{"id":104,"name":"configDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's config directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_CONFIG_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.config`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_RoamingAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { configDir } from '@tauri-apps/api/path';\nconst configDirPath = await configDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":174,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":105,"name":"dataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":196,"character":15}],"signatures":[{"id":106,"name":"dataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_RoamingAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { dataDir } from '@tauri-apps/api/path';\nconst dataDirPath = await dataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":196,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":138,"name":"delimiter","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":560,"character":9}],"signatures":[{"id":139,"name":"delimiter","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the platform-specific path segment delimiter:\n- "},{"kind":"code","text":"`;`"},{"kind":"text","text":" on Windows\n- "},{"kind":"code","text":"`:`"},{"kind":"text","text":" on POSIX"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"sources":[{"fileName":"path.ts","line":560,"character":0}],"type":{"type":"intrinsic","name":"string"}}]},{"id":107,"name":"desktopDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":218,"character":15}],"signatures":[{"id":108,"name":"desktopDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's desktop directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DESKTOP_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Desktop`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Desktop}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { desktopDir } from '@tauri-apps/api/path';\nconst desktopPath = await desktopDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":218,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":149,"name":"dirname","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":619,"character":15}],"signatures":[{"id":150,"name":"dirname","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the directory name of a "},{"kind":"code","text":"`path`"},{"kind":"text","text":". Trailing directory separators are ignored."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { dirname, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst dir = await dirname(appDataDirPath);\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":619,"character":0}],"parameters":[{"id":151,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":109,"name":"documentDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":240,"character":15}],"signatures":[{"id":110,"name":"documentDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's document directory."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { documentDir } from '@tauri-apps/api/path';\nconst documentDirPath = await documentDir();\n```"},{"kind":"text","text":"\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DOCUMENTS_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Documents`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Documents}`"},{"kind":"text","text":"."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":240,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":111,"name":"downloadDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":262,"character":15}],"signatures":[{"id":112,"name":"downloadDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's download directory.\n\n#### Platform-specific\n\n- **Linux**: Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DOWNLOAD_DIR`"},{"kind":"text","text":".\n- **macOS**: Resolves to "},{"kind":"code","text":"`$HOME/Downloads`"},{"kind":"text","text":".\n- **Windows**: Resolves to "},{"kind":"code","text":"`{FOLDERID_Downloads}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { downloadDir } from '@tauri-apps/api/path';\nconst downloadDirPath = await downloadDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":262,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":113,"name":"executableDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":284,"character":15}],"signatures":[{"id":114,"name":"executableDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's executable directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_BIN_HOME/../bin`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$XDG_DATA_HOME/../bin`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/bin`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { executableDir } from '@tauri-apps/api/path';\nconst executableDirPath = await executableDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":284,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":152,"name":"extname","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":635,"character":15}],"signatures":[{"id":153,"name":"extname","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the extension of the "},{"kind":"code","text":"`path`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { extname, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst ext = await extname(resourcePath);\nassert(ext === 'conf');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":635,"character":0}],"parameters":[{"id":154,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":115,"name":"fontDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":306,"character":15}],"signatures":[{"id":116,"name":"fontDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's font directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME/fonts`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share/fonts`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Fonts`"},{"kind":"text","text":".\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { fontDir } from '@tauri-apps/api/path';\nconst fontDirPath = await fontDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":306,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":117,"name":"homeDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":328,"character":15}],"signatures":[{"id":118,"name":"homeDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's home directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$HOME`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Profile}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { homeDir } from '@tauri-apps/api/path';\nconst homeDirPath = await homeDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":328,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":159,"name":"isAbsolute","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":667,"character":15}],"signatures":[{"id":160,"name":"isAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns whether the path is absolute or not."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { isAbsolute } from '@tauri-apps/api/path';\nassert(await isAbsolute('/home/tauri'));\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":667,"character":0}],"parameters":[{"id":161,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":146,"name":"join","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":604,"character":15}],"signatures":[{"id":147,"name":"join","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Joins all given "},{"kind":"code","text":"`path`"},{"kind":"text","text":" segments together using the platform-specific separator as a delimiter, then normalizes the resulting path."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { join, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await join(appDataDirPath, 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":604,"character":0}],"parameters":[{"id":148,"name":"paths","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":119,"name":"localDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":350,"character":15}],"signatures":[{"id":120,"name":"localDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's local data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_LocalAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { localDataDir } from '@tauri-apps/api/path';\nconst localDataDirPath = await localDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":350,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":143,"name":"normalize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":589,"character":15}],"signatures":[{"id":144,"name":"normalize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Normalizes the given "},{"kind":"code","text":"`path`"},{"kind":"text","text":", resolving "},{"kind":"code","text":"`'..'`"},{"kind":"text","text":" and "},{"kind":"code","text":"`'.'`"},{"kind":"text","text":" segments and resolve symbolic links."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { normalize, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await normalize(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":589,"character":0}],"parameters":[{"id":145,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":121,"name":"pictureDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":372,"character":15}],"signatures":[{"id":122,"name":"pictureDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's picture directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_PICTURES_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Pictures`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Pictures}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { pictureDir } from '@tauri-apps/api/path';\nconst pictureDirPath = await pictureDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":372,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":123,"name":"publicDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":394,"character":15}],"signatures":[{"id":124,"name":"publicDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's public directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_PUBLICSHARE_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Public`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Public}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { publicDir } from '@tauri-apps/api/path';\nconst publicDirPath = await publicDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":394,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":140,"name":"resolve","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":574,"character":15}],"signatures":[{"id":141,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolves a sequence of "},{"kind":"code","text":"`paths`"},{"kind":"text","text":" or "},{"kind":"code","text":"`path`"},{"kind":"text","text":" segments into an absolute path."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resolve, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await resolve(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":574,"character":0}],"parameters":[{"id":142,"name":"paths","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":127,"name":"resolveResource","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":431,"character":15}],"signatures":[{"id":128,"name":"resolveResource","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the path to a resource file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('script.sh');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The full path to the resource."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":431,"character":0}],"parameters":[{"id":129,"name":"resourcePath","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The path to the resource.\nMust follow the same syntax as defined in "},{"kind":"code","text":"`tauri.conf.json > tauri > bundle > resources`"},{"kind":"text","text":", i.e. keeping subfolders and parent dir components ("},{"kind":"code","text":"`../`"},{"kind":"text","text":")."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":125,"name":"resourceDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":411,"character":15}],"signatures":[{"id":126,"name":"resourceDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the application's resource directory.\nTo resolve a resource path, see the [[resolveResource | "},{"kind":"code","text":"`resolveResource API`"},{"kind":"text","text":"]]."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resourceDir } from '@tauri-apps/api/path';\nconst resourceDirPath = await resourceDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":411,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":130,"name":"runtimeDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":454,"character":15}],"signatures":[{"id":131,"name":"runtimeDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's runtime directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_RUNTIME_DIR`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { runtimeDir } from '@tauri-apps/api/path';\nconst runtimeDirPath = await runtimeDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":454,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":136,"name":"sep","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":549,"character":9}],"signatures":[{"id":137,"name":"sep","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the platform-specific path segment separator:\n- "},{"kind":"code","text":"`\\` on Windows\n- `"},{"kind":"text","text":"/` on POSIX"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"sources":[{"fileName":"path.ts","line":549,"character":0}],"type":{"type":"intrinsic","name":"string"}}]},{"id":162,"name":"tempDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":536,"character":15}],"signatures":[{"id":163,"name":"tempDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a temporary directory."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { tempDir } from '@tauri-apps/api/path';\nconst temp = await tempDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"sources":[{"fileName":"path.ts","line":536,"character":0}],"parameters":[{"id":164,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":132,"name":"templateDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":476,"character":15}],"signatures":[{"id":133,"name":"templateDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's template directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_TEMPLATES_DIR`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Templates}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { templateDir } from '@tauri-apps/api/path';\nconst templateDirPath = await templateDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":476,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":134,"name":"videoDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":498,"character":15}],"signatures":[{"id":135,"name":"videoDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's video directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_VIDEOS_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Movies`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Videos}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { videoDir } from '@tauri-apps/api/path';\nconst videoDirPath = await videoDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":498,"character":0}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Enumerations","children":[65]},{"title":"Functions","children":[95,89,91,93,97,99,155,101,103,105,138,107,149,109,111,113,152,115,117,159,146,119,143,121,123,140,127,125,130,136,162,132,134]}],"sources":[{"fileName":"path.ts","line":1,"character":0}]},{"id":165,"name":"tauri","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Invoke your custom commands.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.tauri`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":176,"name":"Channel","variant":"declaration","kind":128,"flags":{},"children":[{"id":177,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"tauri.ts","line":71,"character":2}],"signatures":[{"id":178,"name":"new Channel","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"tauri.ts","line":71,"character":2}],"typeParameter":[{"id":179,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":176,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Channel","package":"@tauri-apps/api"}}]},{"id":182,"name":"#onmessage","variant":"declaration","kind":1024,"flags":{"isPrivate":true},"sources":[{"fileName":"tauri.ts","line":67,"character":2}],"type":{"type":"reflection","declaration":{"id":183,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":67,"character":14}],"signatures":[{"id":184,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":67,"character":14}],"parameters":[{"id":185,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"defaultValue":"..."},{"id":181,"name":"__TAURI_CHANNEL_MARKER__","variant":"declaration","kind":1024,"flags":{"isPrivate":true,"isReadonly":true},"sources":[{"fileName":"tauri.ts","line":66,"character":19}],"type":{"type":"literal","value":true},"defaultValue":"true"},{"id":180,"name":"id","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":64,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":186,"name":"onmessage","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"tauri.ts","line":77,"character":6},{"fileName":"tauri.ts","line":81,"character":6}],"getSignature":{"id":187,"name":"onmessage","variant":"signature","kind":524288,"flags":{},"sources":[{"fileName":"tauri.ts","line":81,"character":2}],"type":{"type":"reflection","declaration":{"id":188,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":81,"character":19}],"signatures":[{"id":189,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":81,"character":19}],"parameters":[{"id":190,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}}},"setSignature":{"id":191,"name":"onmessage","variant":"signature","kind":1048576,"flags":{},"sources":[{"fileName":"tauri.ts","line":77,"character":2}],"parameters":[{"id":192,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":193,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":77,"character":25}],"signatures":[{"id":194,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":77,"character":25}],"parameters":[{"id":195,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"}}},{"id":196,"name":"toJSON","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"tauri.ts","line":85,"character":2}],"signatures":[{"id":197,"name":"toJSON","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":85,"character":2}],"type":{"type":"intrinsic","name":"string"}}]}],"groups":[{"title":"Constructors","children":[177]},{"title":"Properties","children":[182,181,180]},{"title":"Accessors","children":[186]},{"title":"Methods","children":[196]}],"sources":[{"fileName":"tauri.ts","line":63,"character":6}],"typeParameters":[{"id":198,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}]},{"id":199,"name":"PluginListener","variant":"declaration","kind":128,"flags":{},"children":[{"id":200,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"tauri.ts","line":95,"character":2}],"signatures":[{"id":201,"name":"new PluginListener","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"tauri.ts","line":95,"character":2}],"parameters":[{"id":202,"name":"plugin","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":203,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":204,"name":"channelId","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":199,"name":"PluginListener","package":"@tauri-apps/api"}}]},{"id":207,"name":"channelId","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":93,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":206,"name":"event","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":92,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":205,"name":"plugin","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":91,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":208,"name":"unregister","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"tauri.ts","line":101,"character":8}],"signatures":[{"id":209,"name":"unregister","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":101,"character":2}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Constructors","children":[200]},{"title":"Properties","children":[207,206,205]},{"title":"Methods","children":[208]}],"sources":[{"fileName":"tauri.ts","line":90,"character":6}]},{"id":167,"name":"InvokeOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"children":[{"id":168,"name":"headers","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":139,"character":2}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.dom.d.ts","qualifiedName":"Headers"},"name":"Headers","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/API/Headers"}]}}],"groups":[{"title":"Properties","children":[168]}],"sources":[{"fileName":"tauri.ts","line":138,"character":10}]},{"id":166,"name":"InvokeArgs","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[{"kind":"text","text":"Command arguments."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":133,"character":5}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"},{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"ArrayBuffer"},"name":"ArrayBuffer","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Uint8Array"},"name":"Uint8Array","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array"}]}},{"id":210,"name":"addPluginListener","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":116,"character":15}],"signatures":[{"id":211,"name":"addPluginListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds a listener to a plugin event."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The listener object to stop listening to the events."}]},{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":116,"character":0}],"typeParameter":[{"id":212,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":213,"name":"plugin","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":214,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":215,"name":"cb","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":216,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":119,"character":6}],"signatures":[{"id":217,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":119,"character":6}],"parameters":[{"id":218,"name":"payload","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":199,"name":"PluginListener","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":225,"name":"convertFileSrc","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":212,"character":9}],"signatures":[{"id":226,"name":"convertFileSrc","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a device file path to an URL that can be loaded by the webview.\nNote that "},{"kind":"code","text":"`asset:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`https://asset.localhost`"},{"kind":"text","text":" must be added to ["},{"kind":"code","text":"`tauri.security.csp`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#securityconfig.csp) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":".\nExample CSP value: "},{"kind":"code","text":"`\"csp\": \"default-src 'self' ipc: https://ipc.localhost; img-src 'self' asset: https://asset.localhost\"`"},{"kind":"text","text":" to use the asset protocol on image sources.\n\nAdditionally, "},{"kind":"code","text":"`asset`"},{"kind":"text","text":" must be added to ["},{"kind":"code","text":"`tauri.allowlist.protocol`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.protocol)\nin "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" and its access scope must be defined on the "},{"kind":"code","text":"`assetScope`"},{"kind":"text","text":" array on the same "},{"kind":"code","text":"`protocol`"},{"kind":"text","text":" object."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appDataDir, join } from '@tauri-apps/api/path';\nimport { convertFileSrc } from '@tauri-apps/api/tauri';\nconst appDataDirPath = await appDataDir();\nconst filePath = await join(appDataDirPath, 'assets/video.mp4');\nconst assetUrl = convertFileSrc(filePath);\n\nconst video = document.getElementById('my-video');\nconst source = document.createElement('source');\nsource.type = 'video/mp4';\nsource.src = assetUrl;\nvideo.appendChild(source);\nvideo.load();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"the URL that can be used as source on the webview."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":212,"character":0}],"parameters":[{"id":227,"name":"filePath","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The file path."}]},"type":{"type":"intrinsic","name":"string"}},{"id":228,"name":"protocol","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The protocol to use. Defaults to "},{"kind":"code","text":"`asset`"},{"kind":"text","text":". You only need to set this when using a custom protocol."}]},"type":{"type":"intrinsic","name":"string"},"defaultValue":"'asset'"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":219,"name":"invoke","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":157,"character":15}],"signatures":[{"id":220,"name":"invoke","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sends a message to the backend."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { invoke } from '@tauri-apps/api/tauri';\nawait invoke('login', { user: 'tauri', password: 'poiwe3h4r5ip3yrhtew9ty' });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving or rejecting to the backend response."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":157,"character":0}],"typeParameter":[{"id":221,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":222,"name":"cmd","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The command name."}]},"type":{"type":"intrinsic","name":"string"}},{"id":223,"name":"args","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The optional arguments to pass to the command."}]},"type":{"type":"reference","target":166,"name":"InvokeArgs","package":"@tauri-apps/api"},"defaultValue":"{}"},{"id":224,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The request options."}]},"type":{"type":"reference","target":167,"name":"InvokeOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":169,"name":"transformCallback","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":41,"character":9}],"signatures":[{"id":170,"name":"transformCallback","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Transforms a callback function to a string identifier that can be passed to the backend.\nThe backend uses the identifier to "},{"kind":"code","text":"`eval()`"},{"kind":"text","text":" the callback."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A unique identifier associated with the callback function."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":41,"character":0}],"parameters":[{"id":171,"name":"callback","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":172,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":42,"character":13}],"signatures":[{"id":173,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":42,"character":13}],"parameters":[{"id":174,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":175,"name":"once","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"number"}}]}],"groups":[{"title":"Classes","children":[176,199]},{"title":"Interfaces","children":[167]},{"title":"Type Aliases","children":[166]},{"title":"Functions","children":[210,225,219,169]}],"sources":[{"fileName":"tauri.ts","line":1,"character":0}]}],"groups":[{"title":"Modules","children":[1,50,64,165]}],"packageName":"@tauri-apps/api","symbolIdMap":{"1":{"sourceFileName":"src/event.ts","qualifiedName":""},"2":{"sourceFileName":"src/event.ts","qualifiedName":"Event"},"3":{"sourceFileName":"src/event.ts","qualifiedName":"Event.event"},"4":{"sourceFileName":"src/event.ts","qualifiedName":"Event.windowLabel"},"5":{"sourceFileName":"src/event.ts","qualifiedName":"Event.id"},"6":{"sourceFileName":"src/event.ts","qualifiedName":"Event.payload"},"7":{"sourceFileName":"src/event.ts","qualifiedName":"Event.T"},"8":{"sourceFileName":"src/event.ts","qualifiedName":"EventCallback"},"9":{"sourceFileName":"src/event.ts","qualifiedName":"__type"},"10":{"sourceFileName":"src/event.ts","qualifiedName":"__type"},"11":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"12":{"sourceFileName":"src/event.ts","qualifiedName":"T"},"13":{"sourceFileName":"src/event.ts","qualifiedName":"UnlistenFn"},"14":{"sourceFileName":"src/event.ts","qualifiedName":"__type"},"15":{"sourceFileName":"src/event.ts","qualifiedName":"__type"},"16":{"sourceFileName":"src/event.ts","qualifiedName":"EventName"},"17":{"sourceFileName":"src/event.ts","qualifiedName":"Options"},"18":{"sourceFileName":"src/event.ts","qualifiedName":"Options.target"},"19":{"sourceFileName":"src/event.ts","qualifiedName":"listen"},"20":{"sourceFileName":"src/event.ts","qualifiedName":"listen"},"21":{"sourceFileName":"src/event.ts","qualifiedName":"T"},"22":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"23":{"sourceFileName":"src/event.ts","qualifiedName":"handler"},"24":{"sourceFileName":"src/event.ts","qualifiedName":"options"},"25":{"sourceFileName":"src/event.ts","qualifiedName":"once"},"26":{"sourceFileName":"src/event.ts","qualifiedName":"once"},"27":{"sourceFileName":"src/event.ts","qualifiedName":"T"},"28":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"29":{"sourceFileName":"src/event.ts","qualifiedName":"handler"},"30":{"sourceFileName":"src/event.ts","qualifiedName":"options"},"31":{"sourceFileName":"src/event.ts","qualifiedName":"emit"},"32":{"sourceFileName":"src/event.ts","qualifiedName":"emit"},"33":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"34":{"sourceFileName":"src/event.ts","qualifiedName":"payload"},"35":{"sourceFileName":"src/event.ts","qualifiedName":"options"},"36":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent"},"37":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_RESIZED"},"38":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_MOVED"},"39":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_CLOSE_REQUESTED"},"40":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_CREATED"},"41":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_DESTROYED"},"42":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FOCUS"},"43":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_BLUR"},"44":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_SCALE_FACTOR_CHANGED"},"45":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_THEME_CHANGED"},"46":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP"},"47":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP_HOVER"},"48":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP_CANCELLED"},"49":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.MENU"},"50":{"sourceFileName":"src/mocks.ts","qualifiedName":""},"51":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockIPC"},"52":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockIPC"},"53":{"sourceFileName":"src/mocks.ts","qualifiedName":"cb"},"54":{"sourceFileName":"src/mocks.ts","qualifiedName":"__type"},"55":{"sourceFileName":"src/mocks.ts","qualifiedName":"__type"},"56":{"sourceFileName":"src/mocks.ts","qualifiedName":"cmd"},"57":{"sourceFileName":"src/mocks.ts","qualifiedName":"payload"},"58":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockWindows"},"59":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockWindows"},"60":{"sourceFileName":"src/mocks.ts","qualifiedName":"current"},"61":{"sourceFileName":"src/mocks.ts","qualifiedName":"additionalWindows"},"62":{"sourceFileName":"src/mocks.ts","qualifiedName":"clearMocks"},"63":{"sourceFileName":"src/mocks.ts","qualifiedName":"clearMocks"},"64":{"sourceFileName":"src/path.ts","qualifiedName":""},"65":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory"},"66":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Audio"},"67":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Cache"},"68":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Config"},"69":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Data"},"70":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.LocalData"},"71":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Document"},"72":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Download"},"73":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Picture"},"74":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Public"},"75":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Video"},"76":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Resource"},"77":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Temp"},"78":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppConfig"},"79":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppData"},"80":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppLocalData"},"81":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppCache"},"82":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppLog"},"83":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Desktop"},"84":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Executable"},"85":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Font"},"86":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Home"},"87":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Runtime"},"88":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Template"},"89":{"sourceFileName":"src/path.ts","qualifiedName":"appConfigDir"},"90":{"sourceFileName":"src/path.ts","qualifiedName":"appConfigDir"},"91":{"sourceFileName":"src/path.ts","qualifiedName":"appDataDir"},"92":{"sourceFileName":"src/path.ts","qualifiedName":"appDataDir"},"93":{"sourceFileName":"src/path.ts","qualifiedName":"appLocalDataDir"},"94":{"sourceFileName":"src/path.ts","qualifiedName":"appLocalDataDir"},"95":{"sourceFileName":"src/path.ts","qualifiedName":"appCacheDir"},"96":{"sourceFileName":"src/path.ts","qualifiedName":"appCacheDir"},"97":{"sourceFileName":"src/path.ts","qualifiedName":"appLogDir"},"98":{"sourceFileName":"src/path.ts","qualifiedName":"appLogDir"},"99":{"sourceFileName":"src/path.ts","qualifiedName":"audioDir"},"100":{"sourceFileName":"src/path.ts","qualifiedName":"audioDir"},"101":{"sourceFileName":"src/path.ts","qualifiedName":"cacheDir"},"102":{"sourceFileName":"src/path.ts","qualifiedName":"cacheDir"},"103":{"sourceFileName":"src/path.ts","qualifiedName":"configDir"},"104":{"sourceFileName":"src/path.ts","qualifiedName":"configDir"},"105":{"sourceFileName":"src/path.ts","qualifiedName":"dataDir"},"106":{"sourceFileName":"src/path.ts","qualifiedName":"dataDir"},"107":{"sourceFileName":"src/path.ts","qualifiedName":"desktopDir"},"108":{"sourceFileName":"src/path.ts","qualifiedName":"desktopDir"},"109":{"sourceFileName":"src/path.ts","qualifiedName":"documentDir"},"110":{"sourceFileName":"src/path.ts","qualifiedName":"documentDir"},"111":{"sourceFileName":"src/path.ts","qualifiedName":"downloadDir"},"112":{"sourceFileName":"src/path.ts","qualifiedName":"downloadDir"},"113":{"sourceFileName":"src/path.ts","qualifiedName":"executableDir"},"114":{"sourceFileName":"src/path.ts","qualifiedName":"executableDir"},"115":{"sourceFileName":"src/path.ts","qualifiedName":"fontDir"},"116":{"sourceFileName":"src/path.ts","qualifiedName":"fontDir"},"117":{"sourceFileName":"src/path.ts","qualifiedName":"homeDir"},"118":{"sourceFileName":"src/path.ts","qualifiedName":"homeDir"},"119":{"sourceFileName":"src/path.ts","qualifiedName":"localDataDir"},"120":{"sourceFileName":"src/path.ts","qualifiedName":"localDataDir"},"121":{"sourceFileName":"src/path.ts","qualifiedName":"pictureDir"},"122":{"sourceFileName":"src/path.ts","qualifiedName":"pictureDir"},"123":{"sourceFileName":"src/path.ts","qualifiedName":"publicDir"},"124":{"sourceFileName":"src/path.ts","qualifiedName":"publicDir"},"125":{"sourceFileName":"src/path.ts","qualifiedName":"resourceDir"},"126":{"sourceFileName":"src/path.ts","qualifiedName":"resourceDir"},"127":{"sourceFileName":"src/path.ts","qualifiedName":"resolveResource"},"128":{"sourceFileName":"src/path.ts","qualifiedName":"resolveResource"},"129":{"sourceFileName":"src/path.ts","qualifiedName":"resourcePath"},"130":{"sourceFileName":"src/path.ts","qualifiedName":"runtimeDir"},"131":{"sourceFileName":"src/path.ts","qualifiedName":"runtimeDir"},"132":{"sourceFileName":"src/path.ts","qualifiedName":"templateDir"},"133":{"sourceFileName":"src/path.ts","qualifiedName":"templateDir"},"134":{"sourceFileName":"src/path.ts","qualifiedName":"videoDir"},"135":{"sourceFileName":"src/path.ts","qualifiedName":"videoDir"},"136":{"sourceFileName":"src/path.ts","qualifiedName":"sep"},"137":{"sourceFileName":"src/path.ts","qualifiedName":"sep"},"138":{"sourceFileName":"src/path.ts","qualifiedName":"delimiter"},"139":{"sourceFileName":"src/path.ts","qualifiedName":"delimiter"},"140":{"sourceFileName":"src/path.ts","qualifiedName":"resolve"},"141":{"sourceFileName":"src/path.ts","qualifiedName":"resolve"},"142":{"sourceFileName":"src/path.ts","qualifiedName":"paths"},"143":{"sourceFileName":"src/path.ts","qualifiedName":"normalize"},"144":{"sourceFileName":"src/path.ts","qualifiedName":"normalize"},"145":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"146":{"sourceFileName":"src/path.ts","qualifiedName":"join"},"147":{"sourceFileName":"src/path.ts","qualifiedName":"join"},"148":{"sourceFileName":"src/path.ts","qualifiedName":"paths"},"149":{"sourceFileName":"src/path.ts","qualifiedName":"dirname"},"150":{"sourceFileName":"src/path.ts","qualifiedName":"dirname"},"151":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"152":{"sourceFileName":"src/path.ts","qualifiedName":"extname"},"153":{"sourceFileName":"src/path.ts","qualifiedName":"extname"},"154":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"155":{"sourceFileName":"src/path.ts","qualifiedName":"basename"},"156":{"sourceFileName":"src/path.ts","qualifiedName":"basename"},"157":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"158":{"sourceFileName":"src/path.ts","qualifiedName":"ext"},"159":{"sourceFileName":"src/path.ts","qualifiedName":"isAbsolute"},"160":{"sourceFileName":"src/path.ts","qualifiedName":"isAbsolute"},"161":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"162":{"sourceFileName":"src/path.ts","qualifiedName":"tempDir"},"163":{"sourceFileName":"src/path.ts","qualifiedName":"tempDir"},"164":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"165":{"sourceFileName":"src/tauri.ts","qualifiedName":""},"166":{"sourceFileName":"src/tauri.ts","qualifiedName":"InvokeArgs"},"167":{"sourceFileName":"src/tauri.ts","qualifiedName":"InvokeOptions"},"168":{"sourceFileName":"src/tauri.ts","qualifiedName":"InvokeOptions.headers"},"169":{"sourceFileName":"src/tauri.ts","qualifiedName":"transformCallback"},"170":{"sourceFileName":"src/tauri.ts","qualifiedName":"transformCallback"},"171":{"sourceFileName":"src/tauri.ts","qualifiedName":"callback"},"172":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"173":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"174":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"175":{"sourceFileName":"src/tauri.ts","qualifiedName":"once"},"176":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel"},"177":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.__constructor"},"178":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel"},"179":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.T"},"180":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.id"},"181":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.__TAURI_CHANNEL_MARKER__"},"182":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.#onmessage"},"183":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"184":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"185":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"186":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.onmessage"},"187":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.onmessage"},"188":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"189":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"190":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"191":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.onmessage"},"192":{"sourceFileName":"src/tauri.ts","qualifiedName":"handler"},"193":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"194":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"195":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"196":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.toJSON"},"197":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.toJSON"},"198":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.T"},"199":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener"},"200":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.__constructor"},"201":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener"},"202":{"sourceFileName":"src/tauri.ts","qualifiedName":"plugin"},"203":{"sourceFileName":"src/tauri.ts","qualifiedName":"event"},"204":{"sourceFileName":"src/tauri.ts","qualifiedName":"channelId"},"205":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.plugin"},"206":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.event"},"207":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.channelId"},"208":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.unregister"},"209":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.unregister"},"210":{"sourceFileName":"src/tauri.ts","qualifiedName":"addPluginListener"},"211":{"sourceFileName":"src/tauri.ts","qualifiedName":"addPluginListener"},"212":{"sourceFileName":"src/tauri.ts","qualifiedName":"T"},"213":{"sourceFileName":"src/tauri.ts","qualifiedName":"plugin"},"214":{"sourceFileName":"src/tauri.ts","qualifiedName":"event"},"215":{"sourceFileName":"src/tauri.ts","qualifiedName":"cb"},"216":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"217":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"218":{"sourceFileName":"src/tauri.ts","qualifiedName":"payload"},"219":{"sourceFileName":"src/tauri.ts","qualifiedName":"invoke"},"220":{"sourceFileName":"src/tauri.ts","qualifiedName":"invoke"},"221":{"sourceFileName":"src/tauri.ts","qualifiedName":"T"},"222":{"sourceFileName":"src/tauri.ts","qualifiedName":"cmd"},"223":{"sourceFileName":"src/tauri.ts","qualifiedName":"args"},"224":{"sourceFileName":"src/tauri.ts","qualifiedName":"options"},"225":{"sourceFileName":"src/tauri.ts","qualifiedName":"convertFileSrc"},"226":{"sourceFileName":"src/tauri.ts","qualifiedName":"convertFileSrc"},"227":{"sourceFileName":"src/tauri.ts","qualifiedName":"filePath"},"228":{"sourceFileName":"src/tauri.ts","qualifiedName":"protocol"}}} \ No newline at end of file +{ + "id": 0, + "name": "@tauri-apps/api", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 1, + "name": "event", + "variant": "declaration", + "kind": 2, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The event system allows you to emit events to the backend and listen to events from it.\n\nThis package is also accessible with " + }, + { + "kind": "code", + "text": "`window.__TAURI__.event`" + }, + { + "kind": "text", + "text": " when [" + }, + { + "kind": "code", + "text": "`build.withGlobalTauri`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": " is set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "children": [ + { + "id": 36, + "name": "TauriEvent", + "variant": "declaration", + "kind": 8, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.1.0" + } + ] + } + ] + }, + "children": [ + { + "id": 49, + "name": "MENU", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 59, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://menu" + } + }, + { + "id": 43, + "name": "WINDOW_BLUR", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 53, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://blur" + } + }, + { + "id": 39, + "name": "WINDOW_CLOSE_REQUESTED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 49, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://close-requested" + } + }, + { + "id": 40, + "name": "WINDOW_CREATED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 50, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://window-created" + } + }, + { + "id": 41, + "name": "WINDOW_DESTROYED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 51, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://destroyed" + } + }, + { + "id": 46, + "name": "WINDOW_FILE_DROP", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 56, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://file-drop" + } + }, + { + "id": 48, + "name": "WINDOW_FILE_DROP_CANCELLED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 58, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://file-drop-cancelled" + } + }, + { + "id": 47, + "name": "WINDOW_FILE_DROP_HOVER", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 57, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://file-drop-hover" + } + }, + { + "id": 42, + "name": "WINDOW_FOCUS", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 52, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://focus" + } + }, + { + "id": 38, + "name": "WINDOW_MOVED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 48, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://move" + } + }, + { + "id": 37, + "name": "WINDOW_RESIZED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://resize" + } + }, + { + "id": 44, + "name": "WINDOW_SCALE_FACTOR_CHANGED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 54, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://scale-change" + } + }, + { + "id": 45, + "name": "WINDOW_THEME_CHANGED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 55, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "tauri://theme-changed" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 49, + 43, + 39, + 40, + 41, + 46, + 48, + 47, + 42, + 38, + 37, + 44, + 45 + ] + } + ], + "sources": [ + { + "fileName": "event.ts", + "line": 46, + "character": 5 + } + ] + }, + { + "id": 2, + "name": "Event", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 3, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event name" + } + ] + }, + "sources": [ + { + "fileName": "event.ts", + "line": 16, + "character": 2 + } + ], + "type": { + "type": "reference", + "target": 16, + "name": "EventName", + "package": "@tauri-apps/api" + } + }, + { + "id": 5, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event identifier used to unlisten" + } + ] + }, + "sources": [ + { + "fileName": "event.ts", + "line": 20, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 6, + "name": "payload", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event payload" + } + ] + }, + "sources": [ + { + "fileName": "event.ts", + "line": 22, + "character": 2 + } + ], + "type": { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + }, + { + "id": 4, + "name": "windowLabel", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The label of the window that emitted this event." + } + ] + }, + "sources": [ + { + "fileName": "event.ts", + "line": 18, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3, + 5, + 6, + 4 + ] + } + ], + "sources": [ + { + "fileName": "event.ts", + "line": 14, + "character": 10 + } + ], + "typeParameters": [ + { + "id": 7, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ] + }, + { + "id": 17, + "name": "Options", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 18, + "name": "target", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Label of the window the function targets.\n\nWhen listening to events and using this value,\nonly events triggered by the window with the given label are received.\n\nWhen emitting events, only the window with the given label will receive it." + } + ] + }, + "sources": [ + { + "fileName": "event.ts", + "line": 40, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 18 + ] + } + ], + "sources": [ + { + "fileName": "event.ts", + "line": 31, + "character": 10 + } + ] + }, + { + "id": 8, + "name": "EventCallback", + "variant": "declaration", + "kind": 4194304, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 25, + "character": 5 + } + ], + "typeParameters": [ + { + "id": 12, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 9, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 25, + "character": 24 + } + ], + "signatures": [ + { + "id": 10, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 11, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + ], + "name": "Event", + "package": "@tauri-apps/api" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 16, + "name": "EventName", + "variant": "declaration", + "kind": 4194304, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 29, + "character": 5 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "templateLiteral", + "head": "", + "tail": [ + [ + { + "type": "reference", + "target": 36, + "name": "TauriEvent", + "package": "@tauri-apps/api" + }, + "" + ] + ] + }, + { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "never" + }, + { + "type": "intrinsic", + "name": "never" + } + ], + "name": "Record", + "package": "typescript", + "externalUrl": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" + } + ] + } + ] + } + }, + { + "id": 13, + "name": "UnlistenFn", + "variant": "declaration", + "kind": 4194304, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 27, + "character": 5 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 14, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 27, + "character": 18 + } + ], + "signatures": [ + { + "id": 15, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 31, + "name": "emit", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 164, + "character": 15 + } + ], + "signatures": [ + { + "id": 32, + "name": "emit", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Emits an event to the backend and all Tauri windows." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { emit } from '@tauri-apps/api/event';\nawait emit('frontend-loaded', { loggedIn: true, token: 'authToken' });\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "event.ts", + "line": 164, + "character": 0 + } + ], + "parameters": [ + { + "id": 33, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event name. Must include only alphanumeric characters, " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`_`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 34, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 35, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 17, + "name": "Options", + "package": "@tauri-apps/api" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 19, + "name": "listen", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 99, + "character": 15 + } + ], + "signatures": [ + { + "id": 20, + "name": "listen", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Listen to an event. The event can be either global or window-specific.\nSee " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "windowLabel", + "target": 4, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " to check the event source." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { listen } from '@tauri-apps/api/event';\nconst unlisten = await listen('error', (event) => {\n console.log(`Got error in window ${event.windowLabel}, payload: ${event.payload}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted." + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "event.ts", + "line": 99, + "character": 0 + } + ], + "typeParameter": [ + { + "id": 21, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 22, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event name. Must include only alphanumeric characters, " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`_`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "reference", + "target": 16, + "name": "EventName", + "package": "@tauri-apps/api" + } + }, + { + "id": 23, + "name": "handler", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event handler callback." + } + ] + }, + "type": { + "type": "reference", + "target": 8, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + ], + "name": "EventCallback", + "package": "@tauri-apps/api" + } + }, + { + "id": 24, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 17, + "name": "Options", + "package": "@tauri-apps/api" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 13, + "name": "UnlistenFn", + "package": "@tauri-apps/api" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 25, + "name": "once", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "event.ts", + "line": 137, + "character": 15 + } + ], + "signatures": [ + { + "id": 26, + "name": "once", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Listen to an one-off event. See " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "listen", + "target": 19, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " for more information." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { once } from '@tauri-apps/api/event';\ninterface LoadedPayload {\n loggedIn: boolean,\n token: string\n}\nconst unlisten = await once('loaded', (event) => {\n console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted." + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "event.ts", + "line": 137, + "character": 0 + } + ], + "typeParameter": [ + { + "id": 27, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 28, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event name. Must include only alphanumeric characters, " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`_`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "reference", + "target": 16, + "name": "EventName", + "package": "@tauri-apps/api" + } + }, + { + "id": 29, + "name": "handler", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 8, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + ], + "name": "EventCallback", + "package": "@tauri-apps/api" + } + }, + { + "id": 30, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 17, + "name": "Options", + "package": "@tauri-apps/api" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 13, + "name": "UnlistenFn", + "package": "@tauri-apps/api" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Enumerations", + "children": [ + 36 + ] + }, + { + "title": "Interfaces", + "children": [ + 2, + 17 + ] + }, + { + "title": "Type Aliases", + "children": [ + 8, + 16, + 13 + ] + }, + { + "title": "Functions", + "children": [ + 31, + 19, + 25 + ] + } + ], + "sources": [ + { + "fileName": "event.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 50, + "name": "mocks", + "variant": "declaration", + "kind": 2, + "flags": {}, + "children": [ + { + "id": 62, + "name": "clearMocks", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "mocks.ts", + "line": 178, + "character": 16 + } + ], + "signatures": [ + { + "id": 63, + "name": "clearMocks", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Clears mocked functions/data injected by the other functions in this module.\nWhen using a test runner that doesn't provide a fresh window object for each test, calling this function will reset tauri specific properties.\n\n# Example\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { mockWindows, clearMocks } from \"@tauri-apps/api/mocks\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked windows\", () => {\n mockWindows(\"main\", \"second\", \"third\");\n\n expect(window).toHaveProperty(\"__TAURI_METADATA__\")\n})\n\ntest(\"no mocked windows\", () => {\n expect(window).not.toHaveProperty(\"__TAURI_METADATA__\")\n})\n```" + } + ], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "mocks.ts", + "line": 178, + "character": 0 + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 51, + "name": "mockIPC", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "mocks.ts", + "line": 80, + "character": 16 + } + ], + "signatures": [ + { + "id": 52, + "name": "mockIPC", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Intercepts all IPC requests with the given mock handler.\n\nThis function can be used when testing tauri frontend applications or when running the frontend in a Node.js context during static site generation.\n\n# Examples\n\nTesting setup using vitest:\n" + }, + { + "kind": "code", + "text": "```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, payload) => {\n switch (cmd) {\n case \"add\":\n return (payload.a as number) + (payload.b as number);\n default:\n break;\n }\n });\n\n expect(invoke('add', { a: 12, b: 15 })).resolves.toBe(27);\n})\n```" + }, + { + "kind": "text", + "text": "\n\nThe callback function can also return a Promise:\n" + }, + { + "kind": "code", + "text": "```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, payload) => {\n if(cmd === \"get_data\") {\n return fetch(\"https://example.com/data.json\")\n .then((response) => response.json())\n }\n });\n\n expect(invoke('get_data')).resolves.toBe({ foo: 'bar' });\n})\n```" + } + ], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "mocks.ts", + "line": 80, + "character": 0 + } + ], + "parameters": [ + { + "id": 53, + "name": "cb", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 54, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "mocks.ts", + "line": 81, + "character": 6 + } + ], + "signatures": [ + { + "id": 55, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "mocks.ts", + "line": 81, + "character": 6 + } + ], + "parameters": [ + { + "id": 56, + "name": "cmd", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 57, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript", + "externalUrl": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 58, + "name": "mockWindows", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "mocks.ts", + "line": 142, + "character": 16 + } + ], + "signatures": [ + { + "id": 59, + "name": "mockWindows", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mocks one or many window labels.\nIn non-tauri context it is required to call this function *before* using the " + }, + { + "kind": "code", + "text": "`@tauri-apps/api/window`" + }, + { + "kind": "text", + "text": " module.\n\nThis function only mocks the *presence* of windows,\nwindow properties (e.g. width and height) can be mocked like regular IPC calls using the " + }, + { + "kind": "code", + "text": "`mockIPC`" + }, + { + "kind": "text", + "text": " function.\n\n# Examples\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\nimport { getCurrent } from \"@tauri-apps/api/window\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nconst win = getCurrent();\n\nwin.label // \"main\"\n```" + }, + { + "kind": "text", + "text": "\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nmockIPC((cmd, args) => {\n if (cmd === \"plugin:event|emit\") {\n console.log('emit event', args?.event, args?.payload);\n }\n});\n\nconst { emit } = await import(\"@tauri-apps/api/event\");\nawait emit('loaded'); // this will cause the mocked IPC handler to log to the console.\n```" + } + ], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "mocks.ts", + "line": 142, + "character": 0 + } + ], + "parameters": [ + { + "id": 60, + "name": "current", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Label of window this JavaScript context is running in." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 61, + "name": "additionalWindows", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Label of additional windows the app has." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "children": [ + 62, + 51, + 58 + ] + } + ], + "sources": [ + { + "fileName": "mocks.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 64, + "name": "path", + "variant": "declaration", + "kind": 2, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path module provides utilities for working with file and directory paths.\n\nThis package is also accessible with " + }, + { + "kind": "code", + "text": "`window.__TAURI__.path`" + }, + { + "kind": "text", + "text": " when [" + }, + { + "kind": "code", + "text": "`build.withGlobalTauri`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": " is set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\n\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security." + } + ] + }, + "children": [ + { + "id": 65, + "name": "BaseDirectory", + "variant": "declaration", + "kind": 8, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "2.0.0" + } + ] + } + ] + }, + "children": [ + { + "id": 81, + "name": "AppCache", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 35, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 16 + } + }, + { + "id": 78, + "name": "AppConfig", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 32, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 13 + } + }, + { + "id": 79, + "name": "AppData", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 14 + } + }, + { + "id": 80, + "name": "AppLocalData", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 34, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 15 + } + }, + { + "id": 82, + "name": "AppLog", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 36, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 17 + } + }, + { + "id": 66, + "name": "Audio", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 20, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 1 + } + }, + { + "id": 67, + "name": "Cache", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 21, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 2 + } + }, + { + "id": 68, + "name": "Config", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 22, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 3 + } + }, + { + "id": 69, + "name": "Data", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 23, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 4 + } + }, + { + "id": 83, + "name": "Desktop", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 38, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 18 + } + }, + { + "id": 71, + "name": "Document", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 25, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 6 + } + }, + { + "id": 72, + "name": "Download", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 26, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 7 + } + }, + { + "id": 84, + "name": "Executable", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 19 + } + }, + { + "id": 85, + "name": "Font", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 40, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 20 + } + }, + { + "id": 86, + "name": "Home", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 21 + } + }, + { + "id": 70, + "name": "LocalData", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 24, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 5 + } + }, + { + "id": 73, + "name": "Picture", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 27, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 8 + } + }, + { + "id": 74, + "name": "Public", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 28, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 9 + } + }, + { + "id": 76, + "name": "Resource", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 30, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 11 + } + }, + { + "id": 87, + "name": "Runtime", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 42, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 22 + } + }, + { + "id": 77, + "name": "Temp", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 31, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 12 + } + }, + { + "id": 88, + "name": "Template", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 23 + } + }, + { + "id": 75, + "name": "Video", + "variant": "declaration", + "kind": 16, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 29, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": 10 + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 81, + 78, + 79, + 80, + 82, + 66, + 67, + 68, + 69, + 83, + 71, + 72, + 84, + 85, + 86, + 70, + 73, + 74, + 76, + 87, + 77, + 88, + 75 + ] + } + ], + "sources": [ + { + "fileName": "path.ts", + "line": 19, + "character": 5 + } + ] + }, + { + "id": 95, + "name": "appCacheDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 108, + "character": 15 + } + ], + "signatures": [ + { + "id": 96, + "name": "appCacheDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the suggested directory for your app's cache files.\nResolves to " + }, + { + "kind": "code", + "text": "`${cacheDir}/${bundleIdentifier}`" + }, + { + "kind": "text", + "text": ", where " + }, + { + "kind": "code", + "text": "`bundleIdentifier`" + }, + { + "kind": "text", + "text": " is the value [" + }, + { + "kind": "code", + "text": "`tauri.bundle.identifier`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { appCacheDir } from '@tauri-apps/api/path';\nconst appCacheDirPath = await appCacheDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.2.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 108, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 89, + "name": "appConfigDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 57, + "character": 15 + } + ], + "signatures": [ + { + "id": 90, + "name": "appConfigDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the suggested directory for your app's config files.\nResolves to " + }, + { + "kind": "code", + "text": "`${configDir}/${bundleIdentifier}`" + }, + { + "kind": "text", + "text": ", where " + }, + { + "kind": "code", + "text": "`bundleIdentifier`" + }, + { + "kind": "text", + "text": " is the value [" + }, + { + "kind": "code", + "text": "`tauri.bundle.identifier`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { appConfigDir } from '@tauri-apps/api/path';\nconst appConfigDirPath = await appConfigDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.2.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 57, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 91, + "name": "appDataDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 74, + "character": 15 + } + ], + "signatures": [ + { + "id": 92, + "name": "appDataDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the suggested directory for your app's data files.\nResolves to " + }, + { + "kind": "code", + "text": "`${dataDir}/${bundleIdentifier}`" + }, + { + "kind": "text", + "text": ", where " + }, + { + "kind": "code", + "text": "`bundleIdentifier`" + }, + { + "kind": "text", + "text": " is the value [" + }, + { + "kind": "code", + "text": "`tauri.bundle.identifier`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.2.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 74, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 93, + "name": "appLocalDataDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 91, + "character": 15 + } + ], + "signatures": [ + { + "id": 94, + "name": "appLocalDataDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the suggested directory for your app's local data files.\nResolves to " + }, + { + "kind": "code", + "text": "`${localDataDir}/${bundleIdentifier}`" + }, + { + "kind": "text", + "text": ", where " + }, + { + "kind": "code", + "text": "`bundleIdentifier`" + }, + { + "kind": "text", + "text": " is the value [" + }, + { + "kind": "code", + "text": "`tauri.bundle.identifier`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { appLocalDataDir } from '@tauri-apps/api/path';\nconst appLocalDataDirPath = await appLocalDataDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.2.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 91, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 97, + "name": "appLogDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 520, + "character": 15 + } + ], + "signatures": [ + { + "id": 98, + "name": "appLogDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the suggested directory for your app's log files.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`${configDir}/${bundleIdentifier}/logs`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`${homeDir}/Library/Logs/{bundleIdentifier}`" + }, + { + "kind": "text", + "text": "\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`${configDir}/${bundleIdentifier}/logs`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { appLogDir } from '@tauri-apps/api/path';\nconst appLogDirPath = await appLogDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.2.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 520, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 99, + "name": "audioDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 130, + "character": 15 + } + ], + "signatures": [ + { + "id": 100, + "name": "audioDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's audio directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" + }, + { + "kind": "code", + "text": "`xdg-user-dirs`" + }, + { + "kind": "text", + "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " + }, + { + "kind": "code", + "text": "`XDG_MUSIC_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Music`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Music}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { audioDir } from '@tauri-apps/api/path';\nconst audioDirPath = await audioDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 130, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 155, + "name": "basename", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 653, + "character": 15 + } + ], + "signatures": [ + { + "id": 156, + "name": "basename", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the last portion of a " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": ". Trailing directory separators are ignored." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { basename, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst base = await basename(resourcePath);\nassert(base === 'app.conf');\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 653, + "character": 0 + } + ], + "parameters": [ + { + "id": 157, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 158, + "name": "ext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional file extension to be removed from the returned path." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 101, + "name": "cacheDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 152, + "character": 15 + } + ], + "signatures": [ + { + "id": 102, + "name": "cacheDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's cache directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`$XDG_CACHE_HOME`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`$HOME/.cache`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Library/Caches`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_LocalAppData}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { cacheDir } from '@tauri-apps/api/path';\nconst cacheDirPath = await cacheDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 152, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 103, + "name": "configDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 174, + "character": 15 + } + ], + "signatures": [ + { + "id": 104, + "name": "configDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's config directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`$XDG_CONFIG_HOME`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`$HOME/.config`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Library/Application Support`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_RoamingAppData}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { configDir } from '@tauri-apps/api/path';\nconst configDirPath = await configDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 174, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 105, + "name": "dataDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 196, + "character": 15 + } + ], + "signatures": [ + { + "id": 106, + "name": "dataDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`$XDG_DATA_HOME`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`$HOME/.local/share`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Library/Application Support`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_RoamingAppData}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { dataDir } from '@tauri-apps/api/path';\nconst dataDirPath = await dataDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 196, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 138, + "name": "delimiter", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 560, + "character": 9 + } + ], + "signatures": [ + { + "id": 139, + "name": "delimiter", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the platform-specific path segment delimiter:\n- " + }, + { + "kind": "code", + "text": "`;`" + }, + { + "kind": "text", + "text": " on Windows\n- " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " on POSIX" + } + ], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "2.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 560, + "character": 0 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 107, + "name": "desktopDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 218, + "character": 15 + } + ], + "signatures": [ + { + "id": 108, + "name": "desktopDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's desktop directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" + }, + { + "kind": "code", + "text": "`xdg-user-dirs`" + }, + { + "kind": "text", + "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " + }, + { + "kind": "code", + "text": "`XDG_DESKTOP_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Desktop`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Desktop}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { desktopDir } from '@tauri-apps/api/path';\nconst desktopPath = await desktopDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 218, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 149, + "name": "dirname", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 619, + "character": 15 + } + ], + "signatures": [ + { + "id": 150, + "name": "dirname", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the directory name of a " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": ". Trailing directory separators are ignored." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { dirname, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst dir = await dirname(appDataDirPath);\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 619, + "character": 0 + } + ], + "parameters": [ + { + "id": 151, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 109, + "name": "documentDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 240, + "character": 15 + } + ], + "signatures": [ + { + "id": 110, + "name": "documentDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's document directory." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { documentDir } from '@tauri-apps/api/path';\nconst documentDirPath = await documentDir();\n```" + }, + { + "kind": "text", + "text": "\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" + }, + { + "kind": "code", + "text": "`xdg-user-dirs`" + }, + { + "kind": "text", + "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " + }, + { + "kind": "code", + "text": "`XDG_DOCUMENTS_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Documents`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Documents}`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 240, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 111, + "name": "downloadDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 262, + "character": 15 + } + ], + "signatures": [ + { + "id": 112, + "name": "downloadDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's download directory.\n\n#### Platform-specific\n\n- **Linux**: Resolves to [" + }, + { + "kind": "code", + "text": "`xdg-user-dirs`" + }, + { + "kind": "text", + "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " + }, + { + "kind": "code", + "text": "`XDG_DOWNLOAD_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS**: Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Downloads`" + }, + { + "kind": "text", + "text": ".\n- **Windows**: Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Downloads}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { downloadDir } from '@tauri-apps/api/path';\nconst downloadDirPath = await downloadDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 262, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 113, + "name": "executableDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 284, + "character": 15 + } + ], + "signatures": [ + { + "id": 114, + "name": "executableDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's executable directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`$XDG_BIN_HOME/../bin`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`$XDG_DATA_HOME/../bin`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`$HOME/.local/bin`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Not supported.\n- **Windows:** Not supported." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { executableDir } from '@tauri-apps/api/path';\nconst executableDirPath = await executableDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 284, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 152, + "name": "extname", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 635, + "character": 15 + } + ], + "signatures": [ + { + "id": 153, + "name": "extname", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the extension of the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { extname, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst ext = await extname(resourcePath);\nassert(ext === 'conf');\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 635, + "character": 0 + } + ], + "parameters": [ + { + "id": 154, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 115, + "name": "fontDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 306, + "character": 15 + } + ], + "signatures": [ + { + "id": 116, + "name": "fontDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's font directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`$XDG_DATA_HOME/fonts`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`$HOME/.local/share/fonts`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Library/Fonts`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Not supported." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { fontDir } from '@tauri-apps/api/path';\nconst fontDirPath = await fontDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 306, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 117, + "name": "homeDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 328, + "character": 15 + } + ], + "signatures": [ + { + "id": 118, + "name": "homeDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's home directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Profile}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { homeDir } from '@tauri-apps/api/path';\nconst homeDirPath = await homeDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 328, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 159, + "name": "isAbsolute", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 667, + "character": 15 + } + ], + "signatures": [ + { + "id": 160, + "name": "isAbsolute", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns whether the path is absolute or not." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { isAbsolute } from '@tauri-apps/api/path';\nassert(await isAbsolute('/home/tauri'));\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 667, + "character": 0 + } + ], + "parameters": [ + { + "id": 161, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 146, + "name": "join", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 604, + "character": 15 + } + ], + "signatures": [ + { + "id": 147, + "name": "join", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Joins all given " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " segments together using the platform-specific separator as a delimiter, then normalizes the resulting path." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { join, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await join(appDataDirPath, 'users', 'tauri', 'avatar.png');\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 604, + "character": 0 + } + ], + "parameters": [ + { + "id": 148, + "name": "paths", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 119, + "name": "localDataDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 350, + "character": 15 + } + ], + "signatures": [ + { + "id": 120, + "name": "localDataDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's local data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`$XDG_DATA_HOME`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`$HOME/.local/share`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Library/Application Support`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_LocalAppData}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { localDataDir } from '@tauri-apps/api/path';\nconst localDataDirPath = await localDataDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 350, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 143, + "name": "normalize", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 589, + "character": 15 + } + ], + "signatures": [ + { + "id": 144, + "name": "normalize", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Normalizes the given " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": ", resolving " + }, + { + "kind": "code", + "text": "`'..'`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`'.'`" + }, + { + "kind": "text", + "text": " segments and resolve symbolic links." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { normalize, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await normalize(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 589, + "character": 0 + } + ], + "parameters": [ + { + "id": 145, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 121, + "name": "pictureDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 372, + "character": 15 + } + ], + "signatures": [ + { + "id": 122, + "name": "pictureDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's picture directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" + }, + { + "kind": "code", + "text": "`xdg-user-dirs`" + }, + { + "kind": "text", + "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " + }, + { + "kind": "code", + "text": "`XDG_PICTURES_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Pictures`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Pictures}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { pictureDir } from '@tauri-apps/api/path';\nconst pictureDirPath = await pictureDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 372, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 123, + "name": "publicDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 394, + "character": 15 + } + ], + "signatures": [ + { + "id": 124, + "name": "publicDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's public directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" + }, + { + "kind": "code", + "text": "`xdg-user-dirs`" + }, + { + "kind": "text", + "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " + }, + { + "kind": "code", + "text": "`XDG_PUBLICSHARE_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Public`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Public}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { publicDir } from '@tauri-apps/api/path';\nconst publicDirPath = await publicDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 394, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 140, + "name": "resolve", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 574, + "character": 15 + } + ], + "signatures": [ + { + "id": 141, + "name": "resolve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resolves a sequence of " + }, + { + "kind": "code", + "text": "`paths`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " segments into an absolute path." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { resolve, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await resolve(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 574, + "character": 0 + } + ], + "parameters": [ + { + "id": 142, + "name": "paths", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 127, + "name": "resolveResource", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 431, + "character": 15 + } + ], + "signatures": [ + { + "id": 128, + "name": "resolveResource", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resolve the path to a resource file." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('script.sh');\n```" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The full path to the resource." + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 431, + "character": 0 + } + ], + "parameters": [ + { + "id": 129, + "name": "resourcePath", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the resource.\nMust follow the same syntax as defined in " + }, + { + "kind": "code", + "text": "`tauri.conf.json > tauri > bundle > resources`" + }, + { + "kind": "text", + "text": ", i.e. keeping subfolders and parent dir components (" + }, + { + "kind": "code", + "text": "`../`" + }, + { + "kind": "text", + "text": ")." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 125, + "name": "resourceDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 411, + "character": 15 + } + ], + "signatures": [ + { + "id": 126, + "name": "resourceDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the application's resource directory.\nTo resolve a resource path, see the [[resolveResource | " + }, + { + "kind": "code", + "text": "`resolveResource API`" + }, + { + "kind": "text", + "text": "]]." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { resourceDir } from '@tauri-apps/api/path';\nconst resourceDirPath = await resourceDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 411, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 130, + "name": "runtimeDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 454, + "character": 15 + } + ], + "signatures": [ + { + "id": 131, + "name": "runtimeDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's runtime directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " + }, + { + "kind": "code", + "text": "`$XDG_RUNTIME_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Not supported.\n- **Windows:** Not supported." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { runtimeDir } from '@tauri-apps/api/path';\nconst runtimeDirPath = await runtimeDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 454, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 136, + "name": "sep", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 549, + "character": 9 + } + ], + "signatures": [ + { + "id": 137, + "name": "sep", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the platform-specific path segment separator:\n- " + }, + { + "kind": "code", + "text": "`\\` on Windows\n- `" + }, + { + "kind": "text", + "text": "/` on POSIX" + } + ], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "2.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 549, + "character": 0 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 162, + "name": "tempDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 536, + "character": 15 + } + ], + "signatures": [ + { + "id": 163, + "name": "tempDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns a temporary directory." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { tempDir } from '@tauri-apps/api/path';\nconst temp = await tempDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "2.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 536, + "character": 0 + } + ], + "parameters": [ + { + "id": 164, + "name": "path", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 132, + "name": "templateDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 476, + "character": 15 + } + ], + "signatures": [ + { + "id": 133, + "name": "templateDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's template directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" + }, + { + "kind": "code", + "text": "`xdg-user-dirs`" + }, + { + "kind": "text", + "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " + }, + { + "kind": "code", + "text": "`XDG_TEMPLATES_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Not supported.\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Templates}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { templateDir } from '@tauri-apps/api/path';\nconst templateDirPath = await templateDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 476, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 134, + "name": "videoDir", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "path.ts", + "line": 498, + "character": 15 + } + ], + "signatures": [ + { + "id": 135, + "name": "videoDir", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Returns the path to the user's video directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" + }, + { + "kind": "code", + "text": "`xdg-user-dirs`" + }, + { + "kind": "text", + "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " + }, + { + "kind": "code", + "text": "`XDG_VIDEOS_DIR`" + }, + { + "kind": "text", + "text": ".\n- **macOS:** Resolves to " + }, + { + "kind": "code", + "text": "`$HOME/Movies`" + }, + { + "kind": "text", + "text": ".\n- **Windows:** Resolves to " + }, + { + "kind": "code", + "text": "`{FOLDERID_Videos}`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { videoDir } from '@tauri-apps/api/path';\nconst videoDirPath = await videoDir();\n```" + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "path.ts", + "line": 498, + "character": 0 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Enumerations", + "children": [ + 65 + ] + }, + { + "title": "Functions", + "children": [ + 95, + 89, + 91, + 93, + 97, + 99, + 155, + 101, + 103, + 105, + 138, + 107, + 149, + 109, + 111, + 113, + 152, + 115, + 117, + 159, + 146, + 119, + 143, + 121, + 123, + 140, + 127, + 125, + 130, + 136, + 162, + 132, + 134 + ] + } + ], + "sources": [ + { + "fileName": "path.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 165, + "name": "tauri", + "variant": "declaration", + "kind": 2, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Invoke your custom commands.\n\nThis package is also accessible with " + }, + { + "kind": "code", + "text": "`window.__TAURI__.tauri`" + }, + { + "kind": "text", + "text": " when [" + }, + { + "kind": "code", + "text": "`build.withGlobalTauri`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": " is set to " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "children": [ + { + "id": 176, + "name": "Channel", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 177, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 71, + "character": 2 + } + ], + "signatures": [ + { + "id": 178, + "name": "new Channel", + "variant": "signature", + "kind": 16384, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 71, + "character": 2 + } + ], + "typeParameter": [ + { + "id": 179, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": 176, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + ], + "name": "Channel", + "package": "@tauri-apps/api" + } + } + ] + }, + { + "id": 182, + "name": "#onmessage", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true + }, + "sources": [ + { + "fileName": "tauri.ts", + "line": 67, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 183, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 67, + "character": 14 + } + ], + "signatures": [ + { + "id": 184, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 67, + "character": 14 + } + ], + "parameters": [ + { + "id": 185, + "name": "response", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 181, + "name": "__TAURI_CHANNEL_MARKER__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPrivate": true, + "isReadonly": true + }, + "sources": [ + { + "fileName": "tauri.ts", + "line": 66, + "character": 19 + } + ], + "type": { + "type": "literal", + "value": true + }, + "defaultValue": "true" + }, + { + "id": 180, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 64, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 186, + "name": "onmessage", + "variant": "declaration", + "kind": 262144, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 77, + "character": 6 + }, + { + "fileName": "tauri.ts", + "line": 81, + "character": 6 + } + ], + "getSignature": { + "id": 187, + "name": "onmessage", + "variant": "signature", + "kind": 524288, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 81, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 188, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 81, + "character": 19 + } + ], + "signatures": [ + { + "id": 189, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 81, + "character": 19 + } + ], + "parameters": [ + { + "id": 190, + "name": "response", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + "setSignature": { + "id": 191, + "name": "onmessage", + "variant": "signature", + "kind": 1048576, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 77, + "character": 2 + } + ], + "parameters": [ + { + "id": 192, + "name": "handler", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 193, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 77, + "character": 25 + } + ], + "signatures": [ + { + "id": 194, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 77, + "character": 25 + } + ], + "parameters": [ + { + "id": 195, + "name": "response", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + }, + { + "id": 196, + "name": "toJSON", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 85, + "character": 2 + } + ], + "signatures": [ + { + "id": 197, + "name": "toJSON", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 85, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 177 + ] + }, + { + "title": "Properties", + "children": [ + 182, + 181, + 180 + ] + }, + { + "title": "Accessors", + "children": [ + 186 + ] + }, + { + "title": "Methods", + "children": [ + 196 + ] + } + ], + "sources": [ + { + "fileName": "tauri.ts", + "line": 63, + "character": 6 + } + ], + "typeParameters": [ + { + "id": 198, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + }, + { + "id": 199, + "name": "PluginListener", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 200, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 95, + "character": 2 + } + ], + "signatures": [ + { + "id": 201, + "name": "new PluginListener", + "variant": "signature", + "kind": 16384, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 95, + "character": 2 + } + ], + "parameters": [ + { + "id": 202, + "name": "plugin", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 203, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 204, + "name": "channelId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "target": 199, + "name": "PluginListener", + "package": "@tauri-apps/api" + } + } + ] + }, + { + "id": 207, + "name": "channelId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 93, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 206, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 92, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 205, + "name": "plugin", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 91, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 208, + "name": "unregister", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 101, + "character": 8 + } + ], + "signatures": [ + { + "id": 209, + "name": "unregister", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 101, + "character": 2 + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 200 + ] + }, + { + "title": "Properties", + "children": [ + 207, + 206, + 205 + ] + }, + { + "title": "Methods", + "children": [ + 208 + ] + } + ], + "sources": [ + { + "fileName": "tauri.ts", + "line": 90, + "character": 6 + } + ] + }, + { + "id": 167, + "name": "InvokeOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "2.0.0" + } + ] + } + ] + }, + "children": [ + { + "id": 168, + "name": "headers", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 139, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "package": "typescript", + "externalUrl": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", + "qualifiedName": "Headers" + }, + "name": "Headers", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Headers" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 168 + ] + } + ], + "sources": [ + { + "fileName": "tauri.ts", + "line": 138, + "character": 10 + } + ] + }, + { + "id": 166, + "name": "InvokeArgs", + "variant": "declaration", + "kind": 4194304, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Command arguments." + } + ], + "blockTags": [ + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "tauri.ts", + "line": 133, + "character": 5 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript", + "externalUrl": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "number" + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "ArrayBuffer" + }, + "name": "ArrayBuffer", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" + }, + { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Uint8Array" + }, + "name": "Uint8Array", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array" + } + ] + } + }, + { + "id": 210, + "name": "addPluginListener", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 116, + "character": 15 + } + ], + "signatures": [ + { + "id": 211, + "name": "addPluginListener", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Adds a listener to a plugin event." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The listener object to stop listening to the events." + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "2.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "tauri.ts", + "line": 116, + "character": 0 + } + ], + "typeParameter": [ + { + "id": 212, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 213, + "name": "plugin", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 214, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 215, + "name": "cb", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 216, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 119, + "character": 6 + } + ], + "signatures": [ + { + "id": 217, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 119, + "character": 6 + } + ], + "parameters": [ + { + "id": 218, + "name": "payload", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 199, + "name": "PluginListener", + "package": "@tauri-apps/api" + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 225, + "name": "convertFileSrc", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 212, + "character": 9 + } + ], + "signatures": [ + { + "id": 226, + "name": "convertFileSrc", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Convert a device file path to an URL that can be loaded by the webview.\nNote that " + }, + { + "kind": "code", + "text": "`asset:`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`http://asset.localhost`" + }, + { + "kind": "text", + "text": " must be added to [" + }, + { + "kind": "code", + "text": "`tauri.security.csp`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#securityconfig.csp) in " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": ".\nExample CSP value: " + }, + { + "kind": "code", + "text": "`\"csp\": \"default-src 'self' ipc: http://ipc.localhost; img-src 'self' asset: http://asset.localhost\"`" + }, + { + "kind": "text", + "text": " to use the asset protocol on image sources.\n\nAdditionally, " + }, + { + "kind": "code", + "text": "`asset`" + }, + { + "kind": "text", + "text": " must be added to [" + }, + { + "kind": "code", + "text": "`tauri.allowlist.protocol`" + }, + { + "kind": "text", + "text": "](https://tauri.app/v1/api/config/#allowlistconfig.protocol)\nin " + }, + { + "kind": "code", + "text": "`tauri.conf.json`" + }, + { + "kind": "text", + "text": " and its access scope must be defined on the " + }, + { + "kind": "code", + "text": "`assetScope`" + }, + { + "kind": "text", + "text": " array on the same " + }, + { + "kind": "code", + "text": "`protocol`" + }, + { + "kind": "text", + "text": " object." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { appDataDir, join } from '@tauri-apps/api/path';\nimport { convertFileSrc } from '@tauri-apps/api/tauri';\nconst appDataDirPath = await appDataDir();\nconst filePath = await join(appDataDirPath, 'assets/video.mp4');\nconst assetUrl = convertFileSrc(filePath);\n\nconst video = document.getElementById('my-video');\nconst source = document.createElement('source');\nsource.type = 'video/mp4';\nsource.src = assetUrl;\nvideo.appendChild(source);\nvideo.load();\n```" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the URL that can be used as source on the webview." + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "tauri.ts", + "line": 212, + "character": 0 + } + ], + "parameters": [ + { + "id": 227, + "name": "filePath", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file path." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 228, + "name": "protocol", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The protocol to use. Defaults to " + }, + { + "kind": "code", + "text": "`asset`" + }, + { + "kind": "text", + "text": ". You only need to set this when using a custom protocol." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "'asset'" + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 219, + "name": "invoke", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 157, + "character": 15 + } + ], + "signatures": [ + { + "id": 220, + "name": "invoke", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sends a message to the backend." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```typescript\nimport { invoke } from '@tauri-apps/api/tauri';\nawait invoke('login', { user: 'tauri', password: 'poiwe3h4r5ip3yrhtew9ty' });\n```" + } + ] + }, + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A promise resolving or rejecting to the backend response." + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "tauri.ts", + "line": 157, + "character": 0 + } + ], + "typeParameter": [ + { + "id": 221, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 222, + "name": "cmd", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The command name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 223, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The optional arguments to pass to the command." + } + ] + }, + "type": { + "type": "reference", + "target": 166, + "name": "InvokeArgs", + "package": "@tauri-apps/api" + }, + "defaultValue": "{}" + }, + { + "id": 224, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request options." + } + ] + }, + "type": { + "type": "reference", + "target": 167, + "name": "InvokeOptions", + "package": "@tauri-apps/api" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": -1, + "name": "T", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript", + "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" + } + } + ] + }, + { + "id": 169, + "name": "transformCallback", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 41, + "character": 9 + } + ], + "signatures": [ + { + "id": 170, + "name": "transformCallback", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transforms a callback function to a string identifier that can be passed to the backend.\nThe backend uses the identifier to " + }, + { + "kind": "code", + "text": "`eval()`" + }, + { + "kind": "text", + "text": " the callback." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A unique identifier associated with the callback function." + } + ] + }, + { + "tag": "@since", + "content": [ + { + "kind": "text", + "text": "1.0.0" + } + ] + } + ] + }, + "sources": [ + { + "fileName": "tauri.ts", + "line": 41, + "character": 0 + } + ], + "parameters": [ + { + "id": 171, + "name": "callback", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 172, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 42, + "character": 13 + } + ], + "signatures": [ + { + "id": 173, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "sources": [ + { + "fileName": "tauri.ts", + "line": 42, + "character": 13 + } + ], + "parameters": [ + { + "id": 174, + "name": "response", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 175, + "name": "once", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 176, + 199 + ] + }, + { + "title": "Interfaces", + "children": [ + 167 + ] + }, + { + "title": "Type Aliases", + "children": [ + 166 + ] + }, + { + "title": "Functions", + "children": [ + 210, + 225, + 219, + 169 + ] + } + ], + "sources": [ + { + "fileName": "tauri.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "Modules", + "children": [ + 1, + 50, + 64, + 165 + ] + } + ], + "packageName": "@tauri-apps/api", + "symbolIdMap": { + "1": { + "sourceFileName": "src/event.ts", + "qualifiedName": "" + }, + "2": { + "sourceFileName": "src/event.ts", + "qualifiedName": "Event" + }, + "3": { + "sourceFileName": "src/event.ts", + "qualifiedName": "Event.event" + }, + "4": { + "sourceFileName": "src/event.ts", + "qualifiedName": "Event.windowLabel" + }, + "5": { + "sourceFileName": "src/event.ts", + "qualifiedName": "Event.id" + }, + "6": { + "sourceFileName": "src/event.ts", + "qualifiedName": "Event.payload" + }, + "7": { + "sourceFileName": "src/event.ts", + "qualifiedName": "Event.T" + }, + "8": { + "sourceFileName": "src/event.ts", + "qualifiedName": "EventCallback" + }, + "9": { + "sourceFileName": "src/event.ts", + "qualifiedName": "__type" + }, + "10": { + "sourceFileName": "src/event.ts", + "qualifiedName": "__type" + }, + "11": { + "sourceFileName": "src/event.ts", + "qualifiedName": "event" + }, + "12": { + "sourceFileName": "src/event.ts", + "qualifiedName": "T" + }, + "13": { + "sourceFileName": "src/event.ts", + "qualifiedName": "UnlistenFn" + }, + "14": { + "sourceFileName": "src/event.ts", + "qualifiedName": "__type" + }, + "15": { + "sourceFileName": "src/event.ts", + "qualifiedName": "__type" + }, + "16": { + "sourceFileName": "src/event.ts", + "qualifiedName": "EventName" + }, + "17": { + "sourceFileName": "src/event.ts", + "qualifiedName": "Options" + }, + "18": { + "sourceFileName": "src/event.ts", + "qualifiedName": "Options.target" + }, + "19": { + "sourceFileName": "src/event.ts", + "qualifiedName": "listen" + }, + "20": { + "sourceFileName": "src/event.ts", + "qualifiedName": "listen" + }, + "21": { + "sourceFileName": "src/event.ts", + "qualifiedName": "T" + }, + "22": { + "sourceFileName": "src/event.ts", + "qualifiedName": "event" + }, + "23": { + "sourceFileName": "src/event.ts", + "qualifiedName": "handler" + }, + "24": { + "sourceFileName": "src/event.ts", + "qualifiedName": "options" + }, + "25": { + "sourceFileName": "src/event.ts", + "qualifiedName": "once" + }, + "26": { + "sourceFileName": "src/event.ts", + "qualifiedName": "once" + }, + "27": { + "sourceFileName": "src/event.ts", + "qualifiedName": "T" + }, + "28": { + "sourceFileName": "src/event.ts", + "qualifiedName": "event" + }, + "29": { + "sourceFileName": "src/event.ts", + "qualifiedName": "handler" + }, + "30": { + "sourceFileName": "src/event.ts", + "qualifiedName": "options" + }, + "31": { + "sourceFileName": "src/event.ts", + "qualifiedName": "emit" + }, + "32": { + "sourceFileName": "src/event.ts", + "qualifiedName": "emit" + }, + "33": { + "sourceFileName": "src/event.ts", + "qualifiedName": "event" + }, + "34": { + "sourceFileName": "src/event.ts", + "qualifiedName": "payload" + }, + "35": { + "sourceFileName": "src/event.ts", + "qualifiedName": "options" + }, + "36": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent" + }, + "37": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_RESIZED" + }, + "38": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_MOVED" + }, + "39": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_CLOSE_REQUESTED" + }, + "40": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_CREATED" + }, + "41": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_DESTROYED" + }, + "42": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_FOCUS" + }, + "43": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_BLUR" + }, + "44": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_SCALE_FACTOR_CHANGED" + }, + "45": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_THEME_CHANGED" + }, + "46": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_FILE_DROP" + }, + "47": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_FILE_DROP_HOVER" + }, + "48": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.WINDOW_FILE_DROP_CANCELLED" + }, + "49": { + "sourceFileName": "src/event.ts", + "qualifiedName": "TauriEvent.MENU" + }, + "50": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "" + }, + "51": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "mockIPC" + }, + "52": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "mockIPC" + }, + "53": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "cb" + }, + "54": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "__type" + }, + "55": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "__type" + }, + "56": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "cmd" + }, + "57": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "payload" + }, + "58": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "mockWindows" + }, + "59": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "mockWindows" + }, + "60": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "current" + }, + "61": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "additionalWindows" + }, + "62": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "clearMocks" + }, + "63": { + "sourceFileName": "src/mocks.ts", + "qualifiedName": "clearMocks" + }, + "64": { + "sourceFileName": "src/path.ts", + "qualifiedName": "" + }, + "65": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory" + }, + "66": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Audio" + }, + "67": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Cache" + }, + "68": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Config" + }, + "69": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Data" + }, + "70": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.LocalData" + }, + "71": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Document" + }, + "72": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Download" + }, + "73": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Picture" + }, + "74": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Public" + }, + "75": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Video" + }, + "76": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Resource" + }, + "77": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Temp" + }, + "78": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.AppConfig" + }, + "79": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.AppData" + }, + "80": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.AppLocalData" + }, + "81": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.AppCache" + }, + "82": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.AppLog" + }, + "83": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Desktop" + }, + "84": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Executable" + }, + "85": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Font" + }, + "86": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Home" + }, + "87": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Runtime" + }, + "88": { + "sourceFileName": "src/path.ts", + "qualifiedName": "BaseDirectory.Template" + }, + "89": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appConfigDir" + }, + "90": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appConfigDir" + }, + "91": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appDataDir" + }, + "92": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appDataDir" + }, + "93": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appLocalDataDir" + }, + "94": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appLocalDataDir" + }, + "95": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appCacheDir" + }, + "96": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appCacheDir" + }, + "97": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appLogDir" + }, + "98": { + "sourceFileName": "src/path.ts", + "qualifiedName": "appLogDir" + }, + "99": { + "sourceFileName": "src/path.ts", + "qualifiedName": "audioDir" + }, + "100": { + "sourceFileName": "src/path.ts", + "qualifiedName": "audioDir" + }, + "101": { + "sourceFileName": "src/path.ts", + "qualifiedName": "cacheDir" + }, + "102": { + "sourceFileName": "src/path.ts", + "qualifiedName": "cacheDir" + }, + "103": { + "sourceFileName": "src/path.ts", + "qualifiedName": "configDir" + }, + "104": { + "sourceFileName": "src/path.ts", + "qualifiedName": "configDir" + }, + "105": { + "sourceFileName": "src/path.ts", + "qualifiedName": "dataDir" + }, + "106": { + "sourceFileName": "src/path.ts", + "qualifiedName": "dataDir" + }, + "107": { + "sourceFileName": "src/path.ts", + "qualifiedName": "desktopDir" + }, + "108": { + "sourceFileName": "src/path.ts", + "qualifiedName": "desktopDir" + }, + "109": { + "sourceFileName": "src/path.ts", + "qualifiedName": "documentDir" + }, + "110": { + "sourceFileName": "src/path.ts", + "qualifiedName": "documentDir" + }, + "111": { + "sourceFileName": "src/path.ts", + "qualifiedName": "downloadDir" + }, + "112": { + "sourceFileName": "src/path.ts", + "qualifiedName": "downloadDir" + }, + "113": { + "sourceFileName": "src/path.ts", + "qualifiedName": "executableDir" + }, + "114": { + "sourceFileName": "src/path.ts", + "qualifiedName": "executableDir" + }, + "115": { + "sourceFileName": "src/path.ts", + "qualifiedName": "fontDir" + }, + "116": { + "sourceFileName": "src/path.ts", + "qualifiedName": "fontDir" + }, + "117": { + "sourceFileName": "src/path.ts", + "qualifiedName": "homeDir" + }, + "118": { + "sourceFileName": "src/path.ts", + "qualifiedName": "homeDir" + }, + "119": { + "sourceFileName": "src/path.ts", + "qualifiedName": "localDataDir" + }, + "120": { + "sourceFileName": "src/path.ts", + "qualifiedName": "localDataDir" + }, + "121": { + "sourceFileName": "src/path.ts", + "qualifiedName": "pictureDir" + }, + "122": { + "sourceFileName": "src/path.ts", + "qualifiedName": "pictureDir" + }, + "123": { + "sourceFileName": "src/path.ts", + "qualifiedName": "publicDir" + }, + "124": { + "sourceFileName": "src/path.ts", + "qualifiedName": "publicDir" + }, + "125": { + "sourceFileName": "src/path.ts", + "qualifiedName": "resourceDir" + }, + "126": { + "sourceFileName": "src/path.ts", + "qualifiedName": "resourceDir" + }, + "127": { + "sourceFileName": "src/path.ts", + "qualifiedName": "resolveResource" + }, + "128": { + "sourceFileName": "src/path.ts", + "qualifiedName": "resolveResource" + }, + "129": { + "sourceFileName": "src/path.ts", + "qualifiedName": "resourcePath" + }, + "130": { + "sourceFileName": "src/path.ts", + "qualifiedName": "runtimeDir" + }, + "131": { + "sourceFileName": "src/path.ts", + "qualifiedName": "runtimeDir" + }, + "132": { + "sourceFileName": "src/path.ts", + "qualifiedName": "templateDir" + }, + "133": { + "sourceFileName": "src/path.ts", + "qualifiedName": "templateDir" + }, + "134": { + "sourceFileName": "src/path.ts", + "qualifiedName": "videoDir" + }, + "135": { + "sourceFileName": "src/path.ts", + "qualifiedName": "videoDir" + }, + "136": { + "sourceFileName": "src/path.ts", + "qualifiedName": "sep" + }, + "137": { + "sourceFileName": "src/path.ts", + "qualifiedName": "sep" + }, + "138": { + "sourceFileName": "src/path.ts", + "qualifiedName": "delimiter" + }, + "139": { + "sourceFileName": "src/path.ts", + "qualifiedName": "delimiter" + }, + "140": { + "sourceFileName": "src/path.ts", + "qualifiedName": "resolve" + }, + "141": { + "sourceFileName": "src/path.ts", + "qualifiedName": "resolve" + }, + "142": { + "sourceFileName": "src/path.ts", + "qualifiedName": "paths" + }, + "143": { + "sourceFileName": "src/path.ts", + "qualifiedName": "normalize" + }, + "144": { + "sourceFileName": "src/path.ts", + "qualifiedName": "normalize" + }, + "145": { + "sourceFileName": "src/path.ts", + "qualifiedName": "path" + }, + "146": { + "sourceFileName": "src/path.ts", + "qualifiedName": "join" + }, + "147": { + "sourceFileName": "src/path.ts", + "qualifiedName": "join" + }, + "148": { + "sourceFileName": "src/path.ts", + "qualifiedName": "paths" + }, + "149": { + "sourceFileName": "src/path.ts", + "qualifiedName": "dirname" + }, + "150": { + "sourceFileName": "src/path.ts", + "qualifiedName": "dirname" + }, + "151": { + "sourceFileName": "src/path.ts", + "qualifiedName": "path" + }, + "152": { + "sourceFileName": "src/path.ts", + "qualifiedName": "extname" + }, + "153": { + "sourceFileName": "src/path.ts", + "qualifiedName": "extname" + }, + "154": { + "sourceFileName": "src/path.ts", + "qualifiedName": "path" + }, + "155": { + "sourceFileName": "src/path.ts", + "qualifiedName": "basename" + }, + "156": { + "sourceFileName": "src/path.ts", + "qualifiedName": "basename" + }, + "157": { + "sourceFileName": "src/path.ts", + "qualifiedName": "path" + }, + "158": { + "sourceFileName": "src/path.ts", + "qualifiedName": "ext" + }, + "159": { + "sourceFileName": "src/path.ts", + "qualifiedName": "isAbsolute" + }, + "160": { + "sourceFileName": "src/path.ts", + "qualifiedName": "isAbsolute" + }, + "161": { + "sourceFileName": "src/path.ts", + "qualifiedName": "path" + }, + "162": { + "sourceFileName": "src/path.ts", + "qualifiedName": "tempDir" + }, + "163": { + "sourceFileName": "src/path.ts", + "qualifiedName": "tempDir" + }, + "164": { + "sourceFileName": "src/path.ts", + "qualifiedName": "path" + }, + "165": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "" + }, + "166": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "InvokeArgs" + }, + "167": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "InvokeOptions" + }, + "168": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "InvokeOptions.headers" + }, + "169": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "transformCallback" + }, + "170": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "transformCallback" + }, + "171": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "callback" + }, + "172": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "173": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "174": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "response" + }, + "175": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "once" + }, + "176": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel" + }, + "177": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.__constructor" + }, + "178": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel" + }, + "179": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.T" + }, + "180": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.id" + }, + "181": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.__TAURI_CHANNEL_MARKER__" + }, + "182": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.#onmessage" + }, + "183": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "184": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "185": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "response" + }, + "186": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.onmessage" + }, + "187": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.onmessage" + }, + "188": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "189": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "190": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "response" + }, + "191": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.onmessage" + }, + "192": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "handler" + }, + "193": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "194": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "195": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "response" + }, + "196": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.toJSON" + }, + "197": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.toJSON" + }, + "198": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "Channel.T" + }, + "199": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "PluginListener" + }, + "200": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "PluginListener.__constructor" + }, + "201": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "PluginListener" + }, + "202": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "plugin" + }, + "203": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "event" + }, + "204": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "channelId" + }, + "205": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "PluginListener.plugin" + }, + "206": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "PluginListener.event" + }, + "207": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "PluginListener.channelId" + }, + "208": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "PluginListener.unregister" + }, + "209": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "PluginListener.unregister" + }, + "210": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "addPluginListener" + }, + "211": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "addPluginListener" + }, + "212": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "T" + }, + "213": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "plugin" + }, + "214": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "event" + }, + "215": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "cb" + }, + "216": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "217": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "__type" + }, + "218": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "payload" + }, + "219": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "invoke" + }, + "220": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "invoke" + }, + "221": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "T" + }, + "222": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "cmd" + }, + "223": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "args" + }, + "224": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "options" + }, + "225": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "convertFileSrc" + }, + "226": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "convertFileSrc" + }, + "227": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "filePath" + }, + "228": { + "sourceFileName": "src/tauri.ts", + "qualifiedName": "protocol" + } + } +} \ No newline at end of file diff --git a/tooling/api/src/tauri.ts b/tooling/api/src/tauri.ts index 733039733db0..8d76c0d32423 100644 --- a/tooling/api/src/tauri.ts +++ b/tooling/api/src/tauri.ts @@ -181,8 +181,8 @@ async function invoke( /** * Convert a device file path to an URL that can be loaded by the webview. - * Note that `asset:` and `https://asset.localhost` must be added to [`tauri.security.csp`](https://tauri.app/v1/api/config/#securityconfig.csp) in `tauri.conf.json`. - * Example CSP value: `"csp": "default-src 'self' ipc: https://ipc.localhost; img-src 'self' asset: https://asset.localhost"` to use the asset protocol on image sources. + * Note that `asset:` and `http://asset.localhost` must be added to [`tauri.security.csp`](https://tauri.app/v1/api/config/#securityconfig.csp) in `tauri.conf.json`. + * Example CSP value: `"csp": "default-src 'self' ipc: http://ipc.localhost; img-src 'self' asset: http://asset.localhost"` to use the asset protocol on image sources. * * 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. diff --git a/tooling/bench/tests/cpu_intensive/src-tauri/tauri.conf.json b/tooling/bench/tests/cpu_intensive/src-tauri/tauri.conf.json index eae6098e9823..68100cc05d98 100644 --- a/tooling/bench/tests/cpu_intensive/src-tauri/tauri.conf.json +++ b/tooling/bench/tests/cpu_intensive/src-tauri/tauri.conf.json @@ -43,7 +43,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/tooling/bench/tests/files_transfer/src-tauri/tauri.conf.json b/tooling/bench/tests/files_transfer/src-tauri/tauri.conf.json index eae6098e9823..68100cc05d98 100644 --- a/tooling/bench/tests/files_transfer/src-tauri/tauri.conf.json +++ b/tooling/bench/tests/files_transfer/src-tauri/tauri.conf.json @@ -43,7 +43,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/tooling/bench/tests/helloworld/src-tauri/tauri.conf.json b/tooling/bench/tests/helloworld/src-tauri/tauri.conf.json index eae6098e9823..68100cc05d98 100644 --- a/tooling/bench/tests/helloworld/src-tauri/tauri.conf.json +++ b/tooling/bench/tests/helloworld/src-tauri/tauri.conf.json @@ -43,7 +43,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file diff --git a/tooling/cli/src/migrate/config.rs b/tooling/cli/src/migrate/config.rs index a6c86bebf4a4..ea827b1a767d 100644 --- a/tooling/cli/src/migrate/config.rs +++ b/tooling/cli/src/migrate/config.rs @@ -85,21 +85,21 @@ fn process_security(security: &mut Map) -> Result<()> { match &mut csp { tauri_utils_v1::config::Csp::Policy(csp) => { if csp.contains("connect-src") { - *csp = csp.replace("connect-src", "connect-src ipc: https://ipc.localhost"); + *csp = csp.replace("connect-src", "connect-src ipc: http://ipc.localhost"); } else { - *csp = format!("{csp}; connect-src ipc: https://ipc.localhost"); + *csp = format!("{csp}; connect-src ipc: http://ipc.localhost"); } } tauri_utils_v1::config::Csp::DirectiveMap(csp) => { if let Some(connect_src) = csp.get_mut("connect-src") { - if !connect_src.contains("ipc: https://ipc.localhost") { - connect_src.push("ipc: https://ipc.localhost"); + if !connect_src.contains("ipc: http://ipc.localhost") { + connect_src.push("ipc: http://ipc.localhost"); } } else { csp.insert( "connect-src".into(), tauri_utils_v1::config::CspDirectiveSources::List(vec![ - "ipc: https://ipc.localhost".to_string() + "ipc: http://ipc.localhost".to_string() ]), ); } @@ -331,7 +331,7 @@ mod test { assert_eq!( migrated["tauri"]["security"]["csp"], format!( - "{}; connect-src ipc: https://ipc.localhost", + "{}; connect-src ipc: http://ipc.localhost", original["tauri"]["security"]["csp"].as_str().unwrap() ) ); @@ -358,7 +358,7 @@ mod test { assert!(migrated["tauri"]["security"]["csp"]["connect-src"] .as_array() .expect("connect-src isn't an array") - .contains(&"ipc: https://ipc.localhost".into())); + .contains(&"ipc: http://ipc.localhost".into())); } #[test] @@ -385,7 +385,7 @@ mod test { .as_str() .expect("connect-src isn't a string"), format!( - "{} ipc: https://ipc.localhost", + "{} ipc: http://ipc.localhost", original["tauri"]["security"]["csp"]["connect-src"] .as_str() .unwrap() diff --git a/tooling/cli/templates/plugin/__example-basic/vanilla/src-tauri/tauri.conf.json b/tooling/cli/templates/plugin/__example-basic/vanilla/src-tauri/tauri.conf.json index 787dadd50f1b..723f2dd24355 100644 --- a/tooling/cli/templates/plugin/__example-basic/vanilla/src-tauri/tauri.conf.json +++ b/tooling/cli/templates/plugin/__example-basic/vanilla/src-tauri/tauri.conf.json @@ -50,7 +50,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'; connect-src ipc: https://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'; connect-src ipc: http://ipc.localhost" } } } \ No newline at end of file From c3aa0086ab3e9065c038410c7c2c95877f2b2405 Mon Sep 17 00:00:00 2001 From: Lucas Nogueira Date: Thu, 7 Sep 2023 16:44:07 -0300 Subject: [PATCH 2/6] fix format_real_schema --- core/tauri/src/pattern.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/tauri/src/pattern.rs b/core/tauri/src/pattern.rs index 2318e5972eaa..7248fc72d80a 100644 --- a/core/tauri/src/pattern.rs +++ b/core/tauri/src/pattern.rs @@ -110,7 +110,7 @@ pub(crate) struct PatternJavascript { #[allow(dead_code)] pub(crate) fn format_real_schema(schema: &str) -> String { if cfg!(windows) || cfg!(target_os = "android") { - format!("https://{schema}.{ISOLATION_IFRAME_SRC_DOMAIN}") + format!("http://{schema}.{ISOLATION_IFRAME_SRC_DOMAIN}") } else { format!("{schema}://{ISOLATION_IFRAME_SRC_DOMAIN}") } From 49cdffb998cc801ace3781f014b6f9c266a1d317 Mon Sep 17 00:00:00 2001 From: Lucas Nogueira Date: Thu, 7 Sep 2023 16:50:54 -0300 Subject: [PATCH 3/6] keep logic on android --- core/tauri/CHANGELOG.md | 2 +- core/tauri/scripts/core.js | 8 +- core/tauri/src/manager.rs | 13 +- core/tauri/src/pattern.rs | 4 +- .../test/fixture/src-tauri/tauri.conf.json | 2 +- examples/api/src-tauri/tauri.conf.json | 4 +- examples/commands/tauri.conf.json | 2 +- examples/helloworld/tauri.conf.json | 2 +- examples/isolation/tauri.conf.json | 2 +- examples/multiwindow/tauri.conf.json | 2 +- examples/navigation/tauri.conf.json | 2 +- examples/parent-window/tauri.conf.json | 2 +- examples/resources/src-tauri/tauri.conf.json | 2 +- examples/splashscreen/tauri.conf.json | 2 +- examples/state/tauri.conf.json | 2 +- examples/streaming/tauri.conf.json | 2 +- .../src-tauri/tauri.conf.json | 2 +- tooling/api/CHANGELOG.md | 2 +- tooling/api/docs/js-api.json | 8033 +---------------- tooling/api/src/tauri.ts | 4 +- .../cpu_intensive/src-tauri/tauri.conf.json | 2 +- .../files_transfer/src-tauri/tauri.conf.json | 2 +- .../helloworld/src-tauri/tauri.conf.json | 2 +- tooling/cli/src/migrate/config.rs | 19 +- .../vanilla/src-tauri/tauri.conf.json | 2 +- 25 files changed, 52 insertions(+), 8069 deletions(-) diff --git a/core/tauri/CHANGELOG.md b/core/tauri/CHANGELOG.md index f3e783931e09..6943b861541a 100644 --- a/core/tauri/CHANGELOG.md +++ b/core/tauri/CHANGELOG.md @@ -1171,7 +1171,7 @@ Here is the logic flow that determines if JSON or JSON5 will be used to parse th ## \[1.0.0-beta.8] -- Fix missing asset protocol path.Now the protocol is `http://asset.localhost/path/to/file` on Windows. Lunix and macOS +- Fix missing asset protocol path.Now the protocol is `https://asset.localhost/path/to/file` on Windows. Lunix and macOS is still `asset://path/to/file`. - [994b5325](https://www.github.com/tauri-apps/tauri/commit/994b5325dd385f564b37fe1530c5d798dc925fff) fix: missing asset protocol path ([#2484](https://www.github.com/tauri-apps/tauri/pull/2484)) on 2021-08-23 - **Breaking change:** Removed `register_uri_scheme_protocol` from the `WebviewAttributes` struct and renamed `register_global_uri_scheme_protocol` to `register_uri_scheme_protocol` on the `Builder` struct, which now takes a `Fn(&AppHandle, &http::Request) -> http::Response` closure. diff --git a/core/tauri/scripts/core.js b/core/tauri/scripts/core.js index 62ac1d1d2416..3942cfb37746 100644 --- a/core/tauri/scripts/core.js +++ b/core/tauri/scripts/core.js @@ -17,9 +17,13 @@ window.__TAURI__.convertFileSrc = function convertFileSrc(filePath, protocol = 'asset') { const path = encodeURIComponent(filePath) - return osName === 'windows' || osName === 'android' + return osName === 'windows' ? `http://${protocol}.localhost/${path}` - : `${protocol}://localhost/${path}` + : ( + osName === 'android' + ? `https://${protocol}.localhost/${path}` + : `${protocol}://localhost/${path}` + ) } window.__TAURI__.transformCallback = function transformCallback( diff --git a/core/tauri/src/manager.rs b/core/tauri/src/manager.rs index f86ca2e452a0..51cb4ca5499d 100644 --- a/core/tauri/src/manager.rs +++ b/core/tauri/src/manager.rs @@ -506,10 +506,13 @@ impl WindowManager { } pub(crate) fn protocol_url(&self) -> Cow<'_, Url> { - #[cfg(any(windows, target_os = "android"))] - return Cow::Owned(Url::parse("http://tauri.localhost").unwrap()); - #[cfg(not(any(windows, target_os = "android")))] - Cow::Owned(Url::parse("tauri://localhost").unwrap()) + if cfg!(windows) { + Cow::Owned(Url::parse("http://tauri.localhost").unwrap()) + } else if cfg!(target_os = "android") { + Cow::Owned(Url::parse("https://tauri.localhost").unwrap()) + } else { + Cow::Owned(Url::parse("tauri://localhost").unwrap()) + } } fn csp(&self) -> Option { @@ -877,6 +880,8 @@ mod test { manager.get_url().to_string(), if cfg!(windows) { "http://tauri.localhost/" + } else if cfg!(target_os = "android") { + "https://tauri.localhost/" } else { "tauri://localhost" } diff --git a/core/tauri/src/pattern.rs b/core/tauri/src/pattern.rs index 7248fc72d80a..bf5a28f3ca8d 100644 --- a/core/tauri/src/pattern.rs +++ b/core/tauri/src/pattern.rs @@ -109,8 +109,10 @@ pub(crate) struct PatternJavascript { #[allow(dead_code)] pub(crate) fn format_real_schema(schema: &str) -> String { - if cfg!(windows) || cfg!(target_os = "android") { + if cfg!(windows) { format!("http://{schema}.{ISOLATION_IFRAME_SRC_DOMAIN}") + } else if cfg!(target_os = "android") { + format!("https://{schema}.{ISOLATION_IFRAME_SRC_DOMAIN}") } else { format!("{schema}://{ISOLATION_IFRAME_SRC_DOMAIN}") } diff --git a/core/tauri/test/fixture/src-tauri/tauri.conf.json b/core/tauri/test/fixture/src-tauri/tauri.conf.json index ecb5e3cecad0..45f0ddd1a9e7 100644 --- a/core/tauri/test/fixture/src-tauri/tauri.conf.json +++ b/core/tauri/test/fixture/src-tauri/tauri.conf.json @@ -15,7 +15,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/api/src-tauri/tauri.conf.json b/examples/api/src-tauri/tauri.conf.json index 20bf653403b7..eef3b5a7ba90 100644 --- a/examples/api/src-tauri/tauri.conf.json +++ b/examples/api/src-tauri/tauri.conf.json @@ -92,11 +92,11 @@ "security": { "csp": { "default-src": "'self' customprotocol: asset:", - "connect-src": "ipc: http://ipc.localhost", + "connect-src": "ipc: http://ipc.localhost https://ipc.localhost", "font-src": [ "https://fonts.gstatic.com" ], - "img-src": "'self' asset: http://asset.localhost blob: data:", + "img-src": "'self' asset: http://asset.localhost https://asset.localhost blob: data:", "style-src": "'unsafe-inline' 'self' https://fonts.googleapis.com" }, "freezePrototype": true, diff --git a/examples/commands/tauri.conf.json b/examples/commands/tauri.conf.json index 223643a7e16c..e4e669384591 100644 --- a/examples/commands/tauri.conf.json +++ b/examples/commands/tauri.conf.json @@ -51,7 +51,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/helloworld/tauri.conf.json b/examples/helloworld/tauri.conf.json index b9cafb3ea9fe..e73e178a5075 100644 --- a/examples/helloworld/tauri.conf.json +++ b/examples/helloworld/tauri.conf.json @@ -50,7 +50,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/isolation/tauri.conf.json b/examples/isolation/tauri.conf.json index 6da027907089..4c9da7394dc9 100644 --- a/examples/isolation/tauri.conf.json +++ b/examples/isolation/tauri.conf.json @@ -60,7 +60,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/multiwindow/tauri.conf.json b/examples/multiwindow/tauri.conf.json index 607aea31d9c0..e049dcb7dc74 100644 --- a/examples/multiwindow/tauri.conf.json +++ b/examples/multiwindow/tauri.conf.json @@ -47,7 +47,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/navigation/tauri.conf.json b/examples/navigation/tauri.conf.json index 82e00b902a3f..dfac5e640fc3 100644 --- a/examples/navigation/tauri.conf.json +++ b/examples/navigation/tauri.conf.json @@ -47,7 +47,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/parent-window/tauri.conf.json b/examples/parent-window/tauri.conf.json index c0f698b0e303..50e80f28b1e9 100644 --- a/examples/parent-window/tauri.conf.json +++ b/examples/parent-window/tauri.conf.json @@ -31,7 +31,7 @@ "category": "DeveloperTool" }, "security": { - "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/resources/src-tauri/tauri.conf.json b/examples/resources/src-tauri/tauri.conf.json index be4e9d98b21f..931fad4afd28 100644 --- a/examples/resources/src-tauri/tauri.conf.json +++ b/examples/resources/src-tauri/tauri.conf.json @@ -53,7 +53,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/splashscreen/tauri.conf.json b/examples/splashscreen/tauri.conf.json index 1429e78d1e2f..59061df41658 100644 --- a/examples/splashscreen/tauri.conf.json +++ b/examples/splashscreen/tauri.conf.json @@ -44,7 +44,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/state/tauri.conf.json b/examples/state/tauri.conf.json index 06018b37aa60..93020a8688c9 100644 --- a/examples/state/tauri.conf.json +++ b/examples/state/tauri.conf.json @@ -51,7 +51,7 @@ } ], "security": { - "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/examples/streaming/tauri.conf.json b/examples/streaming/tauri.conf.json index 78f315249107..7af0b5bc3833 100644 --- a/examples/streaming/tauri.conf.json +++ b/examples/streaming/tauri.conf.json @@ -51,7 +51,7 @@ } ], "security": { - "csp": "default-src 'self' ipc:; media-src stream: http://stream.localhost asset: http://asset.localhost", + "csp": "default-src 'self' ipc:; media-src stream: http://stream.localhost https://stream.localhost asset: http://asset.localhost https://asset.localhost", "assetProtocol": { "scope": [ "**/test_video.mp4" diff --git a/examples/tauri-dynamic-lib/src-tauri/tauri.conf.json b/examples/tauri-dynamic-lib/src-tauri/tauri.conf.json index 0f597d700571..775f8c198194 100644 --- a/examples/tauri-dynamic-lib/src-tauri/tauri.conf.json +++ b/examples/tauri-dynamic-lib/src-tauri/tauri.conf.json @@ -50,7 +50,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/tooling/api/CHANGELOG.md b/tooling/api/CHANGELOG.md index fab4e51b659d..d94f5664e3b5 100644 --- a/tooling/api/CHANGELOG.md +++ b/tooling/api/CHANGELOG.md @@ -281,7 +281,7 @@ ## \[1.0.0-beta.7] -- Fix missing asset protocol path.Now the protocol is `http://asset.localhost/path/to/file` on Windows. Linux and macOS +- Fix missing asset protocol path.Now the protocol is `https://asset.localhost/path/to/file` on Windows. Linux and macOS is still `asset://path/to/file`. - [994b5325](https://www.github.com/tauri-apps/tauri/commit/994b5325dd385f564b37fe1530c5d798dc925fff) fix: missing asset protocol path ([#2484](https://www.github.com/tauri-apps/tauri/pull/2484)) on 2021-08-23 diff --git a/tooling/api/docs/js-api.json b/tooling/api/docs/js-api.json index 04ceade5b332..3806e77c812a 100644 --- a/tooling/api/docs/js-api.json +++ b/tooling/api/docs/js-api.json @@ -1,8032 +1 @@ -{ - "id": 0, - "name": "@tauri-apps/api", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1, - "name": "event", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The event system allows you to emit events to the backend and listen to events from it.\n\nThis package is also accessible with " - }, - { - "kind": "code", - "text": "`window.__TAURI__.event`" - }, - { - "kind": "text", - "text": " when [" - }, - { - "kind": "code", - "text": "`build.withGlobalTauri`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "children": [ - { - "id": 36, - "name": "TauriEvent", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.1.0" - } - ] - } - ] - }, - "children": [ - { - "id": 49, - "name": "MENU", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 59, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://menu" - } - }, - { - "id": 43, - "name": "WINDOW_BLUR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 53, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://blur" - } - }, - { - "id": 39, - "name": "WINDOW_CLOSE_REQUESTED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://close-requested" - } - }, - { - "id": 40, - "name": "WINDOW_CREATED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://window-created" - } - }, - { - "id": 41, - "name": "WINDOW_DESTROYED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://destroyed" - } - }, - { - "id": 46, - "name": "WINDOW_FILE_DROP", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://file-drop" - } - }, - { - "id": 48, - "name": "WINDOW_FILE_DROP_CANCELLED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 58, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://file-drop-cancelled" - } - }, - { - "id": 47, - "name": "WINDOW_FILE_DROP_HOVER", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://file-drop-hover" - } - }, - { - "id": 42, - "name": "WINDOW_FOCUS", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 52, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://focus" - } - }, - { - "id": 38, - "name": "WINDOW_MOVED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://move" - } - }, - { - "id": 37, - "name": "WINDOW_RESIZED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://resize" - } - }, - { - "id": 44, - "name": "WINDOW_SCALE_FACTOR_CHANGED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 54, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://scale-change" - } - }, - { - "id": 45, - "name": "WINDOW_THEME_CHANGED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 55, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "tauri://theme-changed" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 49, - 43, - 39, - 40, - 41, - 46, - 48, - 47, - 42, - 38, - 37, - 44, - 45 - ] - } - ], - "sources": [ - { - "fileName": "event.ts", - "line": 46, - "character": 5 - } - ] - }, - { - "id": 2, - "name": "Event", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event name" - } - ] - }, - "sources": [ - { - "fileName": "event.ts", - "line": 16, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 16, - "name": "EventName", - "package": "@tauri-apps/api" - } - }, - { - "id": 5, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event identifier used to unlisten" - } - ] - }, - "sources": [ - { - "fileName": "event.ts", - "line": 20, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 6, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event payload" - } - ] - }, - "sources": [ - { - "fileName": "event.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - }, - { - "id": 4, - "name": "windowLabel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The label of the window that emitted this event." - } - ] - }, - "sources": [ - { - "fileName": "event.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3, - 5, - 6, - 4 - ] - } - ], - "sources": [ - { - "fileName": "event.ts", - "line": 14, - "character": 10 - } - ], - "typeParameters": [ - { - "id": 7, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ] - }, - { - "id": 17, - "name": "Options", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 18, - "name": "target", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Label of the window the function targets.\n\nWhen listening to events and using this value,\nonly events triggered by the window with the given label are received.\n\nWhen emitting events, only the window with the given label will receive it." - } - ] - }, - "sources": [ - { - "fileName": "event.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 18 - ] - } - ], - "sources": [ - { - "fileName": "event.ts", - "line": 31, - "character": 10 - } - ] - }, - { - "id": 8, - "name": "EventCallback", - "variant": "declaration", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 25, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 12, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 25, - "character": 24 - } - ], - "signatures": [ - { - "id": 10, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 11, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2, - "typeArguments": [ - { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - ], - "name": "Event", - "package": "@tauri-apps/api" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 16, - "name": "EventName", - "variant": "declaration", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 29, - "character": 5 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 36, - "name": "TauriEvent", - "package": "@tauri-apps/api" - }, - "" - ] - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "never" - }, - { - "type": "intrinsic", - "name": "never" - } - ], - "name": "Record", - "package": "typescript", - "externalUrl": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" - } - ] - } - ] - } - }, - { - "id": 13, - "name": "UnlistenFn", - "variant": "declaration", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 27, - "character": 5 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 14, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 27, - "character": 18 - } - ], - "signatures": [ - { - "id": 15, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 31, - "name": "emit", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 164, - "character": 15 - } - ], - "signatures": [ - { - "id": 32, - "name": "emit", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Emits an event to the backend and all Tauri windows." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { emit } from '@tauri-apps/api/event';\nawait emit('frontend-loaded', { loggedIn: true, token: 'authToken' });\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "event.ts", - "line": 164, - "character": 0 - } - ], - "parameters": [ - { - "id": 33, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event name. Must include only alphanumeric characters, " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`/`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`:`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`_`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 34, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 35, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 17, - "name": "Options", - "package": "@tauri-apps/api" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 19, - "name": "listen", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 99, - "character": 15 - } - ], - "signatures": [ - { - "id": 20, - "name": "listen", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listen to an event. The event can be either global or window-specific.\nSee " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "windowLabel", - "target": 4, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " to check the event source." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { listen } from '@tauri-apps/api/event';\nconst unlisten = await listen('error', (event) => {\n console.log(`Got error in window ${event.windowLabel}, payload: ${event.payload}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted." - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "event.ts", - "line": 99, - "character": 0 - } - ], - "typeParameter": [ - { - "id": 21, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 22, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event name. Must include only alphanumeric characters, " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`/`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`:`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`_`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": 16, - "name": "EventName", - "package": "@tauri-apps/api" - } - }, - { - "id": 23, - "name": "handler", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event handler callback." - } - ] - }, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - ], - "name": "EventCallback", - "package": "@tauri-apps/api" - } - }, - { - "id": 24, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 17, - "name": "Options", - "package": "@tauri-apps/api" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "UnlistenFn", - "package": "@tauri-apps/api" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 25, - "name": "once", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "event.ts", - "line": 137, - "character": 15 - } - ], - "signatures": [ - { - "id": 26, - "name": "once", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listen to an one-off event. See " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "listen", - "target": 19, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " for more information." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { once } from '@tauri-apps/api/event';\ninterface LoadedPayload {\n loggedIn: boolean,\n token: string\n}\nconst unlisten = await once('loaded', (event) => {\n console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted." - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "event.ts", - "line": 137, - "character": 0 - } - ], - "typeParameter": [ - { - "id": 27, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 28, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event name. Must include only alphanumeric characters, " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`/`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`:`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`_`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": 16, - "name": "EventName", - "package": "@tauri-apps/api" - } - }, - { - "id": 29, - "name": "handler", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 8, - "typeArguments": [ - { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - ], - "name": "EventCallback", - "package": "@tauri-apps/api" - } - }, - { - "id": 30, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 17, - "name": "Options", - "package": "@tauri-apps/api" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "UnlistenFn", - "package": "@tauri-apps/api" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [ - 36 - ] - }, - { - "title": "Interfaces", - "children": [ - 2, - 17 - ] - }, - { - "title": "Type Aliases", - "children": [ - 8, - 16, - 13 - ] - }, - { - "title": "Functions", - "children": [ - 31, - 19, - 25 - ] - } - ], - "sources": [ - { - "fileName": "event.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 50, - "name": "mocks", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 62, - "name": "clearMocks", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "mocks.ts", - "line": 178, - "character": 16 - } - ], - "signatures": [ - { - "id": 63, - "name": "clearMocks", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Clears mocked functions/data injected by the other functions in this module.\nWhen using a test runner that doesn't provide a fresh window object for each test, calling this function will reset tauri specific properties.\n\n# Example\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { mockWindows, clearMocks } from \"@tauri-apps/api/mocks\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked windows\", () => {\n mockWindows(\"main\", \"second\", \"third\");\n\n expect(window).toHaveProperty(\"__TAURI_METADATA__\")\n})\n\ntest(\"no mocked windows\", () => {\n expect(window).not.toHaveProperty(\"__TAURI_METADATA__\")\n})\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "mocks.ts", - "line": 178, - "character": 0 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 51, - "name": "mockIPC", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "mocks.ts", - "line": 80, - "character": 16 - } - ], - "signatures": [ - { - "id": 52, - "name": "mockIPC", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Intercepts all IPC requests with the given mock handler.\n\nThis function can be used when testing tauri frontend applications or when running the frontend in a Node.js context during static site generation.\n\n# Examples\n\nTesting setup using vitest:\n" - }, - { - "kind": "code", - "text": "```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, payload) => {\n switch (cmd) {\n case \"add\":\n return (payload.a as number) + (payload.b as number);\n default:\n break;\n }\n });\n\n expect(invoke('add', { a: 12, b: 15 })).resolves.toBe(27);\n})\n```" - }, - { - "kind": "text", - "text": "\n\nThe callback function can also return a Promise:\n" - }, - { - "kind": "code", - "text": "```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, payload) => {\n if(cmd === \"get_data\") {\n return fetch(\"https://example.com/data.json\")\n .then((response) => response.json())\n }\n });\n\n expect(invoke('get_data')).resolves.toBe({ foo: 'bar' });\n})\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "mocks.ts", - "line": 80, - "character": 0 - } - ], - "parameters": [ - { - "id": 53, - "name": "cb", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 54, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "mocks.ts", - "line": 81, - "character": 6 - } - ], - "signatures": [ - { - "id": 55, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "mocks.ts", - "line": 81, - "character": 6 - } - ], - "parameters": [ - { - "id": 56, - "name": "cmd", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 57, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript", - "externalUrl": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 58, - "name": "mockWindows", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "mocks.ts", - "line": 142, - "character": 16 - } - ], - "signatures": [ - { - "id": 59, - "name": "mockWindows", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mocks one or many window labels.\nIn non-tauri context it is required to call this function *before* using the " - }, - { - "kind": "code", - "text": "`@tauri-apps/api/window`" - }, - { - "kind": "text", - "text": " module.\n\nThis function only mocks the *presence* of windows,\nwindow properties (e.g. width and height) can be mocked like regular IPC calls using the " - }, - { - "kind": "code", - "text": "`mockIPC`" - }, - { - "kind": "text", - "text": " function.\n\n# Examples\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\nimport { getCurrent } from \"@tauri-apps/api/window\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nconst win = getCurrent();\n\nwin.label // \"main\"\n```" - }, - { - "kind": "text", - "text": "\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nmockIPC((cmd, args) => {\n if (cmd === \"plugin:event|emit\") {\n console.log('emit event', args?.event, args?.payload);\n }\n});\n\nconst { emit } = await import(\"@tauri-apps/api/event\");\nawait emit('loaded'); // this will cause the mocked IPC handler to log to the console.\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "mocks.ts", - "line": 142, - "character": 0 - } - ], - "parameters": [ - { - "id": 60, - "name": "current", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Label of window this JavaScript context is running in." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 61, - "name": "additionalWindows", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Label of additional windows the app has." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "children": [ - 62, - 51, - 58 - ] - } - ], - "sources": [ - { - "fileName": "mocks.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 64, - "name": "path", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path module provides utilities for working with file and directory paths.\n\nThis package is also accessible with " - }, - { - "kind": "code", - "text": "`window.__TAURI__.path`" - }, - { - "kind": "text", - "text": " when [" - }, - { - "kind": "code", - "text": "`build.withGlobalTauri`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security." - } - ] - }, - "children": [ - { - "id": 65, - "name": "BaseDirectory", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "2.0.0" - } - ] - } - ] - }, - "children": [ - { - "id": 81, - "name": "AppCache", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 16 - } - }, - { - "id": 78, - "name": "AppConfig", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 13 - } - }, - { - "id": 79, - "name": "AppData", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 14 - } - }, - { - "id": 80, - "name": "AppLocalData", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 34, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 15 - } - }, - { - "id": 82, - "name": "AppLog", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 17 - } - }, - { - "id": 66, - "name": "Audio", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 20, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 1 - } - }, - { - "id": 67, - "name": "Cache", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 2 - } - }, - { - "id": 68, - "name": "Config", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 3 - } - }, - { - "id": 69, - "name": "Data", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 4 - } - }, - { - "id": 83, - "name": "Desktop", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 18 - } - }, - { - "id": 71, - "name": "Document", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 6 - } - }, - { - "id": 72, - "name": "Download", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 26, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 7 - } - }, - { - "id": 84, - "name": "Executable", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 19 - } - }, - { - "id": 85, - "name": "Font", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 40, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 20 - } - }, - { - "id": 86, - "name": "Home", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 21 - } - }, - { - "id": 70, - "name": "LocalData", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 5 - } - }, - { - "id": 73, - "name": "Picture", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 27, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 8 - } - }, - { - "id": 74, - "name": "Public", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 28, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 9 - } - }, - { - "id": 76, - "name": "Resource", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 11 - } - }, - { - "id": 87, - "name": "Runtime", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 22 - } - }, - { - "id": 77, - "name": "Temp", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 12 - } - }, - { - "id": 88, - "name": "Template", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 23 - } - }, - { - "id": 75, - "name": "Video", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": 10 - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 81, - 78, - 79, - 80, - 82, - 66, - 67, - 68, - 69, - 83, - 71, - 72, - 84, - 85, - 86, - 70, - 73, - 74, - 76, - 87, - 77, - 88, - 75 - ] - } - ], - "sources": [ - { - "fileName": "path.ts", - "line": 19, - "character": 5 - } - ] - }, - { - "id": 95, - "name": "appCacheDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 108, - "character": 15 - } - ], - "signatures": [ - { - "id": 96, - "name": "appCacheDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the suggested directory for your app's cache files.\nResolves to " - }, - { - "kind": "code", - "text": "`${cacheDir}/${bundleIdentifier}`" - }, - { - "kind": "text", - "text": ", where " - }, - { - "kind": "code", - "text": "`bundleIdentifier`" - }, - { - "kind": "text", - "text": " is the value [" - }, - { - "kind": "code", - "text": "`tauri.bundle.identifier`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { appCacheDir } from '@tauri-apps/api/path';\nconst appCacheDirPath = await appCacheDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.2.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 108, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 89, - "name": "appConfigDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 57, - "character": 15 - } - ], - "signatures": [ - { - "id": 90, - "name": "appConfigDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the suggested directory for your app's config files.\nResolves to " - }, - { - "kind": "code", - "text": "`${configDir}/${bundleIdentifier}`" - }, - { - "kind": "text", - "text": ", where " - }, - { - "kind": "code", - "text": "`bundleIdentifier`" - }, - { - "kind": "text", - "text": " is the value [" - }, - { - "kind": "code", - "text": "`tauri.bundle.identifier`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { appConfigDir } from '@tauri-apps/api/path';\nconst appConfigDirPath = await appConfigDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.2.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 57, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 91, - "name": "appDataDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 74, - "character": 15 - } - ], - "signatures": [ - { - "id": 92, - "name": "appDataDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the suggested directory for your app's data files.\nResolves to " - }, - { - "kind": "code", - "text": "`${dataDir}/${bundleIdentifier}`" - }, - { - "kind": "text", - "text": ", where " - }, - { - "kind": "code", - "text": "`bundleIdentifier`" - }, - { - "kind": "text", - "text": " is the value [" - }, - { - "kind": "code", - "text": "`tauri.bundle.identifier`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.2.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 74, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 93, - "name": "appLocalDataDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 91, - "character": 15 - } - ], - "signatures": [ - { - "id": 94, - "name": "appLocalDataDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the suggested directory for your app's local data files.\nResolves to " - }, - { - "kind": "code", - "text": "`${localDataDir}/${bundleIdentifier}`" - }, - { - "kind": "text", - "text": ", where " - }, - { - "kind": "code", - "text": "`bundleIdentifier`" - }, - { - "kind": "text", - "text": " is the value [" - }, - { - "kind": "code", - "text": "`tauri.bundle.identifier`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { appLocalDataDir } from '@tauri-apps/api/path';\nconst appLocalDataDirPath = await appLocalDataDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.2.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 91, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 97, - "name": "appLogDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 520, - "character": 15 - } - ], - "signatures": [ - { - "id": 98, - "name": "appLogDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the suggested directory for your app's log files.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`${configDir}/${bundleIdentifier}/logs`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`${homeDir}/Library/Logs/{bundleIdentifier}`" - }, - { - "kind": "text", - "text": "\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`${configDir}/${bundleIdentifier}/logs`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { appLogDir } from '@tauri-apps/api/path';\nconst appLogDirPath = await appLogDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.2.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 520, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 99, - "name": "audioDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 130, - "character": 15 - } - ], - "signatures": [ - { - "id": 100, - "name": "audioDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's audio directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" - }, - { - "kind": "code", - "text": "`xdg-user-dirs`" - }, - { - "kind": "text", - "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " - }, - { - "kind": "code", - "text": "`XDG_MUSIC_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Music`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Music}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { audioDir } from '@tauri-apps/api/path';\nconst audioDirPath = await audioDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 130, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 155, - "name": "basename", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 653, - "character": 15 - } - ], - "signatures": [ - { - "id": 156, - "name": "basename", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the last portion of a " - }, - { - "kind": "code", - "text": "`path`" - }, - { - "kind": "text", - "text": ". Trailing directory separators are ignored." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { basename, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst base = await basename(resourcePath);\nassert(base === 'app.conf');\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 653, - "character": 0 - } - ], - "parameters": [ - { - "id": 157, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 158, - "name": "ext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional file extension to be removed from the returned path." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 101, - "name": "cacheDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 152, - "character": 15 - } - ], - "signatures": [ - { - "id": 102, - "name": "cacheDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's cache directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`$XDG_CACHE_HOME`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`$HOME/.cache`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Library/Caches`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_LocalAppData}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { cacheDir } from '@tauri-apps/api/path';\nconst cacheDirPath = await cacheDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 152, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 103, - "name": "configDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 174, - "character": 15 - } - ], - "signatures": [ - { - "id": 104, - "name": "configDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's config directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`$XDG_CONFIG_HOME`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`$HOME/.config`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Library/Application Support`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_RoamingAppData}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { configDir } from '@tauri-apps/api/path';\nconst configDirPath = await configDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 174, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 105, - "name": "dataDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 196, - "character": 15 - } - ], - "signatures": [ - { - "id": 106, - "name": "dataDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`$XDG_DATA_HOME`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`$HOME/.local/share`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Library/Application Support`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_RoamingAppData}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { dataDir } from '@tauri-apps/api/path';\nconst dataDirPath = await dataDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 196, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 138, - "name": "delimiter", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 560, - "character": 9 - } - ], - "signatures": [ - { - "id": 139, - "name": "delimiter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the platform-specific path segment delimiter:\n- " - }, - { - "kind": "code", - "text": "`;`" - }, - { - "kind": "text", - "text": " on Windows\n- " - }, - { - "kind": "code", - "text": "`:`" - }, - { - "kind": "text", - "text": " on POSIX" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "2.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 560, - "character": 0 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 107, - "name": "desktopDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 218, - "character": 15 - } - ], - "signatures": [ - { - "id": 108, - "name": "desktopDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's desktop directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" - }, - { - "kind": "code", - "text": "`xdg-user-dirs`" - }, - { - "kind": "text", - "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " - }, - { - "kind": "code", - "text": "`XDG_DESKTOP_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Desktop`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Desktop}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { desktopDir } from '@tauri-apps/api/path';\nconst desktopPath = await desktopDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 218, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 149, - "name": "dirname", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 619, - "character": 15 - } - ], - "signatures": [ - { - "id": 150, - "name": "dirname", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the directory name of a " - }, - { - "kind": "code", - "text": "`path`" - }, - { - "kind": "text", - "text": ". Trailing directory separators are ignored." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { dirname, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst dir = await dirname(appDataDirPath);\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 619, - "character": 0 - } - ], - "parameters": [ - { - "id": 151, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 109, - "name": "documentDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 240, - "character": 15 - } - ], - "signatures": [ - { - "id": 110, - "name": "documentDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's document directory." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { documentDir } from '@tauri-apps/api/path';\nconst documentDirPath = await documentDir();\n```" - }, - { - "kind": "text", - "text": "\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" - }, - { - "kind": "code", - "text": "`xdg-user-dirs`" - }, - { - "kind": "text", - "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " - }, - { - "kind": "code", - "text": "`XDG_DOCUMENTS_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Documents`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Documents}`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 240, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 111, - "name": "downloadDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 262, - "character": 15 - } - ], - "signatures": [ - { - "id": 112, - "name": "downloadDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's download directory.\n\n#### Platform-specific\n\n- **Linux**: Resolves to [" - }, - { - "kind": "code", - "text": "`xdg-user-dirs`" - }, - { - "kind": "text", - "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " - }, - { - "kind": "code", - "text": "`XDG_DOWNLOAD_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS**: Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Downloads`" - }, - { - "kind": "text", - "text": ".\n- **Windows**: Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Downloads}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { downloadDir } from '@tauri-apps/api/path';\nconst downloadDirPath = await downloadDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 262, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 113, - "name": "executableDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 284, - "character": 15 - } - ], - "signatures": [ - { - "id": 114, - "name": "executableDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's executable directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`$XDG_BIN_HOME/../bin`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`$XDG_DATA_HOME/../bin`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`$HOME/.local/bin`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Not supported.\n- **Windows:** Not supported." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { executableDir } from '@tauri-apps/api/path';\nconst executableDirPath = await executableDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 284, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 152, - "name": "extname", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 635, - "character": 15 - } - ], - "signatures": [ - { - "id": 153, - "name": "extname", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the extension of the " - }, - { - "kind": "code", - "text": "`path`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { extname, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst ext = await extname(resourcePath);\nassert(ext === 'conf');\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 635, - "character": 0 - } - ], - "parameters": [ - { - "id": 154, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 115, - "name": "fontDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 306, - "character": 15 - } - ], - "signatures": [ - { - "id": 116, - "name": "fontDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's font directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`$XDG_DATA_HOME/fonts`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`$HOME/.local/share/fonts`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Library/Fonts`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Not supported." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { fontDir } from '@tauri-apps/api/path';\nconst fontDirPath = await fontDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 306, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 117, - "name": "homeDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 328, - "character": 15 - } - ], - "signatures": [ - { - "id": 118, - "name": "homeDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's home directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Profile}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { homeDir } from '@tauri-apps/api/path';\nconst homeDirPath = await homeDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 328, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 159, - "name": "isAbsolute", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 667, - "character": 15 - } - ], - "signatures": [ - { - "id": 160, - "name": "isAbsolute", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns whether the path is absolute or not." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { isAbsolute } from '@tauri-apps/api/path';\nassert(await isAbsolute('/home/tauri'));\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 667, - "character": 0 - } - ], - "parameters": [ - { - "id": 161, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 146, - "name": "join", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 604, - "character": 15 - } - ], - "signatures": [ - { - "id": 147, - "name": "join", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Joins all given " - }, - { - "kind": "code", - "text": "`path`" - }, - { - "kind": "text", - "text": " segments together using the platform-specific separator as a delimiter, then normalizes the resulting path." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { join, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await join(appDataDirPath, 'users', 'tauri', 'avatar.png');\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 604, - "character": 0 - } - ], - "parameters": [ - { - "id": 148, - "name": "paths", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 119, - "name": "localDataDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 350, - "character": 15 - } - ], - "signatures": [ - { - "id": 120, - "name": "localDataDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's local data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`$XDG_DATA_HOME`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`$HOME/.local/share`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Library/Application Support`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_LocalAppData}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { localDataDir } from '@tauri-apps/api/path';\nconst localDataDirPath = await localDataDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 350, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 143, - "name": "normalize", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 589, - "character": 15 - } - ], - "signatures": [ - { - "id": 144, - "name": "normalize", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Normalizes the given " - }, - { - "kind": "code", - "text": "`path`" - }, - { - "kind": "text", - "text": ", resolving " - }, - { - "kind": "code", - "text": "`'..'`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`'.'`" - }, - { - "kind": "text", - "text": " segments and resolve symbolic links." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { normalize, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await normalize(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 589, - "character": 0 - } - ], - "parameters": [ - { - "id": 145, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 121, - "name": "pictureDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 372, - "character": 15 - } - ], - "signatures": [ - { - "id": 122, - "name": "pictureDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's picture directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" - }, - { - "kind": "code", - "text": "`xdg-user-dirs`" - }, - { - "kind": "text", - "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " - }, - { - "kind": "code", - "text": "`XDG_PICTURES_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Pictures`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Pictures}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { pictureDir } from '@tauri-apps/api/path';\nconst pictureDirPath = await pictureDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 372, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 123, - "name": "publicDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 394, - "character": 15 - } - ], - "signatures": [ - { - "id": 124, - "name": "publicDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's public directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" - }, - { - "kind": "code", - "text": "`xdg-user-dirs`" - }, - { - "kind": "text", - "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " - }, - { - "kind": "code", - "text": "`XDG_PUBLICSHARE_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Public`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Public}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { publicDir } from '@tauri-apps/api/path';\nconst publicDirPath = await publicDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 394, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 140, - "name": "resolve", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 574, - "character": 15 - } - ], - "signatures": [ - { - "id": 141, - "name": "resolve", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resolves a sequence of " - }, - { - "kind": "code", - "text": "`paths`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`path`" - }, - { - "kind": "text", - "text": " segments into an absolute path." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { resolve, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await resolve(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 574, - "character": 0 - } - ], - "parameters": [ - { - "id": 142, - "name": "paths", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 127, - "name": "resolveResource", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 431, - "character": 15 - } - ], - "signatures": [ - { - "id": 128, - "name": "resolveResource", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resolve the path to a resource file." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('script.sh');\n```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The full path to the resource." - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 431, - "character": 0 - } - ], - "parameters": [ - { - "id": 129, - "name": "resourcePath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path to the resource.\nMust follow the same syntax as defined in " - }, - { - "kind": "code", - "text": "`tauri.conf.json > tauri > bundle > resources`" - }, - { - "kind": "text", - "text": ", i.e. keeping subfolders and parent dir components (" - }, - { - "kind": "code", - "text": "`../`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 125, - "name": "resourceDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 411, - "character": 15 - } - ], - "signatures": [ - { - "id": 126, - "name": "resourceDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the application's resource directory.\nTo resolve a resource path, see the [[resolveResource | " - }, - { - "kind": "code", - "text": "`resolveResource API`" - }, - { - "kind": "text", - "text": "]]." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { resourceDir } from '@tauri-apps/api/path';\nconst resourceDirPath = await resourceDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 411, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 130, - "name": "runtimeDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 454, - "character": 15 - } - ], - "signatures": [ - { - "id": 131, - "name": "runtimeDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's runtime directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to " - }, - { - "kind": "code", - "text": "`$XDG_RUNTIME_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Not supported.\n- **Windows:** Not supported." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { runtimeDir } from '@tauri-apps/api/path';\nconst runtimeDirPath = await runtimeDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 454, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 136, - "name": "sep", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 549, - "character": 9 - } - ], - "signatures": [ - { - "id": 137, - "name": "sep", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the platform-specific path segment separator:\n- " - }, - { - "kind": "code", - "text": "`\\` on Windows\n- `" - }, - { - "kind": "text", - "text": "/` on POSIX" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "2.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 549, - "character": 0 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 162, - "name": "tempDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 536, - "character": 15 - } - ], - "signatures": [ - { - "id": 163, - "name": "tempDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a temporary directory." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { tempDir } from '@tauri-apps/api/path';\nconst temp = await tempDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "2.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 536, - "character": 0 - } - ], - "parameters": [ - { - "id": 164, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 132, - "name": "templateDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 476, - "character": 15 - } - ], - "signatures": [ - { - "id": 133, - "name": "templateDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's template directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" - }, - { - "kind": "code", - "text": "`xdg-user-dirs`" - }, - { - "kind": "text", - "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " - }, - { - "kind": "code", - "text": "`XDG_TEMPLATES_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Not supported.\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Templates}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { templateDir } from '@tauri-apps/api/path';\nconst templateDirPath = await templateDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 476, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 134, - "name": "videoDir", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "path.ts", - "line": 498, - "character": 15 - } - ], - "signatures": [ - { - "id": 135, - "name": "videoDir", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the path to the user's video directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to [" - }, - { - "kind": "code", - "text": "`xdg-user-dirs`" - }, - { - "kind": "text", - "text": "](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' " - }, - { - "kind": "code", - "text": "`XDG_VIDEOS_DIR`" - }, - { - "kind": "text", - "text": ".\n- **macOS:** Resolves to " - }, - { - "kind": "code", - "text": "`$HOME/Movies`" - }, - { - "kind": "text", - "text": ".\n- **Windows:** Resolves to " - }, - { - "kind": "code", - "text": "`{FOLDERID_Videos}`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { videoDir } from '@tauri-apps/api/path';\nconst videoDirPath = await videoDir();\n```" - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "path.ts", - "line": 498, - "character": 0 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [ - 65 - ] - }, - { - "title": "Functions", - "children": [ - 95, - 89, - 91, - 93, - 97, - 99, - 155, - 101, - 103, - 105, - 138, - 107, - 149, - 109, - 111, - 113, - 152, - 115, - 117, - 159, - 146, - 119, - 143, - 121, - 123, - 140, - 127, - 125, - 130, - 136, - 162, - 132, - 134 - ] - } - ], - "sources": [ - { - "fileName": "path.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 165, - "name": "tauri", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Invoke your custom commands.\n\nThis package is also accessible with " - }, - { - "kind": "code", - "text": "`window.__TAURI__.tauri`" - }, - { - "kind": "text", - "text": " when [" - }, - { - "kind": "code", - "text": "`build.withGlobalTauri`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "children": [ - { - "id": 176, - "name": "Channel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 177, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 71, - "character": 2 - } - ], - "signatures": [ - { - "id": 178, - "name": "new Channel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 71, - "character": 2 - } - ], - "typeParameter": [ - { - "id": 179, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 176, - "typeArguments": [ - { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - ], - "name": "Channel", - "package": "@tauri-apps/api" - } - } - ] - }, - { - "id": 182, - "name": "#onmessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "tauri.ts", - "line": 67, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 67, - "character": 14 - } - ], - "signatures": [ - { - "id": 184, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 67, - "character": 14 - } - ], - "parameters": [ - { - "id": 185, - "name": "response", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 181, - "name": "__TAURI_CHANNEL_MARKER__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPrivate": true, - "isReadonly": true - }, - "sources": [ - { - "fileName": "tauri.ts", - "line": 66, - "character": 19 - } - ], - "type": { - "type": "literal", - "value": true - }, - "defaultValue": "true" - }, - { - "id": 180, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 186, - "name": "onmessage", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 77, - "character": 6 - }, - { - "fileName": "tauri.ts", - "line": 81, - "character": 6 - } - ], - "getSignature": { - "id": 187, - "name": "onmessage", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 188, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 81, - "character": 19 - } - ], - "signatures": [ - { - "id": 189, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 81, - "character": 19 - } - ], - "parameters": [ - { - "id": 190, - "name": "response", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - "setSignature": { - "id": 191, - "name": "onmessage", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 77, - "character": 2 - } - ], - "parameters": [ - { - "id": 192, - "name": "handler", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 193, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 77, - "character": 25 - } - ], - "signatures": [ - { - "id": 194, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 77, - "character": 25 - } - ], - "parameters": [ - { - "id": 195, - "name": "response", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 196, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 85, - "character": 2 - } - ], - "signatures": [ - { - "id": 197, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 177 - ] - }, - { - "title": "Properties", - "children": [ - 182, - 181, - 180 - ] - }, - { - "title": "Accessors", - "children": [ - 186 - ] - }, - { - "title": "Methods", - "children": [ - 196 - ] - } - ], - "sources": [ - { - "fileName": "tauri.ts", - "line": 63, - "character": 6 - } - ], - "typeParameters": [ - { - "id": 198, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 199, - "name": "PluginListener", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 200, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 95, - "character": 2 - } - ], - "signatures": [ - { - "id": 201, - "name": "new PluginListener", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 95, - "character": 2 - } - ], - "parameters": [ - { - "id": 202, - "name": "plugin", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 203, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 204, - "name": "channelId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 199, - "name": "PluginListener", - "package": "@tauri-apps/api" - } - } - ] - }, - { - "id": 207, - "name": "channelId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 206, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 92, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 205, - "name": "plugin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 91, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 208, - "name": "unregister", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 101, - "character": 8 - } - ], - "signatures": [ - { - "id": 209, - "name": "unregister", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 200 - ] - }, - { - "title": "Properties", - "children": [ - 207, - 206, - 205 - ] - }, - { - "title": "Methods", - "children": [ - 208 - ] - } - ], - "sources": [ - { - "fileName": "tauri.ts", - "line": 90, - "character": 6 - } - ] - }, - { - "id": 167, - "name": "InvokeOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "2.0.0" - } - ] - } - ] - }, - "children": [ - { - "id": 168, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 139, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript", - "externalUrl": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/API/Headers" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 168 - ] - } - ], - "sources": [ - { - "fileName": "tauri.ts", - "line": 138, - "character": 10 - } - ] - }, - { - "id": 166, - "name": "InvokeArgs", - "variant": "declaration", - "kind": 4194304, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Command arguments." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "tauri.ts", - "line": 133, - "character": 5 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript", - "externalUrl": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "number" - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" - }, - { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array" - } - ] - } - }, - { - "id": 210, - "name": "addPluginListener", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 116, - "character": 15 - } - ], - "signatures": [ - { - "id": 211, - "name": "addPluginListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Adds a listener to a plugin event." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The listener object to stop listening to the events." - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "2.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "tauri.ts", - "line": 116, - "character": 0 - } - ], - "typeParameter": [ - { - "id": 212, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 213, - "name": "plugin", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 215, - "name": "cb", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 216, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 119, - "character": 6 - } - ], - "signatures": [ - { - "id": 217, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 119, - "character": 6 - } - ], - "parameters": [ - { - "id": 218, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 199, - "name": "PluginListener", - "package": "@tauri-apps/api" - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 225, - "name": "convertFileSrc", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 212, - "character": 9 - } - ], - "signatures": [ - { - "id": 226, - "name": "convertFileSrc", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Convert a device file path to an URL that can be loaded by the webview.\nNote that " - }, - { - "kind": "code", - "text": "`asset:`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`http://asset.localhost`" - }, - { - "kind": "text", - "text": " must be added to [" - }, - { - "kind": "code", - "text": "`tauri.security.csp`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#securityconfig.csp) in " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": ".\nExample CSP value: " - }, - { - "kind": "code", - "text": "`\"csp\": \"default-src 'self' ipc: http://ipc.localhost; img-src 'self' asset: http://asset.localhost\"`" - }, - { - "kind": "text", - "text": " to use the asset protocol on image sources.\n\nAdditionally, " - }, - { - "kind": "code", - "text": "`asset`" - }, - { - "kind": "text", - "text": " must be added to [" - }, - { - "kind": "code", - "text": "`tauri.allowlist.protocol`" - }, - { - "kind": "text", - "text": "](https://tauri.app/v1/api/config/#allowlistconfig.protocol)\nin " - }, - { - "kind": "code", - "text": "`tauri.conf.json`" - }, - { - "kind": "text", - "text": " and its access scope must be defined on the " - }, - { - "kind": "code", - "text": "`assetScope`" - }, - { - "kind": "text", - "text": " array on the same " - }, - { - "kind": "code", - "text": "`protocol`" - }, - { - "kind": "text", - "text": " object." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { appDataDir, join } from '@tauri-apps/api/path';\nimport { convertFileSrc } from '@tauri-apps/api/tauri';\nconst appDataDirPath = await appDataDir();\nconst filePath = await join(appDataDirPath, 'assets/video.mp4');\nconst assetUrl = convertFileSrc(filePath);\n\nconst video = document.getElementById('my-video');\nconst source = document.createElement('source');\nsource.type = 'video/mp4';\nsource.src = assetUrl;\nvideo.appendChild(source);\nvideo.load();\n```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the URL that can be used as source on the webview." - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "tauri.ts", - "line": 212, - "character": 0 - } - ], - "parameters": [ - { - "id": 227, - "name": "filePath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 228, - "name": "protocol", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The protocol to use. Defaults to " - }, - { - "kind": "code", - "text": "`asset`" - }, - { - "kind": "text", - "text": ". You only need to set this when using a custom protocol." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'asset'" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 219, - "name": "invoke", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 157, - "character": 15 - } - ], - "signatures": [ - { - "id": 220, - "name": "invoke", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a message to the backend." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { invoke } from '@tauri-apps/api/tauri';\nawait invoke('login', { user: 'tauri', password: 'poiwe3h4r5ip3yrhtew9ty' });\n```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A promise resolving or rejecting to the backend response." - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "tauri.ts", - "line": 157, - "character": 0 - } - ], - "typeParameter": [ - { - "id": 221, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 222, - "name": "cmd", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The command name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 223, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The optional arguments to pass to the command." - } - ] - }, - "type": { - "type": "reference", - "target": 166, - "name": "InvokeArgs", - "package": "@tauri-apps/api" - }, - "defaultValue": "{}" - }, - { - "id": 224, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The request options." - } - ] - }, - "type": { - "type": "reference", - "target": 167, - "name": "InvokeOptions", - "package": "@tauri-apps/api" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": -1, - "name": "T", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript", - "externalUrl": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" - } - } - ] - }, - { - "id": 169, - "name": "transformCallback", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 41, - "character": 9 - } - ], - "signatures": [ - { - "id": 170, - "name": "transformCallback", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transforms a callback function to a string identifier that can be passed to the backend.\nThe backend uses the identifier to " - }, - { - "kind": "code", - "text": "`eval()`" - }, - { - "kind": "text", - "text": " the callback." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A unique identifier associated with the callback function." - } - ] - }, - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "tauri.ts", - "line": 41, - "character": 0 - } - ], - "parameters": [ - { - "id": 171, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 42, - "character": 13 - } - ], - "signatures": [ - { - "id": 173, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "tauri.ts", - "line": 42, - "character": 13 - } - ], - "parameters": [ - { - "id": 174, - "name": "response", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 175, - "name": "once", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [ - 176, - 199 - ] - }, - { - "title": "Interfaces", - "children": [ - 167 - ] - }, - { - "title": "Type Aliases", - "children": [ - 166 - ] - }, - { - "title": "Functions", - "children": [ - 210, - 225, - 219, - 169 - ] - } - ], - "sources": [ - { - "fileName": "tauri.ts", - "line": 1, - "character": 0 - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "children": [ - 1, - 50, - 64, - 165 - ] - } - ], - "packageName": "@tauri-apps/api", - "symbolIdMap": { - "1": { - "sourceFileName": "src/event.ts", - "qualifiedName": "" - }, - "2": { - "sourceFileName": "src/event.ts", - "qualifiedName": "Event" - }, - "3": { - "sourceFileName": "src/event.ts", - "qualifiedName": "Event.event" - }, - "4": { - "sourceFileName": "src/event.ts", - "qualifiedName": "Event.windowLabel" - }, - "5": { - "sourceFileName": "src/event.ts", - "qualifiedName": "Event.id" - }, - "6": { - "sourceFileName": "src/event.ts", - "qualifiedName": "Event.payload" - }, - "7": { - "sourceFileName": "src/event.ts", - "qualifiedName": "Event.T" - }, - "8": { - "sourceFileName": "src/event.ts", - "qualifiedName": "EventCallback" - }, - "9": { - "sourceFileName": "src/event.ts", - "qualifiedName": "__type" - }, - "10": { - "sourceFileName": "src/event.ts", - "qualifiedName": "__type" - }, - "11": { - "sourceFileName": "src/event.ts", - "qualifiedName": "event" - }, - "12": { - "sourceFileName": "src/event.ts", - "qualifiedName": "T" - }, - "13": { - "sourceFileName": "src/event.ts", - "qualifiedName": "UnlistenFn" - }, - "14": { - "sourceFileName": "src/event.ts", - "qualifiedName": "__type" - }, - "15": { - "sourceFileName": "src/event.ts", - "qualifiedName": "__type" - }, - "16": { - "sourceFileName": "src/event.ts", - "qualifiedName": "EventName" - }, - "17": { - "sourceFileName": "src/event.ts", - "qualifiedName": "Options" - }, - "18": { - "sourceFileName": "src/event.ts", - "qualifiedName": "Options.target" - }, - "19": { - "sourceFileName": "src/event.ts", - "qualifiedName": "listen" - }, - "20": { - "sourceFileName": "src/event.ts", - "qualifiedName": "listen" - }, - "21": { - "sourceFileName": "src/event.ts", - "qualifiedName": "T" - }, - "22": { - "sourceFileName": "src/event.ts", - "qualifiedName": "event" - }, - "23": { - "sourceFileName": "src/event.ts", - "qualifiedName": "handler" - }, - "24": { - "sourceFileName": "src/event.ts", - "qualifiedName": "options" - }, - "25": { - "sourceFileName": "src/event.ts", - "qualifiedName": "once" - }, - "26": { - "sourceFileName": "src/event.ts", - "qualifiedName": "once" - }, - "27": { - "sourceFileName": "src/event.ts", - "qualifiedName": "T" - }, - "28": { - "sourceFileName": "src/event.ts", - "qualifiedName": "event" - }, - "29": { - "sourceFileName": "src/event.ts", - "qualifiedName": "handler" - }, - "30": { - "sourceFileName": "src/event.ts", - "qualifiedName": "options" - }, - "31": { - "sourceFileName": "src/event.ts", - "qualifiedName": "emit" - }, - "32": { - "sourceFileName": "src/event.ts", - "qualifiedName": "emit" - }, - "33": { - "sourceFileName": "src/event.ts", - "qualifiedName": "event" - }, - "34": { - "sourceFileName": "src/event.ts", - "qualifiedName": "payload" - }, - "35": { - "sourceFileName": "src/event.ts", - "qualifiedName": "options" - }, - "36": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent" - }, - "37": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_RESIZED" - }, - "38": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_MOVED" - }, - "39": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_CLOSE_REQUESTED" - }, - "40": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_CREATED" - }, - "41": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_DESTROYED" - }, - "42": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_FOCUS" - }, - "43": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_BLUR" - }, - "44": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_SCALE_FACTOR_CHANGED" - }, - "45": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_THEME_CHANGED" - }, - "46": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_FILE_DROP" - }, - "47": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_FILE_DROP_HOVER" - }, - "48": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.WINDOW_FILE_DROP_CANCELLED" - }, - "49": { - "sourceFileName": "src/event.ts", - "qualifiedName": "TauriEvent.MENU" - }, - "50": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "" - }, - "51": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "mockIPC" - }, - "52": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "mockIPC" - }, - "53": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "cb" - }, - "54": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "__type" - }, - "55": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "__type" - }, - "56": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "cmd" - }, - "57": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "payload" - }, - "58": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "mockWindows" - }, - "59": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "mockWindows" - }, - "60": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "current" - }, - "61": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "additionalWindows" - }, - "62": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "clearMocks" - }, - "63": { - "sourceFileName": "src/mocks.ts", - "qualifiedName": "clearMocks" - }, - "64": { - "sourceFileName": "src/path.ts", - "qualifiedName": "" - }, - "65": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory" - }, - "66": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Audio" - }, - "67": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Cache" - }, - "68": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Config" - }, - "69": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Data" - }, - "70": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.LocalData" - }, - "71": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Document" - }, - "72": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Download" - }, - "73": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Picture" - }, - "74": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Public" - }, - "75": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Video" - }, - "76": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Resource" - }, - "77": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Temp" - }, - "78": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.AppConfig" - }, - "79": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.AppData" - }, - "80": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.AppLocalData" - }, - "81": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.AppCache" - }, - "82": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.AppLog" - }, - "83": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Desktop" - }, - "84": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Executable" - }, - "85": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Font" - }, - "86": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Home" - }, - "87": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Runtime" - }, - "88": { - "sourceFileName": "src/path.ts", - "qualifiedName": "BaseDirectory.Template" - }, - "89": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appConfigDir" - }, - "90": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appConfigDir" - }, - "91": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appDataDir" - }, - "92": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appDataDir" - }, - "93": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appLocalDataDir" - }, - "94": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appLocalDataDir" - }, - "95": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appCacheDir" - }, - "96": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appCacheDir" - }, - "97": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appLogDir" - }, - "98": { - "sourceFileName": "src/path.ts", - "qualifiedName": "appLogDir" - }, - "99": { - "sourceFileName": "src/path.ts", - "qualifiedName": "audioDir" - }, - "100": { - "sourceFileName": "src/path.ts", - "qualifiedName": "audioDir" - }, - "101": { - "sourceFileName": "src/path.ts", - "qualifiedName": "cacheDir" - }, - "102": { - "sourceFileName": "src/path.ts", - "qualifiedName": "cacheDir" - }, - "103": { - "sourceFileName": "src/path.ts", - "qualifiedName": "configDir" - }, - "104": { - "sourceFileName": "src/path.ts", - "qualifiedName": "configDir" - }, - "105": { - "sourceFileName": "src/path.ts", - "qualifiedName": "dataDir" - }, - "106": { - "sourceFileName": "src/path.ts", - "qualifiedName": "dataDir" - }, - "107": { - "sourceFileName": "src/path.ts", - "qualifiedName": "desktopDir" - }, - "108": { - "sourceFileName": "src/path.ts", - "qualifiedName": "desktopDir" - }, - "109": { - "sourceFileName": "src/path.ts", - "qualifiedName": "documentDir" - }, - "110": { - "sourceFileName": "src/path.ts", - "qualifiedName": "documentDir" - }, - "111": { - "sourceFileName": "src/path.ts", - "qualifiedName": "downloadDir" - }, - "112": { - "sourceFileName": "src/path.ts", - "qualifiedName": "downloadDir" - }, - "113": { - "sourceFileName": "src/path.ts", - "qualifiedName": "executableDir" - }, - "114": { - "sourceFileName": "src/path.ts", - "qualifiedName": "executableDir" - }, - "115": { - "sourceFileName": "src/path.ts", - "qualifiedName": "fontDir" - }, - "116": { - "sourceFileName": "src/path.ts", - "qualifiedName": "fontDir" - }, - "117": { - "sourceFileName": "src/path.ts", - "qualifiedName": "homeDir" - }, - "118": { - "sourceFileName": "src/path.ts", - "qualifiedName": "homeDir" - }, - "119": { - "sourceFileName": "src/path.ts", - "qualifiedName": "localDataDir" - }, - "120": { - "sourceFileName": "src/path.ts", - "qualifiedName": "localDataDir" - }, - "121": { - "sourceFileName": "src/path.ts", - "qualifiedName": "pictureDir" - }, - "122": { - "sourceFileName": "src/path.ts", - "qualifiedName": "pictureDir" - }, - "123": { - "sourceFileName": "src/path.ts", - "qualifiedName": "publicDir" - }, - "124": { - "sourceFileName": "src/path.ts", - "qualifiedName": "publicDir" - }, - "125": { - "sourceFileName": "src/path.ts", - "qualifiedName": "resourceDir" - }, - "126": { - "sourceFileName": "src/path.ts", - "qualifiedName": "resourceDir" - }, - "127": { - "sourceFileName": "src/path.ts", - "qualifiedName": "resolveResource" - }, - "128": { - "sourceFileName": "src/path.ts", - "qualifiedName": "resolveResource" - }, - "129": { - "sourceFileName": "src/path.ts", - "qualifiedName": "resourcePath" - }, - "130": { - "sourceFileName": "src/path.ts", - "qualifiedName": "runtimeDir" - }, - "131": { - "sourceFileName": "src/path.ts", - "qualifiedName": "runtimeDir" - }, - "132": { - "sourceFileName": "src/path.ts", - "qualifiedName": "templateDir" - }, - "133": { - "sourceFileName": "src/path.ts", - "qualifiedName": "templateDir" - }, - "134": { - "sourceFileName": "src/path.ts", - "qualifiedName": "videoDir" - }, - "135": { - "sourceFileName": "src/path.ts", - "qualifiedName": "videoDir" - }, - "136": { - "sourceFileName": "src/path.ts", - "qualifiedName": "sep" - }, - "137": { - "sourceFileName": "src/path.ts", - "qualifiedName": "sep" - }, - "138": { - "sourceFileName": "src/path.ts", - "qualifiedName": "delimiter" - }, - "139": { - "sourceFileName": "src/path.ts", - "qualifiedName": "delimiter" - }, - "140": { - "sourceFileName": "src/path.ts", - "qualifiedName": "resolve" - }, - "141": { - "sourceFileName": "src/path.ts", - "qualifiedName": "resolve" - }, - "142": { - "sourceFileName": "src/path.ts", - "qualifiedName": "paths" - }, - "143": { - "sourceFileName": "src/path.ts", - "qualifiedName": "normalize" - }, - "144": { - "sourceFileName": "src/path.ts", - "qualifiedName": "normalize" - }, - "145": { - "sourceFileName": "src/path.ts", - "qualifiedName": "path" - }, - "146": { - "sourceFileName": "src/path.ts", - "qualifiedName": "join" - }, - "147": { - "sourceFileName": "src/path.ts", - "qualifiedName": "join" - }, - "148": { - "sourceFileName": "src/path.ts", - "qualifiedName": "paths" - }, - "149": { - "sourceFileName": "src/path.ts", - "qualifiedName": "dirname" - }, - "150": { - "sourceFileName": "src/path.ts", - "qualifiedName": "dirname" - }, - "151": { - "sourceFileName": "src/path.ts", - "qualifiedName": "path" - }, - "152": { - "sourceFileName": "src/path.ts", - "qualifiedName": "extname" - }, - "153": { - "sourceFileName": "src/path.ts", - "qualifiedName": "extname" - }, - "154": { - "sourceFileName": "src/path.ts", - "qualifiedName": "path" - }, - "155": { - "sourceFileName": "src/path.ts", - "qualifiedName": "basename" - }, - "156": { - "sourceFileName": "src/path.ts", - "qualifiedName": "basename" - }, - "157": { - "sourceFileName": "src/path.ts", - "qualifiedName": "path" - }, - "158": { - "sourceFileName": "src/path.ts", - "qualifiedName": "ext" - }, - "159": { - "sourceFileName": "src/path.ts", - "qualifiedName": "isAbsolute" - }, - "160": { - "sourceFileName": "src/path.ts", - "qualifiedName": "isAbsolute" - }, - "161": { - "sourceFileName": "src/path.ts", - "qualifiedName": "path" - }, - "162": { - "sourceFileName": "src/path.ts", - "qualifiedName": "tempDir" - }, - "163": { - "sourceFileName": "src/path.ts", - "qualifiedName": "tempDir" - }, - "164": { - "sourceFileName": "src/path.ts", - "qualifiedName": "path" - }, - "165": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "" - }, - "166": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "InvokeArgs" - }, - "167": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "InvokeOptions" - }, - "168": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "InvokeOptions.headers" - }, - "169": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "transformCallback" - }, - "170": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "transformCallback" - }, - "171": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "callback" - }, - "172": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "173": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "174": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "response" - }, - "175": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "once" - }, - "176": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel" - }, - "177": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.__constructor" - }, - "178": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel" - }, - "179": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.T" - }, - "180": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.id" - }, - "181": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.__TAURI_CHANNEL_MARKER__" - }, - "182": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.#onmessage" - }, - "183": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "184": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "185": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "response" - }, - "186": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.onmessage" - }, - "187": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.onmessage" - }, - "188": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "189": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "190": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "response" - }, - "191": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.onmessage" - }, - "192": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "handler" - }, - "193": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "194": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "195": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "response" - }, - "196": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.toJSON" - }, - "197": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.toJSON" - }, - "198": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "Channel.T" - }, - "199": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "PluginListener" - }, - "200": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "PluginListener.__constructor" - }, - "201": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "PluginListener" - }, - "202": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "plugin" - }, - "203": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "event" - }, - "204": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "channelId" - }, - "205": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "PluginListener.plugin" - }, - "206": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "PluginListener.event" - }, - "207": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "PluginListener.channelId" - }, - "208": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "PluginListener.unregister" - }, - "209": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "PluginListener.unregister" - }, - "210": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "addPluginListener" - }, - "211": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "addPluginListener" - }, - "212": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "T" - }, - "213": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "plugin" - }, - "214": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "event" - }, - "215": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "cb" - }, - "216": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "217": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "__type" - }, - "218": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "payload" - }, - "219": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "invoke" - }, - "220": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "invoke" - }, - "221": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "T" - }, - "222": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "cmd" - }, - "223": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "args" - }, - "224": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "options" - }, - "225": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "convertFileSrc" - }, - "226": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "convertFileSrc" - }, - "227": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "filePath" - }, - "228": { - "sourceFileName": "src/tauri.ts", - "qualifiedName": "protocol" - } - } -} \ No newline at end of file +{"id":0,"name":"@tauri-apps/api","variant":"project","kind":1,"flags":{},"children":[{"id":1,"name":"event","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"The event system allows you to emit events to the backend and listen to events from it.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.event`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":36,"name":"TauriEvent","variant":"declaration","kind":8,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"children":[{"id":49,"name":"MENU","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":59,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L59"}],"type":{"type":"literal","value":"tauri://menu"}},{"id":43,"name":"WINDOW_BLUR","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":53,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L53"}],"type":{"type":"literal","value":"tauri://blur"}},{"id":39,"name":"WINDOW_CLOSE_REQUESTED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":49,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L49"}],"type":{"type":"literal","value":"tauri://close-requested"}},{"id":40,"name":"WINDOW_CREATED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":50,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L50"}],"type":{"type":"literal","value":"tauri://window-created"}},{"id":41,"name":"WINDOW_DESTROYED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":51,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L51"}],"type":{"type":"literal","value":"tauri://destroyed"}},{"id":46,"name":"WINDOW_FILE_DROP","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":56,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L56"}],"type":{"type":"literal","value":"tauri://file-drop"}},{"id":48,"name":"WINDOW_FILE_DROP_CANCELLED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":58,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L58"}],"type":{"type":"literal","value":"tauri://file-drop-cancelled"}},{"id":47,"name":"WINDOW_FILE_DROP_HOVER","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":57,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L57"}],"type":{"type":"literal","value":"tauri://file-drop-hover"}},{"id":42,"name":"WINDOW_FOCUS","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":52,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L52"}],"type":{"type":"literal","value":"tauri://focus"}},{"id":38,"name":"WINDOW_MOVED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":48,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L48"}],"type":{"type":"literal","value":"tauri://move"}},{"id":37,"name":"WINDOW_RESIZED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":47,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L47"}],"type":{"type":"literal","value":"tauri://resize"}},{"id":44,"name":"WINDOW_SCALE_FACTOR_CHANGED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":54,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L54"}],"type":{"type":"literal","value":"tauri://scale-change"}},{"id":45,"name":"WINDOW_THEME_CHANGED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":55,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L55"}],"type":{"type":"literal","value":"tauri://theme-changed"}}],"groups":[{"title":"Enumeration Members","children":[49,43,39,40,41,46,48,47,42,38,37,44,45]}],"sources":[{"fileName":"event.ts","line":46,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L46"}]},{"id":2,"name":"Event","variant":"declaration","kind":256,"flags":{},"children":[{"id":3,"name":"event","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name"}]},"sources":[{"fileName":"event.ts","line":16,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L16"}],"type":{"type":"reference","target":16,"name":"EventName","package":"@tauri-apps/api"}},{"id":5,"name":"id","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event identifier used to unlisten"}]},"sources":[{"fileName":"event.ts","line":20,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L20"}],"type":{"type":"intrinsic","name":"number"}},{"id":6,"name":"payload","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event payload"}]},"sources":[{"fileName":"event.ts","line":22,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L22"}],"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}},{"id":4,"name":"windowLabel","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The label of the window that emitted this event."}]},"sources":[{"fileName":"event.ts","line":18,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L18"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[3,5,6,4]}],"sources":[{"fileName":"event.ts","line":14,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L14"}],"typeParameters":[{"id":7,"name":"T","variant":"typeParam","kind":131072,"flags":{}}]},{"id":17,"name":"Options","variant":"declaration","kind":256,"flags":{},"children":[{"id":18,"name":"target","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label of the window the function targets.\n\nWhen listening to events and using this value,\nonly events triggered by the window with the given label are received.\n\nWhen emitting events, only the window with the given label will receive it."}]},"sources":[{"fileName":"event.ts","line":40,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L40"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[18]}],"sources":[{"fileName":"event.ts","line":31,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L31"}]},{"id":8,"name":"EventCallback","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"event.ts","line":25,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L25"}],"typeParameters":[{"id":12,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":9,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"event.ts","line":25,"character":24,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L25"}],"signatures":[{"id":10,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":11,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Event","package":"@tauri-apps/api"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":16,"name":"EventName","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"event.ts","line":29,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L29"}],"type":{"type":"union","types":[{"type":"templateLiteral","head":"","tail":[[{"type":"reference","target":36,"name":"TauriEvent","package":"@tauri-apps/api"},""]]},{"type":"intersection","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"never"},{"type":"intrinsic","name":"never"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}]}]}},{"id":13,"name":"UnlistenFn","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"event.ts","line":27,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L27"}],"type":{"type":"reflection","declaration":{"id":14,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"event.ts","line":27,"character":18,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L27"}],"signatures":[{"id":15,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":31,"name":"emit","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":164,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L164"}],"signatures":[{"id":32,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Emits an event to the backend and all Tauri windows."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { emit } from '@tauri-apps/api/event';\nawait emit('frontend-loaded', { loggedIn: true, token: 'authToken' });\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":164,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L164"}],"parameters":[{"id":33,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":34,"name":"payload","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}},{"id":35,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":17,"name":"Options","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":19,"name":"listen","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":99,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L99"}],"signatures":[{"id":20,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an event. The event can be either global or window-specific.\nSee "},{"kind":"inline-tag","tag":"@link","text":"windowLabel","target":4,"tsLinkText":""},{"kind":"text","text":" to check the event source."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { listen } from '@tauri-apps/api/event';\nconst unlisten = await listen('error', (event) => {\n console.log(`Got error in window ${event.windowLabel}, payload: ${event.payload}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":99,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L99"}],"typeParameter":[{"id":21,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":22,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"reference","target":16,"name":"EventName","package":"@tauri-apps/api"}},{"id":23,"name":"handler","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler callback."}]},"type":{"type":"reference","target":8,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"EventCallback","package":"@tauri-apps/api"}},{"id":24,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":17,"name":"Options","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":13,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":25,"name":"once","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":137,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L137"}],"signatures":[{"id":26,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an one-off event. See "},{"kind":"inline-tag","tag":"@link","text":"listen","target":19,"tsLinkText":""},{"kind":"text","text":" for more information."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { once } from '@tauri-apps/api/event';\ninterface LoadedPayload {\n loggedIn: boolean,\n token: string\n}\nconst unlisten = await once('loaded', (event) => {\n console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":137,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L137"}],"typeParameter":[{"id":27,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":28,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"reference","target":16,"name":"EventName","package":"@tauri-apps/api"}},{"id":29,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":8,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"EventCallback","package":"@tauri-apps/api"}},{"id":30,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":17,"name":"Options","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":13,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Enumerations","children":[36]},{"title":"Interfaces","children":[2,17]},{"title":"Type Aliases","children":[8,16,13]},{"title":"Functions","children":[31,19,25]}],"sources":[{"fileName":"event.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/event.ts#L1"}]},{"id":50,"name":"mocks","variant":"declaration","kind":2,"flags":{},"children":[{"id":62,"name":"clearMocks","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":178,"character":16,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L178"}],"signatures":[{"id":63,"name":"clearMocks","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clears mocked functions/data injected by the other functions in this module.\nWhen using a test runner that doesn't provide a fresh window object for each test, calling this function will reset tauri specific properties.\n\n# Example\n\n"},{"kind":"code","text":"```js\nimport { mockWindows, clearMocks } from \"@tauri-apps/api/mocks\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked windows\", () => {\n mockWindows(\"main\", \"second\", \"third\");\n\n expect(window).toHaveProperty(\"__TAURI_METADATA__\")\n})\n\ntest(\"no mocked windows\", () => {\n expect(window).not.toHaveProperty(\"__TAURI_METADATA__\")\n})\n```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":178,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L178"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":51,"name":"mockIPC","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":80,"character":16,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L80"}],"signatures":[{"id":52,"name":"mockIPC","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Intercepts all IPC requests with the given mock handler.\n\nThis function can be used when testing tauri frontend applications or when running the frontend in a Node.js context during static site generation.\n\n# Examples\n\nTesting setup using vitest:\n"},{"kind":"code","text":"```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, payload) => {\n switch (cmd) {\n case \"add\":\n return (payload.a as number) + (payload.b as number);\n default:\n break;\n }\n });\n\n expect(invoke('add', { a: 12, b: 15 })).resolves.toBe(27);\n})\n```"},{"kind":"text","text":"\n\nThe callback function can also return a Promise:\n"},{"kind":"code","text":"```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, payload) => {\n if(cmd === \"get_data\") {\n return fetch(\"https://example.com/data.json\")\n .then((response) => response.json())\n }\n });\n\n expect(invoke('get_data')).resolves.toBe({ foo: 'bar' });\n})\n```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":80,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L80"}],"parameters":[{"id":53,"name":"cb","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":54,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"mocks.ts","line":81,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L81"}],"signatures":[{"id":55,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"mocks.ts","line":81,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L81"}],"parameters":[{"id":56,"name":"cmd","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":57,"name":"payload","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}}],"type":{"type":"intrinsic","name":"any"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":58,"name":"mockWindows","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":142,"character":16,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L142"}],"signatures":[{"id":59,"name":"mockWindows","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mocks one or many window labels.\nIn non-tauri context it is required to call this function *before* using the "},{"kind":"code","text":"`@tauri-apps/api/window`"},{"kind":"text","text":" module.\n\nThis function only mocks the *presence* of windows,\nwindow properties (e.g. width and height) can be mocked like regular IPC calls using the "},{"kind":"code","text":"`mockIPC`"},{"kind":"text","text":" function.\n\n# Examples\n\n"},{"kind":"code","text":"```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\nimport { getCurrent } from \"@tauri-apps/api/window\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nconst win = getCurrent();\n\nwin.label // \"main\"\n```"},{"kind":"text","text":"\n\n"},{"kind":"code","text":"```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nmockIPC((cmd, args) => {\n if (cmd === \"plugin:event|emit\") {\n console.log('emit event', args?.event, args?.payload);\n }\n});\n\nconst { emit } = await import(\"@tauri-apps/api/event\");\nawait emit('loaded'); // this will cause the mocked IPC handler to log to the console.\n```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":142,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L142"}],"parameters":[{"id":60,"name":"current","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label of window this JavaScript context is running in."}]},"type":{"type":"intrinsic","name":"string"}},{"id":61,"name":"additionalWindows","variant":"param","kind":32768,"flags":{"isRest":true},"comment":{"summary":[{"kind":"text","text":"Label of additional windows the app has."}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Functions","children":[62,51,58]}],"sources":[{"fileName":"mocks.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/mocks.ts#L1"}]},{"id":64,"name":"path","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"The path module provides utilities for working with file and directory paths.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.path`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":65,"name":"BaseDirectory","variant":"declaration","kind":8,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"children":[{"id":81,"name":"AppCache","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":35,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L35"}],"type":{"type":"literal","value":16}},{"id":78,"name":"AppConfig","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":32,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L32"}],"type":{"type":"literal","value":13}},{"id":79,"name":"AppData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":33,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L33"}],"type":{"type":"literal","value":14}},{"id":80,"name":"AppLocalData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":34,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L34"}],"type":{"type":"literal","value":15}},{"id":82,"name":"AppLog","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":36,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L36"}],"type":{"type":"literal","value":17}},{"id":66,"name":"Audio","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":20,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L20"}],"type":{"type":"literal","value":1}},{"id":67,"name":"Cache","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":21,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L21"}],"type":{"type":"literal","value":2}},{"id":68,"name":"Config","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":22,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L22"}],"type":{"type":"literal","value":3}},{"id":69,"name":"Data","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":23,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L23"}],"type":{"type":"literal","value":4}},{"id":83,"name":"Desktop","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":38,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L38"}],"type":{"type":"literal","value":18}},{"id":71,"name":"Document","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":25,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L25"}],"type":{"type":"literal","value":6}},{"id":72,"name":"Download","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":26,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L26"}],"type":{"type":"literal","value":7}},{"id":84,"name":"Executable","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":39,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L39"}],"type":{"type":"literal","value":19}},{"id":85,"name":"Font","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":40,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L40"}],"type":{"type":"literal","value":20}},{"id":86,"name":"Home","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":41,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L41"}],"type":{"type":"literal","value":21}},{"id":70,"name":"LocalData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":24,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L24"}],"type":{"type":"literal","value":5}},{"id":73,"name":"Picture","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":27,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L27"}],"type":{"type":"literal","value":8}},{"id":74,"name":"Public","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":28,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L28"}],"type":{"type":"literal","value":9}},{"id":76,"name":"Resource","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":30,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L30"}],"type":{"type":"literal","value":11}},{"id":87,"name":"Runtime","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":42,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L42"}],"type":{"type":"literal","value":22}},{"id":77,"name":"Temp","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":31,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L31"}],"type":{"type":"literal","value":12}},{"id":88,"name":"Template","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":43,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L43"}],"type":{"type":"literal","value":23}},{"id":75,"name":"Video","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"path.ts","line":29,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L29"}],"type":{"type":"literal","value":10}}],"groups":[{"title":"Enumeration Members","children":[81,78,79,80,82,66,67,68,69,83,71,72,84,85,86,70,73,74,76,87,77,88,75]}],"sources":[{"fileName":"path.ts","line":19,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L19"}]},{"id":95,"name":"appCacheDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":108,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L108"}],"signatures":[{"id":96,"name":"appCacheDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's cache files.\nResolves to "},{"kind":"code","text":"`${cacheDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appCacheDir } from '@tauri-apps/api/path';\nconst appCacheDirPath = await appCacheDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":108,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L108"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":89,"name":"appConfigDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":57,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L57"}],"signatures":[{"id":90,"name":"appConfigDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's config files.\nResolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appConfigDir } from '@tauri-apps/api/path';\nconst appConfigDirPath = await appConfigDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":57,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L57"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":91,"name":"appDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":74,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L74"}],"signatures":[{"id":92,"name":"appDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's data files.\nResolves to "},{"kind":"code","text":"`${dataDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":74,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L74"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":93,"name":"appLocalDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":91,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L91"}],"signatures":[{"id":94,"name":"appLocalDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's local data files.\nResolves to "},{"kind":"code","text":"`${localDataDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appLocalDataDir } from '@tauri-apps/api/path';\nconst appLocalDataDirPath = await appLocalDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":91,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L91"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":97,"name":"appLogDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":520,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L520"}],"signatures":[{"id":98,"name":"appLogDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's log files.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}/logs`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`${homeDir}/Library/Logs/{bundleIdentifier}`"},{"kind":"text","text":"\n- **Windows:** Resolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}/logs`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appLogDir } from '@tauri-apps/api/path';\nconst appLogDirPath = await appLogDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":520,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L520"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":99,"name":"audioDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":130,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L130"}],"signatures":[{"id":100,"name":"audioDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's audio directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_MUSIC_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Music`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Music}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { audioDir } from '@tauri-apps/api/path';\nconst audioDirPath = await audioDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":130,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L130"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":155,"name":"basename","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":653,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L653"}],"signatures":[{"id":156,"name":"basename","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the last portion of a "},{"kind":"code","text":"`path`"},{"kind":"text","text":". Trailing directory separators are ignored."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { basename, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst base = await basename(resourcePath);\nassert(base === 'app.conf');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":653,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L653"}],"parameters":[{"id":157,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":158,"name":"ext","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional file extension to be removed from the returned path."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":101,"name":"cacheDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":152,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L152"}],"signatures":[{"id":102,"name":"cacheDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's cache directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_CACHE_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.cache`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Caches`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_LocalAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { cacheDir } from '@tauri-apps/api/path';\nconst cacheDirPath = await cacheDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":152,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L152"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":103,"name":"configDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":174,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L174"}],"signatures":[{"id":104,"name":"configDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's config directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_CONFIG_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.config`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_RoamingAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { configDir } from '@tauri-apps/api/path';\nconst configDirPath = await configDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":174,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L174"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":105,"name":"dataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":196,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L196"}],"signatures":[{"id":106,"name":"dataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_RoamingAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { dataDir } from '@tauri-apps/api/path';\nconst dataDirPath = await dataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":196,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L196"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":138,"name":"delimiter","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":560,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L560"}],"signatures":[{"id":139,"name":"delimiter","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the platform-specific path segment delimiter:\n- "},{"kind":"code","text":"`;`"},{"kind":"text","text":" on Windows\n- "},{"kind":"code","text":"`:`"},{"kind":"text","text":" on POSIX"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"sources":[{"fileName":"path.ts","line":560,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L560"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":107,"name":"desktopDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":218,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L218"}],"signatures":[{"id":108,"name":"desktopDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's desktop directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DESKTOP_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Desktop`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Desktop}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { desktopDir } from '@tauri-apps/api/path';\nconst desktopPath = await desktopDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":218,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L218"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":149,"name":"dirname","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":619,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L619"}],"signatures":[{"id":150,"name":"dirname","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the directory name of a "},{"kind":"code","text":"`path`"},{"kind":"text","text":". Trailing directory separators are ignored."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { dirname, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst dir = await dirname(appDataDirPath);\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":619,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L619"}],"parameters":[{"id":151,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":109,"name":"documentDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":240,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L240"}],"signatures":[{"id":110,"name":"documentDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's document directory."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { documentDir } from '@tauri-apps/api/path';\nconst documentDirPath = await documentDir();\n```"},{"kind":"text","text":"\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DOCUMENTS_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Documents`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Documents}`"},{"kind":"text","text":"."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":240,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L240"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":111,"name":"downloadDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":262,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L262"}],"signatures":[{"id":112,"name":"downloadDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's download directory.\n\n#### Platform-specific\n\n- **Linux**: Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DOWNLOAD_DIR`"},{"kind":"text","text":".\n- **macOS**: Resolves to "},{"kind":"code","text":"`$HOME/Downloads`"},{"kind":"text","text":".\n- **Windows**: Resolves to "},{"kind":"code","text":"`{FOLDERID_Downloads}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { downloadDir } from '@tauri-apps/api/path';\nconst downloadDirPath = await downloadDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":262,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L262"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":113,"name":"executableDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":284,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L284"}],"signatures":[{"id":114,"name":"executableDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's executable directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_BIN_HOME/../bin`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$XDG_DATA_HOME/../bin`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/bin`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { executableDir } from '@tauri-apps/api/path';\nconst executableDirPath = await executableDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":284,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L284"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":152,"name":"extname","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":635,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L635"}],"signatures":[{"id":153,"name":"extname","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the extension of the "},{"kind":"code","text":"`path`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { extname, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst ext = await extname(resourcePath);\nassert(ext === 'conf');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":635,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L635"}],"parameters":[{"id":154,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":115,"name":"fontDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":306,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L306"}],"signatures":[{"id":116,"name":"fontDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's font directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME/fonts`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share/fonts`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Fonts`"},{"kind":"text","text":".\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { fontDir } from '@tauri-apps/api/path';\nconst fontDirPath = await fontDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":306,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L306"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":117,"name":"homeDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":328,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L328"}],"signatures":[{"id":118,"name":"homeDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's home directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$HOME`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Profile}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { homeDir } from '@tauri-apps/api/path';\nconst homeDirPath = await homeDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":328,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L328"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":159,"name":"isAbsolute","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":667,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L667"}],"signatures":[{"id":160,"name":"isAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns whether the path is absolute or not."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { isAbsolute } from '@tauri-apps/api/path';\nassert(await isAbsolute('/home/tauri'));\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":667,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L667"}],"parameters":[{"id":161,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":146,"name":"join","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":604,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L604"}],"signatures":[{"id":147,"name":"join","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Joins all given "},{"kind":"code","text":"`path`"},{"kind":"text","text":" segments together using the platform-specific separator as a delimiter, then normalizes the resulting path."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { join, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await join(appDataDirPath, 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":604,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L604"}],"parameters":[{"id":148,"name":"paths","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":119,"name":"localDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":350,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L350"}],"signatures":[{"id":120,"name":"localDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's local data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_LocalAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { localDataDir } from '@tauri-apps/api/path';\nconst localDataDirPath = await localDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":350,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L350"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":143,"name":"normalize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":589,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L589"}],"signatures":[{"id":144,"name":"normalize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Normalizes the given "},{"kind":"code","text":"`path`"},{"kind":"text","text":", resolving "},{"kind":"code","text":"`'..'`"},{"kind":"text","text":" and "},{"kind":"code","text":"`'.'`"},{"kind":"text","text":" segments and resolve symbolic links."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { normalize, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await normalize(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":589,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L589"}],"parameters":[{"id":145,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":121,"name":"pictureDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":372,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L372"}],"signatures":[{"id":122,"name":"pictureDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's picture directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_PICTURES_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Pictures`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Pictures}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { pictureDir } from '@tauri-apps/api/path';\nconst pictureDirPath = await pictureDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":372,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L372"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":123,"name":"publicDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":394,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L394"}],"signatures":[{"id":124,"name":"publicDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's public directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_PUBLICSHARE_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Public`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Public}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { publicDir } from '@tauri-apps/api/path';\nconst publicDirPath = await publicDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":394,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L394"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":140,"name":"resolve","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":574,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L574"}],"signatures":[{"id":141,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolves a sequence of "},{"kind":"code","text":"`paths`"},{"kind":"text","text":" or "},{"kind":"code","text":"`path`"},{"kind":"text","text":" segments into an absolute path."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resolve, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await resolve(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":574,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L574"}],"parameters":[{"id":142,"name":"paths","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":127,"name":"resolveResource","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":431,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L431"}],"signatures":[{"id":128,"name":"resolveResource","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the path to a resource file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('script.sh');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The full path to the resource."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":431,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L431"}],"parameters":[{"id":129,"name":"resourcePath","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The path to the resource.\nMust follow the same syntax as defined in "},{"kind":"code","text":"`tauri.conf.json > tauri > bundle > resources`"},{"kind":"text","text":", i.e. keeping subfolders and parent dir components ("},{"kind":"code","text":"`../`"},{"kind":"text","text":")."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":125,"name":"resourceDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":411,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L411"}],"signatures":[{"id":126,"name":"resourceDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the application's resource directory.\nTo resolve a resource path, see the [[resolveResource | "},{"kind":"code","text":"`resolveResource API`"},{"kind":"text","text":"]]."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resourceDir } from '@tauri-apps/api/path';\nconst resourceDirPath = await resourceDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":411,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L411"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":130,"name":"runtimeDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":454,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L454"}],"signatures":[{"id":131,"name":"runtimeDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's runtime directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_RUNTIME_DIR`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { runtimeDir } from '@tauri-apps/api/path';\nconst runtimeDirPath = await runtimeDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":454,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L454"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":136,"name":"sep","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":549,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L549"}],"signatures":[{"id":137,"name":"sep","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the platform-specific path segment separator:\n- "},{"kind":"code","text":"`\\` on Windows\n- `"},{"kind":"text","text":"/` on POSIX"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"sources":[{"fileName":"path.ts","line":549,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L549"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":162,"name":"tempDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":536,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L536"}],"signatures":[{"id":163,"name":"tempDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a temporary directory."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { tempDir } from '@tauri-apps/api/path';\nconst temp = await tempDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"sources":[{"fileName":"path.ts","line":536,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L536"}],"parameters":[{"id":164,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":132,"name":"templateDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":476,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L476"}],"signatures":[{"id":133,"name":"templateDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's template directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_TEMPLATES_DIR`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Templates}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { templateDir } from '@tauri-apps/api/path';\nconst templateDirPath = await templateDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":476,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L476"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":134,"name":"videoDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":498,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L498"}],"signatures":[{"id":135,"name":"videoDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's video directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_VIDEOS_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Movies`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Videos}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { videoDir } from '@tauri-apps/api/path';\nconst videoDirPath = await videoDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":498,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L498"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Enumerations","children":[65]},{"title":"Functions","children":[95,89,91,93,97,99,155,101,103,105,138,107,149,109,111,113,152,115,117,159,146,119,143,121,123,140,127,125,130,136,162,132,134]}],"sources":[{"fileName":"path.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/path.ts#L1"}]},{"id":165,"name":"tauri","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Invoke your custom commands.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.tauri`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":176,"name":"Channel","variant":"declaration","kind":128,"flags":{},"children":[{"id":177,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"tauri.ts","line":71,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L71"}],"signatures":[{"id":178,"name":"new Channel","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"tauri.ts","line":71,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L71"}],"typeParameter":[{"id":179,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":176,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Channel","package":"@tauri-apps/api"}}]},{"id":182,"name":"#onmessage","variant":"declaration","kind":1024,"flags":{"isPrivate":true},"sources":[{"fileName":"tauri.ts","line":67,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L67"}],"type":{"type":"reflection","declaration":{"id":183,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":67,"character":14,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L67"}],"signatures":[{"id":184,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":67,"character":14,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L67"}],"parameters":[{"id":185,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"defaultValue":"..."},{"id":181,"name":"__TAURI_CHANNEL_MARKER__","variant":"declaration","kind":1024,"flags":{"isPrivate":true,"isReadonly":true},"sources":[{"fileName":"tauri.ts","line":66,"character":19,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L66"}],"type":{"type":"literal","value":true},"defaultValue":"true"},{"id":180,"name":"id","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":64,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L64"}],"type":{"type":"intrinsic","name":"number"}},{"id":186,"name":"onmessage","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"tauri.ts","line":77,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L77"},{"fileName":"tauri.ts","line":81,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L81"}],"getSignature":{"id":187,"name":"onmessage","variant":"signature","kind":524288,"flags":{},"sources":[{"fileName":"tauri.ts","line":81,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L81"}],"type":{"type":"reflection","declaration":{"id":188,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":81,"character":19,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L81"}],"signatures":[{"id":189,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":81,"character":19,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L81"}],"parameters":[{"id":190,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}}},"setSignature":{"id":191,"name":"onmessage","variant":"signature","kind":1048576,"flags":{},"sources":[{"fileName":"tauri.ts","line":77,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L77"}],"parameters":[{"id":192,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":193,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":77,"character":25,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L77"}],"signatures":[{"id":194,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":77,"character":25,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L77"}],"parameters":[{"id":195,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"}}},{"id":196,"name":"toJSON","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"tauri.ts","line":85,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L85"}],"signatures":[{"id":197,"name":"toJSON","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":85,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L85"}],"type":{"type":"intrinsic","name":"string"}}]}],"groups":[{"title":"Constructors","children":[177]},{"title":"Properties","children":[182,181,180]},{"title":"Accessors","children":[186]},{"title":"Methods","children":[196]}],"sources":[{"fileName":"tauri.ts","line":63,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L63"}],"typeParameters":[{"id":198,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}]},{"id":199,"name":"PluginListener","variant":"declaration","kind":128,"flags":{},"children":[{"id":200,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"tauri.ts","line":95,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L95"}],"signatures":[{"id":201,"name":"new PluginListener","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"tauri.ts","line":95,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L95"}],"parameters":[{"id":202,"name":"plugin","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":203,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":204,"name":"channelId","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":199,"name":"PluginListener","package":"@tauri-apps/api"}}]},{"id":207,"name":"channelId","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":93,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L93"}],"type":{"type":"intrinsic","name":"number"}},{"id":206,"name":"event","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":92,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L92"}],"type":{"type":"intrinsic","name":"string"}},{"id":205,"name":"plugin","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":91,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L91"}],"type":{"type":"intrinsic","name":"string"}},{"id":208,"name":"unregister","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"tauri.ts","line":101,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L101"}],"signatures":[{"id":209,"name":"unregister","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":101,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L101"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Constructors","children":[200]},{"title":"Properties","children":[207,206,205]},{"title":"Methods","children":[208]}],"sources":[{"fileName":"tauri.ts","line":90,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L90"}]},{"id":167,"name":"InvokeOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"children":[{"id":168,"name":"headers","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"tauri.ts","line":139,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L139"}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.dom.d.ts","qualifiedName":"Headers"},"name":"Headers","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/API/Headers"}]}}],"groups":[{"title":"Properties","children":[168]}],"sources":[{"fileName":"tauri.ts","line":138,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L138"}]},{"id":166,"name":"InvokeArgs","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[{"kind":"text","text":"Command arguments."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":133,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L133"}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"},{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"ArrayBuffer"},"name":"ArrayBuffer","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Uint8Array"},"name":"Uint8Array","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array"}]}},{"id":210,"name":"addPluginListener","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":116,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L116"}],"signatures":[{"id":211,"name":"addPluginListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds a listener to a plugin event."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"The listener object to stop listening to the events."}]},{"tag":"@since","content":[{"kind":"text","text":"2.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":116,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L116"}],"typeParameter":[{"id":212,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":213,"name":"plugin","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":214,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":215,"name":"cb","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":216,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":119,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L119"}],"signatures":[{"id":217,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":119,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L119"}],"parameters":[{"id":218,"name":"payload","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":199,"name":"PluginListener","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":225,"name":"convertFileSrc","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":212,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L212"}],"signatures":[{"id":226,"name":"convertFileSrc","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a device file path to an URL that can be loaded by the webview.\nNote that "},{"kind":"code","text":"`asset:`"},{"kind":"text","text":", "},{"kind":"code","text":"`http://asset.localhost`"},{"kind":"text","text":" and "},{"kind":"code","text":"`https://asset.localhost`"},{"kind":"text","text":" must be added to ["},{"kind":"code","text":"`tauri.security.csp`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#securityconfig.csp) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":".\nExample CSP value: "},{"kind":"code","text":"`\"csp\": \"default-src 'self' ipc: http://ipc.localhost https://ipc.localhost; img-src 'self' asset: http://asset.localhost https://asset.localhost\"`"},{"kind":"text","text":" to use the asset protocol on image sources.\n\nAdditionally, "},{"kind":"code","text":"`asset`"},{"kind":"text","text":" must be added to ["},{"kind":"code","text":"`tauri.allowlist.protocol`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.protocol)\nin "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" and its access scope must be defined on the "},{"kind":"code","text":"`assetScope`"},{"kind":"text","text":" array on the same "},{"kind":"code","text":"`protocol`"},{"kind":"text","text":" object."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appDataDir, join } from '@tauri-apps/api/path';\nimport { convertFileSrc } from '@tauri-apps/api/tauri';\nconst appDataDirPath = await appDataDir();\nconst filePath = await join(appDataDirPath, 'assets/video.mp4');\nconst assetUrl = convertFileSrc(filePath);\n\nconst video = document.getElementById('my-video');\nconst source = document.createElement('source');\nsource.type = 'video/mp4';\nsource.src = assetUrl;\nvideo.appendChild(source);\nvideo.load();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"the URL that can be used as source on the webview."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":212,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L212"}],"parameters":[{"id":227,"name":"filePath","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The file path."}]},"type":{"type":"intrinsic","name":"string"}},{"id":228,"name":"protocol","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The protocol to use. Defaults to "},{"kind":"code","text":"`asset`"},{"kind":"text","text":". You only need to set this when using a custom protocol."}]},"type":{"type":"intrinsic","name":"string"},"defaultValue":"'asset'"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":219,"name":"invoke","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":157,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L157"}],"signatures":[{"id":220,"name":"invoke","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sends a message to the backend."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { invoke } from '@tauri-apps/api/tauri';\nawait invoke('login', { user: 'tauri', password: 'poiwe3h4r5ip3yrhtew9ty' });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving or rejecting to the backend response."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":157,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L157"}],"typeParameter":[{"id":221,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":222,"name":"cmd","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The command name."}]},"type":{"type":"intrinsic","name":"string"}},{"id":223,"name":"args","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The optional arguments to pass to the command."}]},"type":{"type":"reference","target":166,"name":"InvokeArgs","package":"@tauri-apps/api"},"defaultValue":"{}"},{"id":224,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The request options."}]},"type":{"type":"reference","target":167,"name":"InvokeOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":169,"name":"transformCallback","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":41,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L41"}],"signatures":[{"id":170,"name":"transformCallback","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Transforms a callback function to a string identifier that can be passed to the backend.\nThe backend uses the identifier to "},{"kind":"code","text":"`eval()`"},{"kind":"text","text":" the callback."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A unique identifier associated with the callback function."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":41,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L41"}],"parameters":[{"id":171,"name":"callback","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":172,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":42,"character":13,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L42"}],"signatures":[{"id":173,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":42,"character":13,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L42"}],"parameters":[{"id":174,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":175,"name":"once","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"number"}}]}],"groups":[{"title":"Classes","children":[176,199]},{"title":"Interfaces","children":[167]},{"title":"Type Aliases","children":[166]},{"title":"Functions","children":[210,225,219,169]}],"sources":[{"fileName":"tauri.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/c3aa0086a/tooling/api/src/tauri.ts#L1"}]}],"groups":[{"title":"Modules","children":[1,50,64,165]}],"packageName":"@tauri-apps/api","symbolIdMap":{"1":{"sourceFileName":"src/event.ts","qualifiedName":""},"2":{"sourceFileName":"src/event.ts","qualifiedName":"Event"},"3":{"sourceFileName":"src/event.ts","qualifiedName":"Event.event"},"4":{"sourceFileName":"src/event.ts","qualifiedName":"Event.windowLabel"},"5":{"sourceFileName":"src/event.ts","qualifiedName":"Event.id"},"6":{"sourceFileName":"src/event.ts","qualifiedName":"Event.payload"},"7":{"sourceFileName":"src/event.ts","qualifiedName":"Event.T"},"8":{"sourceFileName":"src/event.ts","qualifiedName":"EventCallback"},"9":{"sourceFileName":"src/event.ts","qualifiedName":"__type"},"10":{"sourceFileName":"src/event.ts","qualifiedName":"__type"},"11":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"12":{"sourceFileName":"src/event.ts","qualifiedName":"T"},"13":{"sourceFileName":"src/event.ts","qualifiedName":"UnlistenFn"},"14":{"sourceFileName":"src/event.ts","qualifiedName":"__type"},"15":{"sourceFileName":"src/event.ts","qualifiedName":"__type"},"16":{"sourceFileName":"src/event.ts","qualifiedName":"EventName"},"17":{"sourceFileName":"src/event.ts","qualifiedName":"Options"},"18":{"sourceFileName":"src/event.ts","qualifiedName":"Options.target"},"19":{"sourceFileName":"src/event.ts","qualifiedName":"listen"},"20":{"sourceFileName":"src/event.ts","qualifiedName":"listen"},"21":{"sourceFileName":"src/event.ts","qualifiedName":"T"},"22":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"23":{"sourceFileName":"src/event.ts","qualifiedName":"handler"},"24":{"sourceFileName":"src/event.ts","qualifiedName":"options"},"25":{"sourceFileName":"src/event.ts","qualifiedName":"once"},"26":{"sourceFileName":"src/event.ts","qualifiedName":"once"},"27":{"sourceFileName":"src/event.ts","qualifiedName":"T"},"28":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"29":{"sourceFileName":"src/event.ts","qualifiedName":"handler"},"30":{"sourceFileName":"src/event.ts","qualifiedName":"options"},"31":{"sourceFileName":"src/event.ts","qualifiedName":"emit"},"32":{"sourceFileName":"src/event.ts","qualifiedName":"emit"},"33":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"34":{"sourceFileName":"src/event.ts","qualifiedName":"payload"},"35":{"sourceFileName":"src/event.ts","qualifiedName":"options"},"36":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent"},"37":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_RESIZED"},"38":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_MOVED"},"39":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_CLOSE_REQUESTED"},"40":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_CREATED"},"41":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_DESTROYED"},"42":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FOCUS"},"43":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_BLUR"},"44":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_SCALE_FACTOR_CHANGED"},"45":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_THEME_CHANGED"},"46":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP"},"47":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP_HOVER"},"48":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP_CANCELLED"},"49":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.MENU"},"50":{"sourceFileName":"src/mocks.ts","qualifiedName":""},"51":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockIPC"},"52":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockIPC"},"53":{"sourceFileName":"src/mocks.ts","qualifiedName":"cb"},"54":{"sourceFileName":"src/mocks.ts","qualifiedName":"__type"},"55":{"sourceFileName":"src/mocks.ts","qualifiedName":"__type"},"56":{"sourceFileName":"src/mocks.ts","qualifiedName":"cmd"},"57":{"sourceFileName":"src/mocks.ts","qualifiedName":"payload"},"58":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockWindows"},"59":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockWindows"},"60":{"sourceFileName":"src/mocks.ts","qualifiedName":"current"},"61":{"sourceFileName":"src/mocks.ts","qualifiedName":"additionalWindows"},"62":{"sourceFileName":"src/mocks.ts","qualifiedName":"clearMocks"},"63":{"sourceFileName":"src/mocks.ts","qualifiedName":"clearMocks"},"64":{"sourceFileName":"src/path.ts","qualifiedName":""},"65":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory"},"66":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Audio"},"67":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Cache"},"68":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Config"},"69":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Data"},"70":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.LocalData"},"71":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Document"},"72":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Download"},"73":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Picture"},"74":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Public"},"75":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Video"},"76":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Resource"},"77":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Temp"},"78":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppConfig"},"79":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppData"},"80":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppLocalData"},"81":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppCache"},"82":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.AppLog"},"83":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Desktop"},"84":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Executable"},"85":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Font"},"86":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Home"},"87":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Runtime"},"88":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory.Template"},"89":{"sourceFileName":"src/path.ts","qualifiedName":"appConfigDir"},"90":{"sourceFileName":"src/path.ts","qualifiedName":"appConfigDir"},"91":{"sourceFileName":"src/path.ts","qualifiedName":"appDataDir"},"92":{"sourceFileName":"src/path.ts","qualifiedName":"appDataDir"},"93":{"sourceFileName":"src/path.ts","qualifiedName":"appLocalDataDir"},"94":{"sourceFileName":"src/path.ts","qualifiedName":"appLocalDataDir"},"95":{"sourceFileName":"src/path.ts","qualifiedName":"appCacheDir"},"96":{"sourceFileName":"src/path.ts","qualifiedName":"appCacheDir"},"97":{"sourceFileName":"src/path.ts","qualifiedName":"appLogDir"},"98":{"sourceFileName":"src/path.ts","qualifiedName":"appLogDir"},"99":{"sourceFileName":"src/path.ts","qualifiedName":"audioDir"},"100":{"sourceFileName":"src/path.ts","qualifiedName":"audioDir"},"101":{"sourceFileName":"src/path.ts","qualifiedName":"cacheDir"},"102":{"sourceFileName":"src/path.ts","qualifiedName":"cacheDir"},"103":{"sourceFileName":"src/path.ts","qualifiedName":"configDir"},"104":{"sourceFileName":"src/path.ts","qualifiedName":"configDir"},"105":{"sourceFileName":"src/path.ts","qualifiedName":"dataDir"},"106":{"sourceFileName":"src/path.ts","qualifiedName":"dataDir"},"107":{"sourceFileName":"src/path.ts","qualifiedName":"desktopDir"},"108":{"sourceFileName":"src/path.ts","qualifiedName":"desktopDir"},"109":{"sourceFileName":"src/path.ts","qualifiedName":"documentDir"},"110":{"sourceFileName":"src/path.ts","qualifiedName":"documentDir"},"111":{"sourceFileName":"src/path.ts","qualifiedName":"downloadDir"},"112":{"sourceFileName":"src/path.ts","qualifiedName":"downloadDir"},"113":{"sourceFileName":"src/path.ts","qualifiedName":"executableDir"},"114":{"sourceFileName":"src/path.ts","qualifiedName":"executableDir"},"115":{"sourceFileName":"src/path.ts","qualifiedName":"fontDir"},"116":{"sourceFileName":"src/path.ts","qualifiedName":"fontDir"},"117":{"sourceFileName":"src/path.ts","qualifiedName":"homeDir"},"118":{"sourceFileName":"src/path.ts","qualifiedName":"homeDir"},"119":{"sourceFileName":"src/path.ts","qualifiedName":"localDataDir"},"120":{"sourceFileName":"src/path.ts","qualifiedName":"localDataDir"},"121":{"sourceFileName":"src/path.ts","qualifiedName":"pictureDir"},"122":{"sourceFileName":"src/path.ts","qualifiedName":"pictureDir"},"123":{"sourceFileName":"src/path.ts","qualifiedName":"publicDir"},"124":{"sourceFileName":"src/path.ts","qualifiedName":"publicDir"},"125":{"sourceFileName":"src/path.ts","qualifiedName":"resourceDir"},"126":{"sourceFileName":"src/path.ts","qualifiedName":"resourceDir"},"127":{"sourceFileName":"src/path.ts","qualifiedName":"resolveResource"},"128":{"sourceFileName":"src/path.ts","qualifiedName":"resolveResource"},"129":{"sourceFileName":"src/path.ts","qualifiedName":"resourcePath"},"130":{"sourceFileName":"src/path.ts","qualifiedName":"runtimeDir"},"131":{"sourceFileName":"src/path.ts","qualifiedName":"runtimeDir"},"132":{"sourceFileName":"src/path.ts","qualifiedName":"templateDir"},"133":{"sourceFileName":"src/path.ts","qualifiedName":"templateDir"},"134":{"sourceFileName":"src/path.ts","qualifiedName":"videoDir"},"135":{"sourceFileName":"src/path.ts","qualifiedName":"videoDir"},"136":{"sourceFileName":"src/path.ts","qualifiedName":"sep"},"137":{"sourceFileName":"src/path.ts","qualifiedName":"sep"},"138":{"sourceFileName":"src/path.ts","qualifiedName":"delimiter"},"139":{"sourceFileName":"src/path.ts","qualifiedName":"delimiter"},"140":{"sourceFileName":"src/path.ts","qualifiedName":"resolve"},"141":{"sourceFileName":"src/path.ts","qualifiedName":"resolve"},"142":{"sourceFileName":"src/path.ts","qualifiedName":"paths"},"143":{"sourceFileName":"src/path.ts","qualifiedName":"normalize"},"144":{"sourceFileName":"src/path.ts","qualifiedName":"normalize"},"145":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"146":{"sourceFileName":"src/path.ts","qualifiedName":"join"},"147":{"sourceFileName":"src/path.ts","qualifiedName":"join"},"148":{"sourceFileName":"src/path.ts","qualifiedName":"paths"},"149":{"sourceFileName":"src/path.ts","qualifiedName":"dirname"},"150":{"sourceFileName":"src/path.ts","qualifiedName":"dirname"},"151":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"152":{"sourceFileName":"src/path.ts","qualifiedName":"extname"},"153":{"sourceFileName":"src/path.ts","qualifiedName":"extname"},"154":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"155":{"sourceFileName":"src/path.ts","qualifiedName":"basename"},"156":{"sourceFileName":"src/path.ts","qualifiedName":"basename"},"157":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"158":{"sourceFileName":"src/path.ts","qualifiedName":"ext"},"159":{"sourceFileName":"src/path.ts","qualifiedName":"isAbsolute"},"160":{"sourceFileName":"src/path.ts","qualifiedName":"isAbsolute"},"161":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"162":{"sourceFileName":"src/path.ts","qualifiedName":"tempDir"},"163":{"sourceFileName":"src/path.ts","qualifiedName":"tempDir"},"164":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"165":{"sourceFileName":"src/tauri.ts","qualifiedName":""},"166":{"sourceFileName":"src/tauri.ts","qualifiedName":"InvokeArgs"},"167":{"sourceFileName":"src/tauri.ts","qualifiedName":"InvokeOptions"},"168":{"sourceFileName":"src/tauri.ts","qualifiedName":"InvokeOptions.headers"},"169":{"sourceFileName":"src/tauri.ts","qualifiedName":"transformCallback"},"170":{"sourceFileName":"src/tauri.ts","qualifiedName":"transformCallback"},"171":{"sourceFileName":"src/tauri.ts","qualifiedName":"callback"},"172":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"173":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"174":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"175":{"sourceFileName":"src/tauri.ts","qualifiedName":"once"},"176":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel"},"177":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.__constructor"},"178":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel"},"179":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.T"},"180":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.id"},"181":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.__TAURI_CHANNEL_MARKER__"},"182":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.#onmessage"},"183":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"184":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"185":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"186":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.onmessage"},"187":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.onmessage"},"188":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"189":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"190":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"191":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.onmessage"},"192":{"sourceFileName":"src/tauri.ts","qualifiedName":"handler"},"193":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"194":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"195":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"196":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.toJSON"},"197":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.toJSON"},"198":{"sourceFileName":"src/tauri.ts","qualifiedName":"Channel.T"},"199":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener"},"200":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.__constructor"},"201":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener"},"202":{"sourceFileName":"src/tauri.ts","qualifiedName":"plugin"},"203":{"sourceFileName":"src/tauri.ts","qualifiedName":"event"},"204":{"sourceFileName":"src/tauri.ts","qualifiedName":"channelId"},"205":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.plugin"},"206":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.event"},"207":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.channelId"},"208":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.unregister"},"209":{"sourceFileName":"src/tauri.ts","qualifiedName":"PluginListener.unregister"},"210":{"sourceFileName":"src/tauri.ts","qualifiedName":"addPluginListener"},"211":{"sourceFileName":"src/tauri.ts","qualifiedName":"addPluginListener"},"212":{"sourceFileName":"src/tauri.ts","qualifiedName":"T"},"213":{"sourceFileName":"src/tauri.ts","qualifiedName":"plugin"},"214":{"sourceFileName":"src/tauri.ts","qualifiedName":"event"},"215":{"sourceFileName":"src/tauri.ts","qualifiedName":"cb"},"216":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"217":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"218":{"sourceFileName":"src/tauri.ts","qualifiedName":"payload"},"219":{"sourceFileName":"src/tauri.ts","qualifiedName":"invoke"},"220":{"sourceFileName":"src/tauri.ts","qualifiedName":"invoke"},"221":{"sourceFileName":"src/tauri.ts","qualifiedName":"T"},"222":{"sourceFileName":"src/tauri.ts","qualifiedName":"cmd"},"223":{"sourceFileName":"src/tauri.ts","qualifiedName":"args"},"224":{"sourceFileName":"src/tauri.ts","qualifiedName":"options"},"225":{"sourceFileName":"src/tauri.ts","qualifiedName":"convertFileSrc"},"226":{"sourceFileName":"src/tauri.ts","qualifiedName":"convertFileSrc"},"227":{"sourceFileName":"src/tauri.ts","qualifiedName":"filePath"},"228":{"sourceFileName":"src/tauri.ts","qualifiedName":"protocol"}}} \ No newline at end of file diff --git a/tooling/api/src/tauri.ts b/tooling/api/src/tauri.ts index 8d76c0d32423..deb83ac77aae 100644 --- a/tooling/api/src/tauri.ts +++ b/tooling/api/src/tauri.ts @@ -181,8 +181,8 @@ async function invoke( /** * Convert a device file path to an URL that can be loaded by the webview. - * Note that `asset:` and `http://asset.localhost` must be added to [`tauri.security.csp`](https://tauri.app/v1/api/config/#securityconfig.csp) in `tauri.conf.json`. - * Example CSP value: `"csp": "default-src 'self' ipc: http://ipc.localhost; img-src 'self' asset: http://asset.localhost"` to use the asset protocol on image sources. + * Note that `asset:`, `http://asset.localhost` and `https://asset.localhost` must be added to [`tauri.security.csp`](https://tauri.app/v1/api/config/#securityconfig.csp) in `tauri.conf.json`. + * Example CSP value: `"csp": "default-src 'self' ipc: http://ipc.localhost https://ipc.localhost; img-src 'self' asset: http://asset.localhost https://asset.localhost"` to use the asset protocol on image sources. * * 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. diff --git a/tooling/bench/tests/cpu_intensive/src-tauri/tauri.conf.json b/tooling/bench/tests/cpu_intensive/src-tauri/tauri.conf.json index 68100cc05d98..36e81e6e90e4 100644 --- a/tooling/bench/tests/cpu_intensive/src-tauri/tauri.conf.json +++ b/tooling/bench/tests/cpu_intensive/src-tauri/tauri.conf.json @@ -43,7 +43,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/tooling/bench/tests/files_transfer/src-tauri/tauri.conf.json b/tooling/bench/tests/files_transfer/src-tauri/tauri.conf.json index 68100cc05d98..36e81e6e90e4 100644 --- a/tooling/bench/tests/files_transfer/src-tauri/tauri.conf.json +++ b/tooling/bench/tests/files_transfer/src-tauri/tauri.conf.json @@ -43,7 +43,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/tooling/bench/tests/helloworld/src-tauri/tauri.conf.json b/tooling/bench/tests/helloworld/src-tauri/tauri.conf.json index 68100cc05d98..36e81e6e90e4 100644 --- a/tooling/bench/tests/helloworld/src-tauri/tauri.conf.json +++ b/tooling/bench/tests/helloworld/src-tauri/tauri.conf.json @@ -43,7 +43,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file diff --git a/tooling/cli/src/migrate/config.rs b/tooling/cli/src/migrate/config.rs index ea827b1a767d..c20a7bb7cbe6 100644 --- a/tooling/cli/src/migrate/config.rs +++ b/tooling/cli/src/migrate/config.rs @@ -85,21 +85,24 @@ fn process_security(security: &mut Map) -> Result<()> { match &mut csp { tauri_utils_v1::config::Csp::Policy(csp) => { if csp.contains("connect-src") { - *csp = csp.replace("connect-src", "connect-src ipc: http://ipc.localhost"); + *csp = csp.replace( + "connect-src", + "connect-src ipc: http://ipc.localhost https://ipc.localhost", + ); } else { - *csp = format!("{csp}; connect-src ipc: http://ipc.localhost"); + *csp = format!("{csp}; connect-src ipc: http://ipc.localhost https://ipc.localhost"); } } tauri_utils_v1::config::Csp::DirectiveMap(csp) => { if let Some(connect_src) = csp.get_mut("connect-src") { - if !connect_src.contains("ipc: http://ipc.localhost") { - connect_src.push("ipc: http://ipc.localhost"); + if !connect_src.contains("ipc: http://ipc.localhost https://ipc.localhost") { + connect_src.push("ipc: http://ipc.localhost https://ipc.localhost"); } } else { csp.insert( "connect-src".into(), tauri_utils_v1::config::CspDirectiveSources::List(vec![ - "ipc: http://ipc.localhost".to_string() + "ipc: http://ipc.localhost https://ipc.localhost".to_string(), ]), ); } @@ -331,7 +334,7 @@ mod test { assert_eq!( migrated["tauri"]["security"]["csp"], format!( - "{}; connect-src ipc: http://ipc.localhost", + "{}; connect-src ipc: http://ipc.localhost https://ipc.localhost", original["tauri"]["security"]["csp"].as_str().unwrap() ) ); @@ -358,7 +361,7 @@ mod test { assert!(migrated["tauri"]["security"]["csp"]["connect-src"] .as_array() .expect("connect-src isn't an array") - .contains(&"ipc: http://ipc.localhost".into())); + .contains(&"ipc: http://ipc.localhost https://ipc.localhost".into())); } #[test] @@ -385,7 +388,7 @@ mod test { .as_str() .expect("connect-src isn't a string"), format!( - "{} ipc: http://ipc.localhost", + "{} ipc: http://ipc.localhost https://ipc.localhost", original["tauri"]["security"]["csp"]["connect-src"] .as_str() .unwrap() diff --git a/tooling/cli/templates/plugin/__example-basic/vanilla/src-tauri/tauri.conf.json b/tooling/cli/templates/plugin/__example-basic/vanilla/src-tauri/tauri.conf.json index 723f2dd24355..86009a9a5b15 100644 --- a/tooling/cli/templates/plugin/__example-basic/vanilla/src-tauri/tauri.conf.json +++ b/tooling/cli/templates/plugin/__example-basic/vanilla/src-tauri/tauri.conf.json @@ -50,7 +50,7 @@ } ], "security": { - "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'; connect-src ipc: http://ipc.localhost" + "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'; connect-src ipc: http://ipc.localhost https://ipc.localhost" } } } \ No newline at end of file From 5b035fdcb1e2e6a848ea5df53217fa77ce71434b Mon Sep 17 00:00:00 2001 From: Lucas Nogueira Date: Thu, 7 Sep 2023 16:53:19 -0300 Subject: [PATCH 4/6] update lockfile --- examples/api/src-tauri/Cargo.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/api/src-tauri/Cargo.lock b/examples/api/src-tauri/Cargo.lock index 4e8e334fd5a5..9a2f3dc49273 100644 --- a/examples/api/src-tauri/Cargo.lock +++ b/examples/api/src-tauri/Cargo.lock @@ -3399,7 +3399,7 @@ checksum = "9d0e916b1148c8e263850e1ebcbd046f333e0683c724876bb0da63ea4373dc8a" [[package]] name = "tauri" -version = "2.0.0-alpha.11" +version = "2.0.0-alpha.12" dependencies = [ "anyhow", "bytes", @@ -3550,7 +3550,7 @@ dependencies = [ [[package]] name = "tauri-runtime" -version = "1.0.0-alpha.0" +version = "1.0.0-alpha.1" dependencies = [ "gtk", "http", @@ -3568,7 +3568,7 @@ dependencies = [ [[package]] name = "tauri-runtime-wry" -version = "1.0.0-alpha.0" +version = "1.0.0-alpha.1" dependencies = [ "cocoa 0.24.1", "gtk", From 31d90f0b5a9dc29d2997f9f86b350d29e19115e7 Mon Sep 17 00:00:00 2001 From: Lucas Nogueira Date: Thu, 7 Sep 2023 17:03:36 -0300 Subject: [PATCH 5/6] fix origin on android --- core/tauri/src/manager.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/core/tauri/src/manager.rs b/core/tauri/src/manager.rs index 51cb4ca5499d..420db74c5134 100644 --- a/core/tauri/src/manager.rs +++ b/core/tauri/src/manager.rs @@ -616,6 +616,11 @@ impl WindowManager { "null".into() } else if cfg!(windows) && window_url.scheme() != "http" && window_url.scheme() != "https" { format!("http://{}.localhost", window_url.scheme()) + } else if cfg!(target_os = "android") + && window_url.scheme() != "http" + && window_url.scheme() != "https" + { + format!("https://{}.localhost", window_url.scheme()) } else { format!( "{}://{}{}", From b4ce5bdb20a617ab2738bf17656ad68cbb3cf4c8 Mon Sep 17 00:00:00 2001 From: Lucas Nogueira Date: Thu, 7 Sep 2023 17:04:48 -0300 Subject: [PATCH 6/6] also bump CLI --- .changes/fix-windows-custom-protocol-url.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.changes/fix-windows-custom-protocol-url.md b/.changes/fix-windows-custom-protocol-url.md index a5fb28aa4b01..5c3b44c84ee2 100644 --- a/.changes/fix-windows-custom-protocol-url.md +++ b/.changes/fix-windows-custom-protocol-url.md @@ -1,6 +1,8 @@ --- "tauri": patch:breaking "@tauri-apps/api": patch:breaking +"@tauri-apps/cli": patch:breaking +"tauri-cli": patch:breaking --- The custom protocol on Windows now uses the `http` scheme instead of `https`.