tauri/tooling/api/docs/js-api.json

{"id":0,"name":"@tauri-apps/api","variant":"project","kind":1,"flags":{},"children":[{"id":1,"name":"app","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Get application metadata.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.app`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.app`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.app) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"app\": {\n        \"all\": true, // enable all app APIs\n        \"show\": true,\n        \"hide\": true\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":2,"name":"getName","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"app.ts","line":60,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L60"}],"signatures":[{"id":3,"name":"getName","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the application name."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getName } from '@tauri-apps/api/app';\nconst appName = await getName();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"app.ts","line":60,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L60"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":6,"name":"getTauriVersion","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"app.ts","line":80,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L80"}],"signatures":[{"id":7,"name":"getTauriVersion","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the Tauri version."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getTauriVersion } from '@tauri-apps/api/app';\nconst tauriVersion = await getTauriVersion();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"app.ts","line":80,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L80"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":4,"name":"getVersion","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"app.ts","line":41,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L41"}],"signatures":[{"id":5,"name":"getVersion","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the application version."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getVersion } from '@tauri-apps/api/app';\nconst appVersion = await getVersion();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"app.ts","line":41,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":10,"name":"hide","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"app.ts","line":120,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L120"}],"signatures":[{"id":11,"name":"hide","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Hides the application on macOS."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { hide } from '@tauri-apps/api/app';\nawait hide();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"app.ts","line":120,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L120"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":8,"name":"show","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"app.ts","line":100,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L100"}],"signatures":[{"id":9,"name":"show","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shows the application on macOS. This function does not automatically focus any specific app window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { show } from '@tauri-apps/api/app';\nawait show();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"app.ts","line":100,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L100"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Functions","children":[2,6,4,10,8]}],"sources":[{"fileName":"app.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/app.ts#L1"}]},{"id":12,"name":"cli","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse arguments from your Command Line Interface.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.cli`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":13,"name":"ArgMatch","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":15,"name":"occurrences","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of occurrences"}]},"sources":[{"fileName":"cli.ts","line":27,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L27"}],"type":{"type":"intrinsic","name":"number"}},{"id":14,"name":"value","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"string if takes value\nboolean if flag\nstring[] or null if takes multiple values"}]},"sources":[{"fileName":"cli.ts","line":23,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L23"}],"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","children":[15,14]}],"sources":[{"fileName":"cli.ts","line":17,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L17"}]},{"id":19,"name":"CliMatches","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":20,"name":"args","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"cli.ts","line":42,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":13,"name":"ArgMatch","package":"@tauri-apps/api"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}},{"id":21,"name":"subcommand","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"cli.ts","line":43,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L43"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":16,"name":"SubcommandMatch","package":"@tauri-apps/api"}]}}],"groups":[{"title":"Properties","children":[20,21]}],"sources":[{"fileName":"cli.ts","line":41,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L41"}]},{"id":16,"name":"SubcommandMatch","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":18,"name":"matches","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"cli.ts","line":35,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L35"}],"type":{"type":"reference","target":19,"name":"CliMatches","package":"@tauri-apps/api"}},{"id":17,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"cli.ts","line":34,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L34"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[18,17]}],"sources":[{"fileName":"cli.ts","line":33,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L33"}]},{"id":22,"name":"getMatches","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"cli.ts","line":66,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L66"}],"signatures":[{"id":23,"name":"getMatches","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse the arguments provided to the current process and get the matches using the configuration defined ["},{"kind":"code","text":"`tauri.cli`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#tauriconfig.cli) in "},{"kind":"code","text":"`tauri.conf.json`"}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getMatches } from '@tauri-apps/api/cli';\nconst matches = await getMatches();\nif (matches.subcommand?.name === 'run') {\n  // `./your-app run $ARGS` was executed\n  const args = matches.subcommand?.matches.args\n  if ('debug' in args) {\n    // `./your-app run --debug` was executed\n  }\n} else {\n  const args = matches.args\n  // `./your-app $ARGS` was executed\n}\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"cli.ts","line":66,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L66"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":19,"name":"CliMatches","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Interfaces","children":[13,19,16]},{"title":"Functions","children":[22]}],"sources":[{"fileName":"cli.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/cli.ts#L1"}]},{"id":24,"name":"clipboard","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Read and write to the system clipboard.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.clipboard`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.clipboard`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.clipboard) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"clipboard\": {\n        \"all\": true, // enable all Clipboard APIs\n        \"writeText\": true,\n        \"readText\": true\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":28,"name":"readText","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"clipboard.ts","line":63,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/clipboard.ts#L63"}],"signatures":[{"id":29,"name":"readText","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the clipboard content as plain text."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { readText } from '@tauri-apps/api/clipboard';\nconst clipboardText = await readText();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0."}]}]},"sources":[{"fileName":"clipboard.ts","line":63,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/clipboard.ts#L63"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":25,"name":"writeText","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"clipboard.ts","line":44,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/clipboard.ts#L44"}],"signatures":[{"id":26,"name":"writeText","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Writes plain text to the clipboard."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { writeText, readText } from '@tauri-apps/api/clipboard';\nawait writeText('Tauri is awesome!');\nassert(await readText(), 'Tauri is awesome!');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0."}]}]},"sources":[{"fileName":"clipboard.ts","line":44,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/clipboard.ts#L44"}],"parameters":[{"id":27,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Functions","children":[28,25]}],"sources":[{"fileName":"clipboard.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/clipboard.ts#L1"}]},{"id":30,"name":"dialog","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Native system dialogs for opening and saving files.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.dialog`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.dialog`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.dialog) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"dialog\": {\n        \"all\": true, // enable all dialog APIs\n        \"ask\": true, // enable dialog ask API\n        \"confirm\": true, // enable dialog confirm API\n        \"message\": true, // enable dialog message API\n        \"open\": true, // enable file open API\n        \"save\": true // enable file save API\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":49,"name":"ConfirmDialogOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":53,"name":"cancelLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The label of the cancel button."}]},"sources":[{"fileName":"dialog.ts","line":112,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L112"}],"type":{"type":"intrinsic","name":"string"}},{"id":52,"name":"okLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The label of the confirm button."}]},"sources":[{"fileName":"dialog.ts","line":110,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L110"}],"type":{"type":"intrinsic","name":"string"}},{"id":50,"name":"title","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The title of the dialog. Defaults to the app name."}]},"sources":[{"fileName":"dialog.ts","line":106,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L106"}],"type":{"type":"intrinsic","name":"string"}},{"id":51,"name":"type","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The type of the dialog. Defaults to "},{"kind":"code","text":"`info`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"dialog.ts","line":108,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L108"}],"type":{"type":"union","types":[{"type":"literal","value":"info"},{"type":"literal","value":"warning"},{"type":"literal","value":"error"}]}}],"groups":[{"title":"Properties","children":[53,52,50,51]}],"sources":[{"fileName":"dialog.ts","line":104,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L104"}]},{"id":31,"name":"DialogFilter","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Extension filters for the file dialog."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":33,"name":"extensions","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Extensions to filter, without a "},{"kind":"code","text":"`.`"},{"kind":"text","text":" prefix."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nextensions: ['svg', 'png']\n```"}]}]},"sources":[{"fileName":"dialog.ts","line":48,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L48"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":32,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Filter name."}]},"sources":[{"fileName":"dialog.ts","line":40,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L40"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[33,32]}],"sources":[{"fileName":"dialog.ts","line":38,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L38"}]},{"id":45,"name":"MessageDialogOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":48,"name":"okLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The label of the confirm button."}]},"sources":[{"fileName":"dialog.ts","line":101,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L101"}],"type":{"type":"intrinsic","name":"string"}},{"id":46,"name":"title","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The title of the dialog. Defaults to the app name."}]},"sources":[{"fileName":"dialog.ts","line":97,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L97"}],"type":{"type":"intrinsic","name":"string"}},{"id":47,"name":"type","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The type of the dialog. Defaults to "},{"kind":"code","text":"`info`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"dialog.ts","line":99,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L99"}],"type":{"type":"union","types":[{"type":"literal","value":"info"},{"type":"literal","value":"warning"},{"type":"literal","value":"error"}]}}],"groups":[{"title":"Properties","children":[48,46,47]}],"sources":[{"fileName":"dialog.ts","line":95,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L95"}]},{"id":34,"name":"OpenDialogOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Options for the open dialog."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":37,"name":"defaultPath","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Initial directory or file path."}]},"sources":[{"fileName":"dialog.ts","line":62,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L62"}],"type":{"type":"intrinsic","name":"string"}},{"id":39,"name":"directory","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the dialog is a directory selection or not."}]},"sources":[{"fileName":"dialog.ts","line":66,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L66"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":36,"name":"filters","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The filters of the dialog."}]},"sources":[{"fileName":"dialog.ts","line":60,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L60"}],"type":{"type":"array","elementType":{"type":"reference","target":31,"name":"DialogFilter","package":"@tauri-apps/api"}}},{"id":38,"name":"multiple","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the dialog allows multiple selection or not."}]},"sources":[{"fileName":"dialog.ts","line":64,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L64"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":40,"name":"recursive","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"If "},{"kind":"code","text":"`directory`"},{"kind":"text","text":" 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":71,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L71"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":35,"name":"title","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The title of the dialog window."}]},"sources":[{"fileName":"dialog.ts","line":58,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L58"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[37,39,36,38,40,35]}],"sources":[{"fileName":"dialog.ts","line":56,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L56"}]},{"id":41,"name":"SaveDialogOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Options for the save dialog."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":44,"name":"defaultPath","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"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":89,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L89"}],"type":{"type":"intrinsic","name":"string"}},{"id":43,"name":"filters","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The filters of the dialog."}]},"sources":[{"fileName":"dialog.ts","line":83,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L83"}],"type":{"type":"array","elementType":{"type":"reference","target":31,"name":"DialogFilter","package":"@tauri-apps/api"}}},{"id":42,"name":"title","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The title of the dialog window."}]},"sources":[{"fileName":"dialog.ts","line":81,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L81"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[44,43,42]}],"sources":[{"fileName":"dialog.ts","line":79,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L79"}]},{"id":64,"name":"ask","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"dialog.ts","line":271,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L271"}],"signatures":[{"id":65,"name":"ask","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shows a question dialog with "},{"kind":"code","text":"`Yes`"},{"kind":"text","text":" and "},{"kind":"code","text":"`No`"},{"kind":"text","text":" buttons."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { ask } from '@tauri-apps/api/dialog';\nconst yes = await ask('Are you sure?', 'Tauri');\nconst yes2 = await ask('This action cannot be reverted. Are you sure?', { title: 'Tauri', type: 'warning' });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a boolean indicating whether "},{"kind":"code","text":"`Yes`"},{"kind":"text","text":" was clicked or not."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"dialog.ts","line":271,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L271"}],"parameters":[{"id":66,"name":"message","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The message to show."}]},"type":{"type":"intrinsic","name":"string"}},{"id":67,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The dialog's options. If a string, it represents the dialog title."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":49,"name":"ConfirmDialogOptions","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":68,"name":"confirm","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"dialog.ts","line":307,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L307"}],"signatures":[{"id":69,"name":"confirm","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shows a question dialog with "},{"kind":"code","text":"`Ok`"},{"kind":"text","text":" and "},{"kind":"code","text":"`Cancel`"},{"kind":"text","text":" buttons."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { confirm } from '@tauri-apps/api/dialog';\nconst confirmed = await confirm('Are you sure?', 'Tauri');\nconst confirmed2 = await confirm('This action cannot be reverted. Are you sure?', { title: 'Tauri', type: 'warning' });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a boolean indicating whether "},{"kind":"code","text":"`Ok`"},{"kind":"text","text":" was clicked or not."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"dialog.ts","line":307,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L307"}],"parameters":[{"id":70,"name":"message","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The message to show."}]},"type":{"type":"intrinsic","name":"string"}},{"id":71,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The dialog's options. If a string, it represents the dialog title."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":49,"name":"ConfirmDialogOptions","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":60,"name":"message","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"dialog.ts","line":238,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L238"}],"signatures":[{"id":61,"name":"message","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shows a message dialog with an "},{"kind":"code","text":"`Ok`"},{"kind":"text","text":" button."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { message } from '@tauri-apps/api/dialog';\nawait message('Tauri is awesome', 'Tauri');\nawait message('File not found', { title: 'Tauri', type: 'error' });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"dialog.ts","line":238,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L238"}],"parameters":[{"id":62,"name":"message","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The message to show."}]},"type":{"type":"intrinsic","name":"string"}},{"id":63,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The dialog's options. If a string, it represents the dialog title."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":45,"name":"MessageDialogOptions","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":54,"name":"open","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"dialog.ts","line":167,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L167"}],"signatures":[{"id":55,"name":"open","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Open a file/directory selection dialog.\n\nThe 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)."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { open } from '@tauri-apps/api/dialog';\n// Open a selection dialog for image files\nconst selected = await open({\n  multiple: true,\n  filters: [{\n    name: 'Image',\n    extensions: ['png', 'jpeg']\n  }]\n});\nif (Array.isArray(selected)) {\n  // user selected multiple files\n} else if (selected === null) {\n  // user cancelled the selection\n} else {\n  // user selected a single file\n}\n```"}]},{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { open } from '@tauri-apps/api/dialog';\nimport { appDir } from '@tauri-apps/api/path';\n// Open a selection dialog for directories\nconst selected = await open({\n  directory: true,\n  multiple: true,\n  defaultPath: await appDir(),\n});\nif (Array.isArray(selected)) {\n  // user selected multiple directories\n} else if (selected === null) {\n  // user cancelled the selection\n} else {\n  // user selected a single directory\n}\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to the selected path(s)"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"dialog.ts","line":167,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L167"}],"parameters":[{"id":56,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":34,"name":"OpenDialogOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":57,"name":"save","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"dialog.ts","line":207,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L207"}],"signatures":[{"id":58,"name":"save","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Open a file/directory save dialog.\n\nThe 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)."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { save } from '@tauri-apps/api/dialog';\nconst filePath = await save({\n  filters: [{\n    name: 'Image',\n    extensions: ['png', 'jpeg']\n  }]\n});\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to the selected path."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"dialog.ts","line":207,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L207"}],"parameters":[{"id":59,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":41,"name":"SaveDialogOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Interfaces","children":[49,31,45,34,41]},{"title":"Functions","children":[64,68,60,54,57]}],"sources":[{"fileName":"dialog.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/dialog.ts#L1"}]},{"id":72,"name":"event","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"The event system allows you to emit events to the backend and listen to events from it.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.event`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":74,"name":"TauriEvent","variant":"declaration","kind":8,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"children":[{"id":88,"name":"CHECK_UPDATE","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":34,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L34"}],"type":{"type":"literal","value":"tauri://update"}},{"id":92,"name":"DOWNLOAD_PROGRESS","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":38,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L38"}],"type":{"type":"literal","value":"tauri://update-download-progress"}},{"id":90,"name":"INSTALL_UPDATE","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":36,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L36"}],"type":{"type":"literal","value":"tauri://update-install"}},{"id":87,"name":"MENU","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":33,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L33"}],"type":{"type":"literal","value":"tauri://menu"}},{"id":91,"name":"STATUS_UPDATE","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":37,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L37"}],"type":{"type":"literal","value":"tauri://update-status"}},{"id":89,"name":"UPDATE_AVAILABLE","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":35,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L35"}],"type":{"type":"literal","value":"tauri://update-available"}},{"id":81,"name":"WINDOW_BLUR","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":27,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L27"}],"type":{"type":"literal","value":"tauri://blur"}},{"id":77,"name":"WINDOW_CLOSE_REQUESTED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":23,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L23"}],"type":{"type":"literal","value":"tauri://close-requested"}},{"id":78,"name":"WINDOW_CREATED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":24,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L24"}],"type":{"type":"literal","value":"tauri://window-created"}},{"id":79,"name":"WINDOW_DESTROYED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":25,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L25"}],"type":{"type":"literal","value":"tauri://destroyed"}},{"id":84,"name":"WINDOW_FILE_DROP","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":30,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L30"}],"type":{"type":"literal","value":"tauri://file-drop"}},{"id":86,"name":"WINDOW_FILE_DROP_CANCELLED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":32,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L32"}],"type":{"type":"literal","value":"tauri://file-drop-cancelled"}},{"id":85,"name":"WINDOW_FILE_DROP_HOVER","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":31,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L31"}],"type":{"type":"literal","value":"tauri://file-drop-hover"}},{"id":80,"name":"WINDOW_FOCUS","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":26,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L26"}],"type":{"type":"literal","value":"tauri://focus"}},{"id":76,"name":"WINDOW_MOVED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":22,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L22"}],"type":{"type":"literal","value":"tauri://move"}},{"id":75,"name":"WINDOW_RESIZED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":21,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L21"}],"type":{"type":"literal","value":"tauri://resize"}},{"id":82,"name":"WINDOW_SCALE_FACTOR_CHANGED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":28,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L28"}],"type":{"type":"literal","value":"tauri://scale-change"}},{"id":83,"name":"WINDOW_THEME_CHANGED","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"event.ts","line":29,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L29"}],"type":{"type":"literal","value":"tauri://theme-changed"}}],"groups":[{"title":"Enumeration Members","children":[88,92,90,87,91,89,81,77,78,79,84,86,85,80,76,75,82,83]}],"sources":[{"fileName":"event.ts","line":20,"character":12,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L20"}]},{"id":1160,"name":"Event","variant":"declaration","kind":256,"flags":{},"children":[{"id":1161,"name":"event","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name"}]},"sources":[{"fileName":"helpers/event.ts","line":12,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L12"}],"type":{"type":"reference","target":73,"name":"EventName","package":"@tauri-apps/api"}},{"id":1163,"name":"id","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event identifier used to unlisten"}]},"sources":[{"fileName":"helpers/event.ts","line":16,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L16"}],"type":{"type":"intrinsic","name":"number"}},{"id":1164,"name":"payload","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event payload"}]},"sources":[{"fileName":"helpers/event.ts","line":18,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L18"}],"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}},{"id":1162,"name":"windowLabel","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The label of the window that emitted this event."}]},"sources":[{"fileName":"helpers/event.ts","line":14,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L14"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[1161,1163,1164,1162]}],"sources":[{"fileName":"helpers/event.ts","line":10,"character":17,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L10"}],"typeParameters":[{"id":1165,"name":"T","variant":"typeParam","kind":131072,"flags":{}}]},{"id":1166,"name":"EventCallback","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"helpers/event.ts","line":21,"character":12,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L21"}],"typeParameters":[{"id":1170,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":1167,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"helpers/event.ts","line":21,"character":31,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L21"}],"signatures":[{"id":1168,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":1169,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1160,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Event","package":"@tauri-apps/api"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":73,"name":"EventName","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"event.ts","line":15,"character":12,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L15"}],"type":{"type":"union","types":[{"type":"templateLiteral","head":"","tail":[[{"type":"reference","target":74,"name":"TauriEvent","package":"@tauri-apps/api"},""]]},{"type":"intersection","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"never"},{"type":"intrinsic","name":"never"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}]}]}},{"id":1171,"name":"UnlistenFn","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"helpers/event.ts","line":23,"character":12,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L23"}],"type":{"type":"reflection","declaration":{"id":1172,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"helpers/event.ts","line":23,"character":25,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/helpers/event.ts#L23"}],"signatures":[{"id":1173,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":103,"name":"emit","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":113,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L113"}],"signatures":[{"id":104,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Emits an event to the backend and all Tauri windows."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { emit } from '@tauri-apps/api/event';\nawait emit('frontend-loaded', { loggedIn: true, token: 'authToken' });\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":113,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L113"}],"parameters":[{"id":105,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":106,"name":"payload","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":93,"name":"listen","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":63,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L63"}],"signatures":[{"id":94,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an event. The event can be either global or window-specific.\nSee "},{"kind":"inline-tag","tag":"@link","text":"windowLabel","target":1162,"tsLinkText":""},{"kind":"text","text":" to check the event source."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { listen } from '@tauri-apps/api/event';\nconst unlisten = await listen<string>('error', (event) => {\n  console.log(`Got error in window ${event.windowLabel}, payload: ${event.payload}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":63,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L63"}],"typeParameter":[{"id":95,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":96,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"reference","target":73,"name":"EventName","package":"@tauri-apps/api"}},{"id":97,"name":"handler","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler callback."}]},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":98,"name":"once","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"event.ts","line":94,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L94"}],"signatures":[{"id":99,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an one-off event. See "},{"kind":"inline-tag","tag":"@link","text":"listen","target":93,"tsLinkText":""},{"kind":"text","text":" for more information."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { once } from '@tauri-apps/api/event';\ninterface LoadedPayload {\n  loggedIn: boolean,\n  token: string\n}\nconst unlisten = await once<LoadedPayload>('loaded', (event) => {\n  console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"event.ts","line":94,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L94"}],"typeParameter":[{"id":100,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":101,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"reference","target":73,"name":"EventName","package":"@tauri-apps/api"}},{"id":102,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Enumerations","children":[74]},{"title":"Interfaces","children":[1160]},{"title":"Type Aliases","children":[1166,73,1171]},{"title":"Functions","children":[103,93,98]}],"sources":[{"fileName":"event.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/event.ts#L1"}]},{"id":107,"name":"fs","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Access the file system.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.fs`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.fs`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.fs) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```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        \"exists\": true\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\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 "},{"kind":"inline-tag","tag":"@link","text":"base directories","target":108},{"kind":"text","text":"\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 "},{"kind":"inline-tag","tag":"@link","text":"$APPDATA directory","target":381},{"kind":"text","text":":\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"fs\": {\n        \"scope\": [\"$APPDATA/databases/*\"]\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\n\nNotice the use of the "},{"kind":"code","text":"`$APPDATA`"},{"kind":"text","text":" variable. The value is injected at runtime, resolving to the "},{"kind":"inline-tag","tag":"@link","text":"app data directory","target":381},{"kind":"text","text":".\nThe available variables are:\n"},{"kind":"inline-tag","tag":"@link","text":"`$APPCONFIG`","target":379},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$APPDATA`","target":381},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$APPLOCALDATA`","target":383},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$APPCACHE`","target":385},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$APPLOG`","target":387},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$AUDIO`","target":389},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$CACHE`","target":391},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$CONFIG`","target":393},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$DATA`","target":395},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$LOCALDATA`","target":409},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$DESKTOP`","target":397},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$DOCUMENT`","target":399},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$DOWNLOAD`","target":401},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$EXE`","target":403},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$FONT`","target":405},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$HOME`","target":407},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$PICTURE`","target":411},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$PUBLIC`","target":413},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$RUNTIME`","target":420},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$TEMPLATE`","target":422},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$VIDEO`","target":424},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$RESOURCE`","target":415},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$APP`","target":377},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$LOG`","target":426},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$TEMP`","target":369},{"kind":"text","text":".\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."}]},"children":[{"id":150,"name":"Dir","variant":"reference","kind":8388608,"flags":{},"sources":[{"fileName":"fs.ts","line":593,"character":19,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L593"}],"target":108},{"id":167,"name":"writeFile","variant":"reference","kind":8388608,"flags":{},"sources":[{"fileName":"fs.ts","line":597,"character":19,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L597"}],"target":159},{"id":108,"name":"BaseDirectory","variant":"declaration","kind":8,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":126,"name":"App","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":98,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L98"}],"type":{"type":"literal","value":18}},{"id":132,"name":"AppCache","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":104,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L104"}],"type":{"type":"literal","value":24}},{"id":129,"name":"AppConfig","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":101,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L101"}],"type":{"type":"literal","value":21}},{"id":130,"name":"AppData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":102,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L102"}],"type":{"type":"literal","value":22}},{"id":131,"name":"AppLocalData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":103,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L103"}],"type":{"type":"literal","value":23}},{"id":133,"name":"AppLog","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":105,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L105"}],"type":{"type":"literal","value":25}},{"id":109,"name":"Audio","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":81,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L81"}],"type":{"type":"literal","value":1}},{"id":110,"name":"Cache","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":82,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L82"}],"type":{"type":"literal","value":2}},{"id":111,"name":"Config","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":83,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L83"}],"type":{"type":"literal","value":3}},{"id":112,"name":"Data","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":84,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L84"}],"type":{"type":"literal","value":4}},{"id":114,"name":"Desktop","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":86,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L86"}],"type":{"type":"literal","value":6}},{"id":115,"name":"Document","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":87,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L87"}],"type":{"type":"literal","value":7}},{"id":116,"name":"Download","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":88,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L88"}],"type":{"type":"literal","value":8}},{"id":117,"name":"Executable","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":89,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L89"}],"type":{"type":"literal","value":9}},{"id":118,"name":"Font","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":90,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L90"}],"type":{"type":"literal","value":10}},{"id":119,"name":"Home","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":91,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L91"}],"type":{"type":"literal","value":11}},{"id":113,"name":"LocalData","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":85,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L85"}],"type":{"type":"literal","value":5}},{"id":127,"name":"Log","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":99,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L99"}],"type":{"type":"literal","value":19}},{"id":120,"name":"Picture","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":92,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L92"}],"type":{"type":"literal","value":12}},{"id":121,"name":"Public","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":93,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L93"}],"type":{"type":"literal","value":13}},{"id":125,"name":"Resource","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":97,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L97"}],"type":{"type":"literal","value":17}},{"id":122,"name":"Runtime","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":94,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L94"}],"type":{"type":"literal","value":14}},{"id":128,"name":"Temp","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":100,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L100"}],"type":{"type":"literal","value":20}},{"id":123,"name":"Template","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":95,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L95"}],"type":{"type":"literal","value":15}},{"id":124,"name":"Video","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"fs.ts","line":96,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L96"}],"type":{"type":"literal","value":16}}],"groups":[{"title":"Enumeration Members","children":[126,132,129,130,131,133,109,110,111,112,114,115,116,117,118,119,113,127,120,121,125,122,128,123,124]}],"sources":[{"fileName":"fs.ts","line":80,"character":12,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L80"}]},{"id":146,"name":"FileEntry","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":149,"name":"children","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Children of this entry if it's a directory; null otherwise"}]},"sources":[{"fileName":"fs.ts","line":161,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L161"}],"type":{"type":"array","elementType":{"type":"reference","target":146,"name":"FileEntry","package":"@tauri-apps/api"}}},{"id":148,"name":"name","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Name of the directory/file\ncan be null if the path terminates with "},{"kind":"code","text":"`..`"}]},"sources":[{"fileName":"fs.ts","line":159,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L159"}],"type":{"type":"intrinsic","name":"string"}},{"id":147,"name":"path","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"fs.ts","line":154,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L154"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[149,148,147]}],"sources":[{"fileName":"fs.ts","line":153,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L153"}]},{"id":143,"name":"FsBinaryFileOption","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Options object used to write a binary data to a file."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":145,"name":"contents","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The byte array contents."}]},"sources":[{"fileName":"fs.ts","line":147,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L147"}],"type":{"type":"reference","target":142,"name":"BinaryFileContents","package":"@tauri-apps/api"}},{"id":144,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Path to the file to write."}]},"sources":[{"fileName":"fs.ts","line":145,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L145"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[145,144]}],"sources":[{"fileName":"fs.ts","line":143,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L143"}]},{"id":136,"name":"FsDirOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":137,"name":"dir","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":120,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L120"}],"type":{"type":"reference","target":108,"name":"BaseDirectory","package":"@tauri-apps/api"}},{"id":138,"name":"recursive","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":121,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L121"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[137,138]}],"sources":[{"fileName":"fs.ts","line":119,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L119"}]},{"id":134,"name":"FsOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":135,"name":"dir","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":112,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L112"}],"type":{"type":"reference","target":108,"name":"BaseDirectory","package":"@tauri-apps/api"}}],"groups":[{"title":"Properties","children":[135]}],"sources":[{"fileName":"fs.ts","line":111,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L111"}]},{"id":139,"name":"FsTextFileOption","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Options object used to write a UTF-8 string to a file."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":141,"name":"contents","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The UTF-8 string to write to the file."}]},"sources":[{"fileName":"fs.ts","line":133,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L133"}],"type":{"type":"intrinsic","name":"string"}},{"id":140,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Path to the file to write."}]},"sources":[{"fileName":"fs.ts","line":131,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L131"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[141,140]}],"sources":[{"fileName":"fs.ts","line":129,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L129"}]},{"id":142,"name":"BinaryFileContents","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"fs.ts","line":136,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L136"}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es2015.iterable.d.ts","qualifiedName":"Iterable"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Iterable","package":"typescript"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"ArrayLike"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"ArrayLike","package":"typescript"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"ArrayBuffer"},"name":"ArrayBuffer","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"}]}},{"id":188,"name":"copyFile","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":489,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L489"}],"signatures":[{"id":189,"name":"copyFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Copies a file to a destination."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { copyFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Copy the `$APPCONFIG/app.conf` file to `$APPCONFIG/app.conf.bk`\nawait copyFile('app.conf', 'app.conf.bk', { dir: BaseDirectory.AppConfig });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":489,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L489"}],"parameters":[{"id":190,"name":"source","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":191,"name":"destination","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":192,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":180,"name":"createDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":434,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L434"}],"signatures":[{"id":181,"name":"createDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a directory.\nIf one of the path's parent components doesn't exist\nand the "},{"kind":"code","text":"`recursive`"},{"kind":"text","text":" option isn't set to true, the promise will be rejected."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { createDir, BaseDirectory } from '@tauri-apps/api/fs';\n// Create the `$APPDATA/users` directory\nawait createDir('users', { dir: BaseDirectory.AppData, recursive: true });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":434,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L434"}],"parameters":[{"id":182,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":183,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":136,"name":"FsDirOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":202,"name":"exists","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":572,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L572"}],"signatures":[{"id":203,"name":"exists","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Check if a path exists."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { exists, BaseDirectory } from '@tauri-apps/api/fs';\n// Check if the `$APPDATA/avatar.png` file exists\nawait exists('avatar.png', { dir: BaseDirectory.AppData });\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"fs.ts","line":572,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L572"}],"parameters":[{"id":204,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":205,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":155,"name":"readBinaryFile","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":200,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L200"}],"signatures":[{"id":156,"name":"readBinaryFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Reads a file as byte array."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { readBinaryFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Read the image file in the `$RESOURCEDIR/avatar.png` path\nconst contents = await readBinaryFile('avatar.png', { dir: BaseDirectory.Resource });\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":200,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L200"}],"parameters":[{"id":157,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":158,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Uint8Array"},"name":"Uint8Array","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":176,"name":"readDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":405,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L405"}],"signatures":[{"id":177,"name":"readDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"List directory files."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { readDir, BaseDirectory } from '@tauri-apps/api/fs';\n// Reads the `$APPDATA/users` directory recursively\nconst entries = await readDir('users', { dir: BaseDirectory.AppData, recursive: true });\n\nfunction processEntries(entries) {\n  for (const entry of entries) {\n    console.log(`Entry: ${entry.path}`);\n    if (entry.children) {\n      processEntries(entry.children)\n    }\n  }\n}\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":405,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L405"}],"parameters":[{"id":178,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":179,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":136,"name":"FsDirOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":146,"name":"FileEntry","package":"@tauri-apps/api"}}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":151,"name":"readTextFile","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":175,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L175"}],"signatures":[{"id":152,"name":"readTextFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Reads a file as an UTF-8 encoded string."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { readTextFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Read the text file in the `$APPCONFIG/app.conf` path\nconst contents = await readTextFile('app.conf', { dir: BaseDirectory.AppConfig });\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":175,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L175"}],"parameters":[{"id":153,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":154,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":184,"name":"removeDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":462,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L462"}],"signatures":[{"id":185,"name":"removeDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Removes a directory.\nIf the directory is not empty and the "},{"kind":"code","text":"`recursive`"},{"kind":"text","text":" option isn't set to true, the promise will be rejected."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { removeDir, BaseDirectory } from '@tauri-apps/api/fs';\n// Remove the directory `$APPDATA/users`\nawait removeDir('users', { dir: BaseDirectory.AppData });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":462,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L462"}],"parameters":[{"id":186,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":187,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":136,"name":"FsDirOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":193,"name":"removeFile","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":518,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L518"}],"signatures":[{"id":194,"name":"removeFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Removes a file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { removeFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Remove the `$APPConfig/app.conf` file\nawait removeFile('app.conf', { dir: BaseDirectory.AppConfig });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":518,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L518"}],"parameters":[{"id":195,"name":"file","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":196,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":197,"name":"renameFile","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":545,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L545"}],"signatures":[{"id":198,"name":"renameFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Renames a file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { renameFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Rename the `$APPDATA/avatar.png` file\nawait renameFile('avatar.png', 'deleted.png', { dir: BaseDirectory.AppData });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":545,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L545"}],"parameters":[{"id":199,"name":"oldPath","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":200,"name":"newPath","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":201,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":168,"name":"writeBinaryFile","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":309,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L309"},{"fileName":"fs.ts","line":330,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L330"},{"fileName":"fs.ts","line":342,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L342"}],"signatures":[{"id":169,"name":"writeBinaryFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Writes a byte array content to a file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { writeBinaryFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Write a binary file to the `$APPDATA/avatar.png` path\nawait writeBinaryFile('avatar.png', new Uint8Array([]), { dir: BaseDirectory.AppData });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":309,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L309"}],"parameters":[{"id":170,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":171,"name":"contents","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":142,"name":"BinaryFileContents","package":"@tauri-apps/api"}},{"id":172,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Configuration object."}]},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}},{"id":173,"name":"writeBinaryFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Writes a byte array content to a file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { writeBinaryFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Write a binary file to the `$APPDATA/avatar.png` path\nawait writeBinaryFile({ path: 'avatar.png', contents: new Uint8Array([]) }, { dir: BaseDirectory.AppData });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":330,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L330"}],"parameters":[{"id":174,"name":"file","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The object containing the file path and contents."}]},"type":{"type":"reference","target":143,"name":"FsBinaryFileOption","package":"@tauri-apps/api"}},{"id":175,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Configuration object."}]},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":159,"name":"writeTextFile","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"fs.ts","line":227,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L227"},{"fileName":"fs.ts","line":245,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L245"},{"fileName":"fs.ts","line":257,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L257"}],"signatures":[{"id":160,"name":"writeTextFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Writes a UTF-8 text file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { writeTextFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Write a text file to the `$APPCONFIG/app.conf` path\nawait writeTextFile('app.conf', 'file contents', { dir: BaseDirectory.AppConfig });\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":227,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L227"}],"parameters":[{"id":161,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":162,"name":"contents","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":163,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}},{"id":164,"name":"writeTextFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Writes a UTF-8 text file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { writeTextFile, BaseDirectory } from '@tauri-apps/api/fs';\n// Write a text file to the `$APPCONFIG/app.conf` path\nawait writeTextFile({ path: 'app.conf', contents: 'file contents' }, { dir: BaseDirectory.AppConfig });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"fs.ts","line":245,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L245"}],"parameters":[{"id":165,"name":"file","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":139,"name":"FsTextFileOption","package":"@tauri-apps/api"}},{"id":166,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":134,"name":"FsOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"References","children":[150,167]},{"title":"Enumerations","children":[108]},{"title":"Interfaces","children":[146,143,136,134,139]},{"title":"Type Aliases","children":[142]},{"title":"Functions","children":[188,180,202,155,176,151,184,193,197,168,159]}],"sources":[{"fileName":"fs.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/fs.ts#L1"}]},{"id":206,"name":"globalShortcut","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register global shortcuts.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.globalShortcut`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.globalShortcut`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.globalshortcut) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"globalShortcut\": {\n        \"all\": true // enable all global shortcut APIs\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":207,"name":"ShortcutHandler","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"globalShortcut.ts","line":29,"character":12,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L29"}],"type":{"type":"reflection","declaration":{"id":208,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"globalShortcut.ts","line":29,"character":30,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L29"}],"signatures":[{"id":209,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":210,"name":"shortcut","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":219,"name":"isRegistered","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"globalShortcut.ts","line":101,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L101"}],"signatures":[{"id":220,"name":"isRegistered","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given shortcut is registered by this application or not."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { isRegistered } from '@tauri-apps/api/globalShortcut';\nconst isRegistered = await isRegistered('CommandOrControl+P');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"globalShortcut.ts","line":101,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L101"}],"parameters":[{"id":221,"name":"shortcut","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Array of shortcut definitions, modifiers and key separated by \"+\" e.g. CmdOrControl+Q"}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":211,"name":"register","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"globalShortcut.ts","line":46,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L46"}],"signatures":[{"id":212,"name":"register","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a global shortcut."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { register } from '@tauri-apps/api/globalShortcut';\nawait register('CommandOrControl+Shift+C', () => {\n  console.log('Shortcut triggered');\n});\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"globalShortcut.ts","line":46,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L46"}],"parameters":[{"id":213,"name":"shortcut","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shortcut definition, modifiers and key separated by \"+\" e.g. CmdOrControl+Q"}]},"type":{"type":"intrinsic","name":"string"}},{"id":214,"name":"handler","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shortcut handler callback - takes the triggered shortcut as argument"}]},"type":{"type":"reference","target":207,"name":"ShortcutHandler","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":215,"name":"registerAll","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"globalShortcut.ts","line":75,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L75"}],"signatures":[{"id":216,"name":"registerAll","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a collection of global shortcuts."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { registerAll } from '@tauri-apps/api/globalShortcut';\nawait registerAll(['CommandOrControl+Shift+C', 'Ctrl+Alt+F12'], (shortcut) => {\n  console.log(`Shortcut ${shortcut} triggered`);\n});\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"globalShortcut.ts","line":75,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L75"}],"parameters":[{"id":217,"name":"shortcuts","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Array of shortcut definitions, modifiers and key separated by \"+\" e.g. CmdOrControl+Q"}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":218,"name":"handler","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shortcut handler callback - takes the triggered shortcut as argument"}]},"type":{"type":"reference","target":207,"name":"ShortcutHandler","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":222,"name":"unregister","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"globalShortcut.ts","line":123,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L123"}],"signatures":[{"id":223,"name":"unregister","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unregister a global shortcut."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { unregister } from '@tauri-apps/api/globalShortcut';\nawait unregister('CmdOrControl+Space');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"globalShortcut.ts","line":123,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L123"}],"parameters":[{"id":224,"name":"shortcut","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"shortcut definition, modifiers and key separated by \"+\" e.g. CmdOrControl+Q"}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":225,"name":"unregisterAll","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"globalShortcut.ts","line":143,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L143"}],"signatures":[{"id":226,"name":"unregisterAll","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unregisters all shortcuts registered by the application."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { unregisterAll } from '@tauri-apps/api/globalShortcut';\nawait unregisterAll();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"globalShortcut.ts","line":143,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L143"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Type Aliases","children":[207]},{"title":"Functions","children":[219,211,215,222,225]}],"sources":[{"fileName":"globalShortcut.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/globalShortcut.ts#L1"}]},{"id":227,"name":"http","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Access the HTTP client written in Rust.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.http`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be allowlisted on "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```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```"},{"kind":"text","text":"\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 "},{"kind":"code","text":"`tauri-apps`"},{"kind":"text","text":" organization:\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"http\": {\n        \"scope\": [\"https://api.github.com/repos/tauri-apps/*\"]\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\nTrying to execute any API with a URL not configured on the scope results in a promise rejection due to denied access."}]},"children":[{"id":323,"name":"ResponseType","variant":"declaration","kind":8,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":326,"name":"Binary","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"http.ts","line":74,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L74"}],"type":{"type":"literal","value":3}},{"id":324,"name":"JSON","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"http.ts","line":72,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L72"}],"type":{"type":"literal","value":1}},{"id":325,"name":"Text","variant":"declaration","kind":16,"flags":{},"sources":[{"fileName":"http.ts","line":73,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L73"}],"type":{"type":"literal","value":2}}],"groups":[{"title":"Enumeration Members","children":[326,324,325]}],"sources":[{"fileName":"http.ts","line":71,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L71"}]},{"id":254,"name":"Body","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"The body object to be used on POST and PUT requests."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":272,"name":"payload","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"http.ts","line":95,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L95"}],"type":{"type":"intrinsic","name":"unknown"}},{"id":271,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"http.ts","line":94,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L94"}],"type":{"type":"intrinsic","name":"string"}},{"id":264,"name":"bytes","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":217,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L217"}],"signatures":[{"id":265,"name":"bytes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a new byte array body."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { Body } from \"@tauri-apps/api/http\"\nBody.bytes(new Uint8Array([1, 2, 3]));\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The body object ready to be used on the POST and PUT requests."}]}]},"sources":[{"fileName":"http.ts","line":217,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L217"}],"parameters":[{"id":266,"name":"bytes","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The body byte array."}]},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es2015.iterable.d.ts","qualifiedName":"Iterable"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Iterable","package":"typescript"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"ArrayBuffer"},"name":"ArrayBuffer","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"ArrayLike"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"ArrayLike","package":"typescript"}]}}],"type":{"type":"reference","target":254,"name":"Body","package":"@tauri-apps/api"}}]},{"id":255,"name":"form","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":134,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L134"}],"signatures":[{"id":256,"name":"form","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a new form data body. The form data is an object where each key is the entry name,\nand the value is either a string or a file object.\n\nBy default it sets the "},{"kind":"code","text":"`application/x-www-form-urlencoded`"},{"kind":"text","text":" Content-Type header,\nbut you can set it to "},{"kind":"code","text":"`multipart/form-data`"},{"kind":"text","text":" if the Cargo feature "},{"kind":"code","text":"`http-multipart`"},{"kind":"text","text":" is enabled.\n\nNote that a file path must be allowed in the "},{"kind":"code","text":"`fs`"},{"kind":"text","text":" allowlist scope."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { Body } from \"@tauri-apps/api/http\"\nconst body = Body.form({\n  key: 'value',\n  image: {\n    file: '/path/to/file', // either a path or an array buffer of the file contents\n    mime: 'image/jpeg', // optional\n    fileName: 'image.jpg' // optional\n  }\n});\n\n// alternatively, use a FormData:\nconst form = new FormData();\nform.append('key', 'value');\nform.append('image', file, 'image.png');\nconst formBody = Body.form(form);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The body object ready to be used on the POST and PUT requests."}]}]},"sources":[{"fileName":"http.ts","line":134,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L134"}],"parameters":[{"id":257,"name":"data","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The body data."}]},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":234,"name":"Part","package":"@tauri-apps/api"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.dom.d.ts","qualifiedName":"FormData"},"name":"FormData","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/API/FormData"}]}}],"type":{"type":"reference","target":254,"name":"Body","package":"@tauri-apps/api"}}]},{"id":258,"name":"json","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":185,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L185"}],"signatures":[{"id":259,"name":"json","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a new JSON body."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { Body } from \"@tauri-apps/api/http\"\nBody.json({\n  registered: true,\n  name: 'tauri'\n});\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The body object ready to be used on the POST and PUT requests."}]}]},"sources":[{"fileName":"http.ts","line":185,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L185"}],"parameters":[{"id":260,"name":"data","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The body JSON object."}]},"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}}],"type":{"type":"reference","target":254,"name":"Body","package":"@tauri-apps/api"}}]},{"id":261,"name":"text","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":201,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L201"}],"signatures":[{"id":262,"name":"text","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a new UTF-8 string body."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { Body } from \"@tauri-apps/api/http\"\nBody.text('The body content as a string');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The body object ready to be used on the POST and PUT requests."}]}]},"sources":[{"fileName":"http.ts","line":201,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L201"}],"parameters":[{"id":263,"name":"value","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The body string."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":254,"name":"Body","package":"@tauri-apps/api"}}]}],"groups":[{"title":"Properties","children":[272,271]},{"title":"Methods","children":[264,255,258,261]}],"sources":[{"fileName":"http.ts","line":93,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L93"}]},{"id":273,"name":"Client","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":277,"name":"id","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"http.ts","line":303,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L303"}],"type":{"type":"intrinsic","name":"number"}},{"id":306,"name":"delete","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"http.ts","line":484,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L484"}],"signatures":[{"id":307,"name":"delete","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Makes a DELETE request."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getClient } from '@tauri-apps/api/http';\nconst client = await getClient();\nconst response = await client.delete('http://localhost:3003/users/1');\n```"}]}]},"sources":[{"fileName":"http.ts","line":484,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L484"}],"typeParameter":[{"id":308,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":309,"name":"url","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":310,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":244,"name":"RequestOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":311,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Response","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":278,"name":"drop","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"http.ts","line":318,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L318"}],"signatures":[{"id":279,"name":"drop","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Drops the client instance."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getClient } from '@tauri-apps/api/http';\nconst client = await getClient();\nawait client.drop();\n```"}]}]},"sources":[{"fileName":"http.ts","line":318,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L318"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":284,"name":"get","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"http.ts","line":389,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L389"}],"signatures":[{"id":285,"name":"get","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Makes a GET request."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getClient, ResponseType } from '@tauri-apps/api/http';\nconst client = await getClient();\nconst response = await client.get('http://localhost:3003/users', {\n  timeout: 30,\n  // the expected response type\n  responseType: ResponseType.JSON\n});\n```"}]}]},"sources":[{"fileName":"http.ts","line":389,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L389"}],"typeParameter":[{"id":286,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":287,"name":"url","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":288,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":244,"name":"RequestOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":311,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Response","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":301,"name":"patch","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"http.ts","line":467,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L467"}],"signatures":[{"id":302,"name":"patch","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Makes a PATCH request."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getClient, Body } from '@tauri-apps/api/http';\nconst client = await getClient();\nconst response = await client.patch('http://localhost:3003/users/1', {\n  body: Body.json({ email: 'contact@tauri.app' })\n});\n```"}]}]},"sources":[{"fileName":"http.ts","line":467,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L467"}],"typeParameter":[{"id":303,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":304,"name":"url","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":305,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":244,"name":"RequestOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":311,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Response","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":289,"name":"post","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"http.ts","line":413,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L413"}],"signatures":[{"id":290,"name":"post","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Makes a POST request."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getClient, Body, ResponseType } from '@tauri-apps/api/http';\nconst client = await getClient();\nconst response = await client.post('http://localhost:3003/users', {\n  body: Body.json({\n    name: 'tauri',\n    password: 'awesome'\n  }),\n  // in this case the server returns a simple string\n  responseType: ResponseType.Text,\n});\n```"}]}]},"sources":[{"fileName":"http.ts","line":413,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L413"}],"typeParameter":[{"id":291,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":292,"name":"url","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":293,"name":"body","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":254,"name":"Body","package":"@tauri-apps/api"}},{"id":294,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":244,"name":"RequestOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":311,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Response","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":295,"name":"put","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"http.ts","line":443,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L443"}],"signatures":[{"id":296,"name":"put","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Makes a PUT request."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getClient, Body } from '@tauri-apps/api/http';\nconst client = await getClient();\nconst response = await client.put('http://localhost:3003/users/1', {\n  body: Body.form({\n    file: {\n      file: '/home/tauri/avatar.png',\n      mime: 'image/png',\n      fileName: 'avatar.png'\n    }\n  })\n});\n```"}]}]},"sources":[{"fileName":"http.ts","line":443,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L443"}],"typeParameter":[{"id":297,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":298,"name":"url","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":299,"name":"body","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":254,"name":"Body","package":"@tauri-apps/api"}},{"id":300,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":244,"name":"RequestOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":311,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Response","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":280,"name":"request","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"http.ts","line":340,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L340"}],"signatures":[{"id":281,"name":"request","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Makes an HTTP request."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getClient } from '@tauri-apps/api/http';\nconst client = await getClient();\nconst response = await client.request({\n  method: 'GET',\n  url: 'http://localhost:3003/users',\n});\n```"}]}]},"sources":[{"fileName":"http.ts","line":340,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L340"}],"typeParameter":[{"id":282,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":283,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":236,"name":"HttpOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":311,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Response","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Properties","children":[277]},{"title":"Methods","children":[306,278,284,301,289,295,280]}],"sources":[{"fileName":"http.ts","line":302,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L302"}]},{"id":311,"name":"Response","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"Response object."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":321,"name":"data","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The response data."}]},"sources":[{"fileName":"http.ts","line":286,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L286"}],"type":{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}},{"id":319,"name":"headers","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The response headers."}]},"sources":[{"fileName":"http.ts","line":282,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L282"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}},{"id":318,"name":"ok","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A boolean indicating whether the response was successful (status in the range 200–299) or not."}]},"sources":[{"fileName":"http.ts","line":280,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L280"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":320,"name":"rawHeaders","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The response raw headers."}]},"sources":[{"fileName":"http.ts","line":284,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L284"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}},{"id":317,"name":"status","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The response status code."}]},"sources":[{"fileName":"http.ts","line":278,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L278"}],"type":{"type":"intrinsic","name":"number"}},{"id":316,"name":"url","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The request URL."}]},"sources":[{"fileName":"http.ts","line":276,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L276"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[321,319,318,320,317,316]}],"sources":[{"fileName":"http.ts","line":274,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L274"}],"typeParameters":[{"id":322,"name":"T","variant":"typeParam","kind":131072,"flags":{}}]},{"id":231,"name":"ClientOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":233,"name":"connectTimeout","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":65,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L65"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"reference","target":228,"name":"Duration","package":"@tauri-apps/api"}]}},{"id":232,"name":"maxRedirections","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Defines the maximum number of redirects the client should follow.\nIf set to 0, no redirects will be followed."}]},"sources":[{"fileName":"http.ts","line":64,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L64"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[233,232]}],"sources":[{"fileName":"http.ts","line":59,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L59"}]},{"id":228,"name":"Duration","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":230,"name":"nanos","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"http.ts","line":53,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L53"}],"type":{"type":"intrinsic","name":"number"}},{"id":229,"name":"secs","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"http.ts","line":52,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L52"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[230,229]}],"sources":[{"fileName":"http.ts","line":51,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L51"}]},{"id":327,"name":"FilePart","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":328,"name":"file","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"http.ts","line":81,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L81"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}]}},{"id":330,"name":"fileName","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":83,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L83"}],"type":{"type":"intrinsic","name":"string"}},{"id":329,"name":"mime","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":82,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L82"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[328,330,329]}],"sources":[{"fileName":"http.ts","line":80,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L80"}],"typeParameters":[{"id":331,"name":"T","variant":"typeParam","kind":131072,"flags":{}}]},{"id":236,"name":"HttpOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Options object sent to the backend."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":241,"name":"body","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":250,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L250"}],"type":{"type":"reference","target":254,"name":"Body","package":"@tauri-apps/api"}},{"id":239,"name":"headers","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":248,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L248"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"any"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}},{"id":237,"name":"method","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"http.ts","line":246,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L246"}],"type":{"type":"reference","target":235,"name":"HttpVerb","package":"@tauri-apps/api"}},{"id":240,"name":"query","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":249,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L249"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"any"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}},{"id":243,"name":"responseType","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":252,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L252"}],"type":{"type":"reference","target":323,"name":"ResponseType","package":"@tauri-apps/api"}},{"id":242,"name":"timeout","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":251,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L251"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"reference","target":228,"name":"Duration","package":"@tauri-apps/api"}]}},{"id":238,"name":"url","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"http.ts","line":247,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L247"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[241,239,237,240,243,242,238]}],"sources":[{"fileName":"http.ts","line":245,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L245"}]},{"id":245,"name":"FetchOptions","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[{"kind":"text","text":"Options for the "},{"kind":"code","text":"`fetch`"},{"kind":"text","text":" API."}]},"sources":[{"fileName":"http.ts","line":258,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L258"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":236,"name":"HttpOptions","package":"@tauri-apps/api"},{"type":"literal","value":"url"}],"name":"Omit","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys"}},{"id":235,"name":"HttpVerb","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[{"kind":"text","text":"The request HTTP verb."}]},"sources":[{"fileName":"http.ts","line":229,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L229"}],"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":234,"name":"Part","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"http.ts","line":86,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L86"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Uint8Array"},"name":"Uint8Array","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array"},{"type":"reference","target":327,"typeArguments":[{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Uint8Array"},"name":"Uint8Array","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array"}],"name":"FilePart","package":"@tauri-apps/api"}]}},{"id":244,"name":"RequestOptions","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[{"kind":"text","text":"Request options."}]},"sources":[{"fileName":"http.ts","line":256,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L256"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":236,"name":"HttpOptions","package":"@tauri-apps/api"},{"type":"union","types":[{"type":"literal","value":"method"},{"type":"literal","value":"url"}]}],"name":"Omit","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys"}},{"id":249,"name":"fetch","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"http.ts","line":531,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L531"}],"signatures":[{"id":250,"name":"fetch","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Perform an HTTP request using the default client."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { fetch } from '@tauri-apps/api/http';\nconst response = await fetch('http://localhost:3003/users/2', {\n  method: 'GET',\n  timeout: 30,\n});\n```"}]}]},"sources":[{"fileName":"http.ts","line":531,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L531"}],"typeParameter":[{"id":251,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":252,"name":"url","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":253,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":245,"name":"FetchOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":311,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Response","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":246,"name":"getClient","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"http.ts","line":507,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L507"}],"signatures":[{"id":247,"name":"getClient","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a new client using the specified options."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { getClient } from '@tauri-apps/api/http';\nconst client = await getClient();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to the client instance."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"http.ts","line":507,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L507"}],"parameters":[{"id":248,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Client configuration."}]},"type":{"type":"reference","target":231,"name":"ClientOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":273,"name":"Client","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Enumerations","children":[323]},{"title":"Classes","children":[254,273,311]},{"title":"Interfaces","children":[231,228,327,236]},{"title":"Type Aliases","children":[245,235,234,244]},{"title":"Functions","children":[249,246]}],"sources":[{"fileName":"http.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/http.ts#L1"}]},{"id":332,"name":"mocks","variant":"declaration","kind":2,"flags":{},"children":[{"id":344,"name":"clearMocks","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":171,"character":16,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L171"}],"signatures":[{"id":345,"name":"clearMocks","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clears mocked functions/data injected by the other functions in this module.\nWhen using a test runner that doesn't provide a fresh window object for each test, calling this function will reset tauri specific properties.\n\n# Example\n\n"},{"kind":"code","text":"```js\nimport { mockWindows, clearMocks } from \"@tauri-apps/api/mocks\"\n\nafterEach(() => {\n   clearMocks()\n})\n\ntest(\"mocked windows\", () => {\n   mockWindows(\"main\", \"second\", \"third\");\n\n   expect(window).toHaveProperty(\"__TAURI_METADATA__\")\n})\n\ntest(\"no mocked windows\", () => {\n   expect(window).not.toHaveProperty(\"__TAURI_METADATA__\")\n})\n```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":171,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L171"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":333,"name":"mockIPC","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":65,"character":16,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L65"}],"signatures":[{"id":334,"name":"mockIPC","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Intercepts all IPC requests with the given mock handler.\n\nThis function can be used when testing tauri frontend applications or when running the frontend in a Node.js context during static site generation.\n\n# Examples\n\nTesting setup using vitest:\n"},{"kind":"code","text":"```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n   clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, 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```"},{"kind":"text","text":"\n\nThe callback function can also return a Promise:\n"},{"kind":"code","text":"```js\nimport { mockIPC, clearMocks } from \"@tauri-apps/api/mocks\"\nimport { invoke } from \"@tauri-apps/api/tauri\"\n\nafterEach(() => {\n   clearMocks()\n})\n\ntest(\"mocked command\", () => {\n mockIPC((cmd, args) => {\n  if(cmd === \"get_data\") {\n   return fetch(\"https://example.com/data.json\")\n     .then((response) => response.json())\n  }\n });\n\n expect(invoke('get_data')).resolves.toBe({ foo: 'bar' });\n})\n```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":65,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L65"}],"parameters":[{"id":335,"name":"cb","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":336,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"mocks.ts","line":66,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L66"}],"signatures":[{"id":337,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"mocks.ts","line":66,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L66"}],"parameters":[{"id":338,"name":"cmd","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":339,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}}],"type":{"type":"intrinsic","name":"any"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":340,"name":"mockWindows","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"mocks.ts","line":135,"character":16,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L135"}],"signatures":[{"id":341,"name":"mockWindows","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mocks one or many window labels.\nIn non-tauri context it is required to call this function *before* using the "},{"kind":"code","text":"`@tauri-apps/api/window`"},{"kind":"text","text":" module.\n\nThis function only mocks the *presence* of windows,\nwindow properties (e.g. width and height) can be mocked like regular IPC calls using the "},{"kind":"code","text":"`mockIPC`"},{"kind":"text","text":" function.\n\n# Examples\n\n"},{"kind":"code","text":"```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\nimport { getCurrent } from \"@tauri-apps/api/window\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nconst win = getCurrent();\n\nwin.label // \"main\"\n```"},{"kind":"text","text":"\n\n"},{"kind":"code","text":"```js\nimport { mockWindows } from \"@tauri-apps/api/mocks\";\n\nmockWindows(\"main\", \"second\", \"third\");\n\nmockIPC((cmd, args) => {\n if (cmd === \"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```"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"mocks.ts","line":135,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L135"}],"parameters":[{"id":342,"name":"current","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label of window this JavaScript context is running in."}]},"type":{"type":"intrinsic","name":"string"}},{"id":343,"name":"additionalWindows","variant":"param","kind":32768,"flags":{"isRest":true},"comment":{"summary":[{"kind":"text","text":"Label of additional windows the app has."}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Functions","children":[344,333,340]}],"sources":[{"fileName":"mocks.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/mocks.ts#L1"}]},{"id":346,"name":"notification","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Send toast notifications (brief auto-expiring OS window element) to your user.\nCan also be used with the Notification Web API.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.notification`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.notification`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.notification) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"notification\": {\n        \"all\": true // enable all notification APIs\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":347,"name":"Options","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Options to send a notification."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":349,"name":"body","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Optional notification body."}]},"sources":[{"fileName":"notification.ts","line":38,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L38"}],"type":{"type":"intrinsic","name":"string"}},{"id":350,"name":"icon","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Optional notification icon."}]},"sources":[{"fileName":"notification.ts","line":40,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L40"}],"type":{"type":"intrinsic","name":"string"}},{"id":348,"name":"title","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Notification title."}]},"sources":[{"fileName":"notification.ts","line":36,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L36"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[349,350,348]}],"sources":[{"fileName":"notification.ts","line":34,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L34"}]},{"id":351,"name":"Permission","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[{"kind":"text","text":"Possible permission values."}]},"sources":[{"fileName":"notification.ts","line":44,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L44"}],"type":{"type":"union","types":[{"type":"literal","value":"granted"},{"type":"literal","value":"denied"},{"type":"literal","value":"default"}]}},{"id":357,"name":"isPermissionGranted","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"notification.ts","line":56,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L56"}],"signatures":[{"id":358,"name":"isPermissionGranted","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Checks if the permission to send notifications is granted."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { isPermissionGranted } from '@tauri-apps/api/notification';\nconst permissionGranted = await isPermissionGranted();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"notification.ts","line":56,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L56"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":355,"name":"requestPermission","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"notification.ts","line":84,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L84"}],"signatures":[{"id":356,"name":"requestPermission","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Requests the permission to send notifications."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { isPermissionGranted, requestPermission } from '@tauri-apps/api/notification';\nlet permissionGranted = await isPermissionGranted();\nif (!permissionGranted) {\n  const permission = await requestPermission();\n  permissionGranted = permission === 'granted';\n}\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to whether the user granted the permission or not."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"notification.ts","line":84,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L84"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":351,"name":"Permission","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":352,"name":"sendNotification","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"notification.ts","line":106,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L106"}],"signatures":[{"id":353,"name":"sendNotification","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sends a notification to the user."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/api/notification';\nlet permissionGranted = await isPermissionGranted();\nif (!permissionGranted) {\n  const permission = await requestPermission();\n  permissionGranted = permission === 'granted';\n}\nif (permissionGranted) {\n  sendNotification('Tauri is awesome!');\n  sendNotification({ title: 'TAURI', body: 'Tauri is awesome!' });\n}\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"notification.ts","line":106,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L106"}],"parameters":[{"id":354,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":347,"name":"Options","package":"@tauri-apps/api"}]}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Interfaces","children":[347]},{"title":"Type Aliases","children":[351]},{"title":"Functions","children":[357,355,352]}],"sources":[{"fileName":"notification.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/notification.ts#L1"}]},{"id":359,"name":"os","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Provides operating system-related utility methods and properties.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.os`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.os`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.os) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"os\": {\n        \"all\": true, // enable all Os APIs\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":375,"name":"Arch","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"os.ts","line":43,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L43"}],"type":{"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"}]}},{"id":374,"name":"OsType","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"os.ts","line":41,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L41"}],"type":{"type":"union","types":[{"type":"literal","value":"Linux"},{"type":"literal","value":"Darwin"},{"type":"literal","value":"Windows_NT"}]}},{"id":373,"name":"Platform","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"os.ts","line":29,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L29"}],"type":{"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"}]}},{"id":360,"name":"EOL","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"The operating system-specific end-of-line marker.\n- "},{"kind":"code","text":"`\\n`"},{"kind":"text","text":" on POSIX\n- "},{"kind":"code","text":"`\\r\\n`"},{"kind":"text","text":" on Windows"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"os.ts","line":63,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L63"}],"type":{"type":"union","types":[{"type":"literal","value":"\n"},{"type":"literal","value":"\r\n"}]},"defaultValue":"..."},{"id":367,"name":"arch","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"os.ts","line":135,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L135"}],"signatures":[{"id":368,"name":"arch","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the operating system CPU architecture for which the tauri app was compiled.\nPossible values are "},{"kind":"code","text":"`'x86'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'x86_64'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'arm'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'aarch64'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'mips'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'mips64'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'powerpc'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'powerpc64'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'riscv64'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'s390x'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'sparc64'`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { arch } from '@tauri-apps/api/os';\nconst archName = await arch();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"os.ts","line":135,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L135"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":375,"name":"Arch","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":371,"name":"locale","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"os.ts","line":176,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L176"}],"signatures":[{"id":372,"name":"locale","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a String with a "},{"kind":"code","text":"`BCP-47`"},{"kind":"text","text":" language tag inside. If the locale couldn’t be obtained, "},{"kind":"code","text":"`null`"},{"kind":"text","text":" is returned instead."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { locale } from '@tauri-apps/api/os';\nconst locale = await locale();\nif (locale) {\n   // use the locale string here\n}\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.3.0"}]}]},"sources":[{"fileName":"os.ts","line":176,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L176"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":361,"name":"platform","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"os.ts","line":77,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L77"}],"signatures":[{"id":362,"name":"platform","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a string identifying the operating system platform.\nThe value is set at compile time. Possible values are "},{"kind":"code","text":"`'linux'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'darwin'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'ios'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'freebsd'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'dragonfly'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'netbsd'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'openbsd'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'solaris'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'android'`"},{"kind":"text","text":", "},{"kind":"code","text":"`'win32'`"}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { platform } from '@tauri-apps/api/os';\nconst platformName = await platform();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"os.ts","line":77,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L77"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":373,"name":"Platform","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":369,"name":"tempdir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"os.ts","line":154,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L154"}],"signatures":[{"id":370,"name":"tempdir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the operating system's default directory for temporary files as a string."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { tempdir } from '@tauri-apps/api/os';\nconst tempdirPath = await tempdir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"os.ts","line":154,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L154"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":365,"name":"type","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"os.ts","line":115,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L115"}],"signatures":[{"id":366,"name":"type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`'Linux'`"},{"kind":"text","text":" on Linux, "},{"kind":"code","text":"`'Darwin'`"},{"kind":"text","text":" on macOS, and "},{"kind":"code","text":"`'Windows_NT'`"},{"kind":"text","text":" on Windows."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { type } from '@tauri-apps/api/os';\nconst osType = await type();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"os.ts","line":115,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L115"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":374,"name":"OsType","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":363,"name":"version","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"os.ts","line":96,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L96"}],"signatures":[{"id":364,"name":"version","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a string identifying the kernel version."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { version } from '@tauri-apps/api/os';\nconst osVersion = await version();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"os.ts","line":96,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L96"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Type Aliases","children":[375,374,373]},{"title":"Variables","children":[360]},{"title":"Functions","children":[367,371,361,369,365,363]}],"sources":[{"fileName":"os.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/os.ts#L1"}]},{"id":376,"name":"path","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"The path module provides utilities for working with file and directory paths.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.path`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.path`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.path) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```json\n{\n  \"tauri\": {\n    \"allowlist\": {\n      \"path\": {\n        \"all\": true, // enable all Path APIs\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\nIt is recommended to allowlist only the APIs you use for optimal bundle size and security."}]},"children":[{"id":1174,"name":"BaseDirectory","variant":"reference","kind":8388608,"flags":{},"sources":[{"fileName":"path.ts","line":839,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L839"}],"target":108},{"id":429,"name":"delimiter","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Provides the platform-specific path segment delimiter:\n- "},{"kind":"code","text":"`;`"},{"kind":"text","text":" on Windows\n- "},{"kind":"code","text":"`:`"},{"kind":"text","text":" on POSIX"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":660,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L660"}],"type":{"type":"union","types":[{"type":"literal","value":";"},{"type":"literal","value":":"}]},"defaultValue":"..."},{"id":428,"name":"sep","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Provides the platform-specific path segment separator:\n- "},{"kind":"code","text":"`\\` on Windows\n- `"},{"kind":"text","text":"/` on POSIX"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":651,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L651"}],"type":{"type":"union","types":[{"type":"literal","value":"\\"},{"type":"literal","value":"/"}]},"defaultValue":"..."},{"id":385,"name":"appCacheDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":117,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L117"}],"signatures":[{"id":386,"name":"appCacheDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's cache files.\nResolves to "},{"kind":"code","text":"`${cacheDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appCacheDir } from '@tauri-apps/api/path';\nconst appCacheDirPath = await appCacheDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":117,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L117"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":379,"name":"appConfigDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":51,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L51"}],"signatures":[{"id":380,"name":"appConfigDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's config files.\nResolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appConfigDir } from '@tauri-apps/api/path';\nconst appConfigDirPath = await appConfigDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":51,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L51"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":381,"name":"appDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":73,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L73"}],"signatures":[{"id":382,"name":"appDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's data files.\nResolves to "},{"kind":"code","text":"`${dataDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":73,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L73"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":377,"name":"appDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":36,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L36"}],"signatures":[{"id":378,"name":"appDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app config files."}],"blockTags":[{"tag":"@deprecated","content":[{"kind":"text","text":"since 1.2.0: Will be removed in 2.0.0. Use "},{"kind":"inline-tag","tag":"@link","text":"appConfigDir","target":379,"tsLinkText":""},{"kind":"text","text":" or "},{"kind":"inline-tag","tag":"@link","text":"appDataDir","target":381,"tsLinkText":""},{"kind":"text","text":" instead."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":36,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":383,"name":"appLocalDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":95,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L95"}],"signatures":[{"id":384,"name":"appLocalDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's local data files.\nResolves to "},{"kind":"code","text":"`${localDataDir}/${bundleIdentifier}`"},{"kind":"text","text":", where "},{"kind":"code","text":"`bundleIdentifier`"},{"kind":"text","text":" is the value ["},{"kind":"code","text":"`tauri.bundle.identifier`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#bundleconfig.identifier) is configured in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appLocalDataDir } from '@tauri-apps/api/path';\nconst appLocalDataDirPath = await appLocalDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":95,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L95"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":387,"name":"appLogDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":633,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L633"}],"signatures":[{"id":388,"name":"appLogDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested directory for your app's log files.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}/logs`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`${homeDir}/Library/Logs/{bundleIdentifier}`"},{"kind":"text","text":"\n- **Windows:** Resolves to "},{"kind":"code","text":"`${configDir}/${bundleIdentifier}/logs`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appLogDir } from '@tauri-apps/api/path';\nconst appLogDirPath = await appLogDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"path.ts","line":633,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L633"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":389,"name":"audioDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":144,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L144"}],"signatures":[{"id":390,"name":"audioDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's audio directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_MUSIC_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Music`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Music}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { audioDir } from '@tauri-apps/api/path';\nconst audioDirPath = await audioDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":144,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L144"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":445,"name":"basename","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":782,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L782"}],"signatures":[{"id":446,"name":"basename","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the last portion of a "},{"kind":"code","text":"`path`"},{"kind":"text","text":". Trailing directory separators are ignored."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { basename, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst base = await basename(resourcePath);\nassert(base === 'app.conf');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":782,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L782"}],"parameters":[{"id":447,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":448,"name":"ext","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional file extension to be removed from the returned path."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":391,"name":"cacheDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":171,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L171"}],"signatures":[{"id":392,"name":"cacheDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's cache directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_CACHE_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.cache`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Caches`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_LocalAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { cacheDir } from '@tauri-apps/api/path';\nconst cacheDirPath = await cacheDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":171,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L171"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":393,"name":"configDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":198,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L198"}],"signatures":[{"id":394,"name":"configDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's config directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_CONFIG_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.config`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_RoamingAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { configDir } from '@tauri-apps/api/path';\nconst configDirPath = await configDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":198,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L198"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":395,"name":"dataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":225,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L225"}],"signatures":[{"id":396,"name":"dataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_RoamingAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { dataDir } from '@tauri-apps/api/path';\nconst dataDirPath = await dataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":225,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L225"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":397,"name":"desktopDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":252,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L252"}],"signatures":[{"id":398,"name":"desktopDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's desktop directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DESKTOP_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Desktop`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Desktop}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { desktopDir } from '@tauri-apps/api/path';\nconst desktopPath = await desktopDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":252,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L252"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":439,"name":"dirname","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":736,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L736"}],"signatures":[{"id":440,"name":"dirname","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the directory name of a "},{"kind":"code","text":"`path`"},{"kind":"text","text":". Trailing directory separators are ignored."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { dirname, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst dir = await dirname(appDataDirPath);\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":736,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L736"}],"parameters":[{"id":441,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":399,"name":"documentDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":279,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L279"}],"signatures":[{"id":400,"name":"documentDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's document directory."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { documentDir } from '@tauri-apps/api/path';\nconst documentDirPath = await documentDir();\n```"},{"kind":"text","text":"\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DOCUMENTS_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Documents`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Documents}`"},{"kind":"text","text":"."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":279,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L279"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":401,"name":"downloadDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":306,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L306"}],"signatures":[{"id":402,"name":"downloadDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's download directory.\n\n#### Platform-specific\n\n- **Linux**: Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_DOWNLOAD_DIR`"},{"kind":"text","text":".\n- **macOS**: Resolves to "},{"kind":"code","text":"`$HOME/Downloads`"},{"kind":"text","text":".\n- **Windows**: Resolves to "},{"kind":"code","text":"`{FOLDERID_Downloads}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { downloadDir } from '@tauri-apps/api/path';\nconst downloadDirPath = await downloadDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":306,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L306"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":403,"name":"executableDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":333,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L333"}],"signatures":[{"id":404,"name":"executableDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's executable directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_BIN_HOME/../bin`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$XDG_DATA_HOME/../bin`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/bin`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { executableDir } from '@tauri-apps/api/path';\nconst executableDirPath = await executableDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":333,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L333"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":442,"name":"extname","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":758,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L758"}],"signatures":[{"id":443,"name":"extname","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the extension of the "},{"kind":"code","text":"`path`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { extname, resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('app.conf');\nconst ext = await extname(resourcePath);\nassert(ext === 'conf');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":758,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L758"}],"parameters":[{"id":444,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":405,"name":"fontDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":360,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L360"}],"signatures":[{"id":406,"name":"fontDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's font directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME/fonts`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share/fonts`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Fonts`"},{"kind":"text","text":".\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { fontDir } from '@tauri-apps/api/path';\nconst fontDirPath = await fontDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":360,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L360"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":407,"name":"homeDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":387,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L387"}],"signatures":[{"id":408,"name":"homeDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's home directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$HOME`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Profile}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { homeDir } from '@tauri-apps/api/path';\nconst homeDirPath = await homeDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":387,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L387"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":449,"name":"isAbsolute","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":803,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L803"}],"signatures":[{"id":450,"name":"isAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns whether the path is absolute or not."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { isAbsolute } from '@tauri-apps/api/path';\nassert(await isAbsolute('/home/tauri'));\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":803,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L803"}],"parameters":[{"id":451,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":436,"name":"join","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":715,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L715"}],"signatures":[{"id":437,"name":"join","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Joins all given "},{"kind":"code","text":"`path`"},{"kind":"text","text":" segments together using the platform-specific separator as a delimiter, then normalizes the resulting path."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { join, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await join(appDataDirPath, 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":715,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L715"}],"parameters":[{"id":438,"name":"paths","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":409,"name":"localDataDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":414,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L414"}],"signatures":[{"id":410,"name":"localDataDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's local data directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_DATA_HOME`"},{"kind":"text","text":" or "},{"kind":"code","text":"`$HOME/.local/share`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Library/Application Support`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_LocalAppData}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { localDataDir } from '@tauri-apps/api/path';\nconst localDataDirPath = await localDataDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":414,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L414"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":426,"name":"logDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":613,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L613"}],"signatures":[{"id":427,"name":"logDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the suggested log directory."}],"blockTags":[{"tag":"@deprecated","content":[{"kind":"text","text":"since 1.2.0: Will be removed in 2.0.0. Use "},{"kind":"inline-tag","tag":"@link","text":"appLogDir","target":387,"tsLinkText":""},{"kind":"text","text":" instead."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":613,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L613"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":433,"name":"normalize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":694,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L694"}],"signatures":[{"id":434,"name":"normalize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Normalizes the given "},{"kind":"code","text":"`path`"},{"kind":"text","text":", resolving "},{"kind":"code","text":"`'..'`"},{"kind":"text","text":" and "},{"kind":"code","text":"`'.'`"},{"kind":"text","text":" segments and resolve symbolic links."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { normalize, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await normalize(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":694,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L694"}],"parameters":[{"id":435,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":411,"name":"pictureDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":441,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L441"}],"signatures":[{"id":412,"name":"pictureDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's picture directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_PICTURES_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Pictures`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Pictures}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { pictureDir } from '@tauri-apps/api/path';\nconst pictureDirPath = await pictureDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":441,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L441"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":413,"name":"publicDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":468,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L468"}],"signatures":[{"id":414,"name":"publicDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's public directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_PUBLICSHARE_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Public`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Public}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { publicDir } from '@tauri-apps/api/path';\nconst publicDirPath = await publicDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":468,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L468"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":430,"name":"resolve","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":673,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L673"}],"signatures":[{"id":431,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolves a sequence of "},{"kind":"code","text":"`paths`"},{"kind":"text","text":" or "},{"kind":"code","text":"`path`"},{"kind":"text","text":" segments into an absolute path."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resolve, appDataDir } from '@tauri-apps/api/path';\nconst appDataDirPath = await appDataDir();\nconst path = await resolve(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":673,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L673"}],"parameters":[{"id":432,"name":"paths","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":417,"name":"resolveResource","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":515,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L515"}],"signatures":[{"id":418,"name":"resolveResource","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the path to a resource file."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resolveResource } from '@tauri-apps/api/path';\nconst resourcePath = await resolveResource('script.sh');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The full path to the resource."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":515,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L515"}],"parameters":[{"id":419,"name":"resourcePath","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The path to the resource.\nMust follow the same syntax as defined in "},{"kind":"code","text":"`tauri.conf.json > tauri > bundle > resources`"},{"kind":"text","text":", i.e. keeping subfolders and parent dir components ("},{"kind":"code","text":"`../`"},{"kind":"text","text":")."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":415,"name":"resourceDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":490,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L490"}],"signatures":[{"id":416,"name":"resourceDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the application's resource directory.\nTo resolve a resource path, see the [[resolveResource | "},{"kind":"code","text":"`resolveResource API`"},{"kind":"text","text":"]]."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { resourceDir } from '@tauri-apps/api/path';\nconst resourceDirPath = await resourceDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":490,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L490"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":420,"name":"runtimeDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":542,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L542"}],"signatures":[{"id":421,"name":"runtimeDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's runtime directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to "},{"kind":"code","text":"`$XDG_RUNTIME_DIR`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Not supported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { runtimeDir } from '@tauri-apps/api/path';\nconst runtimeDirPath = await runtimeDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":542,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L542"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":422,"name":"templateDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":569,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L569"}],"signatures":[{"id":423,"name":"templateDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's template directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_TEMPLATES_DIR`"},{"kind":"text","text":".\n- **macOS:** Not supported.\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Templates}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { templateDir } from '@tauri-apps/api/path';\nconst templateDirPath = await templateDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":569,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L569"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":424,"name":"videoDir","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"path.ts","line":596,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L596"}],"signatures":[{"id":425,"name":"videoDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the path to the user's video directory.\n\n#### Platform-specific\n\n- **Linux:** Resolves to ["},{"kind":"code","text":"`xdg-user-dirs`"},{"kind":"text","text":"](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)' "},{"kind":"code","text":"`XDG_VIDEOS_DIR`"},{"kind":"text","text":".\n- **macOS:** Resolves to "},{"kind":"code","text":"`$HOME/Movies`"},{"kind":"text","text":".\n- **Windows:** Resolves to "},{"kind":"code","text":"`{FOLDERID_Videos}`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { videoDir } from '@tauri-apps/api/path';\nconst videoDirPath = await videoDir();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"path.ts","line":596,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L596"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"References","children":[1174]},{"title":"Variables","children":[429,428]},{"title":"Functions","children":[385,379,381,377,383,387,389,445,391,393,395,397,439,399,401,403,442,405,407,449,436,409,426,433,411,413,430,417,415,420,422,424]}],"sources":[{"fileName":"path.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/path.ts#L1"}]},{"id":452,"name":"process","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Perform operations on the current process.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.process`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":453,"name":"exit","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"process.ts","line":27,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/process.ts#L27"}],"signatures":[{"id":454,"name":"exit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Exits immediately with the given "},{"kind":"code","text":"`exitCode`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { exit } from '@tauri-apps/api/process';\nawait exit(1);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"process.ts","line":27,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/process.ts#L27"}],"parameters":[{"id":455,"name":"exitCode","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The exit code to use."}]},"type":{"type":"intrinsic","name":"number"},"defaultValue":"0"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":456,"name":"relaunch","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"process.ts","line":49,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/process.ts#L49"}],"signatures":[{"id":457,"name":"relaunch","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Exits the current instance of the app then relaunches it."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { relaunch } from '@tauri-apps/api/process';\nawait relaunch();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"process.ts","line":49,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/process.ts#L49"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Functions","children":[453,456]}],"sources":[{"fileName":"process.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/process.ts#L1"}]},{"id":458,"name":"shell","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Access the system shell.\nAllows you to spawn child processes and manage files and URLs using their default application.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.shell`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.shell`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.shell) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```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```"},{"kind":"text","text":"\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 "},{"kind":"inline-tag","tag":"@link","text":"`open`","target":616},{"kind":"text","text":" API\n\nOn the allowlist, "},{"kind":"code","text":"`open: true`"},{"kind":"text","text":" means that the "},{"kind":"inline-tag","tag":"@link","text":"open","target":616},{"kind":"text","text":" API can be used with any URL,\nas the argument is validated with the "},{"kind":"code","text":"`^((mailto:\\w+)|(tel:\\w+)|(https?://\\w+)).+`"},{"kind":"text","text":" regex.\nYou can change that regex by changing the boolean value to a string, e.g. "},{"kind":"code","text":"`open: ^https://github.com/`"},{"kind":"text","text":".\n\n### Restricting access to the "},{"kind":"inline-tag","tag":"@link","text":"`Command`","target":459},{"kind":"text","text":" APIs\n\nThe "},{"kind":"code","text":"`shell`"},{"kind":"text","text":" allowlist object has a "},{"kind":"code","text":"`scope`"},{"kind":"text","text":" field that defines an array of CLIs that can be used.\nEach CLI is a configuration object "},{"kind":"code","text":"`{ name: string, cmd: string, sidecar?: bool, args?: boolean | Arg[] }`"},{"kind":"text","text":".\n\n- "},{"kind":"code","text":"`name`"},{"kind":"text","text":": the unique identifier of the command, passed to the "},{"kind":"inline-tag","tag":"@link","text":"Command constructor","target":465},{"kind":"text","text":".\nIf it's a sidecar, this must be the value defined on "},{"kind":"code","text":"`tauri.conf.json > tauri > bundle > externalBin`"},{"kind":"text","text":".\n- "},{"kind":"code","text":"`cmd`"},{"kind":"text","text":": the program that is executed on this configuration. If it's a sidecar, this value is ignored.\n- "},{"kind":"code","text":"`sidecar`"},{"kind":"text","text":": whether the object configures a sidecar or a system program.\n- "},{"kind":"code","text":"`args`"},{"kind":"text","text":": the arguments that can be passed to the program. By default no arguments are allowed.\n  - "},{"kind":"code","text":"`true`"},{"kind":"text","text":" means that any argument list is allowed.\n  - "},{"kind":"code","text":"`false`"},{"kind":"text","text":" 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 "},{"kind":"code","text":"`{ validator: string }`"},{"kind":"text","text":" that defines a regex validating the argument value.\n\n#### Example scope configuration\n\nCLI: "},{"kind":"code","text":"`git commit -m \"the commit message\"`"},{"kind":"text","text":"\n\nConfiguration:\n"},{"kind":"code","text":"```json\n{\n  \"scope\": [\n    {\n      \"name\": \"run-git-commit\",\n      \"cmd\": \"git\",\n      \"args\": [\"commit\", \"-m\", { \"validator\": \"\\\\S+\" }]\n    }\n  ]\n}\n```"},{"kind":"text","text":"\nUsage:\n"},{"kind":"code","text":"```typescript\nimport { Command } from '@tauri-apps/api/shell'\nnew Command('run-git-commit', ['commit', '-m', 'the commit message'])\n```"},{"kind":"text","text":"\n\nTrying to execute any API with a program not configured on the scope results in a promise rejection due to denied access."}]},"children":[{"id":538,"name":"Child","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"children":[{"id":539,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"shell.ts","line":325,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L325"}],"signatures":[{"id":540,"name":"new Child","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"shell.ts","line":325,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L325"}],"parameters":[{"id":541,"name":"pid","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":538,"name":"Child","package":"@tauri-apps/api"}}]},{"id":542,"name":"pid","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The child process "},{"kind":"code","text":"`pid`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"shell.ts","line":323,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L323"}],"type":{"type":"intrinsic","name":"number"}},{"id":546,"name":"kill","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":361,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L361"}],"signatures":[{"id":547,"name":"kill","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Kills the child process."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"shell.ts","line":361,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L361"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":543,"name":"write","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":344,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L344"}],"signatures":[{"id":544,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Writes "},{"kind":"code","text":"`data`"},{"kind":"text","text":" to the "},{"kind":"code","text":"`stdin`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { Command } from '@tauri-apps/api/shell';\nconst command = new Command('node');\nconst child = await command.spawn();\nawait child.write('message');\nawait child.write([0, 1, 2, 3, 4, 5]);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"shell.ts","line":344,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L344"}],"parameters":[{"id":545,"name":"data","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The message to write, either a string or a byte array."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Uint8Array"},"name":"Uint8Array","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Constructors","children":[539]},{"title":"Properties","children":[542]},{"title":"Methods","children":[546,543]}],"sources":[{"fileName":"shell.ts","line":321,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L321"}]},{"id":459,"name":"Command","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"The entry point for spawning child processes.\nIt emits the "},{"kind":"code","text":"`close`"},{"kind":"text","text":" and "},{"kind":"code","text":"`error`"},{"kind":"text","text":" events."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { Command } from '@tauri-apps/api/shell';\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```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"children":[{"id":465,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"shell.ts","line":413,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L413"}],"signatures":[{"id":466,"name":"new Command","variant":"signature","kind":16384,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a new "},{"kind":"code","text":"`Command`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"shell.ts","line":413,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L413"}],"parameters":[{"id":467,"name":"program","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The program name to execute.\nIt must be configured on "},{"kind":"code","text":"`tauri.conf.json > tauri > allowlist > shell > scope`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":468,"name":"args","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Program arguments."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"defaultValue":"[]"},{"id":469,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Spawn options."}]},"type":{"type":"reference","target":625,"name":"SpawnOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"overwrites":{"type":"reference","target":550,"name":"EventEmitter.constructor"}}],"overwrites":{"type":"reference","target":549,"name":"EventEmitter.constructor"}},{"id":474,"name":"stderr","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Event emitter for the "},{"kind":"code","text":"`stderr`"},{"kind":"text","text":". Emits the "},{"kind":"code","text":"`data`"},{"kind":"text","text":" event."}]},"sources":[{"fileName":"shell.ts","line":403,"character":11,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L403"}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"literal","value":"data"}],"name":"EventEmitter","package":"@tauri-apps/api"},"defaultValue":"..."},{"id":473,"name":"stdout","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Event emitter for the "},{"kind":"code","text":"`stdout`"},{"kind":"text","text":". Emits the "},{"kind":"code","text":"`data`"},{"kind":"text","text":" event."}]},"sources":[{"fileName":"shell.ts","line":401,"character":11,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L401"}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"literal","value":"data"}],"name":"EventEmitter","package":"@tauri-apps/api"},"defaultValue":"..."},{"id":479,"name":"addListener","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":164,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L164"}],"signatures":[{"id":480,"name":"addListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Alias for "},{"kind":"code","text":"`emitter.on(eventName, listener)`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":164,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L164"}],"parameters":[{"id":481,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":482,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":483,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":164,"character":38,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L164"}],"signatures":[{"id":484,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":164,"character":38,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L164"}],"parameters":[{"id":485,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"inheritedFrom":{"type":"reference","target":557,"name":"EventEmitter.addListener"}}],"inheritedFrom":{"type":"reference","target":556,"name":"EventEmitter.addListener"}},{"id":477,"name":"execute","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":489,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L489"}],"signatures":[{"id":478,"name":"execute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Executes the command as a child process, waiting for it to finish and collecting all of its output."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { Command } from '@tauri-apps/api/shell';\nconst output = await new Command('echo', 'message').execute();\nassert(output.code === 0);\nassert(output.signal === null);\nassert(output.stdout === 'message');\nassert(output.stderr === '');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to the child process output."}]}]},"sources":[{"fileName":"shell.ts","line":489,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L489"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":620,"name":"ChildProcess","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":521,"name":"listenerCount","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":272,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L272"}],"signatures":[{"id":522,"name":"listenerCount","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the number of listeners listening to the event named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":272,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L272"}],"parameters":[{"id":523,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":599,"name":"EventEmitter.listenerCount"}}],"inheritedFrom":{"type":"reference","target":598,"name":"EventEmitter.listenerCount"}},{"id":507,"name":"off","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":221,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L221"}],"signatures":[{"id":508,"name":"off","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Removes the all specified listener from the listener array for the event eventName\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":221,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L221"}],"parameters":[{"id":509,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":510,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":511,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":221,"character":30,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L221"}],"signatures":[{"id":512,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":221,"character":30,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L221"}],"parameters":[{"id":513,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"inheritedFrom":{"type":"reference","target":585,"name":"EventEmitter.off"}}],"inheritedFrom":{"type":"reference","target":584,"name":"EventEmitter.off"}},{"id":493,"name":"on","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":187,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L187"}],"signatures":[{"id":494,"name":"on","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" function to the end of the listeners array for the\nevent named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":". No checks are made to see if the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" has\nalready been added. Multiple calls passing the same combination of "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":"and "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" will result in the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" being added, and called, multiple\ntimes.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"shell.ts","line":187,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L187"}],"parameters":[{"id":495,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":496,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":497,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":187,"character":29,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L187"}],"signatures":[{"id":498,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":187,"character":29,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L187"}],"parameters":[{"id":499,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"inheritedFrom":{"type":"reference","target":571,"name":"EventEmitter.on"}}],"inheritedFrom":{"type":"reference","target":570,"name":"EventEmitter.on"}},{"id":500,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":206,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L206"}],"signatures":[{"id":501,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds a **one-time**"},{"kind":"code","text":"`listener`"},{"kind":"text","text":" function for the event named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":". The\nnext time "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":" is triggered, this listener is removed and then invoked.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":206,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L206"}],"parameters":[{"id":502,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":503,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":504,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":206,"character":31,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L206"}],"signatures":[{"id":505,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":206,"character":31,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L206"}],"parameters":[{"id":506,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"inheritedFrom":{"type":"reference","target":578,"name":"EventEmitter.once"}}],"inheritedFrom":{"type":"reference","target":577,"name":"EventEmitter.once"}},{"id":524,"name":"prependListener","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":289,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L289"}],"signatures":[{"id":525,"name":"prependListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" function to the _beginning_ of the listeners array for the\nevent named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":". No checks are made to see if the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" has\nalready been added. Multiple calls passing the same combination of "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":"and "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" will result in the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" being added, and called, multiple\ntimes.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":289,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L289"}],"parameters":[{"id":526,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":527,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":528,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":289,"character":42,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L289"}],"signatures":[{"id":529,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":289,"character":42,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L289"}],"parameters":[{"id":530,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"inheritedFrom":{"type":"reference","target":602,"name":"EventEmitter.prependListener"}}],"inheritedFrom":{"type":"reference","target":601,"name":"EventEmitter.prependListener"}},{"id":531,"name":"prependOnceListener","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":308,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L308"}],"signatures":[{"id":532,"name":"prependOnceListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds a **one-time**"},{"kind":"code","text":"`listener`"},{"kind":"text","text":" function for the event named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":" to the_beginning_ of the listeners array. The next time "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":" is triggered, this\nlistener is removed, and then invoked.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":308,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L308"}],"parameters":[{"id":533,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":534,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":535,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":308,"character":46,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L308"}],"signatures":[{"id":536,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":308,"character":46,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L308"}],"parameters":[{"id":537,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"inheritedFrom":{"type":"reference","target":609,"name":"EventEmitter.prependOnceListener"}}],"inheritedFrom":{"type":"reference","target":608,"name":"EventEmitter.prependOnceListener"}},{"id":514,"name":"removeAllListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":238,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L238"}],"signatures":[{"id":515,"name":"removeAllListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Removes all listeners, or those of the specified eventName.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":238,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L238"}],"parameters":[{"id":516,"name":"event","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"inheritedFrom":{"type":"reference","target":592,"name":"EventEmitter.removeAllListeners"}}],"inheritedFrom":{"type":"reference","target":591,"name":"EventEmitter.removeAllListeners"}},{"id":486,"name":"removeListener","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":173,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L173"}],"signatures":[{"id":487,"name":"removeListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Alias for "},{"kind":"code","text":"`emitter.off(eventName, listener)`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":173,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L173"}],"parameters":[{"id":488,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":489,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":490,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":173,"character":41,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L173"}],"signatures":[{"id":491,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":173,"character":41,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L173"}],"parameters":[{"id":492,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"},"inheritedFrom":{"type":"reference","target":564,"name":"EventEmitter.removeListener"}}],"inheritedFrom":{"type":"reference","target":563,"name":"EventEmitter.removeListener"}},{"id":475,"name":"spawn","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":451,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L451"}],"signatures":[{"id":476,"name":"spawn","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Executes the command as a child process, returning a handle to it."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to the child process handle."}]}]},"sources":[{"fileName":"shell.ts","line":451,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L451"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":538,"name":"Child","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":460,"name":"sidecar","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"shell.ts","line":436,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L436"}],"signatures":[{"id":461,"name":"sidecar","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a command to execute the given sidecar program."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { Command } from '@tauri-apps/api/shell';\nconst command = Command.sidecar('my-sidecar');\nconst output = await command.execute();\n```"}]}]},"sources":[{"fileName":"shell.ts","line":436,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L436"}],"parameters":[{"id":462,"name":"program","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The program to execute.\nIt must be configured on "},{"kind":"code","text":"`tauri.conf.json > tauri > allowlist > shell > scope`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":463,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"defaultValue":"[]"},{"id":464,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":625,"name":"SpawnOptions","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":459,"name":"Command","package":"@tauri-apps/api"}}]}],"groups":[{"title":"Constructors","children":[465]},{"title":"Properties","children":[474,473]},{"title":"Methods","children":[479,477,521,507,493,500,524,531,514,486,475,460]}],"sources":[{"fileName":"shell.ts","line":393,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L393"}],"extendedTypes":[{"type":"reference","target":548,"typeArguments":[{"type":"union","types":[{"type":"literal","value":"close"},{"type":"literal","value":"error"}]}],"name":"EventEmitter","package":"@tauri-apps/api"}]},{"id":548,"name":"EventEmitter","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":549,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":550,"name":"new EventEmitter","variant":"signature","kind":16384,"flags":{},"typeParameter":[{"id":551,"name":"E","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]},{"id":556,"name":"addListener","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":164,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L164"}],"signatures":[{"id":557,"name":"addListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Alias for "},{"kind":"code","text":"`emitter.on(eventName, listener)`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":164,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L164"}],"parameters":[{"id":558,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}},{"id":559,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":560,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":164,"character":38,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L164"}],"signatures":[{"id":561,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":164,"character":38,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L164"}],"parameters":[{"id":562,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]},{"id":598,"name":"listenerCount","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":272,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L272"}],"signatures":[{"id":599,"name":"listenerCount","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the number of listeners listening to the event named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":272,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L272"}],"parameters":[{"id":600,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"number"}}]},{"id":584,"name":"off","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":221,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L221"}],"signatures":[{"id":585,"name":"off","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Removes the all specified listener from the listener array for the event eventName\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":221,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L221"}],"parameters":[{"id":586,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}},{"id":587,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":588,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":221,"character":30,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L221"}],"signatures":[{"id":589,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":221,"character":30,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L221"}],"parameters":[{"id":590,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]},{"id":570,"name":"on","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":187,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L187"}],"signatures":[{"id":571,"name":"on","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" function to the end of the listeners array for the\nevent named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":". No checks are made to see if the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" has\nalready been added. Multiple calls passing the same combination of "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":"and "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" will result in the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" being added, and called, multiple\ntimes.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"shell.ts","line":187,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L187"}],"parameters":[{"id":572,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}},{"id":573,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":574,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":187,"character":29,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L187"}],"signatures":[{"id":575,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":187,"character":29,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L187"}],"parameters":[{"id":576,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]},{"id":577,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":206,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L206"}],"signatures":[{"id":578,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds a **one-time**"},{"kind":"code","text":"`listener`"},{"kind":"text","text":" function for the event named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":". The\nnext time "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":" is triggered, this listener is removed and then invoked.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":206,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L206"}],"parameters":[{"id":579,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}},{"id":580,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":581,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":206,"character":31,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L206"}],"signatures":[{"id":582,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":206,"character":31,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L206"}],"parameters":[{"id":583,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]},{"id":601,"name":"prependListener","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":289,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L289"}],"signatures":[{"id":602,"name":"prependListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" function to the _beginning_ of the listeners array for the\nevent named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":". No checks are made to see if the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" has\nalready been added. Multiple calls passing the same combination of "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":"and "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" will result in the "},{"kind":"code","text":"`listener`"},{"kind":"text","text":" being added, and called, multiple\ntimes.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":289,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L289"}],"parameters":[{"id":603,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}},{"id":604,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":605,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":289,"character":42,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L289"}],"signatures":[{"id":606,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":289,"character":42,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L289"}],"parameters":[{"id":607,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]},{"id":608,"name":"prependOnceListener","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":308,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L308"}],"signatures":[{"id":609,"name":"prependOnceListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Adds a **one-time**"},{"kind":"code","text":"`listener`"},{"kind":"text","text":" function for the event named "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":" to the_beginning_ of the listeners array. The next time "},{"kind":"code","text":"`eventName`"},{"kind":"text","text":" is triggered, this\nlistener is removed, and then invoked.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":308,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L308"}],"parameters":[{"id":610,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}},{"id":611,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":612,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":308,"character":46,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L308"}],"signatures":[{"id":613,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":308,"character":46,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L308"}],"parameters":[{"id":614,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]},{"id":591,"name":"removeAllListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":238,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L238"}],"signatures":[{"id":592,"name":"removeAllListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Removes all listeners, or those of the specified eventName.\n\nReturns a reference to the "},{"kind":"code","text":"`EventEmitter`"},{"kind":"text","text":", so that calls can be chained."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":238,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L238"}],"parameters":[{"id":593,"name":"event","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]},{"id":563,"name":"removeListener","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"shell.ts","line":173,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L173"}],"signatures":[{"id":564,"name":"removeListener","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Alias for "},{"kind":"code","text":"`emitter.off(eventName, listener)`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":173,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L173"}],"parameters":[{"id":565,"name":"eventName","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}},{"id":566,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":567,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"shell.ts","line":173,"character":41,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L173"}],"signatures":[{"id":568,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"shell.ts","line":173,"character":41,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L173"}],"parameters":[{"id":569,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":548,"typeArguments":[{"type":"reference","target":-1,"name":"E","refersToTypeParameter":true}],"name":"EventEmitter","package":"@tauri-apps/api"}}]}],"groups":[{"title":"Constructors","children":[549]},{"title":"Methods","children":[556,598,584,570,577,601,608,591,563]}],"sources":[{"fileName":"shell.ts","line":153,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L153"}],"typeParameters":[{"id":615,"name":"E","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"extendedBy":[{"type":"reference","target":459,"name":"Command"}]},{"id":620,"name":"ChildProcess","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":621,"name":"code","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Exit code of the process. "},{"kind":"code","text":"`null`"},{"kind":"text","text":" if the process was terminated by a signal on Unix."}]},"sources":[{"fileName":"shell.ts","line":109,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L109"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"number"}]}},{"id":622,"name":"signal","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"If the process was terminated by a signal, represents that signal."}]},"sources":[{"fileName":"shell.ts","line":111,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L111"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"number"}]}},{"id":624,"name":"stderr","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The data that the process wrote to "},{"kind":"code","text":"`stderr`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"shell.ts","line":115,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L115"}],"type":{"type":"intrinsic","name":"string"}},{"id":623,"name":"stdout","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The data that the process wrote to "},{"kind":"code","text":"`stdout`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"shell.ts","line":113,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L113"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[621,622,624,623]}],"sources":[{"fileName":"shell.ts","line":107,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L107"}]},{"id":625,"name":"SpawnOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":626,"name":"cwd","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Current working directory."}]},"sources":[{"fileName":"shell.ts","line":88,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L88"}],"type":{"type":"intrinsic","name":"string"}},{"id":628,"name":"encoding","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Character encoding for stdout/stderr"}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"sources":[{"fileName":"shell.ts","line":96,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L96"}],"type":{"type":"intrinsic","name":"string"}},{"id":627,"name":"env","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Environment variables. set to "},{"kind":"code","text":"`null`"},{"kind":"text","text":" to clear the process env."}]},"sources":[{"fileName":"shell.ts","line":90,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L90"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}}],"groups":[{"title":"Properties","children":[626,628,627]}],"sources":[{"fileName":"shell.ts","line":86,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L86"}]},{"id":616,"name":"open","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"shell.ts","line":564,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L564"}],"signatures":[{"id":617,"name":"open","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Opens a path or URL with the system's default app,\nor the one specified with "},{"kind":"code","text":"`openWith`"},{"kind":"text","text":".\n\nThe "},{"kind":"code","text":"`openWith`"},{"kind":"text","text":" value must be one of "},{"kind":"code","text":"`firefox`"},{"kind":"text","text":", "},{"kind":"code","text":"`google chrome`"},{"kind":"text","text":", "},{"kind":"code","text":"`chromium`"},{"kind":"text","text":" "},{"kind":"code","text":"`safari`"},{"kind":"text","text":",\n"},{"kind":"code","text":"`open`"},{"kind":"text","text":", "},{"kind":"code","text":"`start`"},{"kind":"text","text":", "},{"kind":"code","text":"`xdg-open`"},{"kind":"text","text":", "},{"kind":"code","text":"`gio`"},{"kind":"text","text":", "},{"kind":"code","text":"`gnome-open`"},{"kind":"text","text":", "},{"kind":"code","text":"`kde-open`"},{"kind":"text","text":" or "},{"kind":"code","text":"`wslview`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { open } from '@tauri-apps/api/shell';\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```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"shell.ts","line":564,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L564"}],"parameters":[{"id":618,"name":"path","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The path or URL to open.\nThis value is matched against the string regex defined on "},{"kind":"code","text":"`tauri.conf.json > tauri > allowlist > shell > open`"},{"kind":"text","text":",\nwhich defaults to "},{"kind":"code","text":"`^((mailto:\\w+)|(tel:\\w+)|(https?://\\w+)).+`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":619,"name":"openWith","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"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","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Classes","children":[538,459,548]},{"title":"Interfaces","children":[620,625]},{"title":"Functions","children":[616]}],"sources":[{"fileName":"shell.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/shell.ts#L1"}]},{"id":629,"name":"tauri","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Invoke your custom commands.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.tauri`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":630,"name":"InvokeArgs","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[{"kind":"text","text":"Command arguments."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":63,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L63"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"}},{"id":643,"name":"convertFileSrc","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":129,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L129"}],"signatures":[{"id":644,"name":"convertFileSrc","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a device file path to an URL that can be loaded by the webview.\nNote that "},{"kind":"code","text":"`asset:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`https://asset.localhost`"},{"kind":"text","text":" must be added to ["},{"kind":"code","text":"`tauri.security.csp`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#securityconfig.csp) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":".\nExample CSP value: "},{"kind":"code","text":"`\"csp\": \"default-src 'self'; img-src 'self' asset: https://asset.localhost\"`"},{"kind":"text","text":" to use the asset protocol on image sources.\n\nAdditionally, "},{"kind":"code","text":"`asset`"},{"kind":"text","text":" must be added to ["},{"kind":"code","text":"`tauri.allowlist.protocol`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.protocol)\nin "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" and its access scope must be defined on the "},{"kind":"code","text":"`assetScope`"},{"kind":"text","text":" array on the same "},{"kind":"code","text":"`protocol`"},{"kind":"text","text":" object."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appDataDir, join } from '@tauri-apps/api/path';\nimport { convertFileSrc } from '@tauri-apps/api/tauri';\nconst appDataDirPath = await appDataDir();\nconst filePath = await join(appDataDirPath, 'assets/video.mp4');\nconst assetUrl = convertFileSrc(filePath);\n\nconst video = document.getElementById('my-video');\nconst source = document.createElement('source');\nsource.type = 'video/mp4';\nsource.src = assetUrl;\nvideo.appendChild(source);\nvideo.load();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"the URL that can be used as source on the webview."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":129,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L129"}],"parameters":[{"id":645,"name":"filePath","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The file path."}]},"type":{"type":"intrinsic","name":"string"}},{"id":646,"name":"protocol","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The protocol to use. Defaults to "},{"kind":"code","text":"`asset`"},{"kind":"text","text":". You only need to set this when using a custom protocol."}]},"type":{"type":"intrinsic","name":"string"},"defaultValue":"'asset'"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":638,"name":"invoke","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":79,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L79"}],"signatures":[{"id":639,"name":"invoke","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sends a message to the backend."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { invoke } from '@tauri-apps/api/tauri';\nawait invoke('login', { user: 'tauri', password: 'poiwe3h4r5ip3yrhtew9ty' });\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving or rejecting to the backend response."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":79,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L79"}],"typeParameter":[{"id":640,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":641,"name":"cmd","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The command name."}]},"type":{"type":"intrinsic","name":"string"}},{"id":642,"name":"args","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The optional arguments to pass to the command."}]},"type":{"type":"reference","target":630,"name":"InvokeArgs","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":631,"name":"transformCallback","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"tauri.ts","line":36,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L36"}],"signatures":[{"id":632,"name":"transformCallback","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Transforms a callback function to a string identifier that can be passed to the backend.\nThe backend uses the identifier to "},{"kind":"code","text":"`eval()`"},{"kind":"text","text":" the callback."}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"A unique identifier associated with the callback function."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"tauri.ts","line":36,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L36"}],"parameters":[{"id":633,"name":"callback","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":634,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"tauri.ts","line":37,"character":13,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L37"}],"signatures":[{"id":635,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"tauri.ts","line":37,"character":13,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L37"}],"parameters":[{"id":636,"name":"response","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":637,"name":"once","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"number"}}]}],"groups":[{"title":"Type Aliases","children":[630]},{"title":"Functions","children":[643,638,631]}],"sources":[{"fileName":"tauri.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/tauri.ts#L1"}]},{"id":647,"name":"updater","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Customize the auto updater flow.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.updater`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"children":[{"id":652,"name":"UpdateManifest","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":655,"name":"body","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"updater.ts","line":34,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L34"}],"type":{"type":"intrinsic","name":"string"}},{"id":654,"name":"date","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"updater.ts","line":33,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L33"}],"type":{"type":"intrinsic","name":"string"}},{"id":653,"name":"version","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"updater.ts","line":32,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L32"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[655,654,653]}],"sources":[{"fileName":"updater.ts","line":31,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L31"}]},{"id":656,"name":"UpdateResult","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":657,"name":"manifest","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"updater.ts","line":41,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L41"}],"type":{"type":"reference","target":652,"name":"UpdateManifest","package":"@tauri-apps/api"}},{"id":658,"name":"shouldUpdate","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"updater.ts","line":42,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L42"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[657,658]}],"sources":[{"fileName":"updater.ts","line":40,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L40"}]},{"id":649,"name":"UpdateStatusResult","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":650,"name":"error","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"updater.ts","line":24,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L24"}],"type":{"type":"intrinsic","name":"string"}},{"id":651,"name":"status","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"updater.ts","line":25,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L25"}],"type":{"type":"reference","target":648,"name":"UpdateStatus","package":"@tauri-apps/api"}}],"groups":[{"title":"Properties","children":[650,651]}],"sources":[{"fileName":"updater.ts","line":23,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L23"}]},{"id":648,"name":"UpdateStatus","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"updater.ts","line":18,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L18"}],"type":{"type":"union","types":[{"type":"literal","value":"PENDING"},{"type":"literal","value":"ERROR"},{"type":"literal","value":"DONE"},{"type":"literal","value":"UPTODATE"}]}},{"id":667,"name":"checkUpdate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"updater.ts","line":146,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L146"}],"signatures":[{"id":668,"name":"checkUpdate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Checks if an update is available."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { checkUpdate } from '@tauri-apps/api/updater';\nconst update = await checkUpdate();\n// now run installUpdate() if needed\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Promise resolving to the update status."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"updater.ts","line":146,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L146"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":656,"name":"UpdateResult","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":665,"name":"installUpdate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"updater.ts","line":87,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L87"}],"signatures":[{"id":666,"name":"installUpdate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Install the update if there's one available."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { checkUpdate, installUpdate } from '@tauri-apps/api/updater';\nconst update = await checkUpdate();\nif (update.shouldUpdate) {\n  console.log(`Installing update ${update.manifest?.version}, ${update.manifest?.date}, ${update.manifest.body}`);\n  await installUpdate();\n}\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"updater.ts","line":87,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L87"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":659,"name":"onUpdaterEvent","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"updater.ts","line":63,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L63"}],"signatures":[{"id":660,"name":"onUpdaterEvent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an updater event."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { onUpdaterEvent } from \"@tauri-apps/api/updater\";\nconst unlisten = await onUpdaterEvent(({ error, status }) => {\n console.log('Updater event', error, status);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"updater.ts","line":63,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L63"}],"parameters":[{"id":661,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":662,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"updater.ts","line":64,"character":11,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L64"}],"signatures":[{"id":663,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"updater.ts","line":64,"character":11,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L64"}],"parameters":[{"id":664,"name":"status","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":649,"name":"UpdateStatusResult","package":"@tauri-apps/api"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Interfaces","children":[652,656,649]},{"title":"Type Aliases","children":[648]},{"title":"Functions","children":[667,665,659]}],"sources":[{"fileName":"updater.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/updater.ts#L1"}]},{"id":669,"name":"window","variant":"declaration","kind":2,"flags":{},"comment":{"summary":[{"kind":"text","text":"Provides APIs to create windows, communicate with other windows and manipulate the current window.\n\nThis package is also accessible with "},{"kind":"code","text":"`window.__TAURI__.window`"},{"kind":"text","text":" when ["},{"kind":"code","text":"`build.withGlobalTauri`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#buildconfig.withglobaltauri) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":" is set to "},{"kind":"code","text":"`true`"},{"kind":"text","text":".\n\nThe APIs must be added to ["},{"kind":"code","text":"`tauri.allowlist.window`"},{"kind":"text","text":"](https://tauri.app/v1/api/config/#allowlistconfig.window) in "},{"kind":"code","text":"`tauri.conf.json`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```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        \"setMaximizable\": true,\n        \"setMinimizable\": true,\n        \"setClosable\": 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        \"setContentProtected\": 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        \"setCursorGrab\": true,\n        \"setCursorVisible\": true,\n        \"setCursorIcon\": true,\n        \"setCursorPosition\": true,\n        \"setIgnoreCursorEvents\": true,\n        \"startDragging\": true,\n        \"print\": true\n      }\n    }\n  }\n}\n```"},{"kind":"text","text":"\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 to using "},{"kind":"code","text":"`appWindow.listen`"},{"kind":"text","text":":\n"},{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nappWindow.listen(\"my-window-event\", ({ event, payload }) => { });\n```"}]},"children":[{"id":1100,"name":"UserAttentionType","variant":"declaration","kind":8,"flags":{},"comment":{"summary":[{"kind":"text","text":"Attention type to request on a window."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1101,"name":"Critical","variant":"declaration","kind":16,"flags":{},"comment":{"summary":[{"kind":"text","text":"#### 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":228,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L228"}],"type":{"type":"literal","value":1}},{"id":1102,"name":"Informational","variant":"declaration","kind":16,"flags":{},"comment":{"summary":[{"kind":"text","text":"#### 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":234,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L234"}],"type":{"type":"literal","value":2}}],"groups":[{"title":"Enumeration Members","children":[1101,1102]}],"sources":[{"fileName":"window.ts","line":222,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L222"}]},{"id":1045,"name":"CloseRequestedEvent","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"children":[{"id":1046,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"window.ts","line":2179,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2179"}],"signatures":[{"id":1047,"name":"new CloseRequestedEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"window.ts","line":2179,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2179"}],"parameters":[{"id":1048,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1160,"typeArguments":[{"type":"literal","value":null}],"name":"Event","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":1045,"name":"CloseRequestedEvent","package":"@tauri-apps/api"}}]},{"id":1052,"name":"_preventDefault","variant":"declaration","kind":1024,"flags":{"isPrivate":true},"sources":[{"fileName":"window.ts","line":2177,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2177"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1049,"name":"event","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name"}]},"sources":[{"fileName":"window.ts","line":2172,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2172"}],"type":{"type":"reference","target":73,"name":"EventName","package":"@tauri-apps/api"}},{"id":1051,"name":"id","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event identifier used to unlisten"}]},"sources":[{"fileName":"window.ts","line":2176,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2176"}],"type":{"type":"intrinsic","name":"number"}},{"id":1050,"name":"windowLabel","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The label of the window that emitted this event."}]},"sources":[{"fileName":"window.ts","line":2174,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2174"}],"type":{"type":"intrinsic","name":"string"}},{"id":1055,"name":"isPreventDefault","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":2189,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2189"}],"signatures":[{"id":1056,"name":"isPreventDefault","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"window.ts","line":2189,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2189"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1053,"name":"preventDefault","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":2185,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2185"}],"signatures":[{"id":1054,"name":"preventDefault","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"window.ts","line":2185,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2185"}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Constructors","children":[1046]},{"title":"Properties","children":[1052,1049,1051,1050]},{"title":"Methods","children":[1055,1053]}],"sources":[{"fileName":"window.ts","line":2170,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2170"}]},{"id":1081,"name":"LogicalPosition","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"A position represented in logical pixels."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1082,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"window.ts","line":166,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L166"}],"signatures":[{"id":1083,"name":"new LogicalPosition","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"window.ts","line":166,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L166"}],"parameters":[{"id":1084,"name":"x","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1085,"name":"y","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":1081,"name":"LogicalPosition","package":"@tauri-apps/api"}}]},{"id":1086,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":162,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L162"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Logical'"},{"id":1087,"name":"x","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":163,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L163"}],"type":{"type":"intrinsic","name":"number"}},{"id":1088,"name":"y","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":164,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L164"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","children":[1082]},{"title":"Properties","children":[1086,1087,1088]}],"sources":[{"fileName":"window.ts","line":161,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L161"}]},{"id":1062,"name":"LogicalSize","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"A size represented in logical pixels."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1063,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"window.ts","line":120,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L120"}],"signatures":[{"id":1064,"name":"new LogicalSize","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"window.ts","line":120,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L120"}],"parameters":[{"id":1065,"name":"width","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1066,"name":"height","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":1062,"name":"LogicalSize","package":"@tauri-apps/api"}}]},{"id":1069,"name":"height","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":118,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L118"}],"type":{"type":"intrinsic","name":"number"}},{"id":1067,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":116,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L116"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Logical'"},{"id":1068,"name":"width","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":117,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L117"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","children":[1063]},{"title":"Properties","children":[1069,1067,1068]}],"sources":[{"fileName":"window.ts","line":115,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L115"}]},{"id":1089,"name":"PhysicalPosition","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"A position represented in physical pixels."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1090,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"window.ts","line":182,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L182"}],"signatures":[{"id":1091,"name":"new PhysicalPosition","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"window.ts","line":182,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L182"}],"parameters":[{"id":1092,"name":"x","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1093,"name":"y","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":1089,"name":"PhysicalPosition","package":"@tauri-apps/api"}}]},{"id":1094,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":178,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L178"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Physical'"},{"id":1095,"name":"x","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":179,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L179"}],"type":{"type":"intrinsic","name":"number"}},{"id":1096,"name":"y","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":180,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L180"}],"type":{"type":"intrinsic","name":"number"}},{"id":1097,"name":"toLogical","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":197,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L197"}],"signatures":[{"id":1098,"name":"toLogical","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Converts the physical position to a logical one."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst factor = await appWindow.scaleFactor();\nconst position = await appWindow.innerPosition();\nconst logical = position.toLogical(factor);\n```"}]}]},"sources":[{"fileName":"window.ts","line":197,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L197"}],"parameters":[{"id":1099,"name":"scaleFactor","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":1081,"name":"LogicalPosition","package":"@tauri-apps/api"}}]}],"groups":[{"title":"Constructors","children":[1090]},{"title":"Properties","children":[1094,1095,1096]},{"title":"Methods","children":[1097]}],"sources":[{"fileName":"window.ts","line":177,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L177"}]},{"id":1070,"name":"PhysicalSize","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"A size represented in physical pixels."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1071,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"window.ts","line":136,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L136"}],"signatures":[{"id":1072,"name":"new PhysicalSize","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"window.ts","line":136,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L136"}],"parameters":[{"id":1073,"name":"width","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1074,"name":"height","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"}}]},{"id":1077,"name":"height","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":134,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L134"}],"type":{"type":"intrinsic","name":"number"}},{"id":1075,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":132,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L132"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Physical'"},{"id":1076,"name":"width","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":133,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L133"}],"type":{"type":"intrinsic","name":"number"}},{"id":1078,"name":"toLogical","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":151,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L151"}],"signatures":[{"id":1079,"name":"toLogical","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Converts the physical size to a logical one."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst factor = await appWindow.scaleFactor();\nconst size = await appWindow.innerSize();\nconst logical = size.toLogical(factor);\n```"}]}]},"sources":[{"fileName":"window.ts","line":151,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L151"}],"parameters":[{"id":1080,"name":"scaleFactor","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":1062,"name":"LogicalSize","package":"@tauri-apps/api"}}]}],"groups":[{"title":"Constructors","children":[1071]},{"title":"Properties","children":[1077,1075,1076]},{"title":"Methods","children":[1078]}],"sources":[{"fileName":"window.ts","line":131,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L131"}]},{"id":672,"name":"WebviewWindow","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create new webview windows and get a handle to existing ones.\n\nWindows are identified by a *label*  a unique identifier that can be used to reference it later.\nIt may only contain alphanumeric characters "},{"kind":"code","text":"`a-zA-Z`"},{"kind":"text","text":" plus the following special characters "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```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```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"children":[{"id":678,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"window.ts","line":2247,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2247"}],"signatures":[{"id":679,"name":"new WebviewWindow","variant":"signature","kind":16384,"flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a new WebviewWindow."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { WebviewWindow } from '@tauri-apps/api/window';\nconst webview = new WebviewWindow('my-label', {\n  url: 'https://github.com/tauri-apps/tauri'\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```"},{"kind":"text","text":"\n\n*"}]},{"tag":"@returns","content":[{"kind":"text","text":"The WebviewWindow instance to communicate with the webview."}]}]},"sources":[{"fileName":"window.ts","line":2247,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2247"}],"parameters":[{"id":680,"name":"label","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The unique webview window label. Must be alphanumeric: "},{"kind":"code","text":"`a-zA-Z-/:_`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":681,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1128,"name":"WindowOptions","package":"@tauri-apps/api"},"defaultValue":"{}"}],"type":{"type":"reference","target":672,"name":"WebviewWindow","package":"@tauri-apps/api"},"overwrites":{"type":"reference","target":-1,"name":"WindowManager.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"WindowManager.constructor"}},{"id":828,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The window label. It is a unique identifier for the window, can be used to reference it later."}]},"sources":[{"fileName":"window.ts","line":318,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L318"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.label"}},{"id":829,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Local event listeners."}]},"sources":[{"fileName":"window.ts","line":320,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L320"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"reference","target":1166,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"EventCallback","package":"@tauri-apps/api"}}],"name":"Record","package":"typescript","externalUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.listeners"}},{"id":716,"name":"center","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":926,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L926"}],"signatures":[{"id":717,"name":"center","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Centers the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.center();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":926,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L926"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.center"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.center"}},{"id":750,"name":"close","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1326,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1326"}],"signatures":[{"id":751,"name":"close","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Closes the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.close();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1326,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1326"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.close"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.close"}},{"id":840,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":430,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L430"}],"signatures":[{"id":841,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Emits an event to the backend and all Tauri windows.\nThe event will have this window's "},{"kind":"inline-tag","tag":"@link","text":"label","target":828,"tsLinkText":"label"},{"kind":"text","text":" as "},{"kind":"inline-tag","tag":"@link","text":"source window label","target":1162,"tsLinkText":"source window label"},{"kind":"text","text":"."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.emit('window-loaded', { loggedIn: true, token: 'authToken' });\n```"},{"kind":"text","text":"\n\nThis function can also be used to communicate between windows:\n"},{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.listen('sync-data', (event) => { });\n\n// on another window...\nimport { WebviewWindow } from '@tauri-apps/api/window';\nconst otherWindow = WebviewWindow.getByLabel('other')\nawait otherWindow.emit('sync-data');\n```"},{"kind":"text","text":"\n\nGlobal listeners are also triggered:\n"},{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nimport { listen } from '@tauri-apps/api/event';\nawait listen('ping', (event) => { });\n\nawait appWindow.emit('ping');\n```"}]}]},"sources":[{"fileName":"window.ts","line":430,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L430"}],"parameters":[{"id":842,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":843,"name":"payload","variant":"param","kind":32768,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Event payload."}]},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.emit"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.emit"}},{"id":748,"name":"hide","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1301,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1301"}],"signatures":[{"id":749,"name":"hide","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets the window visibility to false."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.hide();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1301,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1301"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.hide"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.hide"}},{"id":684,"name":"innerPosition","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":500,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L500"}],"signatures":[{"id":685,"name":"innerPosition","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"The position of the top-left hand corner of the window's client area relative to the top-left hand corner of the desktop."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst position = await appWindow.innerPosition();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The window's inner position."}]}]},"sources":[{"fileName":"window.ts","line":500,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L500"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1089,"name":"PhysicalPosition","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.innerPosition"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.innerPosition"}},{"id":688,"name":"innerSize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":551,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L551"}],"signatures":[{"id":689,"name":"innerSize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"The physical size of the window's client area.\nThe client area is the content of the window, excluding the title bar and borders."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst size = await appWindow.innerSize();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The window's inner size."}]}]},"sources":[{"fileName":"window.ts","line":551,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L551"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.innerSize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.innerSize"}},{"id":708,"name":"isClosable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":819,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L819"}],"signatures":[{"id":709,"name":"isClosable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window’s native close button state.\n\n#### Platform-specific\n\n- **Linux / iOS / Android:** Unsupported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst closable = await appWindow.isClosable();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window's native close button is enabled or not."}]}]},"sources":[{"fileName":"window.ts","line":819,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L819"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isClosable"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isClosable"}},{"id":700,"name":"isDecorated","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":704,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L704"}],"signatures":[{"id":701,"name":"isDecorated","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current decorated state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst decorated = await appWindow.isDecorated();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window is decorated or not."}]}]},"sources":[{"fileName":"window.ts","line":704,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L704"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isDecorated"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isDecorated"}},{"id":698,"name":"isFocused","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":679,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L679"}],"signatures":[{"id":699,"name":"isFocused","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current focus state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst focused = await appWindow.isFocused();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window is focused or not."}]},{"tag":"@since","content":[{"kind":"text","text":"1.4"}]}]},"sources":[{"fileName":"window.ts","line":679,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L679"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isFocused"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isFocused"}},{"id":692,"name":"isFullscreen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":602,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L602"}],"signatures":[{"id":693,"name":"isFullscreen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current fullscreen state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst fullscreen = await appWindow.isFullscreen();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window is in fullscreen mode or not."}]}]},"sources":[{"fileName":"window.ts","line":602,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L602"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isFullscreen"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isFullscreen"}},{"id":704,"name":"isMaximizable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":759,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L759"}],"signatures":[{"id":705,"name":"isMaximizable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window’s native maximize button state.\n\n#### Platform-specific\n\n- **Linux / iOS / Android:** Unsupported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst maximizable = await appWindow.isMaximizable();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window's native maximize button is enabled or not."}]}]},"sources":[{"fileName":"window.ts","line":759,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L759"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isMaximizable"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isMaximizable"}},{"id":696,"name":"isMaximized","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":652,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L652"}],"signatures":[{"id":697,"name":"isMaximized","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current maximized state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst maximized = await appWindow.isMaximized();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window is maximized or not."}]}]},"sources":[{"fileName":"window.ts","line":652,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L652"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isMaximized"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isMaximized"}},{"id":706,"name":"isMinimizable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":789,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L789"}],"signatures":[{"id":707,"name":"isMinimizable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window’s native minimize button state.\n\n#### Platform-specific\n\n- **Linux / iOS / Android:** Unsupported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst minimizable = await appWindow.isMinimizable();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window's native minimize button is enabled or not."}]}]},"sources":[{"fileName":"window.ts","line":789,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L789"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isMinimizable"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isMinimizable"}},{"id":694,"name":"isMinimized","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":627,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L627"}],"signatures":[{"id":695,"name":"isMinimized","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current minimized state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst minimized = await appWindow.isMinimized();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.3.0"}]}]},"sources":[{"fileName":"window.ts","line":627,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L627"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isMinimized"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isMinimized"}},{"id":702,"name":"isResizable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":729,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L729"}],"signatures":[{"id":703,"name":"isResizable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current resizable state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst resizable = await appWindow.isResizable();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window is resizable or not."}]}]},"sources":[{"fileName":"window.ts","line":729,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L729"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isResizable"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isResizable"}},{"id":710,"name":"isVisible","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":844,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L844"}],"signatures":[{"id":711,"name":"isVisible","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current visible state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst visible = await appWindow.isVisible();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"Whether the window is visible or not."}]}]},"sources":[{"fileName":"window.ts","line":844,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L844"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isVisible"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.isVisible"}},{"id":830,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":351,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L351"}],"signatures":[{"id":831,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an event emitted by the backend or webview.\nThe event must either be a global event or an event targetting this window.\n\nSee "},{"kind":"inline-tag","tag":"@link","text":"`emit`","target":840,"tsLinkText":"`emit`"},{"kind":"text","text":" for more information."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst unlisten = await appWindow.listen<string>('state-changed', (event) => {\n  console.log(`Got error: ${payload}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"},{"kind":"text","text":"\n\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event."}]}]},"sources":[{"fileName":"window.ts","line":351,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L351"}],"typeParameter":[{"id":832,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":833,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"reference","target":73,"name":"EventName","package":"@tauri-apps/api"}},{"id":834,"name":"handler","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler."}]},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.listen"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.listen"}},{"id":736,"name":"maximize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1151,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1151"}],"signatures":[{"id":737,"name":"maximize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Maximizes the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.maximize();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1151,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1151"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.maximize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.maximize"}},{"id":742,"name":"minimize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1226,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1226"}],"signatures":[{"id":743,"name":"minimize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Minimizes the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.minimize();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1226,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1226"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.minimize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.minimize"}},{"id":807,"name":"onCloseRequested","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1978,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1978"}],"signatures":[{"id":808,"name":"onCloseRequested","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to window close requested. Emitted when the user requests to closes the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nimport { confirm } from '@tauri-apps/api/dialog';\nconst unlisten = await appWindow.onCloseRequested(async (event) => {\n  const confirmed = await confirm('Are you sure?');\n  if (!confirmed) {\n    // user did not confirm closing the window; let's prevent it\n    event.preventDefault();\n  }\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"window.ts","line":1978,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1978"}],"parameters":[{"id":809,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":810,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"window.ts","line":1979,"character":13,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1979"}],"signatures":[{"id":811,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"window.ts","line":1979,"character":13,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1979"}],"parameters":[{"id":812,"name":"event","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1045,"name":"CloseRequestedEvent","package":"@tauri-apps/api"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}]}}]}}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onCloseRequested"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onCloseRequested"}},{"id":822,"name":"onFileDropEvent","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":2112,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2112"}],"signatures":[{"id":823,"name":"onFileDropEvent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to a file drop event.\nThe listener is triggered when the user hovers the selected files on the window,\ndrops the files or cancels the operation."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nconst unlisten = await appWindow.onFileDropEvent((event) => {\n if (event.payload.type === 'hover') {\n   console.log('User hovering', event.payload.paths);\n } else if (event.payload.type === 'drop') {\n   console.log('User dropped', event.payload.paths);\n } else {\n   console.log('File drop cancelled');\n }\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"window.ts","line":2112,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2112"}],"parameters":[{"id":824,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":1119,"name":"FileDropEvent","package":"@tauri-apps/api"}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onFileDropEvent"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onFileDropEvent"}},{"id":813,"name":"onFocusChanged","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":2011,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2011"}],"signatures":[{"id":814,"name":"onFocusChanged","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to window focus change."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nconst unlisten = await appWindow.onFocusChanged(({ payload: focused }) => {\n console.log('Focus changed, window is focused? ' + focused);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"window.ts","line":2011,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2011"}],"parameters":[{"id":815,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onFocusChanged"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onFocusChanged"}},{"id":819,"name":"onMenuClicked","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":2081,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2081"}],"signatures":[{"id":820,"name":"onMenuClicked","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to the window menu item click. The payload is the item id."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nconst unlisten = await appWindow.onMenuClicked(({ payload: menuId }) => {\n console.log('Menu clicked: ' + menuId);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"window.ts","line":2081,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2081"}],"parameters":[{"id":821,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onMenuClicked"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onMenuClicked"}},{"id":804,"name":"onMoved","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1946,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1946"}],"signatures":[{"id":805,"name":"onMoved","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to window move."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nconst unlisten = await appWindow.onMoved(({ payload: position }) => {\n console.log('Window moved', position);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"window.ts","line":1946,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1946"}],"parameters":[{"id":806,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":1089,"name":"PhysicalPosition","package":"@tauri-apps/api"}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onMoved"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onMoved"}},{"id":801,"name":"onResized","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1920,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1920"}],"signatures":[{"id":802,"name":"onResized","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to window resize."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nconst unlisten = await appWindow.onResized(({ payload: size }) => {\n console.log('Window resized', size);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"window.ts","line":1920,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1920"}],"parameters":[{"id":803,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onResized"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onResized"}},{"id":816,"name":"onScaleChanged","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":2053,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2053"}],"signatures":[{"id":817,"name":"onScaleChanged","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to window scale change. Emitted 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."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nconst unlisten = await appWindow.onScaleChanged(({ payload }) => {\n console.log('Scale changed', payload.scaleFactor, payload.size);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"window.ts","line":2053,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2053"}],"parameters":[{"id":818,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":1116,"name":"ScaleFactorChanged","package":"@tauri-apps/api"}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onScaleChanged"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onScaleChanged"}},{"id":825,"name":"onThemeChanged","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":2162,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2162"}],"signatures":[{"id":826,"name":"onThemeChanged","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to the system theme change."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from \"@tauri-apps/api/window\";\nconst unlisten = await appWindow.onThemeChanged(({ payload: theme }) => {\n console.log('New theme: ' + theme);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"sources":[{"fileName":"window.ts","line":2162,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2162"}],"parameters":[{"id":827,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":1109,"name":"Theme","package":"@tauri-apps/api"}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onThemeChanged"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.onThemeChanged"}},{"id":835,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":386,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L386"}],"signatures":[{"id":836,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an one-off event.\nSee "},{"kind":"inline-tag","tag":"@link","text":"`listen`","target":830,"tsLinkText":"`listen`"},{"kind":"text","text":" for more information."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst unlisten = await appWindow.once<null>('initialized', (event) => {\n  console.log(`Window initialized!`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"},{"kind":"text","text":"\n\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event."}]}]},"sources":[{"fileName":"window.ts","line":386,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L386"}],"typeParameter":[{"id":837,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":838,"name":"event","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event name. Must include only alphanumeric characters, "},{"kind":"code","text":"`-`"},{"kind":"text","text":", "},{"kind":"code","text":"`/`"},{"kind":"text","text":", "},{"kind":"code","text":"`:`"},{"kind":"text","text":" and "},{"kind":"code","text":"`_`"},{"kind":"text","text":"."}]},"type":{"type":"intrinsic","name":"string"}},{"id":839,"name":"handler","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler."}]},"type":{"type":"reference","target":1166,"typeArguments":[{"type":"reference","target":-1,"name":"T","refersToTypeParameter":true}],"name":"EventCallback","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1171,"name":"UnlistenFn","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.once"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.once"}},{"id":686,"name":"outerPosition","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":525,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L525"}],"signatures":[{"id":687,"name":"outerPosition","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst position = await appWindow.outerPosition();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The window's outer position."}]}]},"sources":[{"fileName":"window.ts","line":525,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L525"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1089,"name":"PhysicalPosition","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.outerPosition"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.outerPosition"}},{"id":690,"name":"outerSize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":577,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L577"}],"signatures":[{"id":691,"name":"outerSize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"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."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst size = await appWindow.outerSize();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The window's outer size."}]}]},"sources":[{"fileName":"window.ts","line":577,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L577"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.outerSize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.outerSize"}},{"id":718,"name":"requestUserAttention","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":962,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L962"}],"signatures":[{"id":719,"name":"requestUserAttention","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"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 "},{"kind":"code","text":"`UserAttentionType`"},{"kind":"text","text":" for details.\n\nProviding "},{"kind":"code","text":"`null`"},{"kind":"text","text":" 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:** "},{"kind":"code","text":"`null`"},{"kind":"text","text":" has no effect.\n- **Linux:** Urgency levels have the same effect."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.requestUserAttention();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":962,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L962"}],"parameters":[{"id":720,"name":"requestType","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":1100,"name":"UserAttentionType","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.requestUserAttention"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.requestUserAttention"}},{"id":682,"name":"scaleFactor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":475,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L475"}],"signatures":[{"id":683,"name":"scaleFactor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"The scale factor that can be used to map physical pixels to logical pixels."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst factor = await appWindow.scaleFactor();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The window's monitor scale factor."}]}]},"sources":[{"fileName":"window.ts","line":475,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L475"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.scaleFactor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.scaleFactor"}},{"id":755,"name":"setAlwaysOnTop","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1379,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1379"}],"signatures":[{"id":756,"name":"setAlwaysOnTop","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should always be on top of other windows."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setAlwaysOnTop(true);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1379,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1379"}],"parameters":[{"id":757,"name":"alwaysOnTop","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should always be on top of other windows or not."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setAlwaysOnTop"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setAlwaysOnTop"}},{"id":730,"name":"setClosable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1098,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1098"}],"signatures":[{"id":731,"name":"setClosable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets whether the window's native close button is enabled or not.\n\n#### Platform-specific\n\n- **Linux:** GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible\n- **iOS / Android:** Unsupported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setClosable(false);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1098,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1098"}],"parameters":[{"id":732,"name":"closable","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setClosable"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setClosable"}},{"id":758,"name":"setContentProtected","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1407,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1407"}],"signatures":[{"id":759,"name":"setContentProtected","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Prevents the window contents from being captured by other apps."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setContentProtected(true);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]},{"tag":"@since","content":[{"kind":"text","text":"1.2.0"}]}]},"sources":[{"fileName":"window.ts","line":1407,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1407"}],"parameters":[{"id":760,"name":"protected_","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setContentProtected"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setContentProtected"}},{"id":784,"name":"setCursorGrab","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1727,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1727"}],"signatures":[{"id":785,"name":"setCursorGrab","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Grabs the cursor, preventing it from leaving the window.\n\nThere's no guarantee that the cursor will be hidden. You should\nhide it by yourself if you want so.\n\n#### Platform-specific\n\n- **Linux:** Unsupported.\n- **macOS:** This locks the cursor in a fixed location, which looks visually awkward."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setCursorGrab(true);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1727,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1727"}],"parameters":[{"id":786,"name":"grab","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"code","text":"`true`"},{"kind":"text","text":" to grab the cursor icon, "},{"kind":"code","text":"`false`"},{"kind":"text","text":" to release it."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setCursorGrab"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setCursorGrab"}},{"id":790,"name":"setCursorIcon","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1787,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1787"}],"signatures":[{"id":791,"name":"setCursorIcon","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Modifies the cursor icon of the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setCursorIcon('help');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1787,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1787"}],"parameters":[{"id":792,"name":"icon","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The new cursor icon."}]},"type":{"type":"reference","target":670,"name":"CursorIcon","package":"@tauri-apps/api"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setCursorIcon"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setCursorIcon"}},{"id":793,"name":"setCursorPosition","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1814,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1814"}],"signatures":[{"id":794,"name":"setCursorPosition","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Changes the position of the cursor in window coordinates."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow, LogicalPosition } from '@tauri-apps/api/window';\nawait appWindow.setCursorPosition(new LogicalPosition(600, 300));\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1814,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1814"}],"parameters":[{"id":795,"name":"position","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The new cursor position."}]},"type":{"type":"union","types":[{"type":"reference","target":1089,"name":"PhysicalPosition","package":"@tauri-apps/api"},{"type":"reference","target":1081,"name":"LogicalPosition","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setCursorPosition"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setCursorPosition"}},{"id":787,"name":"setCursorVisible","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1760,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1760"}],"signatures":[{"id":788,"name":"setCursorVisible","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Modifies the cursor's visibility.\n\n#### Platform-specific\n\n- **Windows:** The cursor is only hidden within the confines of the window.\n- **macOS:** The cursor is hidden as long as the window has input focus, even if the cursor is\n  outside of the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setCursorVisible(false);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1760,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1760"}],"parameters":[{"id":789,"name":"visible","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"If "},{"kind":"code","text":"`false`"},{"kind":"text","text":", this will hide the cursor. If "},{"kind":"code","text":"`true`"},{"kind":"text","text":", this will show the cursor."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setCursorVisible"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setCursorVisible"}},{"id":752,"name":"setDecorations","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1352,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1352"}],"signatures":[{"id":753,"name":"setDecorations","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should have borders and bars."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setDecorations(false);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1352,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1352"}],"parameters":[{"id":754,"name":"decorations","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should have borders and bars."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setDecorations"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setDecorations"}},{"id":776,"name":"setFocus","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1625,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1625"}],"signatures":[{"id":777,"name":"setFocus","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Bring the window to front and focus."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setFocus();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1625,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1625"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setFocus"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setFocus"}},{"id":773,"name":"setFullscreen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1599,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1599"}],"signatures":[{"id":774,"name":"setFullscreen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets the window fullscreen state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setFullscreen(true);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1599,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1599"}],"parameters":[{"id":775,"name":"fullscreen","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should go to fullscreen or not."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setFullscreen"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setFullscreen"}},{"id":778,"name":"setIcon","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1658,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1658"}],"signatures":[{"id":779,"name":"setIcon","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets the window icon."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setIcon('/tauri/awesome.png');\n```"},{"kind":"text","text":"\n\nNote that you need the "},{"kind":"code","text":"`icon-ico`"},{"kind":"text","text":" or "},{"kind":"code","text":"`icon-png`"},{"kind":"text","text":" Cargo features to use this API.\nTo enable it, change your Cargo.toml file:\n"},{"kind":"code","text":"```toml\n[dependencies]\ntauri = { version = \"...\", features = [\"...\", \"icon-png\"] }\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1658,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1658"}],"parameters":[{"id":780,"name":"icon","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Icon bytes or path to the icon file."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Uint8Array"},"name":"Uint8Array","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setIcon"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setIcon"}},{"id":796,"name":"setIgnoreCursorEvents","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1858,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1858"}],"signatures":[{"id":797,"name":"setIgnoreCursorEvents","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Changes the cursor events behavior."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setIgnoreCursorEvents(true);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1858,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1858"}],"parameters":[{"id":798,"name":"ignore","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"code","text":"`true`"},{"kind":"text","text":" to ignore the cursor events; "},{"kind":"code","text":"`false`"},{"kind":"text","text":" to process them as usual."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setIgnoreCursorEvents"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setIgnoreCursorEvents"}},{"id":767,"name":"setMaxSize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1514,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1514"}],"signatures":[{"id":768,"name":"setMaxSize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets the window maximum inner size. If the "},{"kind":"code","text":"`size`"},{"kind":"text","text":" argument is undefined, the constraint is unset."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow, LogicalSize } from '@tauri-apps/api/window';\nawait appWindow.setMaxSize(new LogicalSize(600, 500));\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1514,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1514"}],"parameters":[{"id":769,"name":"size","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The logical or physical inner size, or "},{"kind":"code","text":"`null`"},{"kind":"text","text":" to unset the constraint."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"literal","value":null},{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"},{"type":"reference","target":1062,"name":"LogicalSize","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setMaxSize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setMaxSize"}},{"id":724,"name":"setMaximizable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1033,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1033"}],"signatures":[{"id":725,"name":"setMaximizable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets whether the window's native maximize button is enabled or not.\nIf resizable is set to false, this setting is ignored.\n\n#### Platform-specific\n\n- **macOS:** Disables the \"zoom\" button in the window titlebar, which is also used to enter fullscreen mode.\n- **Linux / iOS / Android:** Unsupported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setMaximizable(false);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1033,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1033"}],"parameters":[{"id":726,"name":"maximizable","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setMaximizable"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setMaximizable"}},{"id":764,"name":"setMinSize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1472,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1472"}],"signatures":[{"id":765,"name":"setMinSize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets the window minimum inner size. If the "},{"kind":"code","text":"`size`"},{"kind":"text","text":" argument is not provided, the constraint is unset."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow, PhysicalSize } from '@tauri-apps/api/window';\nawait appWindow.setMinSize(new PhysicalSize(600, 500));\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1472,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1472"}],"parameters":[{"id":766,"name":"size","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The logical or physical inner size, or "},{"kind":"code","text":"`null`"},{"kind":"text","text":" to unset the constraint."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"literal","value":null},{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"},{"type":"reference","target":1062,"name":"LogicalSize","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setMinSize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setMinSize"}},{"id":727,"name":"setMinimizable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1065,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1065"}],"signatures":[{"id":728,"name":"setMinimizable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets whether the window's native minimize button is enabled or not.\n\n#### Platform-specific\n\n- **Linux / iOS / Android:** Unsupported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setMinimizable(false);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1065,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1065"}],"parameters":[{"id":729,"name":"minimizable","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setMinimizable"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setMinimizable"}},{"id":770,"name":"setPosition","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1556,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1556"}],"signatures":[{"id":771,"name":"setPosition","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets the window outer position."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow, LogicalPosition } from '@tauri-apps/api/window';\nawait appWindow.setPosition(new LogicalPosition(600, 500));\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1556,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1556"}],"parameters":[{"id":772,"name":"position","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The new position, in logical or physical pixels."}]},"type":{"type":"union","types":[{"type":"reference","target":1089,"name":"PhysicalPosition","package":"@tauri-apps/api"},{"type":"reference","target":1081,"name":"LogicalPosition","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setPosition"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setPosition"}},{"id":721,"name":"setResizable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":999,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L999"}],"signatures":[{"id":722,"name":"setResizable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Updates the window resizable flag."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setResizable(false);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":999,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L999"}],"parameters":[{"id":723,"name":"resizable","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setResizable"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setResizable"}},{"id":761,"name":"setSize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1434,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1434"}],"signatures":[{"id":762,"name":"setSize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resizes the window with a new inner size."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow, LogicalSize } from '@tauri-apps/api/window';\nawait appWindow.setSize(new LogicalSize(600, 500));\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1434,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1434"}],"parameters":[{"id":763,"name":"size","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The logical or physical inner size."}]},"type":{"type":"union","types":[{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"},{"type":"reference","target":1062,"name":"LogicalSize","package":"@tauri-apps/api"}]}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setSize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setSize"}},{"id":781,"name":"setSkipTaskbar","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1692,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1692"}],"signatures":[{"id":782,"name":"setSkipTaskbar","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window icon should be hidden from the taskbar or not.\n\n#### Platform-specific\n\n- **macOS:** Unsupported."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setSkipTaskbar(true);\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1692,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1692"}],"parameters":[{"id":783,"name":"skip","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"true to hide window icon, false to show it."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setSkipTaskbar"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setSkipTaskbar"}},{"id":733,"name":"setTitle","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1125,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1125"}],"signatures":[{"id":734,"name":"setTitle","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets the window title."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.setTitle('Tauri');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1125,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1125"}],"parameters":[{"id":735,"name":"title","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The new title"}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setTitle"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.setTitle"}},{"id":746,"name":"show","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1276,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1276"}],"signatures":[{"id":747,"name":"show","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Sets the window visibility to true."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.show();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1276,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1276"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.show"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.show"}},{"id":799,"name":"startDragging","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1884,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1884"}],"signatures":[{"id":800,"name":"startDragging","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Starts dragging the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.startDragging();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1884,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1884"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.startDragging"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.startDragging"}},{"id":714,"name":"theme","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":899,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L899"}],"signatures":[{"id":715,"name":"theme","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current theme.\n\n#### Platform-specific\n\n- **macOS:** Theme was introduced on macOS 10.14. Returns "},{"kind":"code","text":"`light`"},{"kind":"text","text":" on macOS 10.13 and below."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst theme = await appWindow.theme();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The window theme."}]}]},"sources":[{"fileName":"window.ts","line":899,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L899"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":1109,"name":"Theme","package":"@tauri-apps/api"}]}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.theme"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.theme"}},{"id":712,"name":"title","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":869,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L869"}],"signatures":[{"id":713,"name":"title","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the window's current title."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst title = await appWindow.title();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.3.0"}]}]},"sources":[{"fileName":"window.ts","line":869,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L869"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.title"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.title"}},{"id":740,"name":"toggleMaximize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1201,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1201"}],"signatures":[{"id":741,"name":"toggleMaximize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Toggles the window maximized state."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.toggleMaximize();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1201,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1201"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.toggleMaximize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.toggleMaximize"}},{"id":738,"name":"unmaximize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1176,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1176"}],"signatures":[{"id":739,"name":"unmaximize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unmaximizes the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.unmaximize();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1176,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1176"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.unmaximize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.unmaximize"}},{"id":744,"name":"unminimize","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"window.ts","line":1251,"character":8,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1251"}],"signatures":[{"id":745,"name":"unminimize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unminimizes the window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nawait appWindow.unminimize();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise indicating the success or failure of the operation."}]}]},"sources":[{"fileName":"window.ts","line":1251,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1251"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"},"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.unminimize"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"WindowManager.unminimize"}},{"id":673,"name":"getByLabel","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"window.ts","line":2279,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2279"}],"signatures":[{"id":674,"name":"getByLabel","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the WebviewWindow for the webview associated with the given label."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { WebviewWindow } from '@tauri-apps/api/window';\nconst mainWindow = WebviewWindow.getByLabel('main');\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The WebviewWindow instance to communicate with the webview or null if the webview doesn't exist."}]}]},"sources":[{"fileName":"window.ts","line":2279,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2279"}],"parameters":[{"id":675,"name":"label","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"The webview window label."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":672,"name":"WebviewWindow","package":"@tauri-apps/api"}]}}]},{"id":676,"name":"getFocusedWindow","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"window.ts","line":2299,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2299"}],"signatures":[{"id":677,"name":"getFocusedWindow","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets the focused window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { WebviewWindow } from '@tauri-apps/api/window';\nconst focusedWindow = WebviewWindow.getFocusedWindow();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"The WebviewWindow instance to communicate with the webview or "},{"kind":"code","text":"`undefined`"},{"kind":"text","text":" if there is not any focused window."}]},{"tag":"@since","content":[{"kind":"text","text":"1.4"}]}]},"sources":[{"fileName":"window.ts","line":2299,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2299"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":672,"name":"WebviewWindow","package":"@tauri-apps/api"}]}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Constructors","children":[678]},{"title":"Properties","children":[828,829]},{"title":"Methods","children":[716,750,840,748,684,688,708,700,698,692,704,696,706,694,702,710,830,736,742,807,822,813,819,804,801,816,825,835,686,690,718,682,755,730,758,784,790,793,787,752,776,773,778,796,767,724,764,727,770,721,761,781,733,746,799,714,712,740,738,744,673,676]}],"sources":[{"fileName":"window.ts","line":2227,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2227"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager"},"name":"WindowManager","package":"@tauri-apps/api"}]},{"id":1111,"name":"Monitor","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allows you to retrieve information about a given monitor."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1112,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Human-readable name of the monitor"}]},"sources":[{"fileName":"window.ts","line":83,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L83"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"}]}},{"id":1114,"name":"position","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"the Top-left corner position of the monitor relative to the larger full screen area."}]},"sources":[{"fileName":"window.ts","line":87,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L87"}],"type":{"type":"reference","target":1089,"name":"PhysicalPosition","package":"@tauri-apps/api"}},{"id":1115,"name":"scaleFactor","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The scale factor that can be used to map physical pixels to logical pixels."}]},"sources":[{"fileName":"window.ts","line":89,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L89"}],"type":{"type":"intrinsic","name":"number"}},{"id":1113,"name":"size","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The monitor's resolution."}]},"sources":[{"fileName":"window.ts","line":85,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L85"}],"type":{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"}}],"groups":[{"title":"Properties","children":[1112,1114,1115,1113]}],"sources":[{"fileName":"window.ts","line":81,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L81"}]},{"id":1116,"name":"ScaleFactorChanged","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"The payload for the "},{"kind":"code","text":"`scaleChange`"},{"kind":"text","text":" event."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"children":[{"id":1117,"name":"scaleFactor","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The new window scale factor."}]},"sources":[{"fileName":"window.ts","line":99,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L99"}],"type":{"type":"intrinsic","name":"number"}},{"id":1118,"name":"size","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The new window size"}]},"sources":[{"fileName":"window.ts","line":101,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L101"}],"type":{"type":"reference","target":1070,"name":"PhysicalSize","package":"@tauri-apps/api"}}],"groups":[{"title":"Properties","children":[1117,1118]}],"sources":[{"fileName":"window.ts","line":97,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L97"}]},{"id":1128,"name":"WindowOptions","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Configuration for the window to create."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1154,"name":"acceptFirstMouse","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether clicking an inactive window also clicks through to the webview on macOS."}]},"sources":[{"fileName":"window.ts","line":2410,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2410"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1147,"name":"alwaysOnTop","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window should always be on top of other windows or not."}]},"sources":[{"fileName":"window.ts","line":2382,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2382"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1130,"name":"center","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Show window in the center of the screen.."}]},"sources":[{"fileName":"window.ts","line":2344,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2344"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1159,"name":"closable","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window's native close button is enabled or not. Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"window.ts","line":2433,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2433"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1148,"name":"contentProtected","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Prevents the window contents from being captured by other apps."}]},"sources":[{"fileName":"window.ts","line":2384,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2384"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1146,"name":"decorations","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window should have borders and bars or not."}]},"sources":[{"fileName":"window.ts","line":2380,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2380"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1150,"name":"fileDropEnabled","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the file drop is enabled or not on the webview. By default it is enabled.\n\nDisabling it is required to use drag and drop on the frontend on Windows."}]},"sources":[{"fileName":"window.ts","line":2392,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2392"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1142,"name":"focus","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window will be initially focused or not."}]},"sources":[{"fileName":"window.ts","line":2368,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2368"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1141,"name":"fullscreen","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window is in fullscreen mode or not."}]},"sources":[{"fileName":"window.ts","line":2366,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2366"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1134,"name":"height","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The initial height."}]},"sources":[{"fileName":"window.ts","line":2352,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2352"}],"type":{"type":"intrinsic","name":"number"}},{"id":1153,"name":"hiddenTitle","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"If "},{"kind":"code","text":"`true`"},{"kind":"text","text":", sets the window title to be hidden on macOS."}]},"sources":[{"fileName":"window.ts","line":2406,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2406"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1138,"name":"maxHeight","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The maximum height. Only applies if "},{"kind":"code","text":"`maxWidth`"},{"kind":"text","text":" is also set."}]},"sources":[{"fileName":"window.ts","line":2360,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2360"}],"type":{"type":"intrinsic","name":"number"}},{"id":1137,"name":"maxWidth","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The maximum width. Only applies if "},{"kind":"code","text":"`maxHeight`"},{"kind":"text","text":" is also set."}]},"sources":[{"fileName":"window.ts","line":2358,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2358"}],"type":{"type":"intrinsic","name":"number"}},{"id":1157,"name":"maximizable","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window's native maximize button is enabled or not. Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"window.ts","line":2425,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2425"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1144,"name":"maximized","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window should be maximized upon creation or not."}]},"sources":[{"fileName":"window.ts","line":2376,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2376"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1136,"name":"minHeight","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The minimum height. Only applies if "},{"kind":"code","text":"`minWidth`"},{"kind":"text","text":" is also set."}]},"sources":[{"fileName":"window.ts","line":2356,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2356"}],"type":{"type":"intrinsic","name":"number"}},{"id":1135,"name":"minWidth","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The minimum width. Only applies if "},{"kind":"code","text":"`minHeight`"},{"kind":"text","text":" is also set."}]},"sources":[{"fileName":"window.ts","line":2354,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2354"}],"type":{"type":"intrinsic","name":"number"}},{"id":1158,"name":"minimizable","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window's native minimize button is enabled or not. Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"window.ts","line":2429,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2429"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1139,"name":"resizable","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window is resizable or not."}]},"sources":[{"fileName":"window.ts","line":2362,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2362"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1149,"name":"skipTaskbar","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether or not the window icon should be added to the taskbar."}]},"sources":[{"fileName":"window.ts","line":2386,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2386"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1155,"name":"tabbingIdentifier","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Defines the window [tabbing identifier](https://developer.apple.com/documentation/appkit/nswindow/1644704-tabbingidentifier) on macOS.\n\nWindows with the same tabbing identifier will be grouped together.\nIf the tabbing identifier is not set, automatic tabbing will be disabled."}]},"sources":[{"fileName":"window.ts","line":2417,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2417"}],"type":{"type":"intrinsic","name":"string"}},{"id":1151,"name":"theme","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The initial window theme. Defaults to the system theme.\n\nOnly implemented on Windows and macOS 10.14+."}]},"sources":[{"fileName":"window.ts","line":2398,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2398"}],"type":{"type":"reference","target":1109,"name":"Theme","package":"@tauri-apps/api"}},{"id":1140,"name":"title","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Window title."}]},"sources":[{"fileName":"window.ts","line":2364,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2364"}],"type":{"type":"intrinsic","name":"string"}},{"id":1152,"name":"titleBarStyle","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The style of the macOS title bar."}]},"sources":[{"fileName":"window.ts","line":2402,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2402"}],"type":{"type":"reference","target":1110,"name":"TitleBarStyle","package":"@tauri-apps/api"}},{"id":1143,"name":"transparent","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window is transparent or not.\nNote that on "},{"kind":"code","text":"`macOS`"},{"kind":"text","text":" this requires the "},{"kind":"code","text":"`macos-private-api`"},{"kind":"text","text":" feature flag, enabled under "},{"kind":"code","text":"`tauri.conf.json > tauri > macOSPrivateApi`"},{"kind":"text","text":".\nWARNING: Using private APIs on "},{"kind":"code","text":"`macOS`"},{"kind":"text","text":" prevents your application from being accepted to the "},{"kind":"code","text":"`App Store`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"window.ts","line":2374,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2374"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1129,"name":"url","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Remote URL or local file path to open.\n\n- URL such as "},{"kind":"code","text":"`https://github.com/tauri-apps`"},{"kind":"text","text":" is opened directly on a Tauri window.\n- data: URL such as "},{"kind":"code","text":"`data:text/html,<html>...`"},{"kind":"text","text":" is only supported with the "},{"kind":"code","text":"`window-data-url`"},{"kind":"text","text":" Cargo feature for the "},{"kind":"code","text":"`tauri`"},{"kind":"text","text":" dependency.\n- local file path or route such as "},{"kind":"code","text":"`/path/to/page.html`"},{"kind":"text","text":" or "},{"kind":"code","text":"`/users`"},{"kind":"text","text":" is appended to the application URL (the devServer URL on development, or "},{"kind":"code","text":"`tauri://localhost/`"},{"kind":"text","text":" and "},{"kind":"code","text":"`https://tauri.localhost/`"},{"kind":"text","text":" on production)."}]},"sources":[{"fileName":"window.ts","line":2342,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2342"}],"type":{"type":"intrinsic","name":"string"}},{"id":1156,"name":"userAgent","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The user agent for the webview."}]},"sources":[{"fileName":"window.ts","line":2421,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2421"}],"type":{"type":"intrinsic","name":"string"}},{"id":1145,"name":"visible","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window should be immediately visible upon creation or not."}]},"sources":[{"fileName":"window.ts","line":2378,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2378"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1133,"name":"width","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The initial width."}]},"sources":[{"fileName":"window.ts","line":2350,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2350"}],"type":{"type":"intrinsic","name":"number"}},{"id":1131,"name":"x","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The initial vertical position. Only applies if "},{"kind":"code","text":"`y`"},{"kind":"text","text":" is also set."}]},"sources":[{"fileName":"window.ts","line":2346,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2346"}],"type":{"type":"intrinsic","name":"number"}},{"id":1132,"name":"y","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The initial horizontal position. Only applies if "},{"kind":"code","text":"`x`"},{"kind":"text","text":" is also set."}]},"sources":[{"fileName":"window.ts","line":2348,"character":2,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2348"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[1154,1147,1130,1159,1148,1146,1150,1142,1141,1134,1153,1138,1137,1157,1144,1136,1135,1158,1139,1149,1155,1151,1140,1152,1143,1129,1156,1145,1133,1131,1132]}],"sources":[{"fileName":"window.ts","line":2334,"character":10,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2334"}]},{"id":670,"name":"CursorIcon","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"window.ts","line":237,"character":12,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L237"}],"type":{"type":"union","types":[{"type":"literal","value":"default"},{"type":"literal","value":"crosshair"},{"type":"literal","value":"hand"},{"type":"literal","value":"arrow"},{"type":"literal","value":"move"},{"type":"literal","value":"text"},{"type":"literal","value":"wait"},{"type":"literal","value":"help"},{"type":"literal","value":"progress"},{"type":"literal","value":"notAllowed"},{"type":"literal","value":"contextMenu"},{"type":"literal","value":"cell"},{"type":"literal","value":"verticalText"},{"type":"literal","value":"alias"},{"type":"literal","value":"copy"},{"type":"literal","value":"noDrop"},{"type":"literal","value":"grab"},{"type":"literal","value":"grabbing"},{"type":"literal","value":"allScroll"},{"type":"literal","value":"zoomIn"},{"type":"literal","value":"zoomOut"},{"type":"literal","value":"eResize"},{"type":"literal","value":"nResize"},{"type":"literal","value":"neResize"},{"type":"literal","value":"nwResize"},{"type":"literal","value":"sResize"},{"type":"literal","value":"seResize"},{"type":"literal","value":"swResize"},{"type":"literal","value":"wResize"},{"type":"literal","value":"ewResize"},{"type":"literal","value":"nsResize"},{"type":"literal","value":"neswResize"},{"type":"literal","value":"nwseResize"},{"type":"literal","value":"colResize"},{"type":"literal","value":"rowResize"}]}},{"id":1119,"name":"FileDropEvent","variant":"declaration","kind":4194304,"flags":{},"comment":{"summary":[{"kind":"text","text":"The file drop event types."}]},"sources":[{"fileName":"window.ts","line":105,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L105"}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":1120,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":1122,"name":"paths","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":106,"character":21,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L106"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":1121,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":106,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L106"}],"type":{"type":"literal","value":"hover"}}],"groups":[{"title":"Properties","children":[1122,1121]}],"sources":[{"fileName":"window.ts","line":106,"character":4,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L106"}]}},{"type":"reflection","declaration":{"id":1123,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":1125,"name":"paths","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":107,"character":20,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L107"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":1124,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":107,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L107"}],"type":{"type":"literal","value":"drop"}}],"groups":[{"title":"Properties","children":[1125,1124]}],"sources":[{"fileName":"window.ts","line":107,"character":4,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L107"}]}},{"type":"reflection","declaration":{"id":1126,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":1127,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"window.ts","line":108,"character":6,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L108"}],"type":{"type":"literal","value":"cancel"}}],"groups":[{"title":"Properties","children":[1127]}],"sources":[{"fileName":"window.ts","line":108,"character":4,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L108"}]}}]}},{"id":1109,"name":"Theme","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"window.ts","line":73,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L73"}],"type":{"type":"union","types":[{"type":"literal","value":"light"},{"type":"literal","value":"dark"}]}},{"id":1110,"name":"TitleBarStyle","variant":"declaration","kind":4194304,"flags":{},"sources":[{"fileName":"window.ts","line":74,"character":5,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L74"}],"type":{"type":"union","types":[{"type":"literal","value":"visible"},{"type":"literal","value":"transparent"},{"type":"literal","value":"overlay"}]}},{"id":1061,"name":"appWindow","variant":"declaration","kind":32,"flags":{},"comment":{"summary":[{"kind":"text","text":"The WebviewWindow for the current window."}]},"sources":[{"fileName":"window.ts","line":2310,"character":4,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2310"}],"type":{"type":"reference","target":672,"name":"WebviewWindow","package":"@tauri-apps/api"}},{"id":1107,"name":"availableMonitors","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"window.ts","line":2515,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2515"}],"signatures":[{"id":1108,"name":"availableMonitors","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the list of all the monitors available on the system."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { availableMonitors } from '@tauri-apps/api/window';\nconst monitors = availableMonitors();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"window.ts","line":2515,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2515"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":1111,"name":"Monitor","package":"@tauri-apps/api"}}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":1103,"name":"currentMonitor","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"window.ts","line":2466,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2466"}],"signatures":[{"id":1104,"name":"currentMonitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the monitor on which the window currently resides.\nReturns "},{"kind":"code","text":"`null`"},{"kind":"text","text":" if current monitor can't be detected."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { currentMonitor } from '@tauri-apps/api/window';\nconst monitor = currentMonitor();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"window.ts","line":2466,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2466"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"reference","target":1111,"name":"Monitor","package":"@tauri-apps/api"},{"type":"literal","value":null}]}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]},{"id":1059,"name":"getAll","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"window.ts","line":295,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L295"}],"signatures":[{"id":1060,"name":"getAll","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Gets a list of instances of "},{"kind":"code","text":"`WebviewWindow`"},{"kind":"text","text":" for all available webview windows."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"window.ts","line":295,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L295"}],"type":{"type":"array","elementType":{"type":"reference","target":672,"name":"WebviewWindow","package":"@tauri-apps/api"}}}]},{"id":1057,"name":"getCurrent","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"window.ts","line":283,"character":9,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L283"}],"signatures":[{"id":1058,"name":"getCurrent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Get an instance of "},{"kind":"code","text":"`WebviewWindow`"},{"kind":"text","text":" for the current webview window."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"window.ts","line":283,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L283"}],"type":{"type":"reference","target":672,"name":"WebviewWindow","package":"@tauri-apps/api"}}]},{"id":1105,"name":"primaryMonitor","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"window.ts","line":2491,"character":15,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2491"}],"signatures":[{"id":1106,"name":"primaryMonitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the primary monitor of the system.\nReturns "},{"kind":"code","text":"`null`"},{"kind":"text","text":" if it can't identify any monitor as a primary one."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { primaryMonitor } from '@tauri-apps/api/window';\nconst monitor = primaryMonitor();\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"sources":[{"fileName":"window.ts","line":2491,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L2491"}],"type":{"type":"reference","target":{"sourceFileName":"node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"reference","target":1111,"name":"Monitor","package":"@tauri-apps/api"},{"type":"literal","value":null}]}],"name":"Promise","package":"typescript","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"}}]}],"groups":[{"title":"Enumerations","children":[1100]},{"title":"Classes","children":[1045,1081,1062,1089,1070,672]},{"title":"Interfaces","children":[1111,1116,1128]},{"title":"Type Aliases","children":[670,1119,1109,1110]},{"title":"Variables","children":[1061]},{"title":"Functions","children":[1107,1103,1059,1057,1105]}],"sources":[{"fileName":"window.ts","line":1,"character":0,"url":"https://github.com/tauri-apps/tauri/blob/076e1a81a/tooling/api/src/window.ts#L1"}]}],"groups":[{"title":"Modules","children":[1,12,24,30,72,107,206,227,332,346,359,376,452,458,629,647,669]}],"packageName":"@tauri-apps/api","symbolIdMap":{"1":{"sourceFileName":"src/app.ts","qualifiedName":""},"2":{"sourceFileName":"src/app.ts","qualifiedName":"getName"},"3":{"sourceFileName":"src/app.ts","qualifiedName":"getName"},"4":{"sourceFileName":"src/app.ts","qualifiedName":"getVersion"},"5":{"sourceFileName":"src/app.ts","qualifiedName":"getVersion"},"6":{"sourceFileName":"src/app.ts","qualifiedName":"getTauriVersion"},"7":{"sourceFileName":"src/app.ts","qualifiedName":"getTauriVersion"},"8":{"sourceFileName":"src/app.ts","qualifiedName":"show"},"9":{"sourceFileName":"src/app.ts","qualifiedName":"show"},"10":{"sourceFileName":"src/app.ts","qualifiedName":"hide"},"11":{"sourceFileName":"src/app.ts","qualifiedName":"hide"},"12":{"sourceFileName":"src/cli.ts","qualifiedName":""},"13":{"sourceFileName":"src/cli.ts","qualifiedName":"ArgMatch"},"14":{"sourceFileName":"src/cli.ts","qualifiedName":"ArgMatch.value"},"15":{"sourceFileName":"src/cli.ts","qualifiedName":"ArgMatch.occurrences"},"16":{"sourceFileName":"src/cli.ts","qualifiedName":"SubcommandMatch"},"17":{"sourceFileName":"src/cli.ts","qualifiedName":"SubcommandMatch.name"},"18":{"sourceFileName":"src/cli.ts","qualifiedName":"SubcommandMatch.matches"},"19":{"sourceFileName":"src/cli.ts","qualifiedName":"CliMatches"},"20":{"sourceFileName":"src/cli.ts","qualifiedName":"CliMatches.args"},"21":{"sourceFileName":"src/cli.ts","qualifiedName":"CliMatches.subcommand"},"22":{"sourceFileName":"src/cli.ts","qualifiedName":"getMatches"},"23":{"sourceFileName":"src/cli.ts","qualifiedName":"getMatches"},"24":{"sourceFileName":"src/clipboard.ts","qualifiedName":""},"25":{"sourceFileName":"src/clipboard.ts","qualifiedName":"writeText"},"26":{"sourceFileName":"src/clipboard.ts","qualifiedName":"writeText"},"27":{"sourceFileName":"src/clipboard.ts","qualifiedName":"text"},"28":{"sourceFileName":"src/clipboard.ts","qualifiedName":"readText"},"29":{"sourceFileName":"src/clipboard.ts","qualifiedName":"readText"},"30":{"sourceFileName":"src/dialog.ts","qualifiedName":""},"31":{"sourceFileName":"src/dialog.ts","qualifiedName":"DialogFilter"},"32":{"sourceFileName":"src/dialog.ts","qualifiedName":"DialogFilter.name"},"33":{"sourceFileName":"src/dialog.ts","qualifiedName":"DialogFilter.extensions"},"34":{"sourceFileName":"src/dialog.ts","qualifiedName":"OpenDialogOptions"},"35":{"sourceFileName":"src/dialog.ts","qualifiedName":"OpenDialogOptions.title"},"36":{"sourceFileName":"src/dialog.ts","qualifiedName":"OpenDialogOptions.filters"},"37":{"sourceFileName":"src/dialog.ts","qualifiedName":"OpenDialogOptions.defaultPath"},"38":{"sourceFileName":"src/dialog.ts","qualifiedName":"OpenDialogOptions.multiple"},"39":{"sourceFileName":"src/dialog.ts","qualifiedName":"OpenDialogOptions.directory"},"40":{"sourceFileName":"src/dialog.ts","qualifiedName":"OpenDialogOptions.recursive"},"41":{"sourceFileName":"src/dialog.ts","qualifiedName":"SaveDialogOptions"},"42":{"sourceFileName":"src/dialog.ts","qualifiedName":"SaveDialogOptions.title"},"43":{"sourceFileName":"src/dialog.ts","qualifiedName":"SaveDialogOptions.filters"},"44":{"sourceFileName":"src/dialog.ts","qualifiedName":"SaveDialogOptions.defaultPath"},"45":{"sourceFileName":"src/dialog.ts","qualifiedName":"MessageDialogOptions"},"46":{"sourceFileName":"src/dialog.ts","qualifiedName":"MessageDialogOptions.title"},"47":{"sourceFileName":"src/dialog.ts","qualifiedName":"MessageDialogOptions.type"},"48":{"sourceFileName":"src/dialog.ts","qualifiedName":"MessageDialogOptions.okLabel"},"49":{"sourceFileName":"src/dialog.ts","qualifiedName":"ConfirmDialogOptions"},"50":{"sourceFileName":"src/dialog.ts","qualifiedName":"ConfirmDialogOptions.title"},"51":{"sourceFileName":"src/dialog.ts","qualifiedName":"ConfirmDialogOptions.type"},"52":{"sourceFileName":"src/dialog.ts","qualifiedName":"ConfirmDialogOptions.okLabel"},"53":{"sourceFileName":"src/dialog.ts","qualifiedName":"ConfirmDialogOptions.cancelLabel"},"54":{"sourceFileName":"src/dialog.ts","qualifiedName":"open"},"55":{"sourceFileName":"src/dialog.ts","qualifiedName":"open"},"56":{"sourceFileName":"src/dialog.ts","qualifiedName":"options"},"57":{"sourceFileName":"src/dialog.ts","qualifiedName":"save"},"58":{"sourceFileName":"src/dialog.ts","qualifiedName":"save"},"59":{"sourceFileName":"src/dialog.ts","qualifiedName":"options"},"60":{"sourceFileName":"src/dialog.ts","qualifiedName":"message"},"61":{"sourceFileName":"src/dialog.ts","qualifiedName":"message"},"62":{"sourceFileName":"src/dialog.ts","qualifiedName":"message"},"63":{"sourceFileName":"src/dialog.ts","qualifiedName":"options"},"64":{"sourceFileName":"src/dialog.ts","qualifiedName":"ask"},"65":{"sourceFileName":"src/dialog.ts","qualifiedName":"ask"},"66":{"sourceFileName":"src/dialog.ts","qualifiedName":"message"},"67":{"sourceFileName":"src/dialog.ts","qualifiedName":"options"},"68":{"sourceFileName":"src/dialog.ts","qualifiedName":"confirm"},"69":{"sourceFileName":"src/dialog.ts","qualifiedName":"confirm"},"70":{"sourceFileName":"src/dialog.ts","qualifiedName":"message"},"71":{"sourceFileName":"src/dialog.ts","qualifiedName":"options"},"72":{"sourceFileName":"src/event.ts","qualifiedName":""},"73":{"sourceFileName":"src/event.ts","qualifiedName":"EventName"},"74":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent"},"75":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_RESIZED"},"76":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_MOVED"},"77":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_CLOSE_REQUESTED"},"78":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_CREATED"},"79":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_DESTROYED"},"80":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FOCUS"},"81":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_BLUR"},"82":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_SCALE_FACTOR_CHANGED"},"83":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_THEME_CHANGED"},"84":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP"},"85":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP_HOVER"},"86":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.WINDOW_FILE_DROP_CANCELLED"},"87":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.MENU"},"88":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.CHECK_UPDATE"},"89":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.UPDATE_AVAILABLE"},"90":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.INSTALL_UPDATE"},"91":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.STATUS_UPDATE"},"92":{"sourceFileName":"src/event.ts","qualifiedName":"TauriEvent.DOWNLOAD_PROGRESS"},"93":{"sourceFileName":"src/event.ts","qualifiedName":"listen"},"94":{"sourceFileName":"src/event.ts","qualifiedName":"listen"},"95":{"sourceFileName":"src/event.ts","qualifiedName":"T"},"96":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"97":{"sourceFileName":"src/event.ts","qualifiedName":"handler"},"98":{"sourceFileName":"src/event.ts","qualifiedName":"once"},"99":{"sourceFileName":"src/event.ts","qualifiedName":"once"},"100":{"sourceFileName":"src/event.ts","qualifiedName":"T"},"101":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"102":{"sourceFileName":"src/event.ts","qualifiedName":"handler"},"103":{"sourceFileName":"src/event.ts","qualifiedName":"emit"},"104":{"sourceFileName":"src/event.ts","qualifiedName":"emit"},"105":{"sourceFileName":"src/event.ts","qualifiedName":"event"},"106":{"sourceFileName":"src/event.ts","qualifiedName":"payload"},"107":{"sourceFileName":"src/fs.ts","qualifiedName":""},"108":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory"},"109":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Audio"},"110":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Cache"},"111":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Config"},"112":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Data"},"113":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.LocalData"},"114":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Desktop"},"115":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Document"},"116":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Download"},"117":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Executable"},"118":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Font"},"119":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Home"},"120":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Picture"},"121":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Public"},"122":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Runtime"},"123":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Template"},"124":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Video"},"125":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Resource"},"126":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.App"},"127":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Log"},"128":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.Temp"},"129":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.AppConfig"},"130":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.AppData"},"131":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.AppLocalData"},"132":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.AppCache"},"133":{"sourceFileName":"src/fs.ts","qualifiedName":"BaseDirectory.AppLog"},"134":{"sourceFileName":"src/fs.ts","qualifiedName":"FsOptions"},"135":{"sourceFileName":"src/fs.ts","qualifiedName":"FsOptions.dir"},"136":{"sourceFileName":"src/fs.ts","qualifiedName":"FsDirOptions"},"137":{"sourceFileName":"src/fs.ts","qualifiedName":"FsDirOptions.dir"},"138":{"sourceFileName":"src/fs.ts","qualifiedName":"FsDirOptions.recursive"},"139":{"sourceFileName":"src/fs.ts","qualifiedName":"FsTextFileOption"},"140":{"sourceFileName":"src/fs.ts","qualifiedName":"FsTextFileOption.path"},"141":{"sourceFileName":"src/fs.ts","qualifiedName":"FsTextFileOption.contents"},"142":{"sourceFileName":"src/fs.ts","qualifiedName":"BinaryFileContents"},"143":{"sourceFileName":"src/fs.ts","qualifiedName":"FsBinaryFileOption"},"144":{"sourceFileName":"src/fs.ts","qualifiedName":"FsBinaryFileOption.path"},"145":{"sourceFileName":"src/fs.ts","qualifiedName":"FsBinaryFileOption.contents"},"146":{"sourceFileName":"src/fs.ts","qualifiedName":"FileEntry"},"147":{"sourceFileName":"src/fs.ts","qualifiedName":"FileEntry.path"},"148":{"sourceFileName":"src/fs.ts","qualifiedName":"FileEntry.name"},"149":{"sourceFileName":"src/fs.ts","qualifiedName":"FileEntry.children"},"150":{"sourceFileName":"src/fs.ts","qualifiedName":"Dir"},"151":{"sourceFileName":"src/fs.ts","qualifiedName":"readTextFile"},"152":{"sourceFileName":"src/fs.ts","qualifiedName":"readTextFile"},"153":{"sourceFileName":"src/fs.ts","qualifiedName":"filePath"},"154":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"155":{"sourceFileName":"src/fs.ts","qualifiedName":"readBinaryFile"},"156":{"sourceFileName":"src/fs.ts","qualifiedName":"readBinaryFile"},"157":{"sourceFileName":"src/fs.ts","qualifiedName":"filePath"},"158":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"159":{"sourceFileName":"src/fs.ts","qualifiedName":"writeTextFile"},"160":{"sourceFileName":"src/fs.ts","qualifiedName":"writeTextFile"},"161":{"sourceFileName":"src/fs.ts","qualifiedName":"path"},"162":{"sourceFileName":"src/fs.ts","qualifiedName":"contents"},"163":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"164":{"sourceFileName":"src/fs.ts","qualifiedName":"writeTextFile"},"165":{"sourceFileName":"src/fs.ts","qualifiedName":"file"},"166":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"167":{"sourceFileName":"src/fs.ts","qualifiedName":"writeFile"},"168":{"sourceFileName":"src/fs.ts","qualifiedName":"writeBinaryFile"},"169":{"sourceFileName":"src/fs.ts","qualifiedName":"writeBinaryFile"},"170":{"sourceFileName":"src/fs.ts","qualifiedName":"path"},"171":{"sourceFileName":"src/fs.ts","qualifiedName":"contents"},"172":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"173":{"sourceFileName":"src/fs.ts","qualifiedName":"writeBinaryFile"},"174":{"sourceFileName":"src/fs.ts","qualifiedName":"file"},"175":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"176":{"sourceFileName":"src/fs.ts","qualifiedName":"readDir"},"177":{"sourceFileName":"src/fs.ts","qualifiedName":"readDir"},"178":{"sourceFileName":"src/fs.ts","qualifiedName":"dir"},"179":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"180":{"sourceFileName":"src/fs.ts","qualifiedName":"createDir"},"181":{"sourceFileName":"src/fs.ts","qualifiedName":"createDir"},"182":{"sourceFileName":"src/fs.ts","qualifiedName":"dir"},"183":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"184":{"sourceFileName":"src/fs.ts","qualifiedName":"removeDir"},"185":{"sourceFileName":"src/fs.ts","qualifiedName":"removeDir"},"186":{"sourceFileName":"src/fs.ts","qualifiedName":"dir"},"187":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"188":{"sourceFileName":"src/fs.ts","qualifiedName":"copyFile"},"189":{"sourceFileName":"src/fs.ts","qualifiedName":"copyFile"},"190":{"sourceFileName":"src/fs.ts","qualifiedName":"source"},"191":{"sourceFileName":"src/fs.ts","qualifiedName":"destination"},"192":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"193":{"sourceFileName":"src/fs.ts","qualifiedName":"removeFile"},"194":{"sourceFileName":"src/fs.ts","qualifiedName":"removeFile"},"195":{"sourceFileName":"src/fs.ts","qualifiedName":"file"},"196":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"197":{"sourceFileName":"src/fs.ts","qualifiedName":"renameFile"},"198":{"sourceFileName":"src/fs.ts","qualifiedName":"renameFile"},"199":{"sourceFileName":"src/fs.ts","qualifiedName":"oldPath"},"200":{"sourceFileName":"src/fs.ts","qualifiedName":"newPath"},"201":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"202":{"sourceFileName":"src/fs.ts","qualifiedName":"exists"},"203":{"sourceFileName":"src/fs.ts","qualifiedName":"exists"},"204":{"sourceFileName":"src/fs.ts","qualifiedName":"path"},"205":{"sourceFileName":"src/fs.ts","qualifiedName":"options"},"206":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":""},"207":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"ShortcutHandler"},"208":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"__type"},"209":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"__type"},"210":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"shortcut"},"211":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"register"},"212":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"register"},"213":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"shortcut"},"214":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"handler"},"215":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"registerAll"},"216":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"registerAll"},"217":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"shortcuts"},"218":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"handler"},"219":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"isRegistered"},"220":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"isRegistered"},"221":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"shortcut"},"222":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"unregister"},"223":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"unregister"},"224":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"shortcut"},"225":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"unregisterAll"},"226":{"sourceFileName":"src/globalShortcut.ts","qualifiedName":"unregisterAll"},"227":{"sourceFileName":"src/http.ts","qualifiedName":""},"228":{"sourceFileName":"src/http.ts","qualifiedName":"Duration"},"229":{"sourceFileName":"src/http.ts","qualifiedName":"Duration.secs"},"230":{"sourceFileName":"src/http.ts","qualifiedName":"Duration.nanos"},"231":{"sourceFileName":"src/http.ts","qualifiedName":"ClientOptions"},"232":{"sourceFileName":"src/http.ts","qualifiedName":"ClientOptions.maxRedirections"},"233":{"sourceFileName":"src/http.ts","qualifiedName":"ClientOptions.connectTimeout"},"234":{"sourceFileName":"src/http.ts","qualifiedName":"Part"},"235":{"sourceFileName":"src/http.ts","qualifiedName":"HttpVerb"},"236":{"sourceFileName":"src/http.ts","qualifiedName":"HttpOptions"},"237":{"sourceFileName":"src/http.ts","qualifiedName":"HttpOptions.method"},"238":{"sourceFileName":"src/http.ts","qualifiedName":"HttpOptions.url"},"239":{"sourceFileName":"src/http.ts","qualifiedName":"HttpOptions.headers"},"240":{"sourceFileName":"src/http.ts","qualifiedName":"HttpOptions.query"},"241":{"sourceFileName":"src/http.ts","qualifiedName":"HttpOptions.body"},"242":{"sourceFileName":"src/http.ts","qualifiedName":"HttpOptions.timeout"},"243":{"sourceFileName":"src/http.ts","qualifiedName":"HttpOptions.responseType"},"244":{"sourceFileName":"src/http.ts","qualifiedName":"RequestOptions"},"245":{"sourceFileName":"src/http.ts","qualifiedName":"FetchOptions"},"246":{"sourceFileName":"src/http.ts","qualifiedName":"getClient"},"247":{"sourceFileName":"src/http.ts","qualifiedName":"getClient"},"248":{"sourceFileName":"src/http.ts","qualifiedName":"options"},"249":{"sourceFileName":"src/http.ts","qualifiedName":"fetch"},"250":{"sourceFileName":"src/http.ts","qualifiedName":"fetch"},"251":{"sourceFileName":"src/http.ts","qualifiedName":"T"},"252":{"sourceFileName":"src/http.ts","qualifiedName":"url"},"253":{"sourceFileName":"src/http.ts","qualifiedName":"options"},"254":{"sourceFileName":"src/http.ts","qualifiedName":"Body"},"255":{"sourceFileName":"src/http.ts","qualifiedName":"Body.form"},"256":{"sourceFileName":"src/http.ts","qualifiedName":"Body.form"},"257":{"sourceFileName":"src/http.ts","qualifiedName":"data"},"258":{"sourceFileName":"src/http.ts","qualifiedName":"Body.json"},"259":{"sourceFileName":"src/http.ts","qualifiedName":"Body.json"},"260":{"sourceFileName":"src/http.ts","qualifiedName":"data"},"261":{"sourceFileName":"src/http.ts","qualifiedName":"Body.text"},"262":{"sourceFileName":"src/http.ts","qualifiedName":"Body.text"},"263":{"sourceFileName":"src/http.ts","qualifiedName":"value"},"264":{"sourceFileName":"src/http.ts","qualifiedName":"Body.bytes"},"265":{"sourceFileName":"src/http.ts","qualifiedName":"Body.bytes"},"266":{"sourceFileName":"src/http.ts","qualifiedName":"bytes"},"271":{"sourceFileName":"src/http.ts","qualifiedName":"Body.type"},"272":{"sourceFileName":"src/http.ts","qualifiedName":"Body.payload"},"273":{"sourceFileName":"src/http.ts","qualifiedName":"Client"},"277":{"sourceFileName":"src/http.ts","qualifiedName":"Client.id"},"278":{"sourceFileName":"src/http.ts","qualifiedName":"Client.drop"},"279":{"sourceFileName":"src/http.ts","qualifiedName":"Client.drop"},"280":{"sourceFileName":"src/http.ts","qualifiedName":"Client.request"},"281":{"sourceFileName":"src/http.ts","qualifiedName":"Client.request"},"282":{"sourceFileName":"src/http.ts","qualifiedName":"T"},"283":{"sourceFileName":"src/http.ts","qualifiedName":"options"},"284":{"sourceFileName":"src/http.ts","qualifiedName":"Client.get"},"285":{"sourceFileName":"src/http.ts","qualifiedName":"Client.get"},"286":{"sourceFileName":"src/http.ts","qualifiedName":"T"},"287":{"sourceFileName":"src/http.ts","qualifiedName":"url"},"288":{"sourceFileName":"src/http.ts","qualifiedName":"options"},"289":{"sourceFileName":"src/http.ts","qualifiedName":"Client.post"},"290":{"sourceFileName":"src/http.ts","qualifiedName":"Client.post"},"291":{"sourceFileName":"src/http.ts","qualifiedName":"T"},"292":{"sourceFileName":"src/http.ts","qualifiedName":"url"},"293":{"sourceFileName":"src/http.ts","qualifiedName":"body"},"294":{"sourceFileName":"src/http.ts","qualifiedName":"options"},"295":{"sourceFileName":"src/http.ts","qualifiedName":"Client.put"},"296":{"sourceFileName":"src/http.ts","qualifiedName":"Client.put"},"297":{"sourceFileName":"src/http.ts","qualifiedName":"T"},"298":{"sourceFileName":"src/http.ts","qualifiedName":"url"},"299":{"sourceFileName":"src/http.ts","qualifiedName":"body"},"300":{"sourceFileName":"src/http.ts","qualifiedName":"options"},"301":{"sourceFileName":"src/http.ts","qualifiedName":"Client.patch"},"302":{"sourceFileName":"src/http.ts","qualifiedName":"Client.patch"},"303":{"sourceFileName":"src/http.ts","qualifiedName":"T"},"304":{"sourceFileName":"src/http.ts","qualifiedName":"url"},"305":{"sourceFileName":"src/http.ts","qualifiedName":"options"},"306":{"sourceFileName":"src/http.ts","qualifiedName":"Client.delete"},"307":{"sourceFileName":"src/http.ts","qualifiedName":"Client.delete"},"308":{"sourceFileName":"src/http.ts","qualifiedName":"T"},"309":{"sourceFileName":"src/http.ts","qualifiedName":"url"},"310":{"sourceFileName":"src/http.ts","qualifiedName":"options"},"311":{"sourceFileName":"src/http.ts","qualifiedName":"Response"},"316":{"sourceFileName":"src/http.ts","qualifiedName":"Response.url"},"317":{"sourceFileName":"src/http.ts","qualifiedName":"Response.status"},"318":{"sourceFileName":"src/http.ts","qualifiedName":"Response.ok"},"319":{"sourceFileName":"src/http.ts","qualifiedName":"Response.headers"},"320":{"sourceFileName":"src/http.ts","qualifiedName":"Response.rawHeaders"},"321":{"sourceFileName":"src/http.ts","qualifiedName":"Response.data"},"322":{"sourceFileName":"src/http.ts","qualifiedName":"Response.T"},"323":{"sourceFileName":"src/http.ts","qualifiedName":"ResponseType"},"324":{"sourceFileName":"src/http.ts","qualifiedName":"ResponseType.JSON"},"325":{"sourceFileName":"src/http.ts","qualifiedName":"ResponseType.Text"},"326":{"sourceFileName":"src/http.ts","qualifiedName":"ResponseType.Binary"},"327":{"sourceFileName":"src/http.ts","qualifiedName":"FilePart"},"328":{"sourceFileName":"src/http.ts","qualifiedName":"FilePart.file"},"329":{"sourceFileName":"src/http.ts","qualifiedName":"FilePart.mime"},"330":{"sourceFileName":"src/http.ts","qualifiedName":"FilePart.fileName"},"331":{"sourceFileName":"src/http.ts","qualifiedName":"FilePart.T"},"332":{"sourceFileName":"src/mocks.ts","qualifiedName":""},"333":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockIPC"},"334":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockIPC"},"335":{"sourceFileName":"src/mocks.ts","qualifiedName":"cb"},"336":{"sourceFileName":"src/mocks.ts","qualifiedName":"__type"},"337":{"sourceFileName":"src/mocks.ts","qualifiedName":"__type"},"338":{"sourceFileName":"src/mocks.ts","qualifiedName":"cmd"},"339":{"sourceFileName":"src/mocks.ts","qualifiedName":"args"},"340":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockWindows"},"341":{"sourceFileName":"src/mocks.ts","qualifiedName":"mockWindows"},"342":{"sourceFileName":"src/mocks.ts","qualifiedName":"current"},"343":{"sourceFileName":"src/mocks.ts","qualifiedName":"additionalWindows"},"344":{"sourceFileName":"src/mocks.ts","qualifiedName":"clearMocks"},"345":{"sourceFileName":"src/mocks.ts","qualifiedName":"clearMocks"},"346":{"sourceFileName":"src/notification.ts","qualifiedName":""},"347":{"sourceFileName":"src/notification.ts","qualifiedName":"Options"},"348":{"sourceFileName":"src/notification.ts","qualifiedName":"Options.title"},"349":{"sourceFileName":"src/notification.ts","qualifiedName":"Options.body"},"350":{"sourceFileName":"src/notification.ts","qualifiedName":"Options.icon"},"351":{"sourceFileName":"src/notification.ts","qualifiedName":"Permission"},"352":{"sourceFileName":"src/notification.ts","qualifiedName":"sendNotification"},"353":{"sourceFileName":"src/notification.ts","qualifiedName":"sendNotification"},"354":{"sourceFileName":"src/notification.ts","qualifiedName":"options"},"355":{"sourceFileName":"src/notification.ts","qualifiedName":"requestPermission"},"356":{"sourceFileName":"src/notification.ts","qualifiedName":"requestPermission"},"357":{"sourceFileName":"src/notification.ts","qualifiedName":"isPermissionGranted"},"358":{"sourceFileName":"src/notification.ts","qualifiedName":"isPermissionGranted"},"359":{"sourceFileName":"src/os.ts","qualifiedName":""},"360":{"sourceFileName":"src/os.ts","qualifiedName":"EOL"},"361":{"sourceFileName":"src/os.ts","qualifiedName":"platform"},"362":{"sourceFileName":"src/os.ts","qualifiedName":"platform"},"363":{"sourceFileName":"src/os.ts","qualifiedName":"version"},"364":{"sourceFileName":"src/os.ts","qualifiedName":"version"},"365":{"sourceFileName":"src/os.ts","qualifiedName":"type"},"366":{"sourceFileName":"src/os.ts","qualifiedName":"type"},"367":{"sourceFileName":"src/os.ts","qualifiedName":"arch"},"368":{"sourceFileName":"src/os.ts","qualifiedName":"arch"},"369":{"sourceFileName":"src/os.ts","qualifiedName":"tempdir"},"370":{"sourceFileName":"src/os.ts","qualifiedName":"tempdir"},"371":{"sourceFileName":"src/os.ts","qualifiedName":"locale"},"372":{"sourceFileName":"src/os.ts","qualifiedName":"locale"},"373":{"sourceFileName":"src/os.ts","qualifiedName":"Platform"},"374":{"sourceFileName":"src/os.ts","qualifiedName":"OsType"},"375":{"sourceFileName":"src/os.ts","qualifiedName":"Arch"},"376":{"sourceFileName":"src/path.ts","qualifiedName":""},"377":{"sourceFileName":"src/path.ts","qualifiedName":"appDir"},"378":{"sourceFileName":"src/path.ts","qualifiedName":"appDir"},"379":{"sourceFileName":"src/path.ts","qualifiedName":"appConfigDir"},"380":{"sourceFileName":"src/path.ts","qualifiedName":"appConfigDir"},"381":{"sourceFileName":"src/path.ts","qualifiedName":"appDataDir"},"382":{"sourceFileName":"src/path.ts","qualifiedName":"appDataDir"},"383":{"sourceFileName":"src/path.ts","qualifiedName":"appLocalDataDir"},"384":{"sourceFileName":"src/path.ts","qualifiedName":"appLocalDataDir"},"385":{"sourceFileName":"src/path.ts","qualifiedName":"appCacheDir"},"386":{"sourceFileName":"src/path.ts","qualifiedName":"appCacheDir"},"387":{"sourceFileName":"src/path.ts","qualifiedName":"appLogDir"},"388":{"sourceFileName":"src/path.ts","qualifiedName":"appLogDir"},"389":{"sourceFileName":"src/path.ts","qualifiedName":"audioDir"},"390":{"sourceFileName":"src/path.ts","qualifiedName":"audioDir"},"391":{"sourceFileName":"src/path.ts","qualifiedName":"cacheDir"},"392":{"sourceFileName":"src/path.ts","qualifiedName":"cacheDir"},"393":{"sourceFileName":"src/path.ts","qualifiedName":"configDir"},"394":{"sourceFileName":"src/path.ts","qualifiedName":"configDir"},"395":{"sourceFileName":"src/path.ts","qualifiedName":"dataDir"},"396":{"sourceFileName":"src/path.ts","qualifiedName":"dataDir"},"397":{"sourceFileName":"src/path.ts","qualifiedName":"desktopDir"},"398":{"sourceFileName":"src/path.ts","qualifiedName":"desktopDir"},"399":{"sourceFileName":"src/path.ts","qualifiedName":"documentDir"},"400":{"sourceFileName":"src/path.ts","qualifiedName":"documentDir"},"401":{"sourceFileName":"src/path.ts","qualifiedName":"downloadDir"},"402":{"sourceFileName":"src/path.ts","qualifiedName":"downloadDir"},"403":{"sourceFileName":"src/path.ts","qualifiedName":"executableDir"},"404":{"sourceFileName":"src/path.ts","qualifiedName":"executableDir"},"405":{"sourceFileName":"src/path.ts","qualifiedName":"fontDir"},"406":{"sourceFileName":"src/path.ts","qualifiedName":"fontDir"},"407":{"sourceFileName":"src/path.ts","qualifiedName":"homeDir"},"408":{"sourceFileName":"src/path.ts","qualifiedName":"homeDir"},"409":{"sourceFileName":"src/path.ts","qualifiedName":"localDataDir"},"410":{"sourceFileName":"src/path.ts","qualifiedName":"localDataDir"},"411":{"sourceFileName":"src/path.ts","qualifiedName":"pictureDir"},"412":{"sourceFileName":"src/path.ts","qualifiedName":"pictureDir"},"413":{"sourceFileName":"src/path.ts","qualifiedName":"publicDir"},"414":{"sourceFileName":"src/path.ts","qualifiedName":"publicDir"},"415":{"sourceFileName":"src/path.ts","qualifiedName":"resourceDir"},"416":{"sourceFileName":"src/path.ts","qualifiedName":"resourceDir"},"417":{"sourceFileName":"src/path.ts","qualifiedName":"resolveResource"},"418":{"sourceFileName":"src/path.ts","qualifiedName":"resolveResource"},"419":{"sourceFileName":"src/path.ts","qualifiedName":"resourcePath"},"420":{"sourceFileName":"src/path.ts","qualifiedName":"runtimeDir"},"421":{"sourceFileName":"src/path.ts","qualifiedName":"runtimeDir"},"422":{"sourceFileName":"src/path.ts","qualifiedName":"templateDir"},"423":{"sourceFileName":"src/path.ts","qualifiedName":"templateDir"},"424":{"sourceFileName":"src/path.ts","qualifiedName":"videoDir"},"425":{"sourceFileName":"src/path.ts","qualifiedName":"videoDir"},"426":{"sourceFileName":"src/path.ts","qualifiedName":"logDir"},"427":{"sourceFileName":"src/path.ts","qualifiedName":"logDir"},"428":{"sourceFileName":"src/path.ts","qualifiedName":"sep"},"429":{"sourceFileName":"src/path.ts","qualifiedName":"delimiter"},"430":{"sourceFileName":"src/path.ts","qualifiedName":"resolve"},"431":{"sourceFileName":"src/path.ts","qualifiedName":"resolve"},"432":{"sourceFileName":"src/path.ts","qualifiedName":"paths"},"433":{"sourceFileName":"src/path.ts","qualifiedName":"normalize"},"434":{"sourceFileName":"src/path.ts","qualifiedName":"normalize"},"435":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"436":{"sourceFileName":"src/path.ts","qualifiedName":"join"},"437":{"sourceFileName":"src/path.ts","qualifiedName":"join"},"438":{"sourceFileName":"src/path.ts","qualifiedName":"paths"},"439":{"sourceFileName":"src/path.ts","qualifiedName":"dirname"},"440":{"sourceFileName":"src/path.ts","qualifiedName":"dirname"},"441":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"442":{"sourceFileName":"src/path.ts","qualifiedName":"extname"},"443":{"sourceFileName":"src/path.ts","qualifiedName":"extname"},"444":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"445":{"sourceFileName":"src/path.ts","qualifiedName":"basename"},"446":{"sourceFileName":"src/path.ts","qualifiedName":"basename"},"447":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"448":{"sourceFileName":"src/path.ts","qualifiedName":"ext"},"449":{"sourceFileName":"src/path.ts","qualifiedName":"isAbsolute"},"450":{"sourceFileName":"src/path.ts","qualifiedName":"isAbsolute"},"451":{"sourceFileName":"src/path.ts","qualifiedName":"path"},"452":{"sourceFileName":"src/process.ts","qualifiedName":""},"453":{"sourceFileName":"src/process.ts","qualifiedName":"exit"},"454":{"sourceFileName":"src/process.ts","qualifiedName":"exit"},"455":{"sourceFileName":"src/process.ts","qualifiedName":"exitCode"},"456":{"sourceFileName":"src/process.ts","qualifiedName":"relaunch"},"457":{"sourceFileName":"src/process.ts","qualifiedName":"relaunch"},"458":{"sourceFileName":"src/shell.ts","qualifiedName":""},"459":{"sourceFileName":"src/shell.ts","qualifiedName":"Command"},"460":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.sidecar"},"461":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.sidecar"},"462":{"sourceFileName":"src/shell.ts","qualifiedName":"program"},"463":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"464":{"sourceFileName":"src/shell.ts","qualifiedName":"options"},"465":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.__constructor"},"466":{"sourceFileName":"src/shell.ts","qualifiedName":"Command"},"467":{"sourceFileName":"src/shell.ts","qualifiedName":"program"},"468":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"469":{"sourceFileName":"src/shell.ts","qualifiedName":"options"},"473":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.stdout"},"474":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.stderr"},"475":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.spawn"},"476":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.spawn"},"477":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.execute"},"478":{"sourceFileName":"src/shell.ts","qualifiedName":"Command.execute"},"479":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.addListener"},"480":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.addListener"},"481":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"482":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"483":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"484":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"485":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"486":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.removeListener"},"487":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.removeListener"},"488":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"489":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"490":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"491":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"492":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"493":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.on"},"494":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.on"},"495":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"496":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"497":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"498":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"499":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"500":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.once"},"501":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.once"},"502":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"503":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"504":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"505":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"506":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"507":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.off"},"508":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.off"},"509":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"510":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"511":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"512":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"513":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"514":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.removeAllListeners"},"515":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.removeAllListeners"},"516":{"sourceFileName":"src/shell.ts","qualifiedName":"event"},"521":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.listenerCount"},"522":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.listenerCount"},"523":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"524":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.prependListener"},"525":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.prependListener"},"526":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"527":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"528":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"529":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"530":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"531":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.prependOnceListener"},"532":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.prependOnceListener"},"533":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"534":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"535":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"536":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"537":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"538":{"sourceFileName":"src/shell.ts","qualifiedName":"Child"},"539":{"sourceFileName":"src/shell.ts","qualifiedName":"Child.__constructor"},"540":{"sourceFileName":"src/shell.ts","qualifiedName":"Child"},"541":{"sourceFileName":"src/shell.ts","qualifiedName":"pid"},"542":{"sourceFileName":"src/shell.ts","qualifiedName":"Child.pid"},"543":{"sourceFileName":"src/shell.ts","qualifiedName":"Child.write"},"544":{"sourceFileName":"src/shell.ts","qualifiedName":"Child.write"},"545":{"sourceFileName":"src/shell.ts","qualifiedName":"data"},"546":{"sourceFileName":"src/shell.ts","qualifiedName":"Child.kill"},"547":{"sourceFileName":"src/shell.ts","qualifiedName":"Child.kill"},"548":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter"},"551":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.E"},"556":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.addListener"},"557":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.addListener"},"558":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"559":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"560":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"561":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"562":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"563":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.removeListener"},"564":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.removeListener"},"565":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"566":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"567":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"568":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"569":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"570":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.on"},"571":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.on"},"572":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"573":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"574":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"575":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"576":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"577":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.once"},"578":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.once"},"579":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"580":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"581":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"582":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"583":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"584":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.off"},"585":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.off"},"586":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"587":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"588":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"589":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"590":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"591":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.removeAllListeners"},"592":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.removeAllListeners"},"593":{"sourceFileName":"src/shell.ts","qualifiedName":"event"},"598":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.listenerCount"},"599":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.listenerCount"},"600":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"601":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.prependListener"},"602":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.prependListener"},"603":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"604":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"605":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"606":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"607":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"608":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.prependOnceListener"},"609":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.prependOnceListener"},"610":{"sourceFileName":"src/shell.ts","qualifiedName":"eventName"},"611":{"sourceFileName":"src/shell.ts","qualifiedName":"listener"},"612":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"613":{"sourceFileName":"src/shell.ts","qualifiedName":"__type"},"614":{"sourceFileName":"src/shell.ts","qualifiedName":"args"},"615":{"sourceFileName":"src/shell.ts","qualifiedName":"EventEmitter.E"},"616":{"sourceFileName":"src/shell.ts","qualifiedName":"open"},"617":{"sourceFileName":"src/shell.ts","qualifiedName":"open"},"618":{"sourceFileName":"src/shell.ts","qualifiedName":"path"},"619":{"sourceFileName":"src/shell.ts","qualifiedName":"openWith"},"620":{"sourceFileName":"src/shell.ts","qualifiedName":"ChildProcess"},"621":{"sourceFileName":"src/shell.ts","qualifiedName":"ChildProcess.code"},"622":{"sourceFileName":"src/shell.ts","qualifiedName":"ChildProcess.signal"},"623":{"sourceFileName":"src/shell.ts","qualifiedName":"ChildProcess.stdout"},"624":{"sourceFileName":"src/shell.ts","qualifiedName":"ChildProcess.stderr"},"625":{"sourceFileName":"src/shell.ts","qualifiedName":"SpawnOptions"},"626":{"sourceFileName":"src/shell.ts","qualifiedName":"SpawnOptions.cwd"},"627":{"sourceFileName":"src/shell.ts","qualifiedName":"SpawnOptions.env"},"628":{"sourceFileName":"src/shell.ts","qualifiedName":"SpawnOptions.encoding"},"629":{"sourceFileName":"src/tauri.ts","qualifiedName":""},"630":{"sourceFileName":"src/tauri.ts","qualifiedName":"InvokeArgs"},"631":{"sourceFileName":"src/tauri.ts","qualifiedName":"transformCallback"},"632":{"sourceFileName":"src/tauri.ts","qualifiedName":"transformCallback"},"633":{"sourceFileName":"src/tauri.ts","qualifiedName":"callback"},"634":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"635":{"sourceFileName":"src/tauri.ts","qualifiedName":"__type"},"636":{"sourceFileName":"src/tauri.ts","qualifiedName":"response"},"637":{"sourceFileName":"src/tauri.ts","qualifiedName":"once"},"638":{"sourceFileName":"src/tauri.ts","qualifiedName":"invoke"},"639":{"sourceFileName":"src/tauri.ts","qualifiedName":"invoke"},"640":{"sourceFileName":"src/tauri.ts","qualifiedName":"T"},"641":{"sourceFileName":"src/tauri.ts","qualifiedName":"cmd"},"642":{"sourceFileName":"src/tauri.ts","qualifiedName":"args"},"643":{"sourceFileName":"src/tauri.ts","qualifiedName":"convertFileSrc"},"644":{"sourceFileName":"src/tauri.ts","qualifiedName":"convertFileSrc"},"645":{"sourceFileName":"src/tauri.ts","qualifiedName":"filePath"},"646":{"sourceFileName":"src/tauri.ts","qualifiedName":"protocol"},"647":{"sourceFileName":"src/updater.ts","qualifiedName":""},"648":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateStatus"},"649":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateStatusResult"},"650":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateStatusResult.error"},"651":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateStatusResult.status"},"652":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateManifest"},"653":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateManifest.version"},"654":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateManifest.date"},"655":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateManifest.body"},"656":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateResult"},"657":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateResult.manifest"},"658":{"sourceFileName":"src/updater.ts","qualifiedName":"UpdateResult.shouldUpdate"},"659":{"sourceFileName":"src/updater.ts","qualifiedName":"onUpdaterEvent"},"660":{"sourceFileName":"src/updater.ts","qualifiedName":"onUpdaterEvent"},"661":{"sourceFileName":"src/updater.ts","qualifiedName":"handler"},"662":{"sourceFileName":"src/updater.ts","qualifiedName":"__type"},"663":{"sourceFileName":"src/updater.ts","qualifiedName":"__type"},"664":{"sourceFileName":"src/updater.ts","qualifiedName":"status"},"665":{"sourceFileName":"src/updater.ts","qualifiedName":"installUpdate"},"666":{"sourceFileName":"src/updater.ts","qualifiedName":"installUpdate"},"667":{"sourceFileName":"src/updater.ts","qualifiedName":"checkUpdate"},"668":{"sourceFileName":"src/updater.ts","qualifiedName":"checkUpdate"},"669":{"sourceFileName":"src/window.ts","qualifiedName":""},"670":{"sourceFileName":"src/window.ts","qualifiedName":"CursorIcon"},"672":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindow"},"673":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindow.getByLabel"},"674":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindow.getByLabel"},"675":{"sourceFileName":"src/window.ts","qualifiedName":"label"},"676":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindow.getFocusedWindow"},"677":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindow.getFocusedWindow"},"678":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindow.__constructor"},"679":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindow"},"680":{"sourceFileName":"src/window.ts","qualifiedName":"label"},"681":{"sourceFileName":"src/window.ts","qualifiedName":"options"},"682":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.scaleFactor"},"683":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.scaleFactor"},"684":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.innerPosition"},"685":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.innerPosition"},"686":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.outerPosition"},"687":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.outerPosition"},"688":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.innerSize"},"689":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.innerSize"},"690":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.outerSize"},"691":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.outerSize"},"692":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isFullscreen"},"693":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isFullscreen"},"694":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isMinimized"},"695":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isMinimized"},"696":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isMaximized"},"697":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isMaximized"},"698":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isFocused"},"699":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isFocused"},"700":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isDecorated"},"701":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isDecorated"},"702":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isResizable"},"703":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isResizable"},"704":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isMaximizable"},"705":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isMaximizable"},"706":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isMinimizable"},"707":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isMinimizable"},"708":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isClosable"},"709":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isClosable"},"710":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isVisible"},"711":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.isVisible"},"712":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.title"},"713":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.title"},"714":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.theme"},"715":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.theme"},"716":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.center"},"717":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.center"},"718":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.requestUserAttention"},"719":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.requestUserAttention"},"720":{"sourceFileName":"src/window.ts","qualifiedName":"requestType"},"721":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setResizable"},"722":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setResizable"},"723":{"sourceFileName":"src/window.ts","qualifiedName":"resizable"},"724":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setMaximizable"},"725":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setMaximizable"},"726":{"sourceFileName":"src/window.ts","qualifiedName":"maximizable"},"727":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setMinimizable"},"728":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setMinimizable"},"729":{"sourceFileName":"src/window.ts","qualifiedName":"minimizable"},"730":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setClosable"},"731":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setClosable"},"732":{"sourceFileName":"src/window.ts","qualifiedName":"closable"},"733":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setTitle"},"734":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setTitle"},"735":{"sourceFileName":"src/window.ts","qualifiedName":"title"},"736":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.maximize"},"737":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.maximize"},"738":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.unmaximize"},"739":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.unmaximize"},"740":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.toggleMaximize"},"741":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.toggleMaximize"},"742":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.minimize"},"743":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.minimize"},"744":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.unminimize"},"745":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.unminimize"},"746":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.show"},"747":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.show"},"748":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.hide"},"749":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.hide"},"750":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.close"},"751":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.close"},"752":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setDecorations"},"753":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setDecorations"},"754":{"sourceFileName":"src/window.ts","qualifiedName":"decorations"},"755":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setAlwaysOnTop"},"756":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setAlwaysOnTop"},"757":{"sourceFileName":"src/window.ts","qualifiedName":"alwaysOnTop"},"758":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setContentProtected"},"759":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setContentProtected"},"760":{"sourceFileName":"src/window.ts","qualifiedName":"protected_"},"761":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setSize"},"762":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setSize"},"763":{"sourceFileName":"src/window.ts","qualifiedName":"size"},"764":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setMinSize"},"765":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setMinSize"},"766":{"sourceFileName":"src/window.ts","qualifiedName":"size"},"767":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setMaxSize"},"768":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setMaxSize"},"769":{"sourceFileName":"src/window.ts","qualifiedName":"size"},"770":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setPosition"},"771":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setPosition"},"772":{"sourceFileName":"src/window.ts","qualifiedName":"position"},"773":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setFullscreen"},"774":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setFullscreen"},"775":{"sourceFileName":"src/window.ts","qualifiedName":"fullscreen"},"776":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setFocus"},"777":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setFocus"},"778":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setIcon"},"779":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setIcon"},"780":{"sourceFileName":"src/window.ts","qualifiedName":"icon"},"781":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setSkipTaskbar"},"782":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setSkipTaskbar"},"783":{"sourceFileName":"src/window.ts","qualifiedName":"skip"},"784":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setCursorGrab"},"785":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setCursorGrab"},"786":{"sourceFileName":"src/window.ts","qualifiedName":"grab"},"787":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setCursorVisible"},"788":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setCursorVisible"},"789":{"sourceFileName":"src/window.ts","qualifiedName":"visible"},"790":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setCursorIcon"},"791":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setCursorIcon"},"792":{"sourceFileName":"src/window.ts","qualifiedName":"icon"},"793":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setCursorPosition"},"794":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setCursorPosition"},"795":{"sourceFileName":"src/window.ts","qualifiedName":"position"},"796":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setIgnoreCursorEvents"},"797":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.setIgnoreCursorEvents"},"798":{"sourceFileName":"src/window.ts","qualifiedName":"ignore"},"799":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.startDragging"},"800":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.startDragging"},"801":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onResized"},"802":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onResized"},"803":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"804":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onMoved"},"805":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onMoved"},"806":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"807":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onCloseRequested"},"808":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onCloseRequested"},"809":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"810":{"sourceFileName":"src/window.ts","qualifiedName":"__type"},"811":{"sourceFileName":"src/window.ts","qualifiedName":"__type"},"812":{"sourceFileName":"src/window.ts","qualifiedName":"event"},"813":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onFocusChanged"},"814":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onFocusChanged"},"815":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"816":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onScaleChanged"},"817":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onScaleChanged"},"818":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"819":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onMenuClicked"},"820":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onMenuClicked"},"821":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"822":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onFileDropEvent"},"823":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onFileDropEvent"},"824":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"825":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onThemeChanged"},"826":{"sourceFileName":"src/window.ts","qualifiedName":"WindowManager.onThemeChanged"},"827":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"828":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindowHandle.label"},"829":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindowHandle.listeners"},"830":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindowHandle.listen"},"831":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindowHandle.listen"},"832":{"sourceFileName":"src/window.ts","qualifiedName":"T"},"833":{"sourceFileName":"src/window.ts","qualifiedName":"event"},"834":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"835":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindowHandle.once"},"836":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindowHandle.once"},"837":{"sourceFileName":"src/window.ts","qualifiedName":"T"},"838":{"sourceFileName":"src/window.ts","qualifiedName":"event"},"839":{"sourceFileName":"src/window.ts","qualifiedName":"handler"},"840":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindowHandle.emit"},"841":{"sourceFileName":"src/window.ts","qualifiedName":"WebviewWindowHandle.emit"},"842":{"sourceFileName":"src/window.ts","qualifiedName":"event"},"843":{"sourceFileName":"src/window.ts","qualifiedName":"payload"},"1045":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent"},"1046":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent.__constructor"},"1047":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent"},"1048":{"sourceFileName":"src/window.ts","qualifiedName":"event"},"1049":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent.event"},"1050":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent.windowLabel"},"1051":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent.id"},"1052":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent._preventDefault"},"1053":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent.preventDefault"},"1054":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent.preventDefault"},"1055":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent.isPreventDefault"},"1056":{"sourceFileName":"src/window.ts","qualifiedName":"CloseRequestedEvent.isPreventDefault"},"1057":{"sourceFileName":"src/window.ts","qualifiedName":"getCurrent"},"1058":{"sourceFileName":"src/window.ts","qualifiedName":"getCurrent"},"1059":{"sourceFileName":"src/window.ts","qualifiedName":"getAll"},"1060":{"sourceFileName":"src/window.ts","qualifiedName":"getAll"},"1061":{"sourceFileName":"src/window.ts","qualifiedName":"appWindow"},"1062":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalSize"},"1063":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalSize.__constructor"},"1064":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalSize"},"1065":{"sourceFileName":"src/window.ts","qualifiedName":"width"},"1066":{"sourceFileName":"src/window.ts","qualifiedName":"height"},"1067":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalSize.type"},"1068":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalSize.width"},"1069":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalSize.height"},"1070":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalSize"},"1071":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalSize.__constructor"},"1072":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalSize"},"1073":{"sourceFileName":"src/window.ts","qualifiedName":"width"},"1074":{"sourceFileName":"src/window.ts","qualifiedName":"height"},"1075":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalSize.type"},"1076":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalSize.width"},"1077":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalSize.height"},"1078":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalSize.toLogical"},"1079":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalSize.toLogical"},"1080":{"sourceFileName":"src/window.ts","qualifiedName":"scaleFactor"},"1081":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalPosition"},"1082":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalPosition.__constructor"},"1083":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalPosition"},"1084":{"sourceFileName":"src/window.ts","qualifiedName":"x"},"1085":{"sourceFileName":"src/window.ts","qualifiedName":"y"},"1086":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalPosition.type"},"1087":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalPosition.x"},"1088":{"sourceFileName":"src/window.ts","qualifiedName":"LogicalPosition.y"},"1089":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalPosition"},"1090":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalPosition.__constructor"},"1091":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalPosition"},"1092":{"sourceFileName":"src/window.ts","qualifiedName":"x"},"1093":{"sourceFileName":"src/window.ts","qualifiedName":"y"},"1094":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalPosition.type"},"1095":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalPosition.x"},"1096":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalPosition.y"},"1097":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalPosition.toLogical"},"1098":{"sourceFileName":"src/window.ts","qualifiedName":"PhysicalPosition.toLogical"},"1099":{"sourceFileName":"src/window.ts","qualifiedName":"scaleFactor"},"1100":{"sourceFileName":"src/window.ts","qualifiedName":"UserAttentionType"},"1101":{"sourceFileName":"src/window.ts","qualifiedName":"UserAttentionType.Critical"},"1102":{"sourceFileName":"src/window.ts","qualifiedName":"UserAttentionType.Informational"},"1103":{"sourceFileName":"src/window.ts","qualifiedName":"currentMonitor"},"1104":{"sourceFileName":"src/window.ts","qualifiedName":"currentMonitor"},"1105":{"sourceFileName":"src/window.ts","qualifiedName":"primaryMonitor"},"1106":{"sourceFileName":"src/window.ts","qualifiedName":"primaryMonitor"},"1107":{"sourceFileName":"src/window.ts","qualifiedName":"availableMonitors"},"1108":{"sourceFileName":"src/window.ts","qualifiedName":"availableMonitors"},"1109":{"sourceFileName":"src/window.ts","qualifiedName":"Theme"},"1110":{"sourceFileName":"src/window.ts","qualifiedName":"TitleBarStyle"},"1111":{"sourceFileName":"src/window.ts","qualifiedName":"Monitor"},"1112":{"sourceFileName":"src/window.ts","qualifiedName":"Monitor.name"},"1113":{"sourceFileName":"src/window.ts","qualifiedName":"Monitor.size"},"1114":{"sourceFileName":"src/window.ts","qualifiedName":"Monitor.position"},"1115":{"sourceFileName":"src/window.ts","qualifiedName":"Monitor.scaleFactor"},"1116":{"sourceFileName":"src/window.ts","qualifiedName":"ScaleFactorChanged"},"1117":{"sourceFileName":"src/window.ts","qualifiedName":"ScaleFactorChanged.scaleFactor"},"1118":{"sourceFileName":"src/window.ts","qualifiedName":"ScaleFactorChanged.size"},"1119":{"sourceFileName":"src/window.ts","qualifiedName":"FileDropEvent"},"1120":{"sourceFileName":"src/window.ts","qualifiedName":"__type"},"1121":{"sourceFileName":"src/window.ts","qualifiedName":"__type.type"},"1122":{"sourceFileName":"src/window.ts","qualifiedName":"__type.paths"},"1123":{"sourceFileName":"src/window.ts","qualifiedName":"__type"},"1124":{"sourceFileName":"src/window.ts","qualifiedName":"__type.type"},"1125":{"sourceFileName":"src/window.ts","qualifiedName":"__type.paths"},"1126":{"sourceFileName":"src/window.ts","qualifiedName":"__type"},"1127":{"sourceFileName":"src/window.ts","qualifiedName":"__type.type"},"1128":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions"},"1129":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.url"},"1130":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.center"},"1131":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.x"},"1132":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.y"},"1133":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.width"},"1134":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.height"},"1135":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.minWidth"},"1136":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.minHeight"},"1137":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.maxWidth"},"1138":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.maxHeight"},"1139":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.resizable"},"1140":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.title"},"1141":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.fullscreen"},"1142":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.focus"},"1143":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.transparent"},"1144":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.maximized"},"1145":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.visible"},"1146":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.decorations"},"1147":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.alwaysOnTop"},"1148":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.contentProtected"},"1149":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.skipTaskbar"},"1150":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.fileDropEnabled"},"1151":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.theme"},"1152":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.titleBarStyle"},"1153":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.hiddenTitle"},"1154":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.acceptFirstMouse"},"1155":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.tabbingIdentifier"},"1156":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.userAgent"},"1157":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.maximizable"},"1158":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.minimizable"},"1159":{"sourceFileName":"src/window.ts","qualifiedName":"WindowOptions.closable"},"1160":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"Event"},"1161":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"Event.event"},"1162":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"Event.windowLabel"},"1163":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"Event.id"},"1164":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"Event.payload"},"1165":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"Event.T"},"1166":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"EventCallback"},"1167":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"__type"},"1168":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"__type"},"1169":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"event"},"1170":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"T"},"1171":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"UnlistenFn"},"1172":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"__type"},"1173":{"sourceFileName":"src/helpers/event.ts","qualifiedName":"__type"},"1174":{"sourceFileName":"src/path.ts","qualifiedName":"BaseDirectory"}}}