mirror of
https://github.com/tauri-apps/tauri-docs.git
synced 2026-01-31 00:35:16 +01:00
66596a4954
* chore(docs): Update Rust & TS docs * fix casing Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com> Co-authored-by: Fabian-Lars <fabianlars@fabianlars.de>
1 line
221 KiB
JSON
1 line
221 KiB
JSON
{"id":0,"name":"@tauri-apps/api","kind":1,"flags":{},"originalName":"","children":[{"id":1,"name":"app","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Get application metadata.","text":"This package is also accessible with `window.__TAURI__.app` when `tauri.conf.json > build > withGlobalTauri` is set to true."},"children":[{"id":2,"name":"getName","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"app.ts","line":33,"character":15}],"signatures":[{"id":3,"name":"getName","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the application name.","returns":"A promise resolving to application name.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":6,"name":"getTauriVersion","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"app.ts","line":47,"character":15}],"signatures":[{"id":7,"name":"getTauriVersion","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the tauri version.","returns":"A promise resolving to tauri version.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":4,"name":"getVersion","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"app.ts","line":19,"character":15}],"signatures":[{"id":5,"name":"getVersion","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the application version.","returns":"A promise resolving to the application version.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Functions","kind":64,"children":[2,6,4]}],"sources":[{"fileName":"app.ts","line":12,"character":0}]},{"id":8,"name":"cli","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Parse arguments from your Command Line Interface.","text":"This package is also accessible with `window.__TAURI__.cli` when `tauri.conf.json > build > withGlobalTauri` is set to true."},"children":[{"id":9,"name":"ArgMatch","kind":256,"kindString":"Interface","flags":{},"children":[{"id":11,"name":"occurrences","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Number of occurrences"},"sources":[{"fileName":"cli.ts","line":24,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":10,"name":"value","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"string if takes value\nboolean if flag\nstring[] or null if takes multiple values"},"sources":[{"fileName":"cli.ts","line":20,"character":2}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"groups":[{"title":"Properties","kind":1024,"children":[11,10]}],"sources":[{"fileName":"cli.ts","line":14,"character":10}]},{"id":15,"name":"CliMatches","kind":256,"kindString":"Interface","flags":{},"children":[{"id":16,"name":"args","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"cli.ts","line":33,"character":2}],"type":{"type":"reflection","declaration":{"id":17,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":{"id":18,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":19,"name":"name","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":9,"name":"ArgMatch"}}}}},{"id":20,"name":"subcommand","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"cli.ts","line":34,"character":2}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":12,"name":"SubcommandMatch"}]}}],"groups":[{"title":"Properties","kind":1024,"children":[16,20]}],"sources":[{"fileName":"cli.ts","line":32,"character":10}]},{"id":12,"name":"SubcommandMatch","kind":256,"kindString":"Interface","flags":{},"children":[{"id":14,"name":"matches","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"cli.ts","line":29,"character":2}],"type":{"type":"reference","id":15,"name":"CliMatches"}},{"id":13,"name":"name","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"cli.ts","line":28,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[14,13]}],"sources":[{"fileName":"cli.ts","line":27,"character":10}]},{"id":21,"name":"getMatches","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"cli.ts","line":42,"character":15}],"signatures":[{"id":22,"name":"getMatches","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Parse the arguments provided to the current process and get the matches using the configuration defined `tauri.conf.json > tauri > cli`.","returns":"A promise resolving to the parsed arguments.\n"},"type":{"type":"reference","typeArguments":[{"type":"reference","id":15,"name":"CliMatches"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Interfaces","kind":256,"children":[9,15,12]},{"title":"Functions","kind":64,"children":[21]}],"sources":[{"fileName":"cli.ts","line":12,"character":0}]},{"id":23,"name":"clipboard","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Read and write to the system clipboard.","text":"This package is also accessible with `window.__TAURI__.clipboard` when `tauri.conf.json > build > withGlobalTauri` is set to true."},"children":[{"id":27,"name":"readText","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"clipboard.ts","line":34,"character":15}],"signatures":[{"id":28,"name":"readText","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the clipboard content as plain text.","returns":"A promise resolving to the clipboard content as plain text.\n"},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":24,"name":"writeText","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"clipboard.ts","line":19,"character":15}],"signatures":[{"id":25,"name":"writeText","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes a plain text to the clipboard.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":26,"name":"text","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Functions","kind":64,"children":[27,24]}],"sources":[{"fileName":"clipboard.ts","line":12,"character":0}]},{"id":29,"name":"dialog","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Native system dialogs for opening and saving files.","text":"This package is also accessible with `window.__TAURI__.dialog` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"dialog\": {\n \"all\": true, // enable all dialog APIs\n \"open\": true, // enable file open API\n \"save\": true // enable file save API\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."},"children":[{"id":30,"name":"DialogFilter","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Extension filters for the file dialog."},"children":[{"id":32,"name":"extensions","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Extensions to filter, without a `.` prefix.","tags":[{"tag":"example","text":"\n```typescript\nextensions: ['svg', 'png']\n```\n"}]},"sources":[{"fileName":"dialog.ts","line":41,"character":2}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":31,"name":"name","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Filter name."},"sources":[{"fileName":"dialog.ts","line":33,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[32,31]}],"sources":[{"fileName":"dialog.ts","line":31,"character":10}]},{"id":33,"name":"OpenDialogOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Options for the open dialog."},"children":[{"id":36,"name":"defaultPath","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Initial directory or file path."},"sources":[{"fileName":"dialog.ts","line":51,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":38,"name":"directory","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the dialog is a directory selection or not."},"sources":[{"fileName":"dialog.ts","line":55,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":35,"name":"filters","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The filters of the dialog."},"sources":[{"fileName":"dialog.ts","line":49,"character":2}],"type":{"type":"array","elementType":{"type":"reference","id":30,"name":"DialogFilter"}}},{"id":37,"name":"multiple","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the dialog allows multiple selection or not."},"sources":[{"fileName":"dialog.ts","line":53,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":39,"name":"recursive","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"If `directory` is true, indicates that it will be read recursively later.\nDefines whether subdirectories will be allowed on the scope or not."},"sources":[{"fileName":"dialog.ts","line":60,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":34,"name":"title","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The title of the dialog window."},"sources":[{"fileName":"dialog.ts","line":47,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[36,38,35,37,39,34]}],"sources":[{"fileName":"dialog.ts","line":45,"character":10}]},{"id":40,"name":"SaveDialogOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Options for the save dialog."},"children":[{"id":43,"name":"defaultPath","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Initial directory or file path.\nIf it's a directory path, the dialog interface will change to that folder.\nIf it's not an existing directory, the file name will be set to the dialog's file name input and the dialog will be set to the parent folder."},"sources":[{"fileName":"dialog.ts","line":74,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":42,"name":"filters","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The filters of the dialog."},"sources":[{"fileName":"dialog.ts","line":68,"character":2}],"type":{"type":"array","elementType":{"type":"reference","id":30,"name":"DialogFilter"}}},{"id":41,"name":"title","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The title of the dialog window."},"sources":[{"fileName":"dialog.ts","line":66,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[43,42,41]}],"sources":[{"fileName":"dialog.ts","line":64,"character":10}]},{"id":53,"name":"ask","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":156,"character":15}],"signatures":[{"id":54,"name":"ask","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Shows a question dialog with `Yes` and `No` buttons.","returns":"A promise resolving to a boolean indicating whether `Yes` was clicked or not.\n"},"parameters":[{"id":55,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The message to show."},"type":{"type":"intrinsic","name":"string"}},{"id":56,"name":"title","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The dialog's title. Defaults to the application name.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":57,"name":"confirm","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":175,"character":15}],"signatures":[{"id":58,"name":"confirm","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Shows a question dialog with `Ok` and `Cancel` buttons.","returns":"A promise resolving to a boolean indicating whether `Ok` was clicked or not.\n"},"parameters":[{"id":59,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The message to show."},"type":{"type":"intrinsic","name":"string"}},{"id":60,"name":"title","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The dialog's title. Defaults to the application name.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":50,"name":"message","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":138,"character":15}],"signatures":[{"id":51,"name":"message","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Shows a message dialog with an `Ok` button.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":52,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The message to show.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":44,"name":"open","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":89,"character":15}],"signatures":[{"id":45,"name":"open","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Open a file/directory selection dialog.","text":"The selected paths are added to the filesystem and asset protocol allowlist scopes.\nWhen security is more important than the easy of use of this API,\nprefer writing a dedicated command instead.\n\nNote that the allowlist scope change is not persisted, so the values are cleared when the application is restarted.\nYou can save it to the filesystem using [tauri-plugin-persisted-scope](https://github.com/tauri-apps/tauri-plugin-persisted-scope).\n","returns":"A promise resolving to the selected path(s)\n"},"parameters":[{"id":46,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":33,"name":"OpenDialogOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":47,"name":"save","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":117,"character":15}],"signatures":[{"id":48,"name":"save","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Open a file/directory save dialog.","text":"The selected path is added to the filesystem and asset protocol allowlist scopes.\nWhen security is more important than the easy of use of this API,\nprefer writing a dedicated command instead.\n\nNote that the allowlist scope change is not persisted, so the values are cleared when the application is restarted.\nYou can save it to the filesystem using [tauri-plugin-persisted-scope](https://github.com/tauri-apps/tauri-plugin-persisted-scope).\n","returns":"A promise resolving to the selected path.\n"},"parameters":[{"id":49,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":40,"name":"SaveDialogOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Interfaces","kind":256,"children":[30,33,40]},{"title":"Functions","kind":64,"children":[53,57,50,44,47]}],"sources":[{"fileName":"dialog.ts","line":28,"character":0}]},{"id":61,"name":"event","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"The event system allows you to emit events to the backend and listen to events from it.","text":"This package is also accessible with `window.__TAURI__.event` when `tauri.conf.json > build > withGlobalTauri` is set to true."},"children":[{"id":830,"name":"Event","kind":256,"kindString":"Interface","flags":{},"children":[{"id":831,"name":"event","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Event name"},"sources":[{"fileName":"helpers/event.ts","line":12,"character":2}],"type":{"type":"reference","id":836,"name":"EventName"}},{"id":833,"name":"id","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Event identifier used to unlisten"},"sources":[{"fileName":"helpers/event.ts","line":16,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":834,"name":"payload","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Event payload"},"sources":[{"fileName":"helpers/event.ts","line":18,"character":2}],"type":{"type":"reference","id":835,"name":"T"}},{"id":832,"name":"windowLabel","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The label of the window that emitted this event."},"sources":[{"fileName":"helpers/event.ts","line":14,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[831,833,834,832]}],"sources":[{"fileName":"helpers/event.ts","line":10,"character":17}],"typeParameter":[{"id":835,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}]},{"id":837,"name":"EventCallback","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"helpers/event.ts","line":40,"character":12}],"typeParameter":[{"id":841,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"type":{"type":"reflection","declaration":{"id":838,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"helpers/event.ts","line":40,"character":31}],"signatures":[{"id":839,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":840,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":830,"typeArguments":[{"type":"reference","id":841,"name":"T"}],"name":"Event"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":836,"name":"EventName","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"helpers/event.ts","line":21,"character":12}],"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"literal","value":"tauri://update"},{"type":"literal","value":"tauri://update-available"},{"type":"literal","value":"tauri://update-download-progress"},{"type":"literal","value":"tauri://update-install"},{"type":"literal","value":"tauri://update-status"},{"type":"literal","value":"tauri://resize"},{"type":"literal","value":"tauri://move"},{"type":"literal","value":"tauri://close-requested"},{"type":"literal","value":"tauri://focus"},{"type":"literal","value":"tauri://blur"},{"type":"literal","value":"tauri://scale-change"},{"type":"literal","value":"tauri://menu"},{"type":"literal","value":"tauri://file-drop"},{"type":"literal","value":"tauri://file-drop-hover"},{"type":"literal","value":"tauri://file-drop-cancelled"}]},{"type":"intrinsic","name":"string"}],"qualifiedName":"LiteralUnion","package":"type-fest","name":"LiteralUnion"}},{"id":842,"name":"UnlistenFn","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"helpers/event.ts","line":42,"character":12}],"type":{"type":"reflection","declaration":{"id":843,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"helpers/event.ts","line":42,"character":25}],"signatures":[{"id":844,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":72,"name":"emit","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"event.ts","line":55,"character":15}],"signatures":[{"id":73,"name":"emit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Emits an event to the backend.","returns":"\n"},"parameters":[{"id":74,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"intrinsic","name":"string"}},{"id":75,"name":"payload","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":62,"name":"listen","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"event.ts","line":27,"character":15}],"signatures":[{"id":63,"name":"listen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an event from the backend.","returns":"A promise resolving to a function to unlisten to the event.\n"},"typeParameter":[{"id":64,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":65,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"reference","id":836,"name":"EventName"}},{"id":66,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event handler callback."},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":64,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":842,"name":"UnlistenFn"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":67,"name":"once","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"event.ts","line":41,"character":15}],"signatures":[{"id":68,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an one-off event from the backend.","returns":"A promise resolving to a function to unlisten to the event.\n"},"typeParameter":[{"id":69,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":70,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"reference","id":836,"name":"EventName"}},{"id":71,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event handler callback."},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":69,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":842,"name":"UnlistenFn"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Interfaces","kind":256,"children":[830]},{"title":"Type aliases","kind":4194304,"children":[837,836,842]},{"title":"Functions","kind":64,"children":[72,62,67]}],"sources":[{"fileName":"event.ts","line":12,"character":0}]},{"id":76,"name":"fs","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Access the file system.","text":"This package is also accessible with `window.__TAURI__.fs` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"fs\": {\n \"all\": true, // enable all FS APIs\n \"readFile\": true,\n \"writeFile\": true,\n \"readDir\": true,\n \"copyFile\": true,\n \"createDir\": true,\n \"removeDir\": true,\n \"removeFile\": true,\n \"renameFile\": true\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security.\n\n## Security\n\nThis module prevents path traversal, not allowing absolute paths or parent dir components\n(i.e. \"/usr/path/to/file\" or \"../path/to/file\" paths are not allowed).\nPaths accessed with this API must be relative to one of the [[BaseDirectory | base directories]]\nso if you need access to arbitrary filesystem paths, you must write such logic on the core layer instead.\n\nThe API has a scope configuration that forces you to restrict the paths that can be accessed using glob patterns.\n\nThe scope configuration is an array of glob patterns describing folder paths that are allowed.\nFor instance, this scope configuration only allows accessing files on the\n*databases* folder of the [[path.appDir | $APP directory]]:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"fs\": {\n \"scope\": [\"$APP/databases/*\"]\n }\n }\n }\n}\n```\n\nNotice the use of the `$APP` variable. The value is injected at runtime, resolving to the [[path.appDir | app directory]].\nThe available variables are:\n[[path.audioDir | `$AUDIO`]], [[path.cacheDir | `$CACHE`]], [[path.configDir | `$CONFIG`]], [[path.dataDir | `$DATA`]],\n[[path.localDataDir | `$LOCALDATA`]], [[path.desktopDir | `$DESKTOP`]], [[path.documentDir | `$DOCUMENT`]],\n[[path.downloadDir | `$DOWNLOAD`]], [[path.executableDir | `$EXE`]], [[path.fontDir | `$FONT`]], [[path.homeDir | `$HOME`]],\n[[path.pictureDir | `$PICTURE`]], [[path.publicDir | `$PUBLIC`]], [[path.runtimeDir | `$RUNTIME`]],\n[[path.templateDir | `$TEMPLATE`]], [[path.videoDir | `$VIDEO`]], [[path.resourceDir | `$RESOURCE`]], [[path.appDir | `$APP`]],\n[[path.logDir | `$LOG`]], [[os.tempdir | `$TEMP`]].\n\nTrying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.\n\nNote that this scope applies to **all** APIs on this module.\n"},"children":[{"id":113,"name":"Dir","kind":16777216,"kindString":"Reference","flags":{},"sources":[{"fileName":"fs.ts","line":379,"character":19}],"target":77},{"id":77,"name":"BaseDirectory","kind":8,"kindString":"Enumeration","flags":{},"children":[{"id":95,"name":"App","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":92,"character":2}],"defaultValue":"18"},{"id":78,"name":"Audio","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":75,"character":2}],"defaultValue":"1"},{"id":79,"name":"Cache","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":76,"character":2}],"defaultValue":"2"},{"id":80,"name":"Config","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":77,"character":2}],"defaultValue":"3"},{"id":81,"name":"Data","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":78,"character":2}],"defaultValue":"4"},{"id":83,"name":"Desktop","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":80,"character":2}],"defaultValue":"6"},{"id":84,"name":"Document","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":81,"character":2}],"defaultValue":"7"},{"id":85,"name":"Download","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":82,"character":2}],"defaultValue":"8"},{"id":86,"name":"Executable","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":83,"character":2}],"defaultValue":"9"},{"id":87,"name":"Font","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":84,"character":2}],"defaultValue":"10"},{"id":88,"name":"Home","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":85,"character":2}],"defaultValue":"11"},{"id":82,"name":"LocalData","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":79,"character":2}],"defaultValue":"5"},{"id":96,"name":"Log","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":93,"character":2}],"defaultValue":"19"},{"id":89,"name":"Picture","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":86,"character":2}],"defaultValue":"12"},{"id":90,"name":"Public","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":87,"character":2}],"defaultValue":"13"},{"id":94,"name":"Resource","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":91,"character":2}],"defaultValue":"17"},{"id":91,"name":"Runtime","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":88,"character":2}],"defaultValue":"14"},{"id":97,"name":"Temp","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":94,"character":2}],"defaultValue":"20"},{"id":92,"name":"Template","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":89,"character":2}],"defaultValue":"15"},{"id":93,"name":"Video","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"fs.ts","line":90,"character":2}],"defaultValue":"16"}],"groups":[{"title":"Enumeration members","kind":16,"children":[95,78,79,80,81,83,84,85,86,87,88,82,96,89,90,94,91,97,92,93]}],"sources":[{"fileName":"fs.ts","line":74,"character":12}]},{"id":109,"name":"FileEntry","kind":256,"kindString":"Interface","flags":{},"children":[{"id":112,"name":"children","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Children of this entry if it's a directory; null otherwise"},"sources":[{"fileName":"fs.ts","line":130,"character":2}],"type":{"type":"array","elementType":{"type":"reference","id":109,"name":"FileEntry"}}},{"id":111,"name":"name","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Name of the directory/file\ncan be null if the path terminates with `..`"},"sources":[{"fileName":"fs.ts","line":128,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":110,"name":"path","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"fs.ts","line":123,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[112,111,110]}],"sources":[{"fileName":"fs.ts","line":122,"character":10}]},{"id":106,"name":"FsBinaryFileOption","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Options object used to write a binary data to a file."},"children":[{"id":108,"name":"contents","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The byte array contents."},"sources":[{"fileName":"fs.ts","line":119,"character":2}],"type":{"type":"union","types":[{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"qualifiedName":"Iterable","package":"typescript","name":"Iterable"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"qualifiedName":"ArrayLike","package":"typescript","name":"ArrayLike"}]}},{"id":107,"name":"path","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Path to the file to write."},"sources":[{"fileName":"fs.ts","line":117,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[108,107]}],"sources":[{"fileName":"fs.ts","line":115,"character":10}]},{"id":100,"name":"FsDirOptions","kind":256,"kindString":"Interface","flags":{},"children":[{"id":101,"name":"dir","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":102,"character":2}],"type":{"type":"reference","id":77,"name":"BaseDirectory"}},{"id":102,"name":"recursive","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":103,"character":2}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[101,102]}],"sources":[{"fileName":"fs.ts","line":101,"character":10}]},{"id":98,"name":"FsOptions","kind":256,"kindString":"Interface","flags":{},"children":[{"id":99,"name":"dir","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":98,"character":2}],"type":{"type":"reference","id":77,"name":"BaseDirectory"}}],"groups":[{"title":"Properties","kind":1024,"children":[99]}],"sources":[{"fileName":"fs.ts","line":97,"character":10}]},{"id":103,"name":"FsTextFileOption","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Options object used to write a UTF-8 string to a file."},"children":[{"id":105,"name":"contents","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The UTF-8 string to write to the file."},"sources":[{"fileName":"fs.ts","line":111,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":104,"name":"path","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Path to the file to write."},"sources":[{"fileName":"fs.ts","line":109,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[105,104]}],"sources":[{"fileName":"fs.ts","line":107,"character":10}]},{"id":142,"name":"copyFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":309,"character":15}],"signatures":[{"id":143,"name":"copyFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Copys a file to a destination.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":144,"name":"source","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"A path of the file to copy."},"type":{"type":"intrinsic","name":"string"}},{"id":145,"name":"destination","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"A path for the destination file."},"type":{"type":"intrinsic","name":"string"}},{"id":146,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":98,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":134,"name":"createDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":265,"character":15}],"signatures":[{"id":135,"name":"createDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a directory.\nIf one of the path's parent components doesn't exist\nand the `recursive` option isn't set to true, the promise will be rejected.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":136,"name":"dir","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Path to the directory to create."},"type":{"type":"intrinsic","name":"string"}},{"id":137,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":100,"name":"FsDirOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":118,"name":"readBinaryFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":161,"character":15}],"signatures":[{"id":119,"name":"readBinaryFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Reads a file as byte array.","returns":"A promise resolving to the file bytes array.\n"},"parameters":[{"id":120,"name":"filePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Path to the file."},"type":{"type":"intrinsic","name":"string"}},{"id":121,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":98,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"reference","qualifiedName":"Uint8Array","package":"typescript","name":"Uint8Array"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":130,"name":"readDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":242,"character":15}],"signatures":[{"id":131,"name":"readDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"List directory files.","returns":"A promise resolving to the directory entries.\n"},"parameters":[{"id":132,"name":"dir","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Path to the directory to read."},"type":{"type":"intrinsic","name":"string"}},{"id":133,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":100,"name":"FsDirOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"reference","id":109,"name":"FileEntry"}}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":114,"name":"readTextFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":140,"character":15}],"signatures":[{"id":115,"name":"readTextFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Reads a file as an UTF-8 encoded string.","returns":"A promise resolving to the file content as a UTF-8 encoded string.\n"},"parameters":[{"id":116,"name":"filePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Path to the file."},"type":{"type":"intrinsic","name":"string"}},{"id":117,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":98,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":138,"name":"removeDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":287,"character":15}],"signatures":[{"id":139,"name":"removeDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes a directory.\nIf the directory is not empty and the `recursive` option isn't set to true, the promise will be rejected.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":140,"name":"dir","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Path to the directory to remove."},"type":{"type":"intrinsic","name":"string"}},{"id":141,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":100,"name":"FsDirOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":147,"name":"removeFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":332,"character":15}],"signatures":[{"id":148,"name":"removeFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes a file.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":149,"name":"file","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Path to the file to remove."},"type":{"type":"intrinsic","name":"string"}},{"id":150,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":98,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":151,"name":"renameFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":354,"character":15}],"signatures":[{"id":152,"name":"renameFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Renames a file.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":153,"name":"oldPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"A path of the file to rename."},"type":{"type":"intrinsic","name":"string"}},{"id":154,"name":"newPath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"A path of the new file name."},"type":{"type":"intrinsic","name":"string"}},{"id":155,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":98,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":126,"name":"writeBinaryFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":213,"character":15}],"signatures":[{"id":127,"name":"writeBinaryFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes a byte array content to a file.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":128,"name":"file","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Write configuration object."},"type":{"type":"reference","id":106,"name":"FsBinaryFileOption"}},{"id":129,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":98,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":122,"name":"writeFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":184,"character":15}],"signatures":[{"id":123,"name":"writeFile","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes a UTF-8 text file.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":124,"name":"file","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"File configuration object."},"type":{"type":"reference","id":103,"name":"FsTextFileOption"}},{"id":125,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Configuration object."},"type":{"type":"reference","id":98,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"References","kind":16777216,"children":[113]},{"title":"Enumerations","kind":8,"children":[77]},{"title":"Interfaces","kind":256,"children":[109,106,100,98,103]},{"title":"Functions","kind":64,"children":[142,134,118,130,114,138,147,151,126,122]}],"sources":[{"fileName":"fs.ts","line":72,"character":0}]},{"id":156,"name":"globalShortcut","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Register global shortcuts.","text":"This package is also accessible with `window.__TAURI__.globalShortcut` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"globalShortcut\": {\n \"all\": true // enable all global shortcut APIs\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."},"children":[{"id":157,"name":"ShortcutHandler","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":29,"character":12}],"type":{"type":"reflection","declaration":{"id":158,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":29,"character":30}],"signatures":[{"id":159,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":160,"name":"shortcut","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":169,"name":"isRegistered","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":79,"character":15}],"signatures":[{"id":170,"name":"isRegistered","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Determines whether the given shortcut is registered by this application or not.","returns":"A promise resolving to the state.\n"},"parameters":[{"id":171,"name":"shortcut","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Array of shortcut definitions, modifiers and key separated by \"+\" e.g. CmdOrControl+Q"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":161,"name":"register","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":38,"character":15}],"signatures":[{"id":162,"name":"register","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Register a global shortcut.","returns":"\n"},"parameters":[{"id":163,"name":"shortcut","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Shortcut definition, modifiers and key separated by \"+\" e.g. CmdOrControl+Q"},"type":{"type":"intrinsic","name":"string"}},{"id":164,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Shortcut handler callback - takes the triggered shortcut as argument"},"type":{"type":"reference","id":157,"name":"ShortcutHandler"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":165,"name":"registerAll","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":59,"character":15}],"signatures":[{"id":166,"name":"registerAll","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Register a collection of global shortcuts.","returns":"\n"},"parameters":[{"id":167,"name":"shortcuts","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Array of shortcut definitions, modifiers and key separated by \"+\" e.g. CmdOrControl+Q"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":168,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Shortcut handler callback - takes the triggered shortcut as argument"},"type":{"type":"reference","id":157,"name":"ShortcutHandler"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":172,"name":"unregister","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":95,"character":15}],"signatures":[{"id":173,"name":"unregister","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unregister a global shortcut.","returns":"\n"},"parameters":[{"id":174,"name":"shortcut","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"shortcut definition, modifiers and key separated by \"+\" e.g. CmdOrControl+Q"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":175,"name":"unregisterAll","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":110,"character":15}],"signatures":[{"id":176,"name":"unregisterAll","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unregisters all shortcuts registered by the application.","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Type aliases","kind":4194304,"children":[157]},{"title":"Functions","kind":64,"children":[169,161,165,172,175]}],"sources":[{"fileName":"globalShortcut.ts","line":26,"character":0}]},{"id":177,"name":"http","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Access the HTTP client written in Rust.","text":"This package is also accessible with `window.__TAURI__.http` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"http\": {\n \"all\": true, // enable all http APIs\n \"request\": true // enable HTTP request API\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security.\n\n## Security\n\nThis API has a scope configuration that forces you to restrict the URLs and paths that can be accessed using glob patterns.\n\nFor instance, this scope configuration only allows making HTTP requests to the GitHub API for the `tauri-apps` organization:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"http\": {\n \"scope\": [\"https://api.github.com/repos/tauri-apps/*\"]\n }\n }\n }\n}\n```\nTrying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access.\n"},"children":[{"id":270,"name":"ResponseType","kind":8,"kindString":"Enumeration","flags":{},"children":[{"id":273,"name":"Binary","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"http.ts","line":56,"character":2}],"defaultValue":"3"},{"id":271,"name":"JSON","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"http.ts","line":54,"character":2}],"defaultValue":"1"},{"id":272,"name":"Text","kind":16,"kindString":"Enumeration member","flags":{},"sources":[{"fileName":"http.ts","line":55,"character":2}],"defaultValue":"2"}],"groups":[{"title":"Enumeration members","kind":16,"children":[273,271,272]}],"sources":[{"fileName":"http.ts","line":53,"character":5}]},{"id":201,"name":"Body","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"The body object to be used on POST and PUT requests."},"children":[{"id":219,"name":"payload","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":64,"character":2}],"type":{"type":"intrinsic","name":"unknown"}},{"id":218,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":63,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":211,"name":"bytes","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":119,"character":9}],"signatures":[{"id":212,"name":"bytes","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new byte array body.","returns":"The body object ready to be used on the POST and PUT requests.\n"},"parameters":[{"id":213,"name":"bytes","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","qualifiedName":"Uint8Array","package":"typescript","name":"Uint8Array"}}],"type":{"type":"reference","id":201,"name":"Body"}}]},{"id":202,"name":"form","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":79,"character":9}],"signatures":[{"id":203,"name":"form","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new form data body.","returns":"The body object ready to be used on the POST and PUT requests.\n"},"parameters":[{"id":204,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The body data.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","id":181,"name":"Part"}],"qualifiedName":"Record","package":"typescript","name":"Record"}}],"type":{"type":"reference","id":201,"name":"Body"}}]},{"id":205,"name":"json","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":97,"character":9}],"signatures":[{"id":206,"name":"json","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new JSON body.","returns":"The body object ready to be used on the POST and PUT requests.\n"},"parameters":[{"id":207,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The body JSON object.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"qualifiedName":"Record","package":"typescript","name":"Record"}}],"type":{"type":"reference","id":201,"name":"Body"}}]},{"id":208,"name":"text","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":108,"character":9}],"signatures":[{"id":209,"name":"text","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new UTF-8 string body.","returns":"The body object ready to be used on the POST and PUT requests.\n"},"parameters":[{"id":210,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":201,"name":"Body"}}]}],"groups":[{"title":"Properties","kind":1024,"children":[219,218]},{"title":"Methods","kind":2048,"children":[211,202,205,208]}],"sources":[{"fileName":"http.ts","line":62,"character":6}]},{"id":220,"name":"Client","kind":128,"kindString":"Class","flags":{},"children":[{"id":224,"name":"id","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":189,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":253,"name":"delete","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":333,"character":8}],"signatures":[{"id":254,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes a DELETE request.","returns":"A promise resolving to the response.\n"},"typeParameter":[{"id":255,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":256,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The request URL."},"type":{"type":"intrinsic","name":"string"}},{"id":257,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The request options."},"type":{"type":"reference","id":191,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":258,"typeArguments":[{"type":"reference","id":255,"name":"T"}],"name":"Response"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":225,"name":"drop","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":200,"character":8}],"signatures":[{"id":226,"name":"drop","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Drops the client instance.","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":231,"name":"get","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":261,"character":8}],"signatures":[{"id":232,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes a GET request.","returns":"A promise resolving to the response.\n"},"typeParameter":[{"id":233,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":234,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The request URL."},"type":{"type":"intrinsic","name":"string"}},{"id":235,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The request options."},"type":{"type":"reference","id":191,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":258,"typeArguments":[{"type":"reference","id":233,"name":"T"}],"name":"Response"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":248,"name":"patch","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":318,"character":8}],"signatures":[{"id":249,"name":"patch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes a PATCH request.","returns":"A promise resolving to the response.\n"},"typeParameter":[{"id":250,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":251,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The request URL."},"type":{"type":"intrinsic","name":"string"}},{"id":252,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The request options."},"type":{"type":"reference","id":191,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":258,"typeArguments":[{"type":"reference","id":250,"name":"T"}],"name":"Response"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":236,"name":"post","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":277,"character":8}],"signatures":[{"id":237,"name":"post","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes a POST request.","returns":"A promise resolving to the response.\n"},"typeParameter":[{"id":238,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":239,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The request URL."},"type":{"type":"intrinsic","name":"string"}},{"id":240,"name":"body","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The body of the request."},"type":{"type":"reference","id":201,"name":"Body"}},{"id":241,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The request options."},"type":{"type":"reference","id":191,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":258,"typeArguments":[{"type":"reference","id":238,"name":"T"}],"name":"Response"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":242,"name":"put","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":298,"character":8}],"signatures":[{"id":243,"name":"put","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes a PUT request.","returns":"A promise resolving to the response.\n"},"typeParameter":[{"id":244,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":245,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The request URL."},"type":{"type":"intrinsic","name":"string"}},{"id":246,"name":"body","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The body of the request."},"type":{"type":"reference","id":201,"name":"Body"}},{"id":247,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Request options."},"type":{"type":"reference","id":191,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":258,"typeArguments":[{"type":"reference","id":244,"name":"T"}],"name":"Response"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":227,"name":"request","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":216,"character":8}],"signatures":[{"id":228,"name":"request","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes an HTTP request.","returns":"A promise resolving to the response.\n"},"typeParameter":[{"id":229,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":230,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The request options."},"type":{"type":"reference","id":183,"name":"HttpOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":258,"typeArguments":[{"type":"reference","id":229,"name":"T"}],"name":"Response"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Properties","kind":1024,"children":[224]},{"title":"Methods","kind":2048,"children":[253,225,231,248,236,242,227]}],"sources":[{"fileName":"http.ts","line":188,"character":6}]},{"id":258,"name":"Response","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"Response object."},"children":[{"id":268,"name":"data","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The response data."},"sources":[{"fileName":"http.ts","line":175,"character":2}],"type":{"type":"reference","name":"T"}},{"id":266,"name":"headers","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The response headers."},"sources":[{"fileName":"http.ts","line":171,"character":2}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"qualifiedName":"Record","package":"typescript","name":"Record"}},{"id":265,"name":"ok","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"A boolean indicating whether the response was successful (status in the range 200–299) or not."},"sources":[{"fileName":"http.ts","line":169,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":267,"name":"rawHeaders","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The response raw headers."},"sources":[{"fileName":"http.ts","line":173,"character":2}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"qualifiedName":"Record","package":"typescript","name":"Record"}},{"id":264,"name":"status","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The response status code."},"sources":[{"fileName":"http.ts","line":167,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":263,"name":"url","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The request URL."},"sources":[{"fileName":"http.ts","line":165,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[268,266,265,267,264,263]}],"sources":[{"fileName":"http.ts","line":163,"character":6}],"typeParameter":[{"id":269,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}]},{"id":178,"name":"ClientOptions","kind":256,"kindString":"Interface","flags":{},"children":[{"id":180,"name":"connectTimeout","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":50,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":179,"name":"maxRedirections","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":49,"character":2}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[180,179]}],"sources":[{"fileName":"http.ts","line":48,"character":10}]},{"id":183,"name":"HttpOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Options object sent to the backend."},"children":[{"id":188,"name":"body","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":143,"character":2}],"type":{"type":"reference","id":201,"name":"Body"}},{"id":186,"name":"headers","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":141,"character":2}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"any"}],"qualifiedName":"Record","package":"typescript","name":"Record"}},{"id":184,"name":"method","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":139,"character":2}],"type":{"type":"reference","id":182,"name":"HttpVerb"}},{"id":187,"name":"query","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":142,"character":2}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"any"}],"qualifiedName":"Record","package":"typescript","name":"Record"}},{"id":190,"name":"responseType","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":145,"character":2}],"type":{"type":"reference","id":270,"name":"ResponseType"}},{"id":189,"name":"timeout","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":144,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":185,"name":"url","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":140,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[188,186,184,187,190,189,185]}],"sources":[{"fileName":"http.ts","line":138,"character":10}]},{"id":192,"name":"FetchOptions","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"shortText":"Options for the `fetch` API."},"sources":[{"fileName":"http.ts","line":151,"character":5}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":183,"name":"HttpOptions"},{"type":"literal","value":"url"}],"qualifiedName":"Omit","package":"typescript","name":"Omit"}},{"id":182,"name":"HttpVerb","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"shortText":"The request HTTP verb."},"sources":[{"fileName":"http.ts","line":126,"character":5}],"type":{"type":"union","types":[{"type":"literal","value":"GET"},{"type":"literal","value":"POST"},{"type":"literal","value":"PUT"},{"type":"literal","value":"DELETE"},{"type":"literal","value":"PATCH"},{"type":"literal","value":"HEAD"},{"type":"literal","value":"OPTIONS"},{"type":"literal","value":"CONNECT"},{"type":"literal","value":"TRACE"}]}},{"id":181,"name":"Part","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"http.ts","line":59,"character":5}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","qualifiedName":"Uint8Array","package":"typescript","name":"Uint8Array"}]}},{"id":191,"name":"RequestOptions","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"shortText":"Request options."},"sources":[{"fileName":"http.ts","line":149,"character":5}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":183,"name":"HttpOptions"},{"type":"union","types":[{"type":"literal","value":"method"},{"type":"literal","value":"url"}]}],"qualifiedName":"Omit","package":"typescript","name":"Omit"}},{"id":196,"name":"fetch","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"http.ts","line":369,"character":15}],"signatures":[{"id":197,"name":"fetch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Perform an HTTP request using the default client.","returns":"The response object.\n"},"typeParameter":[{"id":198,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":199,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The request URL."},"type":{"type":"intrinsic","name":"string"}},{"id":200,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The fetch options."},"type":{"type":"reference","id":192,"name":"FetchOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":258,"typeArguments":[{"type":"reference","id":198,"name":"T"}],"name":"Response"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":193,"name":"getClient","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"http.ts","line":349,"character":15}],"signatures":[{"id":194,"name":"getClient","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a new client using the specified options.","returns":"A promise resolving to the client instance.\n"},"parameters":[{"id":195,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Client configuration.\n"},"type":{"type":"reference","id":178,"name":"ClientOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":220,"name":"Client"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Enumerations","kind":8,"children":[270]},{"title":"Classes","kind":128,"children":[201,220,258]},{"title":"Interfaces","kind":256,"children":[178,183]},{"title":"Type aliases","kind":4194304,"children":[192,182,181,191]},{"title":"Functions","kind":64,"children":[196,193]}],"sources":[{"fileName":"http.ts","line":46,"character":0}]},{"id":274,"name":"mocks","kind":2,"kindString":"Module","flags":{},"children":[{"id":286,"name":"clearMocks","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"mocks.ts","line":142,"character":16}],"signatures":[{"id":287,"name":"clearMocks","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"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.","text":"# Example\n\n```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```\n"},"type":{"type":"intrinsic","name":"void"}}]},{"id":275,"name":"mockIPC","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"mocks.ts","line":40,"character":16}],"signatures":[{"id":276,"name":"mockIPC","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Intercepts all IPC requests with the given mock handler.","text":"This 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```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, args) => {\n switch (cmd) {\n case \"add\":\n return (args.a as number) + (args.b as number);\n default:\n break;\n }\n });\n\n expect(invoke('add', { a: 12, b: 15 })).resolves.toBe(27);\n})\n```\n"},"parameters":[{"id":277,"name":"cb","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"\n"},"type":{"type":"reflection","declaration":{"id":278,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":279,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":280,"name":"cmd","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":281,"name":"args","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"qualifiedName":"Record","package":"typescript","name":"Record"}}],"type":{"type":"intrinsic","name":"any"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":282,"name":"mockWindows","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"mocks.ts","line":108,"character":16}],"signatures":[{"id":283,"name":"mockWindows","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Mocks one or many window labels.\nIn non-tauri context it is required to call this function *before* using the `@tauri-apps/api/window` module.","text":"This function only mocks the *presence* of windows,\nwindow properties (e.g. width and height) can be mocked like regular IPC calls using the `mockIPC` function.\n\n# Examples\n\n```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```\n\n```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nmockIPC((cmd, args) => {\n if (cmd === \"tauri\") {\n if (\n args?.__tauriModule === \"Window\" &&\n args?.message?.cmd === \"manage\" &&\n args?.message?.data?.cmd?.type === \"close\"\n ) {\n console.log('closing window!');\n }\n }\n});\n\nconst { getCurrent } = await import(\"@tauri-apps/api/window\");\n\nconst win = getCurrent();\nawait win.close(); // this will cause the mocked IPC handler to log to the console.\n```\n"},"parameters":[{"id":284,"name":"current","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Label of window this JavaScript context is running in."},"type":{"type":"intrinsic","name":"string"}},{"id":285,"name":"additionalWindows","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"shortText":"Label of additional windows the app has.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Functions","kind":64,"children":[286,275,282]}],"sources":[{"fileName":"mocks.ts","line":1,"character":0}]},{"id":288,"name":"notification","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Send toast notifications (brief auto-expiring OS window element) to your user.\nCan also be used with the Notification Web API.","text":"This package is also accessible with `window.__TAURI__.notification` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"notification\": {\n \"all\": true // enable all notification APIs\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."},"children":[{"id":289,"name":"Options","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Options to send a notification."},"children":[{"id":291,"name":"body","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Optional notification body."},"sources":[{"fileName":"notification.ts","line":36,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":292,"name":"icon","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Optional notification icon."},"sources":[{"fileName":"notification.ts","line":38,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":290,"name":"title","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Notification title."},"sources":[{"fileName":"notification.ts","line":34,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[291,292,290]}],"sources":[{"fileName":"notification.ts","line":32,"character":10}]},{"id":293,"name":"Permission","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"shortText":"Possible permission values."},"sources":[{"fileName":"notification.ts","line":42,"character":5}],"type":{"type":"union","types":[{"type":"literal","value":"granted"},{"type":"literal","value":"denied"},{"type":"literal","value":"default"}]}},{"id":299,"name":"isPermissionGranted","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"notification.ts","line":49,"character":15}],"signatures":[{"id":300,"name":"isPermissionGranted","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Checks if the permission to send notifications is granted.","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"literal","value":null}]}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":297,"name":"requestPermission","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"notification.ts","line":66,"character":15}],"signatures":[{"id":298,"name":"requestPermission","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Requests the permission to send notifications.","returns":"A promise resolving to whether the user granted the permission or not.\n"},"type":{"type":"reference","typeArguments":[{"type":"reference","id":293,"name":"Permission"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":294,"name":"sendNotification","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"notification.ts","line":75,"character":9}],"signatures":[{"id":295,"name":"sendNotification","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a notification to the user."},"parameters":[{"id":296,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Notification options.\n"},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","id":289,"name":"Options"}]}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Interfaces","kind":256,"children":[289]},{"title":"Type aliases","kind":4194304,"children":[293]},{"title":"Functions","kind":64,"children":[299,297,294]}],"sources":[{"fileName":"notification.ts","line":27,"character":0}]},{"id":301,"name":"os","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Provides operating system-related utility methods and properties.","text":"This package is also accessible with `window.__TAURI__.os` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"os\": {\n \"all\": true, // enable all Os APIs\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."},"children":[{"id":302,"name":"EOL","kind":32,"kindString":"Variable","flags":{"isConst":true},"comment":{"shortText":"The operating system-specific end-of-line marker.\n- `\\n` on POSIX\n- `\\r\\n` on Windows"},"sources":[{"fileName":"os.ts","line":35,"character":6}],"type":{"type":"union","types":[{"type":"literal","value":"\r\n"},{"type":"literal","value":"\n"}]},"defaultValue":"..."},{"id":309,"name":"arch","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":93,"character":15}],"signatures":[{"id":310,"name":"arch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the operating system CPU architecture for which the tauri app was compiled. Possible values are `'x86'`, `'x86_64'`, `'arm'`, `'aarch64'`, `'mips'`, `'mips64'`, `'powerpc'`, `'powerpc64'`, `'riscv64'`, `'s390x'`, `'sparc64'`"},"type":{"type":"reference","typeArguments":[{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"literal","value":"x86"},{"type":"literal","value":"x86_64"},{"type":"literal","value":"arm"},{"type":"literal","value":"aarch64"},{"type":"literal","value":"mips"},{"type":"literal","value":"mips64"},{"type":"literal","value":"powerpc"},{"type":"literal","value":"powerpc64"},{"type":"literal","value":"riscv64"},{"type":"literal","value":"s390x"},{"type":"literal","value":"sparc64"}]},{"type":"intrinsic","name":"string"}],"qualifiedName":"LiteralUnion","package":"type-fest","name":"LiteralUnion"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":303,"name":"platform","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":41,"character":15}],"signatures":[{"id":304,"name":"platform","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a string identifying the operating system platform.\nThe value is set at compile time. Possible values are `'linux'`, `'darwin'`, `'ios'`, `'freebsd'`, `'dragonfly'`, `'netbsd'`, `'openbsd'`, `'solaris'`, `'android'`, `'win32'`"},"type":{"type":"reference","typeArguments":[{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"literal","value":"linux"},{"type":"literal","value":"darwin"},{"type":"literal","value":"ios"},{"type":"literal","value":"freebsd"},{"type":"literal","value":"dragonfly"},{"type":"literal","value":"netbsd"},{"type":"literal","value":"openbsd"},{"type":"literal","value":"solaris"},{"type":"literal","value":"android"},{"type":"literal","value":"win32"}]},{"type":"intrinsic","name":"string"}],"qualifiedName":"LiteralUnion","package":"type-fest","name":"LiteralUnion"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":311,"name":"tempdir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":120,"character":15}],"signatures":[{"id":312,"name":"tempdir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the operating system's default directory for temporary files as a string."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":307,"name":"type","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":79,"character":15}],"signatures":[{"id":308,"name":"type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows."},"type":{"type":"reference","typeArguments":[{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"literal","value":"Linux"},{"type":"literal","value":"Darwin"},{"type":"literal","value":"Windows_NT"}]},{"type":"intrinsic","name":"string"}],"qualifiedName":"LiteralUnion","package":"type-fest","name":"LiteralUnion"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":305,"name":"version","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":67,"character":15}],"signatures":[{"id":306,"name":"version","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a string identifying the kernel version."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Variables","kind":32,"children":[302]},{"title":"Functions","kind":64,"children":[309,303,311,307,305]}],"sources":[{"fileName":"os.ts","line":26,"character":0}]},{"id":313,"name":"path","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"The path module provides utilities for working with file and directory paths.","text":"This package is also accessible with `window.__TAURI__.path` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"path\": {\n \"all\": true, // enable all Path APIs\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."},"children":[{"id":845,"name":"BaseDirectory","kind":16777216,"kindString":"Reference","flags":{},"sources":[{"fileName":"path.ts","line":566,"character":2}],"target":77},{"id":353,"name":"delimiter","kind":32,"kindString":"Variable","flags":{"isConst":true},"comment":{"shortText":"Provides the platform-specific path segment delimiter:\n- `;` on Windows\n- `:` on POSIX"},"sources":[{"fileName":"path.ts","line":449,"character":6}],"type":{"type":"union","types":[{"type":"literal","value":";"},{"type":"literal","value":":"}]},"defaultValue":"..."},{"id":352,"name":"sep","kind":32,"kindString":"Variable","flags":{"isConst":true},"comment":{"shortText":"Provides the platform-specific path segment separator:\n- `\\` on Windows\n- `/` on POSIX"},"sources":[{"fileName":"path.ts","line":442,"character":6}],"type":{"type":"union","types":[{"type":"literal","value":"\\"},{"type":"literal","value":"/"}]},"defaultValue":"..."},{"id":314,"name":"appDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":36,"character":15}],"signatures":[{"id":315,"name":"appDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the suggested directory for your app config files.\nResolves to `${configDir}/${bundleIdentifier}`, where `bundleIdentifier` is the value configured on `tauri.conf.json > tauri > bundle > identifier`.","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":316,"name":"audioDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":58,"character":15}],"signatures":[{"id":317,"name":"audioDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's audio directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_MUSIC_DIR`.\n- **macOS:** Resolves to `$HOME/Music`.\n- **Windows:** Resolves to `{FOLDERID_Music}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":369,"name":"basename","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":525,"character":15}],"signatures":[{"id":370,"name":"basename","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":" Returns the last portion of a `path`. Trailing directory separators are ignored."},"parameters":[{"id":371,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":372,"name":"ext","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"An optional file extension to be removed from the returned path.\n"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":318,"name":"cacheDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":80,"character":15}],"signatures":[{"id":319,"name":"cacheDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's cache directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to `$XDG_CACHE_HOME` or `$HOME/.cache`.\n- **macOS:** Resolves to `$HOME/Library/Caches`.\n- **Windows:** Resolves to `{FOLDERID_LocalAppData}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":320,"name":"configDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":102,"character":15}],"signatures":[{"id":321,"name":"configDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's config directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to `$XDG_CONFIG_HOME` or `$HOME/.config`.\n- **macOS:** Resolves to `$HOME/Library/Application Support`.\n- **Windows:** Resolves to `{FOLDERID_LocalAppData}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":322,"name":"dataDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":124,"character":15}],"signatures":[{"id":323,"name":"dataDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's data directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to `$XDG_DATA_HOME` or `$HOME/.local/share`.\n- **macOS:** Resolves to `$HOME/Library/Application Support`.\n- **Windows:** Resolves to `{FOLDERID_RoamingAppData}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":324,"name":"desktopDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":146,"character":15}],"signatures":[{"id":325,"name":"desktopDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's desktop directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_DESKTOP_DIR`.\n- **macOS:** Resolves to `$HOME/Library/Desktop`.\n- **Windows:** Resolves to `{FOLDERID_Desktop}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":363,"name":"dirname","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":497,"character":15}],"signatures":[{"id":364,"name":"dirname","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the directory name of a `path`. Trailing directory separators are ignored."},"parameters":[{"id":365,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":326,"name":"documentDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":168,"character":15}],"signatures":[{"id":327,"name":"documentDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's document directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_DOCUMENTS_DIR`.\n- **macOS:** Resolves to `$HOME/Documents`.\n- **Windows:** Resolves to `{FOLDERID_Documents}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":328,"name":"downloadDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":190,"character":15}],"signatures":[{"id":329,"name":"downloadDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's download directory.","text":"#### Platform-specific\n\n- **Linux**: Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_DOWNLOAD_DIR`.\n- **macOS**: Resolves to `$HOME/Downloads`.\n- **Windows**: Resolves to `{FOLDERID_Downloads}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":330,"name":"executableDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":212,"character":15}],"signatures":[{"id":331,"name":"executableDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's executable directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to `$XDG_BIN_HOME/../bin` or `$XDG_DATA_HOME/../bin` or `$HOME/.local/bin`.\n- **macOS:** Not supported.\n- **Windows:** Not supported.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":366,"name":"extname","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":510,"character":15}],"signatures":[{"id":367,"name":"extname","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the extension of the `path`."},"parameters":[{"id":368,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":332,"name":"fontDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":234,"character":15}],"signatures":[{"id":333,"name":"fontDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's font directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to `$XDG_DATA_HOME/fonts` or `$HOME/.local/share/fonts`.\n- **macOS:** Resolves to `$HOME/Library/Fonts`.\n- **Windows:** Not supported.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":334,"name":"homeDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":256,"character":15}],"signatures":[{"id":335,"name":"homeDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's home directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to `$HOME`.\n- **macOS:** Resolves to `$HOME`.\n- **Windows:** Resolves to `{FOLDERID_Profile}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":373,"name":"isAbsolute","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":536,"character":15}],"signatures":[{"id":374,"name":"isAbsolute","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":375,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":360,"name":"join","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":484,"character":15}],"signatures":[{"id":361,"name":"join","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":" Joins all given `path` segments together using the platform-specific separator as a delimiter, then normalizes the resulting path."},"parameters":[{"id":362,"name":"paths","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"shortText":"A sequence of path segments.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":336,"name":"localDataDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":278,"character":15}],"signatures":[{"id":337,"name":"localDataDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's local data directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to `$XDG_DATA_HOME` or `$HOME/.local/share`.\n- **macOS:** Resolves to `$HOME/Library/Application Support`.\n- **Windows:** Resolves to `{FOLDERID_LocalAppData}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":350,"name":"logDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":426,"character":15}],"signatures":[{"id":351,"name":"logDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the suggested log directory.","text":"### Platform-specific\n\n- **Linux:** Resolves to `${configDir}/${bundleIdentifier}`.\n- **macOS:** Resolves to `${homeDir}//Library/Logs/{bundleIdentifier}`\n- **Windows:** Resolves to `${configDir}/${bundleIdentifier}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":357,"name":"normalize","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":469,"character":15}],"signatures":[{"id":358,"name":"normalize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Normalizes the given `path`, resolving `'..'` and `'.'` segments and resolve symolic links."},"parameters":[{"id":359,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":338,"name":"pictureDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":300,"character":15}],"signatures":[{"id":339,"name":"pictureDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's picture directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_PICTURES_DIR`.\n- **macOS:** Resolves to `$HOME/Pictures`.\n- **Windows:** Resolves to `{FOLDERID_Pictures}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":340,"name":"publicDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":322,"character":15}],"signatures":[{"id":341,"name":"publicDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's public directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_PUBLICSHARE_DIR`.\n- **macOS:** Resolves to `$HOME/Public`.\n- **Windows:** Resolves to `{FOLDERID_Public}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":354,"name":"resolve","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":456,"character":15}],"signatures":[{"id":355,"name":"resolve","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Resolves a sequence of `paths` or `path` segments into an absolute path."},"parameters":[{"id":356,"name":"paths","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"shortText":"A sequence of paths or path segments.\n"},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":342,"name":"resourceDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":338,"character":15}],"signatures":[{"id":343,"name":"resourceDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's resource directory.","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":344,"name":"runtimeDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":360,"character":15}],"signatures":[{"id":345,"name":"runtimeDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's runtime directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to `$XDG_RUNTIME_DIR`.\n- **macOS:** Not supported.\n- **Windows:** Not supported.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":346,"name":"templateDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":382,"character":15}],"signatures":[{"id":347,"name":"templateDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's template directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_TEMPLATES_DIR`.\n- **macOS:** Not supported.\n- **Windows:** Resolves to `{FOLDERID_Templates}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":348,"name":"videoDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":404,"character":15}],"signatures":[{"id":349,"name":"videoDir","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the path to the user's video directory.","text":"#### Platform-specific\n\n- **Linux:** Resolves to [`xdg-user-dirs`](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' `XDG_VIDEOS_DIR`.\n- **macOS:** Resolves to `$HOME/Movies`.\n- **Windows:** Resolves to `{FOLDERID_Videos}`.\n","returns":"\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"References","kind":16777216,"children":[845]},{"title":"Variables","kind":32,"children":[353,352]},{"title":"Functions","kind":64,"children":[314,316,369,318,320,322,324,363,326,328,330,366,332,334,373,360,336,350,357,338,340,354,342,344,346,348]}],"sources":[{"fileName":"path.ts","line":26,"character":0}]},{"id":376,"name":"process","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Perform operations on the current process.","text":"This package is also accessible with `window.__TAURI__.process` when `tauri.conf.json > build > withGlobalTauri` is set to true."},"children":[{"id":377,"name":"exit","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"process.ts","line":20,"character":15}],"signatures":[{"id":378,"name":"exit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Exits immediately with the given `exitCode`.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":379,"name":"exitCode","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The exit code to use."},"type":{"type":"intrinsic","name":"number"},"defaultValue":"0"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":380,"name":"relaunch","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"process.ts","line":35,"character":15}],"signatures":[{"id":381,"name":"relaunch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Exits the current instance of the app then relaunches it.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Functions","kind":64,"children":[377,380]}],"sources":[{"fileName":"process.ts","line":12,"character":0}]},{"id":382,"name":"shell","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Access the system shell.\nAllows you to spawn child processes and manage files and URLs using their default application.","text":"This package is also accessible with `window.__TAURI__.shell` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"shell\": {\n \"all\": true, // enable all shell APIs\n \"execute\": true, // enable process spawn APIs\n \"sidecar\": true, // enable spawning sidecars\n \"open\": true // enable opening files/URLs using the default program\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security.\n\n## Security\n\nThis API has a scope configuration that forces you to restrict the programs and arguments that can be used.\n\n### Restricting access to the [[open | `open`]] API\n\nOn the allowlist, `open: true` means that the [[open]] API can be used with any URL,\nas the argument is validated with the `^https?://` regex.\nYou can change that regex by changing the boolean value to a string, e.g. `open: ^https://github.com/`.\n\n### Restricting access to the [[Command | `Command`]] APIs\n\nThe `shell` allowlist object has a `scope` field that defines an array of CLIs that can be used.\nEach CLI is a configuration object `{ name: string, cmd: string, sidecar?: bool, args?: boolean | Arg[] }`.\n\n- `name`: the unique identifier of the command, passed to the [[Command.constructor | Command constructor]].\nIf it's a sidecar, this must be the value defined on `tauri.conf.json > tauri > bundle > externalBin`.\n- `cmd`: the program that is executed on this configuration. If it's a sidecar, this value is ignored.\n- `sidecar`: whether the object configures a sidecar or a system program.\n- `args`: the arguments that can be passed to the program. By default no arguments are allowed.\n - `true` means that any argument list is allowed.\n - `false` means that no arguments are allowed.\n - otherwise an array can be configured. Each item is either a string representing the fixed argument value\n or a `{ validator: string }` that defines a regex validating the argument value.\n\n#### Example scope configuration\n\nCLI: `git commit -m \"the commit message\"`\n\nConfiguration:\n```json\n{\n \"scope\": {\n \"name\": \"run-git-commit\",\n \"cmd\": \"git\",\n \"args\": [\"commit\", \"-m\", { \"validator\": \"\\\\S+\" }]\n }\n}\n```\nUsage:\n```typescript\nimport { Command } from '@tauri-apps/api/shell'\nnew Command('run-git-commit', ['commit', '-m', 'the commit message'])\n```\n\nTrying to execute any API with a program not configured on the scope results in a promise rejection due to denied access.\n"},"children":[{"id":414,"name":"Child","kind":128,"kindString":"Class","flags":{},"children":[{"id":415,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"shell.ts","line":183,"character":2}],"signatures":[{"id":416,"name":"new Child","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":417,"name":"pid","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":414,"name":"Child"}}]},{"id":418,"name":"pid","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The child process `pid`."},"sources":[{"fileName":"shell.ts","line":181,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":422,"name":"kill","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":218,"character":8}],"signatures":[{"id":423,"name":"kill","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Kills the child process.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":419,"name":"write","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":201,"character":8}],"signatures":[{"id":420,"name":"write","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Writes `data` to the `stdin`.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nconst command = new Command('node')\nconst child = await command.spawn()\nawait child.write('message')\nawait child.write([0, 1, 2, 3, 4, 5])\n```\n"}]},"parameters":[{"id":421,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The message to write, either a string or a byte array."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","qualifiedName":"Uint8Array","package":"typescript","name":"Uint8Array"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Constructors","kind":512,"children":[415]},{"title":"Properties","kind":1024,"children":[418]},{"title":"Methods","kind":2048,"children":[422,419]}],"sources":[{"fileName":"shell.ts","line":179,"character":6}]},{"id":383,"name":"Command","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"The entry point for spawning child processes.\nIt emits the `close` and `error` events.","tags":[{"tag":"example","text":"\n```typescript\nconst command = new Command('node')\ncommand.on('close', data => {\n console.log(`command finished with code ${data.code} and signal ${data.signal}`)\n})\ncommand.on('error', error => console.error(`command error: \"${error}\"`))\ncommand.stdout.on('data', line => console.log(`command stdout: \"${line}\"`))\ncommand.stderr.on('data', line => console.log(`command stderr: \"${line}\"`))\n\nconst child = await command.spawn()\nconsole.log('pid:', child.pid)\n```\n"}]},"children":[{"id":389,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"shell.ts","line":266,"character":2}],"signatures":[{"id":390,"name":"new Command","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates a new `Command` instance."},"parameters":[{"id":391,"name":"program","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The program name to execute.\nIt must be configured on `tauri.conf.json > tauri > allowlist > shell > scope`."},"type":{"type":"intrinsic","name":"string"}},{"id":392,"name":"args","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Program arguments."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"defaultValue":"[]"},{"id":393,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Spawn options.\n"},"type":{"type":"reference","id":463,"name":"SpawnOptions"}}],"type":{"type":"reference","id":383,"name":"Command"},"overwrites":{"type":"reference","id":426,"name":"EventEmitter.constructor"}}],"overwrites":{"type":"reference","id":425,"name":"EventEmitter.constructor"}},{"id":398,"name":"stderr","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"shortText":"Event emitter for the `stderr`. Emits the `data` event."},"sources":[{"fileName":"shell.ts","line":256,"character":11}],"type":{"type":"reference","id":424,"typeArguments":[{"type":"literal","value":"data"}],"name":"EventEmitter"},"defaultValue":"..."},{"id":397,"name":"stdout","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"shortText":"Event emitter for the `stdout`. Emits the `data` event."},"sources":[{"fileName":"shell.ts","line":254,"character":11}],"type":{"type":"reference","id":424,"typeArguments":[{"type":"literal","value":"data"}],"name":"EventEmitter"},"defaultValue":"..."},{"id":401,"name":"execute","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":343,"character":8}],"signatures":[{"id":402,"name":"execute","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Executes the command as a child process, waiting for it to finish and collecting all of its output.","returns":"A promise resolving to the child process output.\n","tags":[{"tag":"example","text":"\n```typescript\nconst output = await new Command('echo', 'message').execute()\nassert(output.code === 0)\nassert(output.signal === null)\nassert(output.stdout === 'message')\nassert(output.stderr === '')\n```\n"}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":458,"name":"ChildProcess"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":407,"name":"on","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":173,"character":2}],"signatures":[{"id":408,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an event from the child process.","returns":"The `this` instance for chained calls.\n"},"parameters":[{"id":409,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The event name."},"type":{"type":"union","types":[{"type":"literal","value":"close"},{"type":"literal","value":"error"}]}},{"id":410,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The event handler.\n"},"type":{"type":"reflection","declaration":{"id":411,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":412,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":413,"name":"arg","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":424,"typeArguments":[{"type":"union","types":[{"type":"literal","value":"close"},{"type":"literal","value":"error"}]}],"name":"EventEmitter"},"inheritedFrom":{"type":"reference","id":447,"name":"EventEmitter.on"}}],"inheritedFrom":{"type":"reference","id":446,"name":"EventEmitter.on"}},{"id":399,"name":"spawn","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":306,"character":8}],"signatures":[{"id":400,"name":"spawn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Executes the command as a child process, returning a handle to it.","returns":"A promise resolving to the child process handle.\n"},"type":{"type":"reference","typeArguments":[{"type":"reference","id":414,"name":"Child"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":384,"name":"sidecar","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"shell.ts","line":291,"character":9}],"signatures":[{"id":385,"name":"sidecar","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Creates a command to execute the given sidecar program.","returns":"\n","tags":[{"tag":"example","text":"\n```typescript\nconst command = Command.sidecar('my-sidecar')\nconst output = await command.execute()\n```\n"}]},"parameters":[{"id":386,"name":"program","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The program to execute.\nIt must be configured on `tauri.conf.json > tauri > allowlist > shell > scope`."},"type":{"type":"intrinsic","name":"string"}},{"id":387,"name":"args","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Program arguments."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"defaultValue":"[]"},{"id":388,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Spawn options."},"type":{"type":"reference","id":463,"name":"SpawnOptions"}}],"type":{"type":"reference","id":383,"name":"Command"}}]}],"groups":[{"title":"Constructors","kind":512,"children":[389]},{"title":"Properties","kind":1024,"children":[398,397]},{"title":"Methods","kind":2048,"children":[401,407,399,384]}],"sources":[{"fileName":"shell.ts","line":246,"character":6}],"extendedTypes":[{"type":"reference","id":424,"typeArguments":[{"type":"union","types":[{"type":"literal","value":"close"},{"type":"literal","value":"error"}]}],"name":"EventEmitter"}]},{"id":424,"name":"EventEmitter","kind":128,"kindString":"Class","flags":{},"children":[{"id":425,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"signatures":[{"id":426,"name":"new EventEmitter","kind":16384,"kindString":"Constructor signature","flags":{},"typeParameter":[{"id":427,"name":"E","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":424,"typeArguments":[{"type":"reference","id":427,"name":"E"}],"name":"EventEmitter"}}]},{"id":446,"name":"on","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":173,"character":2}],"signatures":[{"id":447,"name":"on","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an event from the child process.","returns":"The `this` instance for chained calls.\n"},"parameters":[{"id":448,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The event name."},"type":{"type":"reference","id":427,"name":"E"}},{"id":449,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The event handler.\n"},"type":{"type":"reflection","declaration":{"id":450,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":451,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":452,"name":"arg","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":424,"typeArguments":[{"type":"reference","id":427,"name":"E"}],"name":"EventEmitter"}}]}],"groups":[{"title":"Constructors","kind":512,"children":[425]},{"title":"Methods","kind":2048,"children":[446]}],"sources":[{"fileName":"shell.ts","line":136,"character":6}],"typeParameter":[{"id":453,"name":"E","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"extendedBy":[{"type":"reference","id":383,"name":"Command"}]},{"id":458,"name":"ChildProcess","kind":256,"kindString":"Interface","flags":{},"children":[{"id":459,"name":"code","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Exit code of the process. `null` if the process was terminated by a signal on Unix."},"sources":[{"fileName":"shell.ts","line":95,"character":2}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"number"}]}},{"id":460,"name":"signal","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"If the process was terminated by a signal, represents that signal."},"sources":[{"fileName":"shell.ts","line":97,"character":2}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"number"}]}},{"id":462,"name":"stderr","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The data that the process wrote to `stderr`."},"sources":[{"fileName":"shell.ts","line":101,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":461,"name":"stdout","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The data that the process wrote to `stdout`."},"sources":[{"fileName":"shell.ts","line":99,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[459,460,462,461]}],"sources":[{"fileName":"shell.ts","line":93,"character":10}]},{"id":463,"name":"SpawnOptions","kind":256,"kindString":"Interface","flags":{},"children":[{"id":464,"name":"cwd","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Current working directory."},"sources":[{"fileName":"shell.ts","line":83,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":465,"name":"env","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Environment variables. set to `null` to clear the process env."},"sources":[{"fileName":"shell.ts","line":85,"character":2}],"type":{"type":"reflection","declaration":{"id":466,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":{"id":467,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":468,"name":"name","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}}}}],"groups":[{"title":"Properties","kind":1024,"children":[464,465]}],"sources":[{"fileName":"shell.ts","line":81,"character":10}]},{"id":454,"name":"open","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"shell.ts","line":416,"character":15}],"signatures":[{"id":455,"name":"open","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Opens a path or URL with the system's default app,\nor the one specified with `openWith`.","text":"The `openWith` value must be one of `firefox`, `google chrome`, `chromium` `safari`,\n`open`, `start`, `xdg-open`, `gio`, `gnome-open`, `kde-open` or `wslview`.\n","returns":"\n","tags":[{"tag":"example","text":"\n```typescript\n// opens the given URL on the default browser:\nawait open('https://github.com/tauri-apps/tauri')\n// opens the given URL using `firefox`:\nawait open('https://github.com/tauri-apps/tauri', 'firefox')\n// opens a file using the default program:\nawait open('/path/to/file')\n```\n"}]},"parameters":[{"id":456,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The path or URL to open.\nThis value is matched against the string regex defined on `tauri.conf.json > tauri > allowlist > shell > open`,\nwhich defaults to `^https?://`."},"type":{"type":"intrinsic","name":"string"}},{"id":457,"name":"openWith","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The app to open the file or URL with.\nDefaults to the system default application for the specified path type."},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Classes","kind":128,"children":[414,383,424]},{"title":"Interfaces","kind":256,"children":[458,463]},{"title":"Functions","kind":64,"children":[454]}],"sources":[{"fileName":"shell.ts","line":78,"character":0}]},{"id":469,"name":"tauri","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Invoke your custom commands.","text":"This package is also accessible with `window.__TAURI__.tauri` when `tauri.conf.json > build > withGlobalTauri` is set to true."},"children":[{"id":470,"name":"InvokeArgs","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Command arguments."},"sources":[{"fileName":"tauri.ts","line":57,"character":10}],"indexSignature":{"id":471,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":472,"name":"key","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"unknown"}}},{"id":485,"name":"convertFileSrc","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"tauri.ts","line":116,"character":9}],"signatures":[{"id":486,"name":"convertFileSrc","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Convert a device file path to an URL that can be loaded by the webview.\nNote that `asset:` and `https://asset.localhost` must be allowed on the `csp` value configured on `tauri.conf.json > tauri > security`.\nExample CSP value: `\"csp\": \"default-src 'self'; img-src 'self' asset: https://asset.localhost\"` to use the asset protocol on image sources.","text":"Additionally, the `asset` must be allowlisted under `tauri.conf.json > tauri > allowlist > protocol`,\nand its access scope must be defined on the `assetScope` array on the same `protocol` object.\n","returns":"the URL that can be used as source on the webview.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appDir, join } from '@tauri-apps/api/path'\nimport { convertFileSrc } from '@tauri-apps/api/tauri'\nconst appDirPath = await appDir()\nconst filePath = await join(appDir, '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```\n"}]},"parameters":[{"id":487,"name":"filePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The file path."},"type":{"type":"intrinsic","name":"string"}},{"id":488,"name":"protocol","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The protocol to use. Defaults to `asset`. You only need to set this when using a custom protocol."},"type":{"type":"intrinsic","name":"string"},"defaultValue":"'asset'"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":480,"name":"invoke","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"tauri.ts","line":68,"character":15}],"signatures":[{"id":481,"name":"invoke","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a message to the backend.","returns":"A promise resolving or rejecting to the backend response.\n"},"typeParameter":[{"id":482,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":483,"name":"cmd","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The command name."},"type":{"type":"intrinsic","name":"string"}},{"id":484,"name":"args","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The optional arguments to pass to the command."},"type":{"type":"reference","id":470,"name":"InvokeArgs"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":482,"name":"T"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":473,"name":"transformCallback","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"tauri.ts","line":34,"character":9}],"signatures":[{"id":474,"name":"transformCallback","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Transforms a callback function to a string identifier that can be passed to the backend.\nThe backend uses the identifier to `eval()` the callback.","returns":"A unique identifier associated with the callback function.\n"},"parameters":[{"id":475,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":476,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":477,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":478,"name":"response","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":479,"name":"once","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"number"}}]}],"groups":[{"title":"Interfaces","kind":256,"children":[470]},{"title":"Functions","kind":64,"children":[485,480,473]}],"sources":[{"fileName":"tauri.ts","line":13,"character":0}]},{"id":489,"name":"updater","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Customize the auto updater flow.","text":"This package is also accessible with `window.__TAURI__.updater` when `tauri.conf.json > build > withGlobalTauri` is set to true."},"children":[{"id":494,"name":"UpdateManifest","kind":256,"kindString":"Interface","flags":{},"children":[{"id":497,"name":"body","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":24,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":496,"name":"date","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":23,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":495,"name":"version","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":22,"character":2}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","kind":1024,"children":[497,496,495]}],"sources":[{"fileName":"updater.ts","line":21,"character":10}]},{"id":498,"name":"UpdateResult","kind":256,"kindString":"Interface","flags":{},"children":[{"id":499,"name":"manifest","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"updater.ts","line":28,"character":2}],"type":{"type":"reference","id":494,"name":"UpdateManifest"}},{"id":500,"name":"shouldUpdate","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":29,"character":2}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","kind":1024,"children":[499,500]}],"sources":[{"fileName":"updater.ts","line":27,"character":10}]},{"id":491,"name":"UpdateStatusResult","kind":256,"kindString":"Interface","flags":{},"children":[{"id":492,"name":"error","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"updater.ts","line":17,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":493,"name":"status","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":18,"character":2}],"type":{"type":"reference","id":490,"name":"UpdateStatus"}}],"groups":[{"title":"Properties","kind":1024,"children":[492,493]}],"sources":[{"fileName":"updater.ts","line":16,"character":10}]},{"id":490,"name":"UpdateStatus","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"updater.ts","line":14,"character":5}],"type":{"type":"union","types":[{"type":"literal","value":"PENDING"},{"type":"literal","value":"ERROR"},{"type":"literal","value":"DONE"},{"type":"literal","value":"UPTODATE"}]}},{"id":503,"name":"checkUpdate","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"updater.ts","line":89,"character":15}],"signatures":[{"id":504,"name":"checkUpdate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Checks if an update is available.","returns":"Promise resolving to the update status.\n"},"type":{"type":"reference","typeArguments":[{"type":"reference","id":498,"name":"UpdateResult"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":501,"name":"installUpdate","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"updater.ts","line":37,"character":15}],"signatures":[{"id":502,"name":"installUpdate","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Install the update if there's one available.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Interfaces","kind":256,"children":[494,498,491]},{"title":"Type aliases","kind":4194304,"children":[490]},{"title":"Functions","kind":64,"children":[503,501]}],"sources":[{"fileName":"updater.ts","line":12,"character":0}]},{"id":505,"name":"window","kind":2,"kindString":"Module","flags":{},"comment":{"shortText":"Provides APIs to create windows, communicate with other windows and manipulate the current window.","text":"This package is also accessible with `window.__TAURI__.window` when `tauri.conf.json > build > withGlobalTauri` is set to true.\n\nThe APIs must be allowlisted on `tauri.conf.json`:\n```json\n{\n \"tauri\": {\n \"allowlist\": {\n \"window\": {\n \"all\": true, // enable all window APIs\n \"create\": true, // enable window creation\n \"center\": true,\n \"requestUserAttention\": true,\n \"setResizable\": true,\n \"setTitle\": true,\n \"maximize\": true,\n \"unmaximize\": true,\n \"minimize\": true,\n \"unminimize\": true,\n \"show\": true,\n \"hide\": true,\n \"close\": true,\n \"setDecorations\": true,\n \"setAlwaysOnTop\": true,\n \"setSize\": true,\n \"setMinSize\": true,\n \"setMaxSize\": true,\n \"setPosition\": true,\n \"setFullscreen\": true,\n \"setFocus\": true,\n \"setIcon\": true,\n \"setSkipTaskbar\": true,\n \"startDragging\": true,\n \"print\": true\n }\n }\n }\n}\n```\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security.\n\n# Window events\n\nEvents can be listened using `appWindow.listen`:\n```typescript\nimport { appWindow } from '@tauri-apps/api/window'\nappWindow.listen('tauri://move', ({ event, payload }) => {\n const { x, y } = payload // payload here is a `PhysicalPosition`\n})\n```\n\nWindow-specific events emitted by the backend:\n\n#### 'tauri://resize'\nEmitted when the size of the window has changed.\n*EventPayload*:\n```typescript\ntype ResizePayload = PhysicalSize\n```\n\n#### 'tauri://move'\nEmitted when the position of the window has changed.\n*EventPayload*:\n```typescript\ntype MovePayload = PhysicalPosition\n```\n\n#### 'tauri://close-requested'\nEmitted when the user requests the window to be closed.\nIf a listener is registered for this event, Tauri won't close the window so you must call `appWindow.close()` manually.\n\n#### 'tauri://focus'\nEmitted when the window gains focus.\n\n#### 'tauri://blur'\nEmitted when the window loses focus.\n\n#### 'tauri://scale-change'\nEmitted when the window's scale factor has changed.\nThe following user actions can cause DPI changes:\n- Changing the display's resolution.\n- Changing the display's scale factor (e.g. in Control Panel on Windows).\n- Moving the window to a display with a different scale factor.\n*Event payload*:\n```typescript\ninterface ScaleFactorChanged {\n scaleFactor: number\n size: PhysicalSize\n}\n```\n\n#### 'tauri://menu'\nEmitted when a menu item is clicked.\n*EventPayload*:\n```typescript\ntype MenuClicked = string\n```\n"},"children":[{"id":794,"name":"UserAttentionType","kind":8,"kindString":"Enumeration","flags":{},"comment":{"shortText":"Attention type to request on a window."},"children":[{"id":795,"name":"Critical","kind":16,"kindString":"Enumeration member","flags":{},"comment":{"shortText":"#### Platform-specific\n - **macOS:** Bounces the dock icon until the application is in focus.\n- **Windows:** Flashes both the window and the taskbar button until the application is in focus."},"sources":[{"fileName":"window.ts","line":204,"character":2}],"defaultValue":"1"},{"id":796,"name":"Informational","kind":16,"kindString":"Enumeration member","flags":{},"comment":{"shortText":"#### Platform-specific\n- **macOS:** Bounces the dock icon once.\n- **Windows:** Flashes the taskbar button until the application is in focus."},"sources":[{"fileName":"window.ts","line":210,"character":2}],"defaultValue":"2"}],"groups":[{"title":"Enumeration members","kind":16,"children":[795,796]}],"sources":[{"fileName":"window.ts","line":198,"character":5}]},{"id":775,"name":"LogicalPosition","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"A position represented in logical pixels."},"children":[{"id":776,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":159,"character":2}],"signatures":[{"id":777,"name":"new LogicalPosition","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":778,"name":"x","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":779,"name":"y","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":775,"name":"LogicalPosition"}}]},{"id":780,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":155,"character":2}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Logical'"},{"id":781,"name":"x","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":156,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":782,"name":"y","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":157,"character":2}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","kind":512,"children":[776]},{"title":"Properties","kind":1024,"children":[780,781,782]}],"sources":[{"fileName":"window.ts","line":154,"character":6}]},{"id":756,"name":"LogicalSize","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"A size represented in logical pixels."},"children":[{"id":757,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":130,"character":2}],"signatures":[{"id":758,"name":"new LogicalSize","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":759,"name":"width","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":760,"name":"height","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":756,"name":"LogicalSize"}}]},{"id":763,"name":"height","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":128,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":761,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":126,"character":2}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Logical'"},{"id":762,"name":"width","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":127,"character":2}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","kind":512,"children":[757]},{"title":"Properties","kind":1024,"children":[763,761,762]}],"sources":[{"fileName":"window.ts","line":125,"character":6}]},{"id":783,"name":"PhysicalPosition","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"A position represented in physical pixels."},"children":[{"id":784,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":171,"character":2}],"signatures":[{"id":785,"name":"new PhysicalPosition","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":786,"name":"x","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":787,"name":"y","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":783,"name":"PhysicalPosition"}}]},{"id":788,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":167,"character":2}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Physical'"},{"id":789,"name":"x","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":168,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":790,"name":"y","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":169,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":791,"name":"toLogical","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":177,"character":2}],"signatures":[{"id":792,"name":"toLogical","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Converts the physical position to a logical one."},"parameters":[{"id":793,"name":"scaleFactor","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":775,"name":"LogicalPosition"}}]}],"groups":[{"title":"Constructors","kind":512,"children":[784]},{"title":"Properties","kind":1024,"children":[788,789,790]},{"title":"Methods","kind":2048,"children":[791]}],"sources":[{"fileName":"window.ts","line":166,"character":6}]},{"id":764,"name":"PhysicalSize","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"A size represented in physical pixels."},"children":[{"id":765,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":142,"character":2}],"signatures":[{"id":766,"name":"new PhysicalSize","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":767,"name":"width","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":768,"name":"height","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":764,"name":"PhysicalSize"}}]},{"id":771,"name":"height","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":140,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":769,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":138,"character":2}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Physical'"},{"id":770,"name":"width","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":139,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":772,"name":"toLogical","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":148,"character":2}],"signatures":[{"id":773,"name":"toLogical","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Converts the physical size to a logical one."},"parameters":[{"id":774,"name":"scaleFactor","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":756,"name":"LogicalSize"}}]}],"groups":[{"title":"Constructors","kind":512,"children":[765]},{"title":"Properties","kind":1024,"children":[771,769,770]},{"title":"Methods","kind":2048,"children":[772]}],"sources":[{"fileName":"window.ts","line":137,"character":6}]},{"id":507,"name":"WebviewWindow","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"Create new webview windows and get a handle to existing ones.","text":"Windows are identified by a *label* a unique identifier that can be used to reference it later.\nIt may only contain alphanumeric characters `a-zA-Z` plus the following special characters `-`, `/`, `:` and `_`.\n","tags":[{"tag":"example","text":"\n```typescript\n// loading embedded asset:\nconst webview = new WebviewWindow('theUniqueLabel', {\n url: 'path/to/page.html'\n})\n// alternatively, load a remote URL:\nconst webview = new WebviewWindow('theUniqueLabel', {\n url: 'https://github.com/tauri-apps/tauri'\n})\n\nwebview.once('tauri://created', function () {\n // webview window successfully created\n})\nwebview.once('tauri://error', function (e) {\n // an error happened creating the webview window\n})\n\n// emit an event to the backend\nawait webview.emit(\"some event\", \"data\")\n// listen to an event from the backend\nconst unlisten = await webview.listen(\"event name\", e => {})\nunlisten()\n```\n"}]},"children":[{"id":511,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":1134,"character":2}],"signatures":[{"id":512,"name":"new WebviewWindow","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates a new WebviewWindow.\n* @param label The unique webview window label. Must be alphanumeric: `a-zA-Z-/:_`.","returns":"The WebviewWindow instance to communicate with the webview.\n"},"parameters":[{"id":513,"name":"label","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":514,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":808,"name":"WindowOptions"},"defaultValue":"{}"}],"type":{"type":"reference","id":507,"name":"WebviewWindow"},"overwrites":{"type":"reference","id":647,"name":"WindowManager.constructor"}}],"overwrites":{"type":"reference","id":646,"name":"WindowManager.constructor"}},{"id":593,"name":"label","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The window label. It is a unique identifier for the window, can be used to reference it later."},"sources":[{"fileName":"window.ts","line":250,"character":2}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":727,"name":"WindowManager.label"}},{"id":594,"name":"listeners","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Local event listeners."},"sources":[{"fileName":"window.ts","line":252,"character":2}],"type":{"type":"reflection","declaration":{"id":595,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":{"id":596,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":597,"name":"key","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"array","elementType":{"type":"reference","id":837,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"EventCallback"}}}}},"inheritedFrom":{"type":"reference","id":728,"name":"WindowManager.listeners"}},{"id":612,"name":"_handleTauriEvent","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":316,"character":2}],"signatures":[{"id":613,"name":"_handleTauriEvent","kind":4096,"kindString":"Call signature","flags":{},"typeParameter":[{"id":614,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":615,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":616,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":614,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":747,"name":"WindowManager._handleTauriEvent"}}],"inheritedFrom":{"type":"reference","id":746,"name":"WindowManager._handleTauriEvent"}},{"id":535,"name":"center","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":510,"character":8}],"signatures":[{"id":536,"name":"center","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Centers the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":670,"name":"WindowManager.center"}}],"inheritedFrom":{"type":"reference","id":669,"name":"WindowManager.center"}},{"id":560,"name":"close","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":756,"character":8}],"signatures":[{"id":561,"name":"close","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Closes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":695,"name":"WindowManager.close"}}],"inheritedFrom":{"type":"reference","id":694,"name":"WindowManager.close"}},{"id":608,"name":"emit","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":305,"character":8}],"signatures":[{"id":609,"name":"emit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Emits an event to the backend, tied to the webview window."},"parameters":[{"id":610,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"intrinsic","name":"string"}},{"id":611,"name":"payload","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Event payload.\n"},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":743,"name":"WindowManager.emit"}}],"inheritedFrom":{"type":"reference","id":742,"name":"WindowManager.emit"}},{"id":558,"name":"hide","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":736,"character":8}],"signatures":[{"id":559,"name":"hide","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window visibility to false.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":693,"name":"WindowManager.hide"}}],"inheritedFrom":{"type":"reference","id":692,"name":"WindowManager.hide"}},{"id":517,"name":"innerPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":353,"character":8}],"signatures":[{"id":518,"name":"innerPosition","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The position of the top-left hand corner of the window's client area relative to the top-left hand corner of the desktop."},"type":{"type":"reference","typeArguments":[{"type":"reference","id":783,"name":"PhysicalPosition"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":652,"name":"WindowManager.innerPosition"}}],"inheritedFrom":{"type":"reference","id":651,"name":"WindowManager.innerPosition"}},{"id":521,"name":"innerSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":388,"character":8}],"signatures":[{"id":522,"name":"innerSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The physical size of the window's client area.\nThe client area is the content of the window, excluding the title bar and borders."},"type":{"type":"reference","typeArguments":[{"type":"reference","id":764,"name":"PhysicalSize"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":656,"name":"WindowManager.innerSize"}}],"inheritedFrom":{"type":"reference","id":655,"name":"WindowManager.innerSize"}},{"id":529,"name":"isDecorated","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":455,"character":8}],"signatures":[{"id":530,"name":"isDecorated","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current decorated state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":664,"name":"WindowManager.isDecorated"}}],"inheritedFrom":{"type":"reference","id":663,"name":"WindowManager.isDecorated"}},{"id":525,"name":"isFullscreen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":423,"character":8}],"signatures":[{"id":526,"name":"isFullscreen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current fullscreen state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":660,"name":"WindowManager.isFullscreen"}}],"inheritedFrom":{"type":"reference","id":659,"name":"WindowManager.isFullscreen"}},{"id":527,"name":"isMaximized","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":439,"character":8}],"signatures":[{"id":528,"name":"isMaximized","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current maximized state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":662,"name":"WindowManager.isMaximized"}}],"inheritedFrom":{"type":"reference","id":661,"name":"WindowManager.isMaximized"}},{"id":531,"name":"isResizable","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":471,"character":8}],"signatures":[{"id":532,"name":"isResizable","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current resizable state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":666,"name":"WindowManager.isResizable"}}],"inheritedFrom":{"type":"reference","id":665,"name":"WindowManager.isResizable"}},{"id":533,"name":"isVisible","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":487,"character":8}],"signatures":[{"id":534,"name":"isVisible","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current visible state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":668,"name":"WindowManager.isVisible"}}],"inheritedFrom":{"type":"reference","id":667,"name":"WindowManager.isVisible"}},{"id":598,"name":"listen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":267,"character":8}],"signatures":[{"id":599,"name":"listen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an event emitted by the backend that is tied to the webview window.","returns":"A promise resolving to a function to unlisten to the event.\n"},"typeParameter":[{"id":600,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":601,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"reference","id":836,"name":"EventName"}},{"id":602,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event handler."},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":600,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":842,"name":"UnlistenFn"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":733,"name":"WindowManager.listen"}}],"inheritedFrom":{"type":"reference","id":732,"name":"WindowManager.listen"}},{"id":546,"name":"maximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":616,"character":8}],"signatures":[{"id":547,"name":"maximize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Maximizes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":681,"name":"WindowManager.maximize"}}],"inheritedFrom":{"type":"reference","id":680,"name":"WindowManager.maximize"}},{"id":552,"name":"minimize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":676,"character":8}],"signatures":[{"id":553,"name":"minimize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Minimizes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":687,"name":"WindowManager.minimize"}}],"inheritedFrom":{"type":"reference","id":686,"name":"WindowManager.minimize"}},{"id":603,"name":"once","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":288,"character":8}],"signatures":[{"id":604,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an one-off event emitted by the backend that is tied to the webview window.","returns":"A promise resolving to a function to unlisten to the event.\n"},"typeParameter":[{"id":605,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":606,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"intrinsic","name":"string"}},{"id":607,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event handler."},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":605,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":842,"name":"UnlistenFn"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":738,"name":"WindowManager.once"}}],"inheritedFrom":{"type":"reference","id":737,"name":"WindowManager.once"}},{"id":519,"name":"outerPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":369,"character":8}],"signatures":[{"id":520,"name":"outerPosition","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop."},"type":{"type":"reference","typeArguments":[{"type":"reference","id":783,"name":"PhysicalPosition"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":654,"name":"WindowManager.outerPosition"}}],"inheritedFrom":{"type":"reference","id":653,"name":"WindowManager.outerPosition"}},{"id":523,"name":"outerSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":407,"character":8}],"signatures":[{"id":524,"name":"outerSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The physical size of the entire window.\nThese dimensions include the title bar and borders. If you don't want that (and you usually don't), use inner_size instead."},"type":{"type":"reference","typeArguments":[{"type":"reference","id":764,"name":"PhysicalSize"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":658,"name":"WindowManager.outerSize"}}],"inheritedFrom":{"type":"reference","id":657,"name":"WindowManager.outerSize"}},{"id":537,"name":"requestUserAttention","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":541,"character":8}],"signatures":[{"id":538,"name":"requestUserAttention","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":" Requests user attention to the window, this has no effect if the application\nis already focused. How requesting for user attention manifests is platform dependent,\nsee `UserAttentionType` for details.","text":"Providing `null` will unset the request for user attention. Unsetting the request for\nuser attention might not be done automatically by the WM when the window receives input.\n\n#### Platform-specific\n\n- **macOS:** `null` has no effect.\n- **Linux:** Urgency levels have the same effect.\n","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":539,"name":"requestType","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":794,"name":"UserAttentionType"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":672,"name":"WindowManager.requestUserAttention"}}],"inheritedFrom":{"type":"reference","id":671,"name":"WindowManager.requestUserAttention"}},{"id":515,"name":"scaleFactor","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":337,"character":8}],"signatures":[{"id":516,"name":"scaleFactor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The scale factor that can be used to map physical pixels to logical pixels."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":650,"name":"WindowManager.scaleFactor"}}],"inheritedFrom":{"type":"reference","id":649,"name":"WindowManager.scaleFactor"}},{"id":565,"name":"setAlwaysOnTop","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":799,"character":8}],"signatures":[{"id":566,"name":"setAlwaysOnTop","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Whether the window should always be on top of other windows.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":567,"name":"alwaysOnTop","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Whether the window should always be on top of other windows or not."},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":700,"name":"WindowManager.setAlwaysOnTop"}}],"inheritedFrom":{"type":"reference","id":699,"name":"WindowManager.setAlwaysOnTop"}},{"id":562,"name":"setDecorations","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":777,"character":8}],"signatures":[{"id":563,"name":"setDecorations","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Whether the window should have borders and bars.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":564,"name":"decorations","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Whether the window should have borders and bars."},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":697,"name":"WindowManager.setDecorations"}}],"inheritedFrom":{"type":"reference","id":696,"name":"WindowManager.setDecorations"}},{"id":583,"name":"setFocus","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1007,"character":8}],"signatures":[{"id":584,"name":"setFocus","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Bring the window to front and focus.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":718,"name":"WindowManager.setFocus"}}],"inheritedFrom":{"type":"reference","id":717,"name":"WindowManager.setFocus"}},{"id":580,"name":"setFullscreen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":986,"character":8}],"signatures":[{"id":581,"name":"setFullscreen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window fullscreen state.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":582,"name":"fullscreen","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Whether the window should go to fullscreen or not."},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":715,"name":"WindowManager.setFullscreen"}}],"inheritedFrom":{"type":"reference","id":714,"name":"WindowManager.setFullscreen"}},{"id":585,"name":"setIcon","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1035,"character":8}],"signatures":[{"id":586,"name":"setIcon","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window icon.","text":"Note that you need the `icon-ico` or `icon-png` Cargo features to use this API.\nTo enable it, change your Cargo.toml file:\n```toml\n[dependencies]\ntauri = { version = \"...\", features = [\"...\", \"icon-png\"] }\n```\n","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":587,"name":"icon","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Icon bytes or path to the icon file."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","qualifiedName":"Uint8Array","package":"typescript","name":"Uint8Array"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":720,"name":"WindowManager.setIcon"}}],"inheritedFrom":{"type":"reference","id":719,"name":"WindowManager.setIcon"}},{"id":574,"name":"setMaxSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":906,"character":8}],"signatures":[{"id":575,"name":"setMaxSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window maximum inner size. If the `size` argument is undefined, the constraint is unset.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appWindow, LogicalSize } from '@tauri-apps/api/window'\nawait appWindow.setMaxSize(new LogicalSize(600, 500))\n```\n"}]},"parameters":[{"id":576,"name":"size","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The logical or physical inner size, or `null` to unset the constraint."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"literal","value":null},{"type":"reference","id":764,"name":"PhysicalSize"},{"type":"reference","id":756,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":709,"name":"WindowManager.setMaxSize"}}],"inheritedFrom":{"type":"reference","id":708,"name":"WindowManager.setMaxSize"}},{"id":571,"name":"setMinSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":864,"character":8}],"signatures":[{"id":572,"name":"setMinSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window minimum inner size. If the `size` argument is not provided, the constraint is unset.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appWindow, PhysicalSize } from '@tauri-apps/api/window'\nawait appWindow.setMinSize(new PhysicalSize(600, 500))\n```\n"}]},"parameters":[{"id":573,"name":"size","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The logical or physical inner size, or `null` to unset the constraint."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"literal","value":null},{"type":"reference","id":764,"name":"PhysicalSize"},{"type":"reference","id":756,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":706,"name":"WindowManager.setMinSize"}}],"inheritedFrom":{"type":"reference","id":705,"name":"WindowManager.setMinSize"}},{"id":577,"name":"setPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":948,"character":8}],"signatures":[{"id":578,"name":"setPosition","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window outer position.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appWindow, LogicalPosition } from '@tauri-apps/api/window'\nawait appWindow.setPosition(new LogicalPosition(600, 500))\n```\n"}]},"parameters":[{"id":579,"name":"position","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The new position, in logical or physical pixels."},"type":{"type":"union","types":[{"type":"reference","id":783,"name":"PhysicalPosition"},{"type":"reference","id":775,"name":"LogicalPosition"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":712,"name":"WindowManager.setPosition"}}],"inheritedFrom":{"type":"reference","id":711,"name":"WindowManager.setPosition"}},{"id":540,"name":"setResizable","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":573,"character":8}],"signatures":[{"id":541,"name":"setResizable","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the window resizable flag.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":542,"name":"resizable","kind":32768,"kindString":"Parameter","flags":{},"comment":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":675,"name":"WindowManager.setResizable"}}],"inheritedFrom":{"type":"reference","id":674,"name":"WindowManager.setResizable"}},{"id":568,"name":"setSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":826,"character":8}],"signatures":[{"id":569,"name":"setSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Resizes the window with a new inner size.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appWindow, LogicalSize } from '@tauri-apps/api/window'\nawait appWindow.setSize(new LogicalSize(600, 500))\n```\n"}]},"parameters":[{"id":570,"name":"size","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The logical or physical inner size."},"type":{"type":"union","types":[{"type":"reference","id":764,"name":"PhysicalSize"},{"type":"reference","id":756,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":703,"name":"WindowManager.setSize"}}],"inheritedFrom":{"type":"reference","id":702,"name":"WindowManager.setSize"}},{"id":588,"name":"setSkipTaskbar","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1060,"character":8}],"signatures":[{"id":589,"name":"setSkipTaskbar","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Whether to show the window icon in the task bar or not.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":590,"name":"skip","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"true to hide window icon, false to show it."},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":723,"name":"WindowManager.setSkipTaskbar"}}],"inheritedFrom":{"type":"reference","id":722,"name":"WindowManager.setSkipTaskbar"}},{"id":543,"name":"setTitle","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":595,"character":8}],"signatures":[{"id":544,"name":"setTitle","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window title.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":545,"name":"title","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The new title"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":678,"name":"WindowManager.setTitle"}}],"inheritedFrom":{"type":"reference","id":677,"name":"WindowManager.setTitle"}},{"id":556,"name":"show","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":716,"character":8}],"signatures":[{"id":557,"name":"show","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window visibility to true.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":691,"name":"WindowManager.show"}}],"inheritedFrom":{"type":"reference","id":690,"name":"WindowManager.show"}},{"id":591,"name":"startDragging","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1081,"character":8}],"signatures":[{"id":592,"name":"startDragging","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Starts dragging the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":726,"name":"WindowManager.startDragging"}}],"inheritedFrom":{"type":"reference","id":725,"name":"WindowManager.startDragging"}},{"id":550,"name":"toggleMaximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":656,"character":8}],"signatures":[{"id":551,"name":"toggleMaximize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Toggles the window maximized state.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":685,"name":"WindowManager.toggleMaximize"}}],"inheritedFrom":{"type":"reference","id":684,"name":"WindowManager.toggleMaximize"}},{"id":548,"name":"unmaximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":636,"character":8}],"signatures":[{"id":549,"name":"unmaximize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unmaximizes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":683,"name":"WindowManager.unmaximize"}}],"inheritedFrom":{"type":"reference","id":682,"name":"WindowManager.unmaximize"}},{"id":554,"name":"unminimize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":696,"character":8}],"signatures":[{"id":555,"name":"unminimize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unminimizes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":689,"name":"WindowManager.unminimize"}}],"inheritedFrom":{"type":"reference","id":688,"name":"WindowManager.unminimize"}},{"id":508,"name":"getByLabel","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"window.ts","line":1161,"character":9}],"signatures":[{"id":509,"name":"getByLabel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the WebviewWindow for the webview associated with the given label.","returns":"The WebviewWindow instance to communicate with the webview or null if the webview doesn't exist.\n"},"parameters":[{"id":510,"name":"label","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The webview window label."},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":507,"name":"WebviewWindow"}]}}]}],"groups":[{"title":"Constructors","kind":512,"children":[511]},{"title":"Properties","kind":1024,"children":[593,594]},{"title":"Methods","kind":2048,"children":[612,535,560,608,558,517,521,529,525,527,531,533,598,546,552,603,519,523,537,515,565,562,583,580,585,574,571,577,540,568,588,543,556,591,550,548,554,508]}],"sources":[{"fileName":"window.ts","line":1128,"character":6}],"extendedTypes":[{"type":"reference","id":645,"name":"WindowManager"}]},{"id":617,"name":"WebviewWindowHandle","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"A webview window handle allows emitting and listening to events from the backend that are tied to the window."},"children":[{"id":618,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":254,"character":2}],"signatures":[{"id":619,"name":"new WebviewWindowHandle","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":620,"name":"label","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":617,"name":"WebviewWindowHandle"}}]},{"id":621,"name":"label","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The window label. It is a unique identifier for the window, can be used to reference it later."},"sources":[{"fileName":"window.ts","line":250,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":622,"name":"listeners","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Local event listeners."},"sources":[{"fileName":"window.ts","line":252,"character":2}],"type":{"type":"reflection","declaration":{"id":623,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":{"id":624,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":625,"name":"key","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"array","elementType":{"type":"reference","id":837,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"EventCallback"}}}}}},{"id":640,"name":"_handleTauriEvent","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":316,"character":2}],"signatures":[{"id":641,"name":"_handleTauriEvent","kind":4096,"kindString":"Call signature","flags":{},"typeParameter":[{"id":642,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":643,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":644,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":614,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":636,"name":"emit","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":305,"character":8}],"signatures":[{"id":637,"name":"emit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Emits an event to the backend, tied to the webview window."},"parameters":[{"id":638,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"intrinsic","name":"string"}},{"id":639,"name":"payload","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Event payload.\n"},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":626,"name":"listen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":267,"character":8}],"signatures":[{"id":627,"name":"listen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an event emitted by the backend that is tied to the webview window.","returns":"A promise resolving to a function to unlisten to the event.\n"},"typeParameter":[{"id":628,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":629,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"reference","id":836,"name":"EventName"}},{"id":630,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event handler."},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":600,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":842,"name":"UnlistenFn"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":631,"name":"once","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":288,"character":8}],"signatures":[{"id":632,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an one-off event emitted by the backend that is tied to the webview window.","returns":"A promise resolving to a function to unlisten to the event.\n"},"typeParameter":[{"id":633,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":634,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"intrinsic","name":"string"}},{"id":635,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event handler."},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":605,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":842,"name":"UnlistenFn"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Constructors","kind":512,"children":[618]},{"title":"Properties","kind":1024,"children":[621,622]},{"title":"Methods","kind":2048,"children":[640,636,626,631]}],"sources":[{"fileName":"window.ts","line":248,"character":6}],"extendedBy":[{"type":"reference","id":645,"name":"WindowManager"}]},{"id":645,"name":"WindowManager","kind":128,"kindString":"Class","flags":{},"comment":{"shortText":"Manage the current window object."},"children":[{"id":646,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"signatures":[{"id":647,"name":"new WindowManager","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":648,"name":"label","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":645,"name":"WindowManager"},"inheritedFrom":{"type":"reference","id":619,"name":"WebviewWindowHandle.constructor"}}],"inheritedFrom":{"type":"reference","id":618,"name":"WebviewWindowHandle.constructor"}},{"id":727,"name":"label","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The window label. It is a unique identifier for the window, can be used to reference it later."},"sources":[{"fileName":"window.ts","line":250,"character":2}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":621,"name":"WebviewWindowHandle.label"}},{"id":728,"name":"listeners","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Local event listeners."},"sources":[{"fileName":"window.ts","line":252,"character":2}],"type":{"type":"reflection","declaration":{"id":729,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"indexSignature":{"id":730,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"parameters":[{"id":731,"name":"key","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"array","elementType":{"type":"reference","id":837,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"EventCallback"}}}}},"inheritedFrom":{"type":"reference","id":622,"name":"WebviewWindowHandle.listeners"}},{"id":746,"name":"_handleTauriEvent","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":316,"character":2}],"signatures":[{"id":747,"name":"_handleTauriEvent","kind":4096,"kindString":"Call signature","flags":{},"typeParameter":[{"id":748,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":749,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":750,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":614,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":641,"name":"WebviewWindowHandle._handleTauriEvent"}}],"inheritedFrom":{"type":"reference","id":640,"name":"WebviewWindowHandle._handleTauriEvent"}},{"id":669,"name":"center","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":510,"character":8}],"signatures":[{"id":670,"name":"center","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Centers the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":694,"name":"close","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":756,"character":8}],"signatures":[{"id":695,"name":"close","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Closes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":742,"name":"emit","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":305,"character":8}],"signatures":[{"id":743,"name":"emit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Emits an event to the backend, tied to the webview window."},"parameters":[{"id":744,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"intrinsic","name":"string"}},{"id":745,"name":"payload","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"Event payload.\n"},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":637,"name":"WebviewWindowHandle.emit"}}],"inheritedFrom":{"type":"reference","id":636,"name":"WebviewWindowHandle.emit"}},{"id":692,"name":"hide","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":736,"character":8}],"signatures":[{"id":693,"name":"hide","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window visibility to false.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":651,"name":"innerPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":353,"character":8}],"signatures":[{"id":652,"name":"innerPosition","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The position of the top-left hand corner of the window's client area relative to the top-left hand corner of the desktop."},"type":{"type":"reference","typeArguments":[{"type":"reference","id":783,"name":"PhysicalPosition"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":655,"name":"innerSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":388,"character":8}],"signatures":[{"id":656,"name":"innerSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The physical size of the window's client area.\nThe client area is the content of the window, excluding the title bar and borders."},"type":{"type":"reference","typeArguments":[{"type":"reference","id":764,"name":"PhysicalSize"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":663,"name":"isDecorated","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":455,"character":8}],"signatures":[{"id":664,"name":"isDecorated","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current decorated state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":659,"name":"isFullscreen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":423,"character":8}],"signatures":[{"id":660,"name":"isFullscreen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current fullscreen state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":661,"name":"isMaximized","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":439,"character":8}],"signatures":[{"id":662,"name":"isMaximized","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current maximized state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":665,"name":"isResizable","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":471,"character":8}],"signatures":[{"id":666,"name":"isResizable","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current resizable state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":667,"name":"isVisible","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":487,"character":8}],"signatures":[{"id":668,"name":"isVisible","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the window's current visible state."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":732,"name":"listen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":267,"character":8}],"signatures":[{"id":733,"name":"listen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an event emitted by the backend that is tied to the webview window.","returns":"A promise resolving to a function to unlisten to the event.\n"},"typeParameter":[{"id":734,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":735,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"reference","id":836,"name":"EventName"}},{"id":736,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event handler."},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":600,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":842,"name":"UnlistenFn"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":627,"name":"WebviewWindowHandle.listen"}}],"inheritedFrom":{"type":"reference","id":626,"name":"WebviewWindowHandle.listen"}},{"id":680,"name":"maximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":616,"character":8}],"signatures":[{"id":681,"name":"maximize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Maximizes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":686,"name":"minimize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":676,"character":8}],"signatures":[{"id":687,"name":"minimize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Minimizes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":737,"name":"once","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":288,"character":8}],"signatures":[{"id":738,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Listen to an one-off event emitted by the backend that is tied to the webview window.","returns":"A promise resolving to a function to unlisten to the event.\n"},"typeParameter":[{"id":739,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":740,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`."},"type":{"type":"intrinsic","name":"string"}},{"id":741,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Event handler."},"type":{"type":"reference","id":837,"typeArguments":[{"type":"reference","id":605,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":842,"name":"UnlistenFn"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"},"inheritedFrom":{"type":"reference","id":632,"name":"WebviewWindowHandle.once"}}],"inheritedFrom":{"type":"reference","id":631,"name":"WebviewWindowHandle.once"}},{"id":653,"name":"outerPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":369,"character":8}],"signatures":[{"id":654,"name":"outerPosition","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop."},"type":{"type":"reference","typeArguments":[{"type":"reference","id":783,"name":"PhysicalPosition"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":657,"name":"outerSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":407,"character":8}],"signatures":[{"id":658,"name":"outerSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The physical size of the entire window.\nThese dimensions include the title bar and borders. If you don't want that (and you usually don't), use inner_size instead."},"type":{"type":"reference","typeArguments":[{"type":"reference","id":764,"name":"PhysicalSize"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":671,"name":"requestUserAttention","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":541,"character":8}],"signatures":[{"id":672,"name":"requestUserAttention","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":" Requests user attention to the window, this has no effect if the application\nis already focused. How requesting for user attention manifests is platform dependent,\nsee `UserAttentionType` for details.","text":"Providing `null` will unset the request for user attention. Unsetting the request for\nuser attention might not be done automatically by the WM when the window receives input.\n\n#### Platform-specific\n\n- **macOS:** `null` has no effect.\n- **Linux:** Urgency levels have the same effect.\n","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":673,"name":"requestType","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":794,"name":"UserAttentionType"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":649,"name":"scaleFactor","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":337,"character":8}],"signatures":[{"id":650,"name":"scaleFactor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"The scale factor that can be used to map physical pixels to logical pixels."},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":699,"name":"setAlwaysOnTop","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":799,"character":8}],"signatures":[{"id":700,"name":"setAlwaysOnTop","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Whether the window should always be on top of other windows.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":701,"name":"alwaysOnTop","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Whether the window should always be on top of other windows or not."},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":696,"name":"setDecorations","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":777,"character":8}],"signatures":[{"id":697,"name":"setDecorations","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Whether the window should have borders and bars.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":698,"name":"decorations","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Whether the window should have borders and bars."},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":717,"name":"setFocus","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1007,"character":8}],"signatures":[{"id":718,"name":"setFocus","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Bring the window to front and focus.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":714,"name":"setFullscreen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":986,"character":8}],"signatures":[{"id":715,"name":"setFullscreen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window fullscreen state.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":716,"name":"fullscreen","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Whether the window should go to fullscreen or not."},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":719,"name":"setIcon","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1035,"character":8}],"signatures":[{"id":720,"name":"setIcon","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window icon.","text":"Note that you need the `icon-ico` or `icon-png` Cargo features to use this API.\nTo enable it, change your Cargo.toml file:\n```toml\n[dependencies]\ntauri = { version = \"...\", features = [\"...\", \"icon-png\"] }\n```\n","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":721,"name":"icon","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"Icon bytes or path to the icon file."},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","qualifiedName":"Uint8Array","package":"typescript","name":"Uint8Array"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":708,"name":"setMaxSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":906,"character":8}],"signatures":[{"id":709,"name":"setMaxSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window maximum inner size. If the `size` argument is undefined, the constraint is unset.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appWindow, LogicalSize } from '@tauri-apps/api/window'\nawait appWindow.setMaxSize(new LogicalSize(600, 500))\n```\n"}]},"parameters":[{"id":710,"name":"size","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The logical or physical inner size, or `null` to unset the constraint."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"literal","value":null},{"type":"reference","id":764,"name":"PhysicalSize"},{"type":"reference","id":756,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":705,"name":"setMinSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":864,"character":8}],"signatures":[{"id":706,"name":"setMinSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window minimum inner size. If the `size` argument is not provided, the constraint is unset.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appWindow, PhysicalSize } from '@tauri-apps/api/window'\nawait appWindow.setMinSize(new PhysicalSize(600, 500))\n```\n"}]},"parameters":[{"id":707,"name":"size","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The logical or physical inner size, or `null` to unset the constraint."},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"literal","value":null},{"type":"reference","id":764,"name":"PhysicalSize"},{"type":"reference","id":756,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":711,"name":"setPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":948,"character":8}],"signatures":[{"id":712,"name":"setPosition","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window outer position.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appWindow, LogicalPosition } from '@tauri-apps/api/window'\nawait appWindow.setPosition(new LogicalPosition(600, 500))\n```\n"}]},"parameters":[{"id":713,"name":"position","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The new position, in logical or physical pixels."},"type":{"type":"union","types":[{"type":"reference","id":783,"name":"PhysicalPosition"},{"type":"reference","id":775,"name":"LogicalPosition"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":674,"name":"setResizable","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":573,"character":8}],"signatures":[{"id":675,"name":"setResizable","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Updates the window resizable flag.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":676,"name":"resizable","kind":32768,"kindString":"Parameter","flags":{},"comment":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":702,"name":"setSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":826,"character":8}],"signatures":[{"id":703,"name":"setSize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Resizes the window with a new inner size.","returns":"A promise indicating the success or failure of the operation.\n","tags":[{"tag":"example","text":"\n```typescript\nimport { appWindow, LogicalSize } from '@tauri-apps/api/window'\nawait appWindow.setSize(new LogicalSize(600, 500))\n```\n"}]},"parameters":[{"id":704,"name":"size","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The logical or physical inner size."},"type":{"type":"union","types":[{"type":"reference","id":764,"name":"PhysicalSize"},{"type":"reference","id":756,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":722,"name":"setSkipTaskbar","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1060,"character":8}],"signatures":[{"id":723,"name":"setSkipTaskbar","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Whether to show the window icon in the task bar or not.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":724,"name":"skip","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"true to hide window icon, false to show it."},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":677,"name":"setTitle","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":595,"character":8}],"signatures":[{"id":678,"name":"setTitle","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window title.","returns":"A promise indicating the success or failure of the operation.\n"},"parameters":[{"id":679,"name":"title","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The new title"},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":690,"name":"show","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":716,"character":8}],"signatures":[{"id":691,"name":"show","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the window visibility to true.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":725,"name":"startDragging","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1081,"character":8}],"signatures":[{"id":726,"name":"startDragging","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Starts dragging the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":684,"name":"toggleMaximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":656,"character":8}],"signatures":[{"id":685,"name":"toggleMaximize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Toggles the window maximized state.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":682,"name":"unmaximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":636,"character":8}],"signatures":[{"id":683,"name":"unmaximize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unmaximizes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":688,"name":"unminimize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":696,"character":8}],"signatures":[{"id":689,"name":"unminimize","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Unminimizes the window.","returns":"A promise indicating the success or failure of the operation.\n"},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Constructors","kind":512,"children":[646]},{"title":"Properties","kind":1024,"children":[727,728]},{"title":"Methods","kind":2048,"children":[746,669,694,742,692,651,655,663,659,661,665,667,732,680,686,737,653,657,671,649,699,696,717,714,719,708,705,711,674,702,722,677,690,725,684,682,688]}],"sources":[{"fileName":"window.ts","line":334,"character":6}],"extendedTypes":[{"type":"reference","id":617,"name":"WebviewWindowHandle"}],"extendedBy":[{"type":"reference","id":507,"name":"WebviewWindow"}]},{"id":803,"name":"Monitor","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Allows you to retrieve information about a given monitor."},"children":[{"id":804,"name":"name","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"Human-readable name of the monitor"},"sources":[{"fileName":"window.ts","line":115,"character":2}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"}]}},{"id":806,"name":"position","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"the Top-left corner position of the monitor relative to the larger full screen area."},"sources":[{"fileName":"window.ts","line":119,"character":2}],"type":{"type":"reference","id":783,"name":"PhysicalPosition"}},{"id":807,"name":"scaleFactor","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The scale factor that can be used to map physical pixels to logical pixels."},"sources":[{"fileName":"window.ts","line":121,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":805,"name":"size","kind":1024,"kindString":"Property","flags":{},"comment":{"shortText":"The monitor's resolution."},"sources":[{"fileName":"window.ts","line":117,"character":2}],"type":{"type":"reference","id":764,"name":"PhysicalSize"}}],"groups":[{"title":"Properties","kind":1024,"children":[804,806,807,805]}],"sources":[{"fileName":"window.ts","line":113,"character":10}]},{"id":808,"name":"WindowOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"shortText":"Configuration for the window to create."},"children":[{"id":827,"name":"alwaysOnTop","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the window should always be on top of other windows or not."},"sources":[{"fileName":"window.ts","line":1239,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":810,"name":"center","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Show window in the center of the screen.."},"sources":[{"fileName":"window.ts","line":1201,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":826,"name":"decorations","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the window should have borders and bars or not."},"sources":[{"fileName":"window.ts","line":1237,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":829,"name":"fileDropEnabled","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the file drop is enabled or not on the webview. By default it is enabled.","text":"Disabling it is required to use drag and drop on the frontend on Windows.\n"},"sources":[{"fileName":"window.ts","line":1247,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":822,"name":"focus","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the window will be initially hidden or focused."},"sources":[{"fileName":"window.ts","line":1225,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":821,"name":"fullscreen","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the window is in fullscreen mode or not."},"sources":[{"fileName":"window.ts","line":1223,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":814,"name":"height","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The initial height."},"sources":[{"fileName":"window.ts","line":1209,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":818,"name":"maxHeight","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The maximum height. Only applies if `maxWidth` is also set."},"sources":[{"fileName":"window.ts","line":1217,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":817,"name":"maxWidth","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The maximum width. Only applies if `maxHeight` is also set."},"sources":[{"fileName":"window.ts","line":1215,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":824,"name":"maximized","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the window should be maximized upon creation or not."},"sources":[{"fileName":"window.ts","line":1233,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":816,"name":"minHeight","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The minimum height. Only applies if `minWidth` is also set."},"sources":[{"fileName":"window.ts","line":1213,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":815,"name":"minWidth","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The minimum width. Only applies if `minHeight` is also set."},"sources":[{"fileName":"window.ts","line":1211,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":819,"name":"resizable","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the window is resizable or not."},"sources":[{"fileName":"window.ts","line":1219,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":828,"name":"skipTaskbar","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether or not the window icon should be added to the taskbar."},"sources":[{"fileName":"window.ts","line":1241,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":820,"name":"title","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Window title."},"sources":[{"fileName":"window.ts","line":1221,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":823,"name":"transparent","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the window is transparent or not.\nNote that on `macOS` this requires the `macos-private-api` feature flag, enabled under `tauri.conf.json > tauri > macosPrivateApi`.\nWARNING: Using private APIs on `macOS` prevents your application from being accepted for the `App Store`."},"sources":[{"fileName":"window.ts","line":1231,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":809,"name":"url","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Remote URL or local file path to open.","text":"- URL such as `https://github.com/tauri-apps` is opened directly on a Tauri window.\n- data: URL such as `data:text/html,<html>...` is only supported with the `window-data-url` Cargo feature for the `tauri` dependency.\n- local file path or route such as `/path/to/page.html` or `/users` is appended to the application URL (the devServer URL on development, or `tauri://localhost/` and `https://tauri.localhost/` on production).\n"},"sources":[{"fileName":"window.ts","line":1199,"character":2}],"type":{"type":"intrinsic","name":"string"}},{"id":825,"name":"visible","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"Whether the window should be immediately visible upon creation or not."},"sources":[{"fileName":"window.ts","line":1235,"character":2}],"type":{"type":"intrinsic","name":"boolean"}},{"id":813,"name":"width","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The initial width."},"sources":[{"fileName":"window.ts","line":1207,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":811,"name":"x","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The initial vertical position. Only applies if `y` is also set."},"sources":[{"fileName":"window.ts","line":1203,"character":2}],"type":{"type":"intrinsic","name":"number"}},{"id":812,"name":"y","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"shortText":"The initial horizontal position. Only applies if `x` is also set."},"sources":[{"fileName":"window.ts","line":1205,"character":2}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[827,810,826,829,822,821,814,818,817,824,816,815,819,828,820,823,809,825,813,811,812]}],"sources":[{"fileName":"window.ts","line":1191,"character":10}]},{"id":755,"name":"appWindow","kind":32,"kindString":"Variable","flags":{},"comment":{"shortText":"The WebviewWindow for the current window."},"sources":[{"fileName":"window.ts","line":1171,"character":4}],"type":{"type":"reference","id":507,"name":"WebviewWindow"}},{"id":801,"name":"availableMonitors","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":1287,"character":15}],"signatures":[{"id":802,"name":"availableMonitors","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the list of all the monitors available on the system."},"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"reference","id":803,"name":"Monitor"}}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":797,"name":"currentMonitor","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":1254,"character":15}],"signatures":[{"id":798,"name":"currentMonitor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the monitor on which the window currently resides.\nReturns `null` if current monitor can't be detected."},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"reference","id":803,"name":"Monitor"},{"type":"literal","value":null}]}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]},{"id":753,"name":"getAll","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":230,"character":9}],"signatures":[{"id":754,"name":"getAll","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets an instance of `WebviewWindow` for all available webview windows.","returns":"The list of WebviewWindow.\n"},"type":{"type":"array","elementType":{"type":"reference","id":507,"name":"WebviewWindow"}}}]},{"id":751,"name":"getCurrent","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":218,"character":9}],"signatures":[{"id":752,"name":"getCurrent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Get an instance of `WebviewWindow` for the current webview window.","returns":"The current WebviewWindow.\n"},"type":{"type":"reference","id":507,"name":"WebviewWindow"}}]},{"id":799,"name":"primaryMonitor","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":1272,"character":15}],"signatures":[{"id":800,"name":"primaryMonitor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns the primary monitor of the system.\nReturns `null` if it can't identify any monitor as a primary one."},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"reference","id":803,"name":"Monitor"},{"type":"literal","value":null}]}],"qualifiedName":"Promise","package":"typescript","name":"Promise"}}]}],"groups":[{"title":"Enumerations","kind":8,"children":[794]},{"title":"Classes","kind":128,"children":[775,756,783,764,507,617,645]},{"title":"Interfaces","kind":256,"children":[803,808]},{"title":"Variables","kind":32,"children":[755]},{"title":"Functions","kind":64,"children":[801,797,753,751,799]}],"sources":[{"fileName":"window.ts","line":108,"character":0}]}],"groups":[{"title":"Modules","kind":2,"children":[1,8,23,29,61,76,156,177,274,288,301,313,376,382,469,489,505]}]} |