diff --git a/.github/workflows/check-generated-files.yml b/.github/workflows/check-generated-files.yml index f2954e2c1a4c..b5524783b437 100644 --- a/.github/workflows/check-generated-files.yml +++ b/.github/workflows/check-generated-files.yml @@ -9,6 +9,7 @@ on: paths: - '.github/workflows/check-generated-files.yml' - 'tooling/api/src/**' + - 'tooling/api/docs/js-api.json' - 'core/tauri/scripts/bundle.global.js' - 'core/tauri-utils/src/config.rs' - 'tooling/cli/schema.json' @@ -17,6 +18,7 @@ on: paths: - '.github/workflows/check-generated-files.yml' - 'tooling/api/src/**' + - 'tooling/api/docs/js-api.json' - 'core/tauri/scripts/bundle.global.js' - 'core/tauri-utils/src/config.rs' - 'tooling/cli/schema.json' @@ -30,33 +32,34 @@ jobs: changes: runs-on: ubuntu-latest outputs: - bundle: ${{ steps.filter.outputs.bundle }} + api: ${{ steps.filter.outputs.api }} schema: ${{ steps.filter.outputs.schema }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: dorny/paths-filter@v2 id: filter with: filters: | - bundle: + api: - 'tooling/api/src/**' + - 'tooling/api/docs/js-api.json' - 'core/tauri/scripts/bundle.global.js' schema: - 'core/tauri-utils/src/config.rs' - 'tooling/cli/schema.json' - 'core/config-schema/schema.json' - check-bundle: + check-api: runs-on: ubuntu-latest needs: changes - if: needs.changes.outputs.bundle == 'true' + if: needs.changes.outputs.api == 'true' steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - - name: generate bundle + - name: build api working-directory: tooling/api run: yarn && yarn build - - name: check bundle + - name: check api run: ./.scripts/ci/has-diff.sh check-schema: @@ -64,7 +67,7 @@ jobs: needs: changes if: needs.changes.outputs.schema == 'true' steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: install stable uses: actions-rs/toolchain@v1 diff --git a/.prettierignore b/.prettierignore index 1381127fbe4d..86c1e514da66 100644 --- a/.prettierignore +++ b/.prettierignore @@ -9,4 +9,5 @@ dist /tooling/cli/templates /tooling/cli/node /tooling/cli/schema.json +/tooling/api/docs/js-api.json /core/config-schema/schema.json diff --git a/tooling/api/.gitignore b/tooling/api/.gitignore index e77e5b1c3571..99b0d35f79ae 100644 --- a/tooling/api/.gitignore +++ b/tooling/api/.gitignore @@ -64,4 +64,5 @@ package-lock.json .vscode/settings.json # Documentation output -docs \ No newline at end of file +docs/* +!docs/js-api.json diff --git a/tooling/api/docs/js-api.json b/tooling/api/docs/js-api.json new file mode 100644 index 000000000000..9a7f3d397335 --- /dev/null +++ b/tooling/api/docs/js-api.json @@ -0,0 +1 @@ +{"id":0,"name":"@tauri-apps/api","kind":1,"flags":{},"originalName":"","children":[{"id":1,"name":"app","kind":2,"kindString":"Module","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","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"app.ts","line":60,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/app.ts#L60"}],"signatures":[{"id":3,"name":"getName","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":6,"name":"getTauriVersion","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"app.ts","line":80,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/app.ts#L80"}],"signatures":[{"id":7,"name":"getTauriVersion","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":4,"name":"getVersion","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"app.ts","line":41,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/app.ts#L41"}],"signatures":[{"id":5,"name":"getVersion","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":10,"name":"hide","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"app.ts","line":120,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/app.ts#L120"}],"signatures":[{"id":11,"name":"hide","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":8,"name":"show","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"app.ts","line":100,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/app.ts#L100"}],"signatures":[{"id":9,"name":"show","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Functions","children":[2,6,4,10,8]}],"sources":[{"fileName":"app.ts","line":29,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/app.ts#L29"}]},{"id":12,"name":"cli","kind":2,"kindString":"Module","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","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":15,"name":"occurrences","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Number of occurrences"}]},"sources":[{"fileName":"cli.ts","line":27,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L27"}],"type":{"type":"intrinsic","name":"number"}},{"id":14,"name":"value","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L17"}]},{"id":19,"name":"CliMatches","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":20,"name":"args","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"cli.ts","line":42,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L42"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","id":13,"name":"ArgMatch"}],"name":"Record","qualifiedName":"Record","package":"typescript"}},{"id":21,"name":"subcommand","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"cli.ts","line":43,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L43"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":16,"name":"SubcommandMatch"}]}}],"groups":[{"title":"Properties","children":[20,21]}],"sources":[{"fileName":"cli.ts","line":41,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L41"}]},{"id":16,"name":"SubcommandMatch","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":18,"name":"matches","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"cli.ts","line":35,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L35"}],"type":{"type":"reference","id":19,"name":"CliMatches"}},{"id":17,"name":"name","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"cli.ts","line":34,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L33"}]},{"id":22,"name":"getMatches","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"cli.ts","line":66,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L66"}],"signatures":[{"id":23,"name":"getMatches","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":19,"name":"CliMatches"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Interfaces","children":[13,19,16]},{"title":"Functions","children":[22]}],"sources":[{"fileName":"cli.ts","line":12,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/cli.ts#L12"}]},{"id":24,"name":"clipboard","kind":2,"kindString":"Module","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","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"clipboard.ts","line":63,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/clipboard.ts#L63"}],"signatures":[{"id":29,"name":"readText","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":25,"name":"writeText","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"clipboard.ts","line":44,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/clipboard.ts#L44"}],"signatures":[{"id":26,"name":"writeText","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":27,"name":"text","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Functions","children":[28,25]}],"sources":[{"fileName":"clipboard.ts","line":29,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/clipboard.ts#L29"}]},{"id":30,"name":"dialog","kind":2,"kindString":"Module","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","kind":256,"kindString":"Interface","flags":{},"children":[{"id":53,"name":"cancelLabel","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L112"}],"type":{"type":"intrinsic","name":"string"}},{"id":52,"name":"okLabel","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L110"}],"type":{"type":"intrinsic","name":"string"}},{"id":50,"name":"title","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L106"}],"type":{"type":"intrinsic","name":"string"}},{"id":51,"name":"type","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L104"}]},{"id":31,"name":"DialogFilter","kind":256,"kindString":"Interface","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","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L48"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":32,"name":"name","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Filter name."}]},"sources":[{"fileName":"dialog.ts","line":40,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L38"}]},{"id":45,"name":"MessageDialogOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":48,"name":"okLabel","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L101"}],"type":{"type":"intrinsic","name":"string"}},{"id":46,"name":"title","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L97"}],"type":{"type":"intrinsic","name":"string"}},{"id":47,"name":"type","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L95"}]},{"id":34,"name":"OpenDialogOptions","kind":256,"kindString":"Interface","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","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L62"}],"type":{"type":"intrinsic","name":"string"}},{"id":39,"name":"directory","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L66"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":36,"name":"filters","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L60"}],"type":{"type":"array","elementType":{"type":"reference","id":31,"name":"DialogFilter"}}},{"id":38,"name":"multiple","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L64"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":40,"name":"recursive","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L71"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":35,"name":"title","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L56"}]},{"id":41,"name":"SaveDialogOptions","kind":256,"kindString":"Interface","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","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L89"}],"type":{"type":"intrinsic","name":"string"}},{"id":43,"name":"filters","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L83"}],"type":{"type":"array","elementType":{"type":"reference","id":31,"name":"DialogFilter"}}},{"id":42,"name":"title","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L79"}]},{"id":64,"name":"ask","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":271,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L271"}],"signatures":[{"id":65,"name":"ask","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":66,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The message to show."}]},"type":{"type":"intrinsic","name":"string"}},{"id":67,"name":"options","kind":32768,"kindString":"Parameter","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","id":49,"name":"ConfirmDialogOptions"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":68,"name":"confirm","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":307,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L307"}],"signatures":[{"id":69,"name":"confirm","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":70,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The message to show."}]},"type":{"type":"intrinsic","name":"string"}},{"id":71,"name":"options","kind":32768,"kindString":"Parameter","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","id":49,"name":"ConfirmDialogOptions"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":60,"name":"message","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":238,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L238"}],"signatures":[{"id":61,"name":"message","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":62,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The message to show."}]},"type":{"type":"intrinsic","name":"string"}},{"id":63,"name":"options","kind":32768,"kindString":"Parameter","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","id":45,"name":"MessageDialogOptions"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":54,"name":"open","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":167,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L167"}],"signatures":[{"id":55,"name":"open","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":56,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":34,"name":"OpenDialogOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":57,"name":"save","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"dialog.ts","line":207,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L207"}],"signatures":[{"id":58,"name":"save","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":59,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":41,"name":"SaveDialogOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Interfaces","children":[49,31,45,34,41]},{"title":"Functions","children":[64,68,60,54,57]}],"sources":[{"fileName":"dialog.ts","line":31,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/dialog.ts#L31"}]},{"id":72,"name":"event","kind":2,"kindString":"Module","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","kind":8,"kindString":"Enumeration","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"children":[{"id":88,"name":"CHECK_UPDATE","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":34,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L34"}],"type":{"type":"literal","value":"tauri://update"}},{"id":92,"name":"DOWNLOAD_PROGRESS","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":38,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L38"}],"type":{"type":"literal","value":"tauri://update-download-progress"}},{"id":90,"name":"INSTALL_UPDATE","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":36,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L36"}],"type":{"type":"literal","value":"tauri://update-install"}},{"id":87,"name":"MENU","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":33,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L33"}],"type":{"type":"literal","value":"tauri://menu"}},{"id":91,"name":"STATUS_UPDATE","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":37,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L37"}],"type":{"type":"literal","value":"tauri://update-status"}},{"id":89,"name":"UPDATE_AVAILABLE","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":35,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L35"}],"type":{"type":"literal","value":"tauri://update-available"}},{"id":81,"name":"WINDOW_BLUR","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":27,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L27"}],"type":{"type":"literal","value":"tauri://blur"}},{"id":77,"name":"WINDOW_CLOSE_REQUESTED","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":23,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L23"}],"type":{"type":"literal","value":"tauri://close-requested"}},{"id":78,"name":"WINDOW_CREATED","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":24,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L24"}],"type":{"type":"literal","value":"tauri://window-created"}},{"id":79,"name":"WINDOW_DESTROYED","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":25,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L25"}],"type":{"type":"literal","value":"tauri://destroyed"}},{"id":84,"name":"WINDOW_FILE_DROP","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":30,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L30"}],"type":{"type":"literal","value":"tauri://file-drop"}},{"id":86,"name":"WINDOW_FILE_DROP_CANCELLED","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":32,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L32"}],"type":{"type":"literal","value":"tauri://file-drop-cancelled"}},{"id":85,"name":"WINDOW_FILE_DROP_HOVER","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":31,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L31"}],"type":{"type":"literal","value":"tauri://file-drop-hover"}},{"id":80,"name":"WINDOW_FOCUS","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":26,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L26"}],"type":{"type":"literal","value":"tauri://focus"}},{"id":76,"name":"WINDOW_MOVED","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":22,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L22"}],"type":{"type":"literal","value":"tauri://move"}},{"id":75,"name":"WINDOW_RESIZED","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":21,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L21"}],"type":{"type":"literal","value":"tauri://resize"}},{"id":82,"name":"WINDOW_SCALE_FACTOR_CHANGED","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":28,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L28"}],"type":{"type":"literal","value":"tauri://scale-change"}},{"id":83,"name":"WINDOW_THEME_CHANGED","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"event.ts","line":29,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L20"}]},{"id":1120,"name":"Event","kind":256,"kindString":"Interface","flags":{},"children":[{"id":1121,"name":"event","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Event name"}]},"sources":[{"fileName":"helpers/event.ts","line":12,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L12"}],"type":{"type":"intrinsic","name":"string"}},{"id":1123,"name":"id","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Event identifier used to unlisten"}]},"sources":[{"fileName":"helpers/event.ts","line":16,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L16"}],"type":{"type":"intrinsic","name":"number"}},{"id":1124,"name":"payload","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Event payload"}]},"sources":[{"fileName":"helpers/event.ts","line":18,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L18"}],"type":{"type":"reference","id":1125,"name":"T"}},{"id":1122,"name":"windowLabel","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L14"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[1121,1123,1124,1122]}],"sources":[{"fileName":"helpers/event.ts","line":10,"character":17,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L10"}],"typeParameters":[{"id":1125,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}]},{"id":1126,"name":"EventCallback","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"helpers/event.ts","line":21,"character":12,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L21"}],"typeParameters":[{"id":1130,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"type":{"type":"reflection","declaration":{"id":1127,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"helpers/event.ts","line":21,"character":31,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L21"}],"signatures":[{"id":1128,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":1129,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1120,"typeArguments":[{"type":"reference","id":1130,"name":"T"}],"name":"Event"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":73,"name":"EventName","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"event.ts","line":15,"character":12,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L15"}],"type":{"type":"union","types":[{"type":"reference","id":74,"name":"TauriEvent"},{"type":"intrinsic","name":"string"}]}},{"id":1131,"name":"UnlistenFn","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"helpers/event.ts","line":23,"character":12,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L23"}],"type":{"type":"reflection","declaration":{"id":1132,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"helpers/event.ts","line":23,"character":25,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/helpers/event.ts#L23"}],"signatures":[{"id":1133,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":103,"name":"emit","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"event.ts","line":112,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L112"}],"signatures":[{"id":104,"name":"emit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Emits an event to the backend."}],"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"}]}]},"parameters":[{"id":105,"name":"event","kind":32768,"kindString":"Parameter","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","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":93,"name":"listen","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"event.ts","line":62,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L62"}],"signatures":[{"id":94,"name":"listen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an event from the backend."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { listen } from '@tauri-apps/api/event';\nconst unlisten = await listen('error', (event) => {\n console.log(`Got error in window ${event.windowLabel}, payload: ${event.payload}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"typeParameter":[{"id":95,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":96,"name":"event","kind":32768,"kindString":"Parameter","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":97,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler callback."}]},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":95,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":98,"name":"once","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"event.ts","line":93,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L93"}],"signatures":[{"id":99,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an one-off event from the backend."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { once } from '@tauri-apps/api/event';\ninterface LoadedPayload {\n loggedIn: boolean,\n token: string\n}\nconst unlisten = await once('loaded', (event) => {\n console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);\n});\n\n// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted\nunlisten();\n```"}]},{"tag":"@returns","content":[{"kind":"text","text":"A promise resolving to a function to unlisten to the event.\nNote that removing the listener is required if your listener goes out of scope e.g. the component is unmounted."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"typeParameter":[{"id":100,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":101,"name":"event","kind":32768,"kindString":"Parameter","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":102,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":100,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Enumerations","children":[74]},{"title":"Interfaces","children":[1120]},{"title":"Type Aliases","children":[1126,73,1131]},{"title":"Functions","children":[103,93,98]}],"sources":[{"fileName":"event.ts","line":12,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/event.ts#L12"}]},{"id":107,"name":"fs","kind":2,"kindString":"Module","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":379},{"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":379},{"kind":"text","text":".\nThe available variables are:\n"},{"kind":"inline-tag","tag":"@link","text":"`$APPCONFIG`","target":377},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$APPDATA`","target":379},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$APPLOCALDATA`","target":381},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$APPCACHE`","target":383},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$APPLOG`","target":385},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$AUDIO`","target":387},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$CACHE`","target":389},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$CONFIG`","target":391},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$DATA`","target":393},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$LOCALDATA`","target":407},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$DESKTOP`","target":395},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$DOCUMENT`","target":397},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$DOWNLOAD`","target":399},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$EXE`","target":401},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$FONT`","target":403},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$HOME`","target":405},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$PICTURE`","target":409},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$PUBLIC`","target":411},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$RUNTIME`","target":418},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$TEMPLATE`","target":420},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$VIDEO`","target":422},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$RESOURCE`","target":413},{"kind":"text","text":", "},{"kind":"inline-tag","tag":"@link","text":"`$APP`","target":375},{"kind":"text","text":",\n"},{"kind":"inline-tag","tag":"@link","text":"`$LOG`","target":424},{"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","kind":8388608,"kindString":"Reference","flags":{},"sources":[{"fileName":"fs.ts","line":593,"character":19,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L593"}],"target":108},{"id":167,"name":"writeFile","kind":8388608,"kindString":"Reference","flags":{},"sources":[{"fileName":"fs.ts","line":597,"character":19,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L597"}],"target":159},{"id":108,"name":"BaseDirectory","kind":8,"kindString":"Enumeration","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":126,"name":"App","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":98,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L98"}],"type":{"type":"literal","value":18}},{"id":132,"name":"AppCache","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":104,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L104"}],"type":{"type":"literal","value":24}},{"id":129,"name":"AppConfig","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":101,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L101"}],"type":{"type":"literal","value":21}},{"id":130,"name":"AppData","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":102,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L102"}],"type":{"type":"literal","value":22}},{"id":131,"name":"AppLocalData","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":103,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L103"}],"type":{"type":"literal","value":23}},{"id":133,"name":"AppLog","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":105,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L105"}],"type":{"type":"literal","value":25}},{"id":109,"name":"Audio","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":81,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L81"}],"type":{"type":"literal","value":1}},{"id":110,"name":"Cache","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":82,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L82"}],"type":{"type":"literal","value":2}},{"id":111,"name":"Config","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":83,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L83"}],"type":{"type":"literal","value":3}},{"id":112,"name":"Data","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":84,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L84"}],"type":{"type":"literal","value":4}},{"id":114,"name":"Desktop","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":86,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L86"}],"type":{"type":"literal","value":6}},{"id":115,"name":"Document","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":87,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L87"}],"type":{"type":"literal","value":7}},{"id":116,"name":"Download","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":88,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L88"}],"type":{"type":"literal","value":8}},{"id":117,"name":"Executable","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":89,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L89"}],"type":{"type":"literal","value":9}},{"id":118,"name":"Font","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":90,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L90"}],"type":{"type":"literal","value":10}},{"id":119,"name":"Home","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":91,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L91"}],"type":{"type":"literal","value":11}},{"id":113,"name":"LocalData","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":85,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L85"}],"type":{"type":"literal","value":5}},{"id":127,"name":"Log","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":99,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L99"}],"type":{"type":"literal","value":19}},{"id":120,"name":"Picture","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":92,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L92"}],"type":{"type":"literal","value":12}},{"id":121,"name":"Public","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":93,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L93"}],"type":{"type":"literal","value":13}},{"id":125,"name":"Resource","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":97,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L97"}],"type":{"type":"literal","value":17}},{"id":122,"name":"Runtime","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":94,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L94"}],"type":{"type":"literal","value":14}},{"id":128,"name":"Temp","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":100,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L100"}],"type":{"type":"literal","value":20}},{"id":123,"name":"Template","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":95,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L95"}],"type":{"type":"literal","value":15}},{"id":124,"name":"Video","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"fs.ts","line":96,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L80"}]},{"id":146,"name":"FileEntry","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":149,"name":"children","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L161"}],"type":{"type":"array","elementType":{"type":"reference","id":146,"name":"FileEntry"}}},{"id":148,"name":"name","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L159"}],"type":{"type":"intrinsic","name":"string"}},{"id":147,"name":"path","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"fs.ts","line":154,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L153"}]},{"id":143,"name":"FsBinaryFileOption","kind":256,"kindString":"Interface","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","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The byte array contents."}]},"sources":[{"fileName":"fs.ts","line":147,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L147"}],"type":{"type":"reference","id":142,"name":"BinaryFileContents"}},{"id":144,"name":"path","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Path to the file to write."}]},"sources":[{"fileName":"fs.ts","line":145,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L143"}]},{"id":136,"name":"FsDirOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":137,"name":"dir","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":120,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L120"}],"type":{"type":"reference","id":108,"name":"BaseDirectory"}},{"id":138,"name":"recursive","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":121,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L119"}]},{"id":134,"name":"FsOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":135,"name":"dir","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"fs.ts","line":112,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L112"}],"type":{"type":"reference","id":108,"name":"BaseDirectory"}}],"groups":[{"title":"Properties","children":[135]}],"sources":[{"fileName":"fs.ts","line":111,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L111"}]},{"id":139,"name":"FsTextFileOption","kind":256,"kindString":"Interface","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","kind":1024,"kindString":"Property","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L133"}],"type":{"type":"intrinsic","name":"string"}},{"id":140,"name":"path","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Path to the file to write."}]},"sources":[{"fileName":"fs.ts","line":131,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L129"}]},{"id":142,"name":"BinaryFileContents","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"fs.ts","line":136,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L136"}],"type":{"type":"union","types":[{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Iterable","qualifiedName":"Iterable","package":"typescript"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"name":"ArrayLike","qualifiedName":"ArrayLike","package":"typescript"},{"type":"reference","name":"ArrayBuffer","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer","qualifiedName":"ArrayBuffer","package":"typescript"}]}},{"id":188,"name":"copyFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":489,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L489"}],"signatures":[{"id":189,"name":"copyFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":190,"name":"source","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":191,"name":"destination","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":192,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":134,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":180,"name":"createDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":434,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L434"}],"signatures":[{"id":181,"name":"createDir","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":182,"name":"dir","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":183,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":136,"name":"FsDirOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":202,"name":"exists","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":572,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L572"}],"signatures":[{"id":203,"name":"exists","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":204,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":205,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":134,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":155,"name":"readBinaryFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":200,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L200"}],"signatures":[{"id":156,"name":"readBinaryFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":157,"name":"filePath","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":158,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":134,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"reference","name":"Uint8Array","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":176,"name":"readDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":405,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L405"}],"signatures":[{"id":177,"name":"readDir","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":178,"name":"dir","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":179,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":136,"name":"FsDirOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"reference","id":146,"name":"FileEntry"}}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":151,"name":"readTextFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":175,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L175"}],"signatures":[{"id":152,"name":"readTextFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":153,"name":"filePath","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":154,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":134,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":184,"name":"removeDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":462,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L462"}],"signatures":[{"id":185,"name":"removeDir","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":186,"name":"dir","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":187,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":136,"name":"FsDirOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":193,"name":"removeFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":518,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L518"}],"signatures":[{"id":194,"name":"removeFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":195,"name":"file","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":196,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":134,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":197,"name":"renameFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":545,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L545"}],"signatures":[{"id":198,"name":"renameFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":199,"name":"oldPath","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":200,"name":"newPath","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":201,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":134,"name":"FsOptions"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":168,"name":"writeBinaryFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":309,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L309"},{"fileName":"fs.ts","line":330,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L330"},{"fileName":"fs.ts","line":342,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L342"}],"signatures":[{"id":169,"name":"writeBinaryFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":170,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":171,"name":"contents","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":142,"name":"BinaryFileContents"}},{"id":172,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Configuration object."}]},"type":{"type":"reference","id":134,"name":"FsOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}},{"id":173,"name":"writeBinaryFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":174,"name":"file","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The object containing the file path and contents."}]},"type":{"type":"reference","id":143,"name":"FsBinaryFileOption"}},{"id":175,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Configuration object."}]},"type":{"type":"reference","id":134,"name":"FsOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":159,"name":"writeTextFile","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"fs.ts","line":227,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L227"},{"fileName":"fs.ts","line":245,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L245"},{"fileName":"fs.ts","line":257,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L257"}],"signatures":[{"id":160,"name":"writeTextFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":161,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":162,"name":"contents","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":163,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":134,"name":"FsOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}},{"id":164,"name":"writeTextFile","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":165,"name":"file","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":139,"name":"FsTextFileOption"}},{"id":166,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":134,"name":"FsOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"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":75,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/fs.ts#L75"}]},{"id":206,"name":"globalShortcut","kind":2,"kindString":"Module","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","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":29,"character":12,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/globalShortcut.ts#L29"}],"type":{"type":"reflection","declaration":{"id":208,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":29,"character":30,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/globalShortcut.ts#L29"}],"signatures":[{"id":209,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":210,"name":"shortcut","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":219,"name":"isRegistered","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":101,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/globalShortcut.ts#L101"}],"signatures":[{"id":220,"name":"isRegistered","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":221,"name":"shortcut","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":211,"name":"register","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":46,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/globalShortcut.ts#L46"}],"signatures":[{"id":212,"name":"register","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":213,"name":"shortcut","kind":32768,"kindString":"Parameter","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","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Shortcut handler callback - takes the triggered shortcut as argument"}]},"type":{"type":"reference","id":207,"name":"ShortcutHandler"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":215,"name":"registerAll","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":75,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/globalShortcut.ts#L75"}],"signatures":[{"id":216,"name":"registerAll","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":217,"name":"shortcuts","kind":32768,"kindString":"Parameter","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","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Shortcut handler callback - takes the triggered shortcut as argument"}]},"type":{"type":"reference","id":207,"name":"ShortcutHandler"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":222,"name":"unregister","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":123,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/globalShortcut.ts#L123"}],"signatures":[{"id":223,"name":"unregister","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":224,"name":"shortcut","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":225,"name":"unregisterAll","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"globalShortcut.ts","line":143,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/globalShortcut.ts#L143"}],"signatures":[{"id":226,"name":"unregisterAll","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Type Aliases","children":[207]},{"title":"Functions","children":[219,211,215,222,225]}],"sources":[{"fileName":"globalShortcut.ts","line":26,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/globalShortcut.ts#L26"}]},{"id":227,"name":"http","kind":2,"kindString":"Module","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","kind":8,"kindString":"Enumeration","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":326,"name":"Binary","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"http.ts","line":74,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L74"}],"type":{"type":"literal","value":3}},{"id":324,"name":"JSON","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"http.ts","line":72,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L72"}],"type":{"type":"literal","value":1}},{"id":325,"name":"Text","kind":16,"kindString":"Enumeration Member","flags":{},"sources":[{"fileName":"http.ts","line":73,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L71"}]},{"id":254,"name":"Body","kind":128,"kindString":"Class","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","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":95,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L95"}],"type":{"type":"intrinsic","name":"unknown"}},{"id":271,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":94,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L94"}],"type":{"type":"intrinsic","name":"string"}},{"id":264,"name":"bytes","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":221,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L221"}],"signatures":[{"id":265,"name":"bytes","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":266,"name":"bytes","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The body byte array."}]},"type":{"type":"union","types":[{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Iterable","qualifiedName":"Iterable","package":"typescript"},{"type":"reference","name":"ArrayBuffer","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer","qualifiedName":"ArrayBuffer","package":"typescript"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"name":"ArrayLike","qualifiedName":"ArrayLike","package":"typescript"}]}}],"type":{"type":"reference","id":254,"name":"Body"}}]},{"id":255,"name":"form","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":138,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L138"}],"signatures":[{"id":256,"name":"form","kind":4096,"kindString":"Call signature","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', {\n file: '/path/to/file',\n mime: 'image/jpeg',\n fileName: 'image.jpg'\n});\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."}]}]},"parameters":[{"id":257,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The body data."}]},"type":{"type":"union","types":[{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","id":234,"name":"Part"}],"name":"Record","qualifiedName":"Record","package":"typescript"},{"type":"reference","name":"FormData","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/API/FormData","qualifiedName":"FormData","package":"typescript"}]}}],"type":{"type":"reference","id":254,"name":"Body"}}]},{"id":258,"name":"json","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":189,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L189"}],"signatures":[{"id":259,"name":"json","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":260,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The body JSON object."}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"Record","qualifiedName":"Record","package":"typescript"}}],"type":{"type":"reference","id":254,"name":"Body"}}]},{"id":261,"name":"text","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"http.ts","line":205,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L205"}],"signatures":[{"id":262,"name":"text","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":263,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The body string."}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":254,"name":"Body"}}]}],"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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L93"}]},{"id":273,"name":"Client","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":277,"name":"id","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":307,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L307"}],"type":{"type":"intrinsic","name":"number"}},{"id":306,"name":"delete","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":488,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L488"}],"signatures":[{"id":307,"name":"delete","kind":4096,"kindString":"Call signature","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```"}]}]},"typeParameter":[{"id":308,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":309,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":310,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":244,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":311,"typeArguments":[{"type":"reference","id":308,"name":"T"}],"name":"Response"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":278,"name":"drop","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":322,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L322"}],"signatures":[{"id":279,"name":"drop","kind":4096,"kindString":"Call signature","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```"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":284,"name":"get","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":393,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L393"}],"signatures":[{"id":285,"name":"get","kind":4096,"kindString":"Call signature","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```"}]}]},"typeParameter":[{"id":286,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":287,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":288,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":244,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":311,"typeArguments":[{"type":"reference","id":286,"name":"T"}],"name":"Response"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":301,"name":"patch","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":471,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L471"}],"signatures":[{"id":302,"name":"patch","kind":4096,"kindString":"Call signature","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```"}]}]},"typeParameter":[{"id":303,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":304,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":305,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":244,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":311,"typeArguments":[{"type":"reference","id":303,"name":"T"}],"name":"Response"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":289,"name":"post","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":417,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L417"}],"signatures":[{"id":290,"name":"post","kind":4096,"kindString":"Call signature","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```"}]}]},"typeParameter":[{"id":291,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":292,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":293,"name":"body","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":254,"name":"Body"}},{"id":294,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":244,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":311,"typeArguments":[{"type":"reference","id":291,"name":"T"}],"name":"Response"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":295,"name":"put","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":447,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L447"}],"signatures":[{"id":296,"name":"put","kind":4096,"kindString":"Call signature","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```"}]}]},"typeParameter":[{"id":297,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":298,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":299,"name":"body","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":254,"name":"Body"}},{"id":300,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":244,"name":"RequestOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":311,"typeArguments":[{"type":"reference","id":297,"name":"T"}],"name":"Response"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":280,"name":"request","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"http.ts","line":344,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L344"}],"signatures":[{"id":281,"name":"request","kind":4096,"kindString":"Call signature","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```"}]}]},"typeParameter":[{"id":282,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":283,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":236,"name":"HttpOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":311,"typeArguments":[{"type":"reference","id":282,"name":"T"}],"name":"Response"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Properties","children":[277]},{"title":"Methods","children":[306,278,284,301,289,295,280]}],"sources":[{"fileName":"http.ts","line":306,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L306"}]},{"id":311,"name":"Response","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Response object."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":321,"name":"data","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The response data."}]},"sources":[{"fileName":"http.ts","line":290,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L290"}],"type":{"type":"reference","name":"T"}},{"id":319,"name":"headers","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The response headers."}]},"sources":[{"fileName":"http.ts","line":286,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L286"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","qualifiedName":"Record","package":"typescript"}},{"id":318,"name":"ok","kind":1024,"kindString":"Property","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":284,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L284"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":320,"name":"rawHeaders","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The response raw headers."}]},"sources":[{"fileName":"http.ts","line":288,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L288"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"Record","qualifiedName":"Record","package":"typescript"}},{"id":317,"name":"status","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The response status code."}]},"sources":[{"fileName":"http.ts","line":282,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L282"}],"type":{"type":"intrinsic","name":"number"}},{"id":316,"name":"url","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The request URL."}]},"sources":[{"fileName":"http.ts","line":280,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L280"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[321,319,318,320,317,316]}],"sources":[{"fileName":"http.ts","line":278,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L278"}],"typeParameters":[{"id":322,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}]},{"id":231,"name":"ClientOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":233,"name":"connectTimeout","kind":1024,"kindString":"Property","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":65,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L65"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"reference","id":228,"name":"Duration"}]}},{"id":232,"name":"maxRedirections","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":60,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L60"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[233,232]}],"sources":[{"fileName":"http.ts","line":59,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L59"}]},{"id":228,"name":"Duration","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":230,"name":"nanos","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":53,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L53"}],"type":{"type":"intrinsic","name":"number"}},{"id":229,"name":"secs","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":52,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L51"}]},{"id":327,"name":"FilePart","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":328,"name":"file","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":81,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L81"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","id":331,"name":"T"}]}},{"id":330,"name":"fileName","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":83,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L83"}],"type":{"type":"intrinsic","name":"string"}},{"id":329,"name":"mime","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":82,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L80"}],"typeParameters":[{"id":331,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}]},{"id":236,"name":"HttpOptions","kind":256,"kindString":"Interface","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","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":254,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L254"}],"type":{"type":"reference","id":254,"name":"Body"}},{"id":239,"name":"headers","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":252,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L252"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"any"}],"name":"Record","qualifiedName":"Record","package":"typescript"}},{"id":237,"name":"method","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":250,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L250"}],"type":{"type":"reference","id":235,"name":"HttpVerb"}},{"id":240,"name":"query","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":253,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L253"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"any"}],"name":"Record","qualifiedName":"Record","package":"typescript"}},{"id":243,"name":"responseType","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":256,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L256"}],"type":{"type":"reference","id":323,"name":"ResponseType"}},{"id":242,"name":"timeout","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"http.ts","line":255,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L255"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"reference","id":228,"name":"Duration"}]}},{"id":238,"name":"url","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"http.ts","line":251,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L251"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[241,239,237,240,243,242,238]}],"sources":[{"fileName":"http.ts","line":249,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L249"}]},{"id":245,"name":"FetchOptions","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Options for the "},{"kind":"code","text":"`fetch`"},{"kind":"text","text":" API."}]},"sources":[{"fileName":"http.ts","line":262,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L262"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":236,"name":"HttpOptions"},{"type":"literal","value":"url"}],"name":"Omit","qualifiedName":"Omit","package":"typescript"}},{"id":235,"name":"HttpVerb","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"The request HTTP verb."}]},"sources":[{"fileName":"http.ts","line":233,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L233"}],"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","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"http.ts","line":86,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L86"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"Uint8Array","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array","qualifiedName":"Uint8Array","package":"typescript"},{"type":"reference","id":327,"typeArguments":[{"type":"reference","name":"Uint8Array","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}],"name":"FilePart"}]}},{"id":244,"name":"RequestOptions","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Request options."}]},"sources":[{"fileName":"http.ts","line":260,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L260"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":236,"name":"HttpOptions"},{"type":"union","types":[{"type":"literal","value":"method"},{"type":"literal","value":"url"}]}],"name":"Omit","qualifiedName":"Omit","package":"typescript"}},{"id":249,"name":"fetch","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"http.ts","line":535,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L535"}],"signatures":[{"id":250,"name":"fetch","kind":4096,"kindString":"Call signature","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```"}]}]},"typeParameter":[{"id":251,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":252,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":253,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":245,"name":"FetchOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":311,"typeArguments":[{"type":"reference","id":251,"name":"T"}],"name":"Response"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":246,"name":"getClient","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"http.ts","line":511,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L511"}],"signatures":[{"id":247,"name":"getClient","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":248,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Client configuration."}]},"type":{"type":"reference","id":231,"name":"ClientOptions"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":273,"name":"Client"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"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":46,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/http.ts#L46"}]},{"id":332,"name":"mocks","kind":2,"kindString":"Module","flags":{},"children":[{"id":344,"name":"clearMocks","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"mocks.ts","line":167,"character":16,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/mocks.ts#L167"}],"signatures":[{"id":345,"name":"clearMocks","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"intrinsic","name":"void"}}]},{"id":333,"name":"mockIPC","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"mocks.ts","line":61,"character":16,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/mocks.ts#L61"}],"signatures":[{"id":334,"name":"mockIPC","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":335,"name":"cb","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":336,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"mocks.ts","line":62,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/mocks.ts#L62"}],"signatures":[{"id":337,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":338,"name":"cmd","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":339,"name":"args","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","qualifiedName":"Record","package":"typescript"}}],"type":{"type":"intrinsic","name":"any"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":340,"name":"mockWindows","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"mocks.ts","line":131,"character":16,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/mocks.ts#L131"}],"signatures":[{"id":341,"name":"mockWindows","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":342,"name":"current","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Label of window this JavaScript context is running in."}]},"type":{"type":"intrinsic","name":"string"}},{"id":343,"name":"additionalWindows","kind":32768,"kindString":"Parameter","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/mocks.ts#L1"}]},{"id":346,"name":"notification","kind":2,"kindString":"Module","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","kind":256,"kindString":"Interface","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","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Optional notification body."}]},"sources":[{"fileName":"notification.ts","line":38,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/notification.ts#L38"}],"type":{"type":"intrinsic","name":"string"}},{"id":350,"name":"icon","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Optional notification icon."}]},"sources":[{"fileName":"notification.ts","line":40,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/notification.ts#L40"}],"type":{"type":"intrinsic","name":"string"}},{"id":348,"name":"title","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Notification title."}]},"sources":[{"fileName":"notification.ts","line":36,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/notification.ts#L34"}]},{"id":351,"name":"Permission","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Possible permission values."}]},"sources":[{"fileName":"notification.ts","line":44,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"notification.ts","line":56,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/notification.ts#L56"}],"signatures":[{"id":358,"name":"isPermissionGranted","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":355,"name":"requestPermission","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"notification.ts","line":84,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/notification.ts#L84"}],"signatures":[{"id":356,"name":"requestPermission","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":351,"name":"Permission"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":352,"name":"sendNotification","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"notification.ts","line":106,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/notification.ts#L106"}],"signatures":[{"id":353,"name":"sendNotification","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":354,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","id":347,"name":"Options"}]}}],"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":27,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/notification.ts#L27"}]},{"id":359,"name":"os","kind":2,"kindString":"Module","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":373,"name":"Arch","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"os.ts","line":43,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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":372,"name":"OsType","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"os.ts","line":41,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/os.ts#L41"}],"type":{"type":"union","types":[{"type":"literal","value":"Linux"},{"type":"literal","value":"Darwin"},{"type":"literal","value":"Windows_NT"}]}},{"id":371,"name":"Platform","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"os.ts","line":29,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/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","kind":32,"kindString":"Variable","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/os.ts#L63"}],"type":{"type":"union","types":[{"type":"literal","value":"\n"},{"type":"literal","value":"\r\n"}]},"defaultValue":"..."},{"id":367,"name":"arch","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":135,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/os.ts#L135"}],"signatures":[{"id":368,"name":"arch","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":373,"name":"Arch"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":361,"name":"platform","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":77,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/os.ts#L77"}],"signatures":[{"id":362,"name":"platform","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":371,"name":"Platform"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":369,"name":"tempdir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":154,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/os.ts#L154"}],"signatures":[{"id":370,"name":"tempdir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":365,"name":"type","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":115,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/os.ts#L115"}],"signatures":[{"id":366,"name":"type","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":372,"name":"OsType"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":363,"name":"version","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"os.ts","line":96,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/os.ts#L96"}],"signatures":[{"id":364,"name":"version","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Type Aliases","children":[373,372,371]},{"title":"Variables","children":[360]},{"title":"Functions","children":[367,361,369,365,363]}],"sources":[{"fileName":"os.ts","line":26,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/os.ts#L26"}]},{"id":374,"name":"path","kind":2,"kindString":"Module","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":1134,"name":"BaseDirectory","kind":8388608,"kindString":"Reference","flags":{},"sources":[{"fileName":"path.ts","line":839,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L839"}],"target":108},{"id":427,"name":"delimiter","kind":32,"kindString":"Variable","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L660"}],"type":{"type":"union","types":[{"type":"literal","value":";"},{"type":"literal","value":":"}]},"defaultValue":"..."},{"id":426,"name":"sep","kind":32,"kindString":"Variable","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L651"}],"type":{"type":"union","types":[{"type":"literal","value":"\\"},{"type":"literal","value":"/"}]},"defaultValue":"..."},{"id":383,"name":"appCacheDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":117,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L117"}],"signatures":[{"id":384,"name":"appCacheDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":377,"name":"appConfigDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":51,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L51"}],"signatures":[{"id":378,"name":"appConfigDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":379,"name":"appDataDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":73,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L73"}],"signatures":[{"id":380,"name":"appDataDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":375,"name":"appDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":36,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L36"}],"signatures":[{"id":376,"name":"appDir","kind":4096,"kindString":"Call signature","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":377},{"kind":"text","text":" or "},{"kind":"inline-tag","tag":"@link","text":"appDataDir","target":379},{"kind":"text","text":" instead."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":381,"name":"appLocalDataDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":95,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L95"}],"signatures":[{"id":382,"name":"appLocalDataDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":385,"name":"appLogDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":633,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L633"}],"signatures":[{"id":386,"name":"appLogDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":387,"name":"audioDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":144,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L144"}],"signatures":[{"id":388,"name":"audioDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":443,"name":"basename","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":782,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L782"}],"signatures":[{"id":444,"name":"basename","kind":4096,"kindString":"Call signature","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');\n```"}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"parameters":[{"id":445,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":446,"name":"ext","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":389,"name":"cacheDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":171,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L171"}],"signatures":[{"id":390,"name":"cacheDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":391,"name":"configDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":198,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L198"}],"signatures":[{"id":392,"name":"configDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":393,"name":"dataDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":225,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L225"}],"signatures":[{"id":394,"name":"dataDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":395,"name":"desktopDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":252,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L252"}],"signatures":[{"id":396,"name":"desktopDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":437,"name":"dirname","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":736,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L736"}],"signatures":[{"id":438,"name":"dirname","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":439,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":397,"name":"documentDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":279,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L279"}],"signatures":[{"id":398,"name":"documentDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":399,"name":"downloadDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":306,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L306"}],"signatures":[{"id":400,"name":"downloadDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":401,"name":"executableDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":333,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L333"}],"signatures":[{"id":402,"name":"executableDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":440,"name":"extname","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":758,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L758"}],"signatures":[{"id":441,"name":"extname","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":442,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":403,"name":"fontDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":360,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L360"}],"signatures":[{"id":404,"name":"fontDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":405,"name":"homeDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":387,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L387"}],"signatures":[{"id":406,"name":"homeDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":447,"name":"isAbsolute","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":803,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L803"}],"signatures":[{"id":448,"name":"isAbsolute","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":449,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":434,"name":"join","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":715,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L715"}],"signatures":[{"id":435,"name":"join","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":436,"name":"paths","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":407,"name":"localDataDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":414,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L414"}],"signatures":[{"id":408,"name":"localDataDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":424,"name":"logDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":613,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L613"}],"signatures":[{"id":425,"name":"logDir","kind":4096,"kindString":"Call signature","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":385},{"kind":"text","text":" instead."}]},{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":431,"name":"normalize","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":694,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L694"}],"signatures":[{"id":432,"name":"normalize","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":433,"name":"path","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":409,"name":"pictureDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":441,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L441"}],"signatures":[{"id":410,"name":"pictureDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":411,"name":"publicDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":468,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L468"}],"signatures":[{"id":412,"name":"publicDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":428,"name":"resolve","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":673,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L673"}],"signatures":[{"id":429,"name":"resolve","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":430,"name":"paths","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":415,"name":"resolveResource","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":515,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L515"}],"signatures":[{"id":416,"name":"resolveResource","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":417,"name":"resourcePath","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":413,"name":"resourceDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":490,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L490"}],"signatures":[{"id":414,"name":"resourceDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":418,"name":"runtimeDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":542,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L542"}],"signatures":[{"id":419,"name":"runtimeDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":420,"name":"templateDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":569,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L569"}],"signatures":[{"id":421,"name":"templateDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":422,"name":"videoDir","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"path.ts","line":596,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L596"}],"signatures":[{"id":423,"name":"videoDir","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"References","children":[1134]},{"title":"Variables","children":[427,426]},{"title":"Functions","children":[383,377,379,375,381,385,387,443,389,391,393,395,437,397,399,401,440,403,405,447,434,407,424,431,409,411,428,415,413,418,420,422]}],"sources":[{"fileName":"path.ts","line":26,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/path.ts#L26"}]},{"id":450,"name":"process","kind":2,"kindString":"Module","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":451,"name":"exit","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"process.ts","line":27,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/process.ts#L27"}],"signatures":[{"id":452,"name":"exit","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":453,"name":"exitCode","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The exit code to use."}]},"type":{"type":"intrinsic","name":"number"},"defaultValue":"0"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":454,"name":"relaunch","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"process.ts","line":49,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/process.ts#L49"}],"signatures":[{"id":455,"name":"relaunch","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Functions","children":[451,454]}],"sources":[{"fileName":"process.ts","line":12,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/process.ts#L12"}]},{"id":456,"name":"shell","kind":2,"kindString":"Module","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":614},{"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":614},{"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":457},{"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":463},{"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 \"name\": \"run-git-commit\",\n \"cmd\": \"git\",\n \"args\": [\"commit\", \"-m\", { \"validator\": \"\\\\S+\" }]\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":536,"name":"Child","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.1.0"}]}]},"children":[{"id":537,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"shell.ts","line":323,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L323"}],"signatures":[{"id":538,"name":"new Child","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":539,"name":"pid","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":536,"name":"Child"}}]},{"id":540,"name":"pid","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The child process "},{"kind":"code","text":"`pid`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"shell.ts","line":321,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L321"}],"type":{"type":"intrinsic","name":"number"}},{"id":544,"name":"kill","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":359,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L359"}],"signatures":[{"id":545,"name":"kill","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":541,"name":"write","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":342,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L342"}],"signatures":[{"id":542,"name":"write","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":543,"name":"data","kind":32768,"kindString":"Parameter","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","name":"Uint8Array","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[537]},{"title":"Properties","children":[540]},{"title":"Methods","children":[544,541]}],"sources":[{"fileName":"shell.ts","line":319,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L319"}]},{"id":457,"name":"Command","kind":128,"kindString":"Class","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":463,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"shell.ts","line":411,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L411"}],"signatures":[{"id":464,"name":"new Command","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Creates a new "},{"kind":"code","text":"`Command`"},{"kind":"text","text":" instance."}]},"parameters":[{"id":465,"name":"program","kind":32768,"kindString":"Parameter","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":466,"name":"args","kind":32768,"kindString":"Parameter","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":467,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Spawn options."}]},"type":{"type":"reference","id":623,"name":"SpawnOptions"}}],"type":{"type":"reference","id":457,"name":"Command"},"overwrites":{"type":"reference","id":548,"name":"EventEmitter.constructor"}}],"overwrites":{"type":"reference","id":547,"name":"EventEmitter.constructor"}},{"id":472,"name":"stderr","kind":1024,"kindString":"Property","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":401,"character":11,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L401"}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"literal","value":"data"}],"name":"EventEmitter"},"defaultValue":"..."},{"id":471,"name":"stdout","kind":1024,"kindString":"Property","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":399,"character":11,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L399"}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"literal","value":"data"}],"name":"EventEmitter"},"defaultValue":"..."},{"id":477,"name":"addListener","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":162,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L162"}],"signatures":[{"id":478,"name":"addListener","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":479,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":480,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":481,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":162,"character":38,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L162"}],"signatures":[{"id":482,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":483,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":457,"name":"Command"},"inheritedFrom":{"type":"reference","id":555,"name":"EventEmitter.addListener"}}],"inheritedFrom":{"type":"reference","id":554,"name":"EventEmitter.addListener"}},{"id":475,"name":"execute","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":487,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L487"}],"signatures":[{"id":476,"name":"execute","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":618,"name":"ChildProcess"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":519,"name":"listenerCount","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":270,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L270"}],"signatures":[{"id":520,"name":"listenerCount","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":521,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":597,"name":"EventEmitter.listenerCount"}}],"inheritedFrom":{"type":"reference","id":596,"name":"EventEmitter.listenerCount"}},{"id":505,"name":"off","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":219,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L219"}],"signatures":[{"id":506,"name":"off","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":507,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":508,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":509,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":219,"character":30,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L219"}],"signatures":[{"id":510,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":511,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":457,"name":"Command"},"inheritedFrom":{"type":"reference","id":583,"name":"EventEmitter.off"}}],"inheritedFrom":{"type":"reference","id":582,"name":"EventEmitter.off"}},{"id":491,"name":"on","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":185,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L185"}],"signatures":[{"id":492,"name":"on","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":493,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":494,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":495,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":185,"character":29,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L185"}],"signatures":[{"id":496,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":497,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":457,"name":"Command"},"inheritedFrom":{"type":"reference","id":569,"name":"EventEmitter.on"}}],"inheritedFrom":{"type":"reference","id":568,"name":"EventEmitter.on"}},{"id":498,"name":"once","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":204,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L204"}],"signatures":[{"id":499,"name":"once","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":500,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":501,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":502,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":204,"character":31,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L204"}],"signatures":[{"id":503,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":504,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":457,"name":"Command"},"inheritedFrom":{"type":"reference","id":576,"name":"EventEmitter.once"}}],"inheritedFrom":{"type":"reference","id":575,"name":"EventEmitter.once"}},{"id":522,"name":"prependListener","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":287,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L287"}],"signatures":[{"id":523,"name":"prependListener","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":524,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":525,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":526,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":287,"character":42,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L287"}],"signatures":[{"id":527,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":528,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":457,"name":"Command"},"inheritedFrom":{"type":"reference","id":600,"name":"EventEmitter.prependListener"}}],"inheritedFrom":{"type":"reference","id":599,"name":"EventEmitter.prependListener"}},{"id":529,"name":"prependOnceListener","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":306,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L306"}],"signatures":[{"id":530,"name":"prependOnceListener","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":531,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":532,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":533,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":306,"character":46,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L306"}],"signatures":[{"id":534,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":535,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":457,"name":"Command"},"inheritedFrom":{"type":"reference","id":607,"name":"EventEmitter.prependOnceListener"}}],"inheritedFrom":{"type":"reference","id":606,"name":"EventEmitter.prependOnceListener"}},{"id":512,"name":"removeAllListeners","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":236,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L236"}],"signatures":[{"id":513,"name":"removeAllListeners","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":514,"name":"event","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}}],"type":{"type":"reference","id":457,"name":"Command"},"inheritedFrom":{"type":"reference","id":590,"name":"EventEmitter.removeAllListeners"}}],"inheritedFrom":{"type":"reference","id":589,"name":"EventEmitter.removeAllListeners"}},{"id":484,"name":"removeListener","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":171,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L171"}],"signatures":[{"id":485,"name":"removeListener","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":486,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":"error"},{"type":"literal","value":"close"}]}},{"id":487,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":488,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":171,"character":41,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L171"}],"signatures":[{"id":489,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":490,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":457,"name":"Command"},"inheritedFrom":{"type":"reference","id":562,"name":"EventEmitter.removeListener"}}],"inheritedFrom":{"type":"reference","id":561,"name":"EventEmitter.removeListener"}},{"id":473,"name":"spawn","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":449,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L449"}],"signatures":[{"id":474,"name":"spawn","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":536,"name":"Child"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":458,"name":"sidecar","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"shell.ts","line":434,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L434"}],"signatures":[{"id":459,"name":"sidecar","kind":4096,"kindString":"Call signature","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```"}]}]},"parameters":[{"id":460,"name":"program","kind":32768,"kindString":"Parameter","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":461,"name":"args","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"defaultValue":"[]"},{"id":462,"name":"options","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":623,"name":"SpawnOptions"}}],"type":{"type":"reference","id":457,"name":"Command"}}]}],"groups":[{"title":"Constructors","children":[463]},{"title":"Properties","children":[472,471]},{"title":"Methods","children":[477,475,519,505,491,498,522,529,512,484,473,458]}],"sources":[{"fileName":"shell.ts","line":391,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L391"}],"extendedTypes":[{"type":"reference","id":546,"typeArguments":[{"type":"union","types":[{"type":"literal","value":"close"},{"type":"literal","value":"error"}]}],"name":"EventEmitter"}]},{"id":546,"name":"EventEmitter","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":547,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"signatures":[{"id":548,"name":"new EventEmitter","kind":16384,"kindString":"Constructor signature","flags":{},"typeParameter":[{"id":549,"name":"E","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]},{"id":554,"name":"addListener","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":162,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L162"}],"signatures":[{"id":555,"name":"addListener","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":556,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":549,"name":"E"}},{"id":557,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":558,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":162,"character":38,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L162"}],"signatures":[{"id":559,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":560,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]},{"id":596,"name":"listenerCount","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":270,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L270"}],"signatures":[{"id":597,"name":"listenerCount","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":598,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":549,"name":"E"}}],"type":{"type":"intrinsic","name":"number"}}]},{"id":582,"name":"off","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":219,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L219"}],"signatures":[{"id":583,"name":"off","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":584,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":549,"name":"E"}},{"id":585,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":586,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":219,"character":30,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L219"}],"signatures":[{"id":587,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":588,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]},{"id":568,"name":"on","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":185,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L185"}],"signatures":[{"id":569,"name":"on","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":570,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":549,"name":"E"}},{"id":571,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":572,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":185,"character":29,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L185"}],"signatures":[{"id":573,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":574,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]},{"id":575,"name":"once","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":204,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L204"}],"signatures":[{"id":576,"name":"once","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":577,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":549,"name":"E"}},{"id":578,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":579,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":204,"character":31,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L204"}],"signatures":[{"id":580,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":581,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]},{"id":599,"name":"prependListener","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":287,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L287"}],"signatures":[{"id":600,"name":"prependListener","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":601,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":549,"name":"E"}},{"id":602,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":603,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":287,"character":42,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L287"}],"signatures":[{"id":604,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":605,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]},{"id":606,"name":"prependOnceListener","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":306,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L306"}],"signatures":[{"id":607,"name":"prependOnceListener","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":608,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":549,"name":"E"}},{"id":609,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":610,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":306,"character":46,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L306"}],"signatures":[{"id":611,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":612,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]},{"id":589,"name":"removeAllListeners","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":236,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L236"}],"signatures":[{"id":590,"name":"removeAllListeners","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":591,"name":"event","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","id":549,"name":"E"}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]},{"id":561,"name":"removeListener","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"shell.ts","line":171,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L171"}],"signatures":[{"id":562,"name":"removeListener","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":563,"name":"eventName","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":549,"name":"E"}},{"id":564,"name":"listener","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":565,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"shell.ts","line":171,"character":41,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L171"}],"signatures":[{"id":566,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":567,"name":"args","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","id":546,"typeArguments":[{"type":"reference","id":549,"name":"E"}],"name":"EventEmitter"}}]}],"groups":[{"title":"Constructors","children":[547]},{"title":"Methods","children":[554,596,582,568,575,599,606,589,561]}],"sources":[{"fileName":"shell.ts","line":151,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L151"}],"typeParameters":[{"id":613,"name":"E","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"extendedBy":[{"type":"reference","id":457,"name":"Command"}]},{"id":618,"name":"ChildProcess","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":619,"name":"code","kind":1024,"kindString":"Property","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":107,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L107"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"number"}]}},{"id":620,"name":"signal","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"If the process was terminated by a signal, represents that signal."}]},"sources":[{"fileName":"shell.ts","line":109,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L109"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"number"}]}},{"id":622,"name":"stderr","kind":1024,"kindString":"Property","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":113,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L113"}],"type":{"type":"intrinsic","name":"string"}},{"id":621,"name":"stdout","kind":1024,"kindString":"Property","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":111,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L111"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[619,620,622,621]}],"sources":[{"fileName":"shell.ts","line":105,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L105"}]},{"id":623,"name":"SpawnOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":624,"name":"cwd","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Current working directory."}]},"sources":[{"fileName":"shell.ts","line":86,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L86"}],"type":{"type":"intrinsic","name":"string"}},{"id":626,"name":"encoding","kind":1024,"kindString":"Property","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":94,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L94"}],"type":{"type":"intrinsic","name":"string"}},{"id":625,"name":"env","kind":1024,"kindString":"Property","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":88,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L88"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","qualifiedName":"Record","package":"typescript"}}],"groups":[{"title":"Properties","children":[624,626,625]}],"sources":[{"fileName":"shell.ts","line":84,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L84"}]},{"id":614,"name":"open","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"shell.ts","line":562,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L562"}],"signatures":[{"id":615,"name":"open","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":616,"name":"path","kind":32768,"kindString":"Parameter","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":617,"name":"openWith","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Classes","children":[536,457,546]},{"title":"Interfaces","children":[618,623]},{"title":"Functions","children":[614]}],"sources":[{"fileName":"shell.ts","line":78,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/shell.ts#L78"}]},{"id":627,"name":"tauri","kind":2,"kindString":"Module","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":628,"name":"InvokeArgs","kind":4194304,"kindString":"Type alias","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/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/tauri.ts#L63"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","qualifiedName":"Record","package":"typescript"}},{"id":641,"name":"convertFileSrc","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"tauri.ts","line":129,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/tauri.ts#L129"}],"signatures":[{"id":642,"name":"convertFileSrc","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":643,"name":"filePath","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The file path."}]},"type":{"type":"intrinsic","name":"string"}},{"id":644,"name":"protocol","kind":32768,"kindString":"Parameter","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":636,"name":"invoke","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"tauri.ts","line":79,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/tauri.ts#L79"}],"signatures":[{"id":637,"name":"invoke","kind":4096,"kindString":"Call signature","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"}]}]},"typeParameter":[{"id":638,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":639,"name":"cmd","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The command name."}]},"type":{"type":"intrinsic","name":"string"}},{"id":640,"name":"args","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The optional arguments to pass to the command."}]},"type":{"type":"reference","id":628,"name":"InvokeArgs"},"defaultValue":"{}"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":638,"name":"T"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":629,"name":"transformCallback","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"tauri.ts","line":36,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/tauri.ts#L36"}],"signatures":[{"id":630,"name":"transformCallback","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":631,"name":"callback","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":632,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"tauri.ts","line":37,"character":13,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/tauri.ts#L37"}],"signatures":[{"id":633,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":634,"name":"response","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":635,"name":"once","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"number"}}]}],"groups":[{"title":"Type Aliases","children":[628]},{"title":"Functions","children":[641,636,629]}],"sources":[{"fileName":"tauri.ts","line":13,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/tauri.ts#L13"}]},{"id":645,"name":"updater","kind":2,"kindString":"Module","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":650,"name":"UpdateManifest","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":653,"name":"body","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":34,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L34"}],"type":{"type":"intrinsic","name":"string"}},{"id":652,"name":"date","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":33,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L33"}],"type":{"type":"intrinsic","name":"string"}},{"id":651,"name":"version","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":32,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L32"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[653,652,651]}],"sources":[{"fileName":"updater.ts","line":31,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L31"}]},{"id":654,"name":"UpdateResult","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":655,"name":"manifest","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"updater.ts","line":41,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L41"}],"type":{"type":"reference","id":650,"name":"UpdateManifest"}},{"id":656,"name":"shouldUpdate","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":42,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L42"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[655,656]}],"sources":[{"fileName":"updater.ts","line":40,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L40"}]},{"id":647,"name":"UpdateStatusResult","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":648,"name":"error","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"updater.ts","line":24,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L24"}],"type":{"type":"intrinsic","name":"string"}},{"id":649,"name":"status","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"updater.ts","line":25,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L25"}],"type":{"type":"reference","id":646,"name":"UpdateStatus"}}],"groups":[{"title":"Properties","children":[648,649]}],"sources":[{"fileName":"updater.ts","line":23,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L23"}]},{"id":646,"name":"UpdateStatus","kind":4194304,"kindString":"Type alias","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/lorenzolewis/tauri/blob/852e11e1/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":665,"name":"checkUpdate","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"updater.ts","line":146,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L146"}],"signatures":[{"id":666,"name":"checkUpdate","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":654,"name":"UpdateResult"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":663,"name":"installUpdate","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"updater.ts","line":87,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L87"}],"signatures":[{"id":664,"name":"installUpdate","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":657,"name":"onUpdaterEvent","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"updater.ts","line":63,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L63"}],"signatures":[{"id":658,"name":"onUpdaterEvent","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":659,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":660,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"updater.ts","line":64,"character":11,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L64"}],"signatures":[{"id":661,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":662,"name":"status","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":647,"name":"UpdateStatusResult"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Interfaces","children":[650,654,647]},{"title":"Type Aliases","children":[646]},{"title":"Functions","children":[665,663,657]}],"sources":[{"fileName":"updater.ts","line":12,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/updater.ts#L12"}]},{"id":667,"name":"window","kind":2,"kindString":"Module","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 \"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":1062,"name":"UserAttentionType","kind":8,"kindString":"Enumeration","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":1063,"name":"Critical","kind":16,"kindString":"Enumeration Member","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":225,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L225"}],"type":{"type":"literal","value":1}},{"id":1064,"name":"Informational","kind":16,"kindString":"Enumeration Member","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":231,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L231"}],"type":{"type":"literal","value":2}}],"groups":[{"title":"Enumeration Members","children":[1063,1064]}],"sources":[{"fileName":"window.ts","line":219,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L219"}]},{"id":1007,"name":"CloseRequestedEvent","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.2"}]}]},"children":[{"id":1008,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":1922,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1922"}],"signatures":[{"id":1009,"name":"new CloseRequestedEvent","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":1010,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1120,"typeArguments":[{"type":"literal","value":null}],"name":"Event"}}],"type":{"type":"reference","id":1007,"name":"CloseRequestedEvent"}}]},{"id":1014,"name":"_preventDefault","kind":1024,"kindString":"Property","flags":{"isPrivate":true},"sources":[{"fileName":"window.ts","line":1920,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1920"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1011,"name":"event","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Event name"}]},"sources":[{"fileName":"window.ts","line":1915,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1915"}],"type":{"type":"intrinsic","name":"string"}},{"id":1013,"name":"id","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Event identifier used to unlisten"}]},"sources":[{"fileName":"window.ts","line":1919,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1919"}],"type":{"type":"intrinsic","name":"number"}},{"id":1012,"name":"windowLabel","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The label of the window that emitted this event."}]},"sources":[{"fileName":"window.ts","line":1917,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1917"}],"type":{"type":"intrinsic","name":"string"}},{"id":1017,"name":"isPreventDefault","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1932,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1932"}],"signatures":[{"id":1018,"name":"isPreventDefault","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1015,"name":"preventDefault","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1928,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1928"}],"signatures":[{"id":1016,"name":"preventDefault","kind":4096,"kindString":"Call signature","flags":{},"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Constructors","children":[1008]},{"title":"Properties","children":[1014,1011,1013,1012]},{"title":"Methods","children":[1017,1015]}],"sources":[{"fileName":"window.ts","line":1913,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1913"}]},{"id":1043,"name":"LogicalPosition","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"A position represented in logical pixels."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1044,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":163,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L163"}],"signatures":[{"id":1045,"name":"new LogicalPosition","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":1046,"name":"x","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1047,"name":"y","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":1043,"name":"LogicalPosition"}}]},{"id":1048,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":159,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L159"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Logical'"},{"id":1049,"name":"x","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":160,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L160"}],"type":{"type":"intrinsic","name":"number"}},{"id":1050,"name":"y","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":161,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L161"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","children":[1044]},{"title":"Properties","children":[1048,1049,1050]}],"sources":[{"fileName":"window.ts","line":158,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L158"}]},{"id":1024,"name":"LogicalSize","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"A size represented in logical pixels."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1025,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":117,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L117"}],"signatures":[{"id":1026,"name":"new LogicalSize","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":1027,"name":"width","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1028,"name":"height","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":1024,"name":"LogicalSize"}}]},{"id":1031,"name":"height","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":115,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L115"}],"type":{"type":"intrinsic","name":"number"}},{"id":1029,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":113,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L113"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Logical'"},{"id":1030,"name":"width","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":114,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L114"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","children":[1025]},{"title":"Properties","children":[1031,1029,1030]}],"sources":[{"fileName":"window.ts","line":112,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L112"}]},{"id":1051,"name":"PhysicalPosition","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"A position represented in physical pixels."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1052,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":179,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L179"}],"signatures":[{"id":1053,"name":"new PhysicalPosition","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":1054,"name":"x","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1055,"name":"y","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":1051,"name":"PhysicalPosition"}}]},{"id":1056,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":175,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L175"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Physical'"},{"id":1057,"name":"x","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":176,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L176"}],"type":{"type":"intrinsic","name":"number"}},{"id":1058,"name":"y","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":177,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L177"}],"type":{"type":"intrinsic","name":"number"}},{"id":1059,"name":"toLogical","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":194,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L194"}],"signatures":[{"id":1060,"name":"toLogical","kind":4096,"kindString":"Call signature","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```"}]}]},"parameters":[{"id":1061,"name":"scaleFactor","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":1043,"name":"LogicalPosition"}}]}],"groups":[{"title":"Constructors","children":[1052]},{"title":"Properties","children":[1056,1057,1058]},{"title":"Methods","children":[1059]}],"sources":[{"fileName":"window.ts","line":174,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L174"}]},{"id":1032,"name":"PhysicalSize","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"A size represented in physical pixels."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1033,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":133,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L133"}],"signatures":[{"id":1034,"name":"new PhysicalSize","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":1035,"name":"width","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1036,"name":"height","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":1032,"name":"PhysicalSize"}}]},{"id":1039,"name":"height","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":131,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L131"}],"type":{"type":"intrinsic","name":"number"}},{"id":1037,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":129,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L129"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"'Physical'"},{"id":1038,"name":"width","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":130,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L130"}],"type":{"type":"intrinsic","name":"number"}},{"id":1040,"name":"toLogical","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":148,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L148"}],"signatures":[{"id":1041,"name":"toLogical","kind":4096,"kindString":"Call signature","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```"}]}]},"parameters":[{"id":1042,"name":"scaleFactor","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":1024,"name":"LogicalSize"}}]}],"groups":[{"title":"Constructors","children":[1033]},{"title":"Properties","children":[1039,1037,1038]},{"title":"Methods","children":[1040]}],"sources":[{"fileName":"window.ts","line":128,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L128"}]},{"id":670,"name":"WebviewWindow","kind":128,"kindString":"Class","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":674,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":1990,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1990"}],"signatures":[{"id":675,"name":"new WebviewWindow","kind":16384,"kindString":"Constructor signature","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."}]}]},"parameters":[{"id":676,"name":"label","kind":32768,"kindString":"Parameter","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":677,"name":"options","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1090,"name":"WindowOptions"},"defaultValue":"{}"}],"type":{"type":"reference","id":670,"name":"WebviewWindow"},"overwrites":{"type":"reference","id":855,"name":"WindowManager.constructor"}}],"overwrites":{"type":"reference","id":854,"name":"WindowManager.constructor"}},{"id":807,"name":"label","kind":1024,"kindString":"Property","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":314,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L314"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":986,"name":"WindowManager.label"}},{"id":808,"name":"listeners","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Local event listeners."}]},"sources":[{"fileName":"window.ts","line":316,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L316"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"reference","id":1126,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"EventCallback"}}],"name":"Record","qualifiedName":"Record","package":"typescript"},"inheritedFrom":{"type":"reference","id":987,"name":"WindowManager.listeners"}},{"id":823,"name":"_handleTauriEvent","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":409,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L409"}],"signatures":[{"id":824,"name":"_handleTauriEvent","kind":4096,"kindString":"Call signature","flags":{},"typeParameter":[{"id":825,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":826,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":827,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":825,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":1003,"name":"WindowManager._handleTauriEvent"}}],"inheritedFrom":{"type":"reference","id":1002,"name":"WindowManager._handleTauriEvent"}},{"id":704,"name":"center","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":776,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L776"}],"signatures":[{"id":705,"name":"center","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":884,"name":"WindowManager.center"}}],"inheritedFrom":{"type":"reference","id":883,"name":"WindowManager.center"}},{"id":729,"name":"close","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1077,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1077"}],"signatures":[{"id":730,"name":"close","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":909,"name":"WindowManager.close"}}],"inheritedFrom":{"type":"reference","id":908,"name":"WindowManager.close"}},{"id":819,"name":"emit","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":398,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L398"}],"signatures":[{"id":820,"name":"emit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Emits an event to the backend, tied to the webview window."}],"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```"}]}]},"parameters":[{"id":821,"name":"event","kind":32768,"kindString":"Parameter","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":822,"name":"payload","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Event payload."}]},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":999,"name":"WindowManager.emit"}}],"inheritedFrom":{"type":"reference","id":998,"name":"WindowManager.emit"}},{"id":727,"name":"hide","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1052,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1052"}],"signatures":[{"id":728,"name":"hide","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":907,"name":"WindowManager.hide"}}],"inheritedFrom":{"type":"reference","id":906,"name":"WindowManager.hide"}},{"id":680,"name":"innerPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":466,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L466"}],"signatures":[{"id":681,"name":"innerPosition","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":1051,"name":"PhysicalPosition"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":860,"name":"WindowManager.innerPosition"}}],"inheritedFrom":{"type":"reference","id":859,"name":"WindowManager.innerPosition"}},{"id":684,"name":"innerSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":517,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L517"}],"signatures":[{"id":685,"name":"innerSize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":1032,"name":"PhysicalSize"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":864,"name":"WindowManager.innerSize"}}],"inheritedFrom":{"type":"reference","id":863,"name":"WindowManager.innerSize"}},{"id":694,"name":"isDecorated","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":643,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L643"}],"signatures":[{"id":695,"name":"isDecorated","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":874,"name":"WindowManager.isDecorated"}}],"inheritedFrom":{"type":"reference","id":873,"name":"WindowManager.isDecorated"}},{"id":688,"name":"isFullscreen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":568,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L568"}],"signatures":[{"id":689,"name":"isFullscreen","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":868,"name":"WindowManager.isFullscreen"}}],"inheritedFrom":{"type":"reference","id":867,"name":"WindowManager.isFullscreen"}},{"id":692,"name":"isMaximized","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":618,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L618"}],"signatures":[{"id":693,"name":"isMaximized","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":872,"name":"WindowManager.isMaximized"}}],"inheritedFrom":{"type":"reference","id":871,"name":"WindowManager.isMaximized"}},{"id":690,"name":"isMinimized","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":593,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L593"}],"signatures":[{"id":691,"name":"isMinimized","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":870,"name":"WindowManager.isMinimized"}}],"inheritedFrom":{"type":"reference","id":869,"name":"WindowManager.isMinimized"}},{"id":696,"name":"isResizable","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":668,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L668"}],"signatures":[{"id":697,"name":"isResizable","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":876,"name":"WindowManager.isResizable"}}],"inheritedFrom":{"type":"reference","id":875,"name":"WindowManager.isResizable"}},{"id":698,"name":"isVisible","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":693,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L693"}],"signatures":[{"id":699,"name":"isVisible","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":878,"name":"WindowManager.isVisible"}}],"inheritedFrom":{"type":"reference","id":877,"name":"WindowManager.isVisible"}},{"id":809,"name":"listen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":343,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L343"}],"signatures":[{"id":810,"name":"listen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an event emitted by the backend that is tied to the webview window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst unlisten = await appWindow.listen('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```"}]},{"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."}]}]},"typeParameter":[{"id":811,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":812,"name":"event","kind":32768,"kindString":"Parameter","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":813,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler."}]},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":811,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":989,"name":"WindowManager.listen"}}],"inheritedFrom":{"type":"reference","id":988,"name":"WindowManager.listen"}},{"id":715,"name":"maximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":902,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L902"}],"signatures":[{"id":716,"name":"maximize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":895,"name":"WindowManager.maximize"}}],"inheritedFrom":{"type":"reference","id":894,"name":"WindowManager.maximize"}},{"id":721,"name":"minimize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":977,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L977"}],"signatures":[{"id":722,"name":"minimize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":901,"name":"WindowManager.minimize"}}],"inheritedFrom":{"type":"reference","id":900,"name":"WindowManager.minimize"}},{"id":786,"name":"onCloseRequested","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1722,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1722"}],"signatures":[{"id":787,"name":"onCloseRequested","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":788,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":789,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"window.ts","line":1723,"character":13,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1723"}],"signatures":[{"id":790,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":791,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1007,"name":"CloseRequestedEvent"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}]}}]}}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":966,"name":"WindowManager.onCloseRequested"}}],"inheritedFrom":{"type":"reference","id":965,"name":"WindowManager.onCloseRequested"}},{"id":801,"name":"onFileDropEvent","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1855,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1855"}],"signatures":[{"id":802,"name":"onFileDropEvent","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":803,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1081,"name":"FileDropEvent"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":981,"name":"WindowManager.onFileDropEvent"}}],"inheritedFrom":{"type":"reference","id":980,"name":"WindowManager.onFileDropEvent"}},{"id":792,"name":"onFocusChanged","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1754,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1754"}],"signatures":[{"id":793,"name":"onFocusChanged","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":794,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":972,"name":"WindowManager.onFocusChanged"}}],"inheritedFrom":{"type":"reference","id":971,"name":"WindowManager.onFocusChanged"}},{"id":798,"name":"onMenuClicked","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1824,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1824"}],"signatures":[{"id":799,"name":"onMenuClicked","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":800,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":978,"name":"WindowManager.onMenuClicked"}}],"inheritedFrom":{"type":"reference","id":977,"name":"WindowManager.onMenuClicked"}},{"id":783,"name":"onMoved","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1694,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1694"}],"signatures":[{"id":784,"name":"onMoved","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":785,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1051,"name":"PhysicalPosition"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":963,"name":"WindowManager.onMoved"}}],"inheritedFrom":{"type":"reference","id":962,"name":"WindowManager.onMoved"}},{"id":780,"name":"onResized","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1671,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1671"}],"signatures":[{"id":781,"name":"onResized","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":782,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1032,"name":"PhysicalSize"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":960,"name":"WindowManager.onResized"}}],"inheritedFrom":{"type":"reference","id":959,"name":"WindowManager.onResized"}},{"id":795,"name":"onScaleChanged","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1796,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1796"}],"signatures":[{"id":796,"name":"onScaleChanged","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":797,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1078,"name":"ScaleFactorChanged"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":975,"name":"WindowManager.onScaleChanged"}}],"inheritedFrom":{"type":"reference","id":974,"name":"WindowManager.onScaleChanged"}},{"id":804,"name":"onThemeChanged","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1905,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1905"}],"signatures":[{"id":805,"name":"onThemeChanged","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":806,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1071,"name":"Theme"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":984,"name":"WindowManager.onThemeChanged"}}],"inheritedFrom":{"type":"reference","id":983,"name":"WindowManager.onThemeChanged"}},{"id":814,"name":"once","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":376,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L376"}],"signatures":[{"id":815,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an one-off event emitted by the backend that is tied to the webview window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst unlisten = await appWindow.once('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```"}]},{"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."}]}]},"typeParameter":[{"id":816,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":817,"name":"event","kind":32768,"kindString":"Parameter","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":818,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler."}]},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":816,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":994,"name":"WindowManager.once"}}],"inheritedFrom":{"type":"reference","id":993,"name":"WindowManager.once"}},{"id":682,"name":"outerPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":491,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L491"}],"signatures":[{"id":683,"name":"outerPosition","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":1051,"name":"PhysicalPosition"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":862,"name":"WindowManager.outerPosition"}}],"inheritedFrom":{"type":"reference","id":861,"name":"WindowManager.outerPosition"}},{"id":686,"name":"outerSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":543,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L543"}],"signatures":[{"id":687,"name":"outerSize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":1032,"name":"PhysicalSize"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":866,"name":"WindowManager.outerSize"}}],"inheritedFrom":{"type":"reference","id":865,"name":"WindowManager.outerSize"}},{"id":706,"name":"requestUserAttention","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":812,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L812"}],"signatures":[{"id":707,"name":"requestUserAttention","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":708,"name":"requestType","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":1062,"name":"UserAttentionType"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":886,"name":"WindowManager.requestUserAttention"}}],"inheritedFrom":{"type":"reference","id":885,"name":"WindowManager.requestUserAttention"}},{"id":678,"name":"scaleFactor","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":441,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L441"}],"signatures":[{"id":679,"name":"scaleFactor","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":858,"name":"WindowManager.scaleFactor"}}],"inheritedFrom":{"type":"reference","id":857,"name":"WindowManager.scaleFactor"}},{"id":734,"name":"setAlwaysOnTop","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1130,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1130"}],"signatures":[{"id":735,"name":"setAlwaysOnTop","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":736,"name":"alwaysOnTop","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":914,"name":"WindowManager.setAlwaysOnTop"}}],"inheritedFrom":{"type":"reference","id":913,"name":"WindowManager.setAlwaysOnTop"}},{"id":737,"name":"setContentProtected","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1158,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1158"}],"signatures":[{"id":738,"name":"setContentProtected","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":739,"name":"protected_","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":917,"name":"WindowManager.setContentProtected"}}],"inheritedFrom":{"type":"reference","id":916,"name":"WindowManager.setContentProtected"}},{"id":763,"name":"setCursorGrab","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1478,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1478"}],"signatures":[{"id":764,"name":"setCursorGrab","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":765,"name":"grab","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":943,"name":"WindowManager.setCursorGrab"}}],"inheritedFrom":{"type":"reference","id":942,"name":"WindowManager.setCursorGrab"}},{"id":769,"name":"setCursorIcon","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1538,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1538"}],"signatures":[{"id":770,"name":"setCursorIcon","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":771,"name":"icon","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The new cursor icon."}]},"type":{"type":"reference","id":668,"name":"CursorIcon"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":949,"name":"WindowManager.setCursorIcon"}}],"inheritedFrom":{"type":"reference","id":948,"name":"WindowManager.setCursorIcon"}},{"id":772,"name":"setCursorPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1565,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1565"}],"signatures":[{"id":773,"name":"setCursorPosition","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":774,"name":"position","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The new cursor position."}]},"type":{"type":"union","types":[{"type":"reference","id":1051,"name":"PhysicalPosition"},{"type":"reference","id":1043,"name":"LogicalPosition"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":952,"name":"WindowManager.setCursorPosition"}}],"inheritedFrom":{"type":"reference","id":951,"name":"WindowManager.setCursorPosition"}},{"id":766,"name":"setCursorVisible","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1511,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1511"}],"signatures":[{"id":767,"name":"setCursorVisible","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":768,"name":"visible","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":946,"name":"WindowManager.setCursorVisible"}}],"inheritedFrom":{"type":"reference","id":945,"name":"WindowManager.setCursorVisible"}},{"id":731,"name":"setDecorations","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1103,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1103"}],"signatures":[{"id":732,"name":"setDecorations","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":733,"name":"decorations","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should have borders and bars."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":911,"name":"WindowManager.setDecorations"}}],"inheritedFrom":{"type":"reference","id":910,"name":"WindowManager.setDecorations"}},{"id":755,"name":"setFocus","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1376,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1376"}],"signatures":[{"id":756,"name":"setFocus","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":935,"name":"WindowManager.setFocus"}}],"inheritedFrom":{"type":"reference","id":934,"name":"WindowManager.setFocus"}},{"id":752,"name":"setFullscreen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1350,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1350"}],"signatures":[{"id":753,"name":"setFullscreen","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":754,"name":"fullscreen","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should go to fullscreen or not."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":932,"name":"WindowManager.setFullscreen"}}],"inheritedFrom":{"type":"reference","id":931,"name":"WindowManager.setFullscreen"}},{"id":757,"name":"setIcon","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1409,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1409"}],"signatures":[{"id":758,"name":"setIcon","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":759,"name":"icon","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Icon bytes or path to the icon file."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"Uint8Array","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":937,"name":"WindowManager.setIcon"}}],"inheritedFrom":{"type":"reference","id":936,"name":"WindowManager.setIcon"}},{"id":775,"name":"setIgnoreCursorEvents","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1609,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1609"}],"signatures":[{"id":776,"name":"setIgnoreCursorEvents","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":777,"name":"ignore","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":955,"name":"WindowManager.setIgnoreCursorEvents"}}],"inheritedFrom":{"type":"reference","id":954,"name":"WindowManager.setIgnoreCursorEvents"}},{"id":746,"name":"setMaxSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1265,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1265"}],"signatures":[{"id":747,"name":"setMaxSize","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":748,"name":"size","kind":32768,"kindString":"Parameter","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","id":1032,"name":"PhysicalSize"},{"type":"reference","id":1024,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":926,"name":"WindowManager.setMaxSize"}}],"inheritedFrom":{"type":"reference","id":925,"name":"WindowManager.setMaxSize"}},{"id":743,"name":"setMinSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1223,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1223"}],"signatures":[{"id":744,"name":"setMinSize","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":745,"name":"size","kind":32768,"kindString":"Parameter","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","id":1032,"name":"PhysicalSize"},{"type":"reference","id":1024,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":923,"name":"WindowManager.setMinSize"}}],"inheritedFrom":{"type":"reference","id":922,"name":"WindowManager.setMinSize"}},{"id":749,"name":"setPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1307,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1307"}],"signatures":[{"id":750,"name":"setPosition","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":751,"name":"position","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The new position, in logical or physical pixels."}]},"type":{"type":"union","types":[{"type":"reference","id":1051,"name":"PhysicalPosition"},{"type":"reference","id":1043,"name":"LogicalPosition"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":929,"name":"WindowManager.setPosition"}}],"inheritedFrom":{"type":"reference","id":928,"name":"WindowManager.setPosition"}},{"id":709,"name":"setResizable","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":849,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L849"}],"signatures":[{"id":710,"name":"setResizable","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":711,"name":"resizable","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":889,"name":"WindowManager.setResizable"}}],"inheritedFrom":{"type":"reference","id":888,"name":"WindowManager.setResizable"}},{"id":740,"name":"setSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1185,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1185"}],"signatures":[{"id":741,"name":"setSize","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":742,"name":"size","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The logical or physical inner size."}]},"type":{"type":"union","types":[{"type":"reference","id":1032,"name":"PhysicalSize"},{"type":"reference","id":1024,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":920,"name":"WindowManager.setSize"}}],"inheritedFrom":{"type":"reference","id":919,"name":"WindowManager.setSize"}},{"id":760,"name":"setSkipTaskbar","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1443,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1443"}],"signatures":[{"id":761,"name":"setSkipTaskbar","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":762,"name":"skip","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"true to hide window icon, false to show it."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":940,"name":"WindowManager.setSkipTaskbar"}}],"inheritedFrom":{"type":"reference","id":939,"name":"WindowManager.setSkipTaskbar"}},{"id":712,"name":"setTitle","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":876,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L876"}],"signatures":[{"id":713,"name":"setTitle","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":714,"name":"title","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The new title"}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":892,"name":"WindowManager.setTitle"}}],"inheritedFrom":{"type":"reference","id":891,"name":"WindowManager.setTitle"}},{"id":725,"name":"show","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1027,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1027"}],"signatures":[{"id":726,"name":"show","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":905,"name":"WindowManager.show"}}],"inheritedFrom":{"type":"reference","id":904,"name":"WindowManager.show"}},{"id":778,"name":"startDragging","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1635,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1635"}],"signatures":[{"id":779,"name":"startDragging","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":958,"name":"WindowManager.startDragging"}}],"inheritedFrom":{"type":"reference","id":957,"name":"WindowManager.startDragging"}},{"id":702,"name":"theme","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":748,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L748"}],"signatures":[{"id":703,"name":"theme","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":1071,"name":"Theme"}]}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":882,"name":"WindowManager.theme"}}],"inheritedFrom":{"type":"reference","id":881,"name":"WindowManager.theme"}},{"id":700,"name":"title","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":718,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L718"}],"signatures":[{"id":701,"name":"title","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":880,"name":"WindowManager.title"}}],"inheritedFrom":{"type":"reference","id":879,"name":"WindowManager.title"}},{"id":719,"name":"toggleMaximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":952,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L952"}],"signatures":[{"id":720,"name":"toggleMaximize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":899,"name":"WindowManager.toggleMaximize"}}],"inheritedFrom":{"type":"reference","id":898,"name":"WindowManager.toggleMaximize"}},{"id":717,"name":"unmaximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":927,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L927"}],"signatures":[{"id":718,"name":"unmaximize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":897,"name":"WindowManager.unmaximize"}}],"inheritedFrom":{"type":"reference","id":896,"name":"WindowManager.unmaximize"}},{"id":723,"name":"unminimize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1002,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1002"}],"signatures":[{"id":724,"name":"unminimize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":903,"name":"WindowManager.unminimize"}}],"inheritedFrom":{"type":"reference","id":902,"name":"WindowManager.unminimize"}},{"id":671,"name":"getByLabel","kind":2048,"kindString":"Method","flags":{"isStatic":true},"sources":[{"fileName":"window.ts","line":2022,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2022"}],"signatures":[{"id":672,"name":"getByLabel","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":673,"name":"label","kind":32768,"kindString":"Parameter","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","id":670,"name":"WebviewWindow"}]}}]}],"groups":[{"title":"Constructors","children":[674]},{"title":"Properties","children":[807,808]},{"title":"Methods","children":[823,704,729,819,727,680,684,694,688,692,690,696,698,809,715,721,786,801,792,798,783,780,795,804,814,682,686,706,678,734,737,763,769,772,766,731,755,752,757,775,746,743,749,709,740,760,712,725,778,702,700,719,717,723,671]}],"sources":[{"fileName":"window.ts","line":1970,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1970"}],"extendedTypes":[{"type":"reference","id":853,"name":"WindowManager"}]},{"id":828,"name":"WebviewWindowHandle","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"A webview window handle allows emitting and listening to events from the backend that are tied to the window."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":829,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":318,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L318"}],"signatures":[{"id":830,"name":"new WebviewWindowHandle","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":831,"name":"label","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":828,"name":"WebviewWindowHandle"}}]},{"id":832,"name":"label","kind":1024,"kindString":"Property","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":314,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L314"}],"type":{"type":"intrinsic","name":"string"}},{"id":833,"name":"listeners","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Local event listeners."}]},"sources":[{"fileName":"window.ts","line":316,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L316"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"reference","id":1126,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"EventCallback"}}],"name":"Record","qualifiedName":"Record","package":"typescript"}},{"id":848,"name":"_handleTauriEvent","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":409,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L409"}],"signatures":[{"id":849,"name":"_handleTauriEvent","kind":4096,"kindString":"Call signature","flags":{},"typeParameter":[{"id":850,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":851,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":852,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":825,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":844,"name":"emit","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":398,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L398"}],"signatures":[{"id":845,"name":"emit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Emits an event to the backend, tied to the webview window."}],"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```"}]}]},"parameters":[{"id":846,"name":"event","kind":32768,"kindString":"Parameter","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":847,"name":"payload","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Event payload."}]},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":834,"name":"listen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":343,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L343"}],"signatures":[{"id":835,"name":"listen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an event emitted by the backend that is tied to the webview window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst unlisten = await appWindow.listen('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```"}]},{"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."}]}]},"typeParameter":[{"id":836,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":837,"name":"event","kind":32768,"kindString":"Parameter","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":838,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler."}]},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":811,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":839,"name":"once","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":376,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L376"}],"signatures":[{"id":840,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an one-off event emitted by the backend that is tied to the webview window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst unlisten = await appWindow.once('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```"}]},{"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."}]}]},"typeParameter":[{"id":841,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":842,"name":"event","kind":32768,"kindString":"Parameter","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":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler."}]},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":816,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[829]},{"title":"Properties","children":[832,833]},{"title":"Methods","children":[848,844,834,839]}],"sources":[{"fileName":"window.ts","line":312,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L312"}],"extendedBy":[{"type":"reference","id":853,"name":"WindowManager"}]},{"id":853,"name":"WindowManager","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Manage the current window object."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":854,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"window.ts","line":318,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L318"}],"signatures":[{"id":855,"name":"new WindowManager","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":856,"name":"label","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","id":853,"name":"WindowManager"},"inheritedFrom":{"type":"reference","id":830,"name":"WebviewWindowHandle.constructor"}}],"inheritedFrom":{"type":"reference","id":829,"name":"WebviewWindowHandle.constructor"}},{"id":986,"name":"label","kind":1024,"kindString":"Property","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":314,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L314"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","id":832,"name":"WebviewWindowHandle.label"}},{"id":987,"name":"listeners","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Local event listeners."}]},"sources":[{"fileName":"window.ts","line":316,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L316"}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"reference","id":1126,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"EventCallback"}}],"name":"Record","qualifiedName":"Record","package":"typescript"},"inheritedFrom":{"type":"reference","id":833,"name":"WebviewWindowHandle.listeners"}},{"id":1002,"name":"_handleTauriEvent","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":409,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L409"}],"signatures":[{"id":1003,"name":"_handleTauriEvent","kind":4096,"kindString":"Call signature","flags":{},"typeParameter":[{"id":1004,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":1005,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1006,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":825,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":849,"name":"WebviewWindowHandle._handleTauriEvent"}}],"inheritedFrom":{"type":"reference","id":848,"name":"WebviewWindowHandle._handleTauriEvent"}},{"id":883,"name":"center","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":776,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L776"}],"signatures":[{"id":884,"name":"center","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":908,"name":"close","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1077,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1077"}],"signatures":[{"id":909,"name":"close","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":998,"name":"emit","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":398,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L398"}],"signatures":[{"id":999,"name":"emit","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Emits an event to the backend, tied to the webview window."}],"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```"}]}]},"parameters":[{"id":1000,"name":"event","kind":32768,"kindString":"Parameter","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":1001,"name":"payload","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Event payload."}]},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":845,"name":"WebviewWindowHandle.emit"}}],"inheritedFrom":{"type":"reference","id":844,"name":"WebviewWindowHandle.emit"}},{"id":906,"name":"hide","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1052,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1052"}],"signatures":[{"id":907,"name":"hide","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":859,"name":"innerPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":466,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L466"}],"signatures":[{"id":860,"name":"innerPosition","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":1051,"name":"PhysicalPosition"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":863,"name":"innerSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":517,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L517"}],"signatures":[{"id":864,"name":"innerSize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":1032,"name":"PhysicalSize"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":873,"name":"isDecorated","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":643,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L643"}],"signatures":[{"id":874,"name":"isDecorated","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":867,"name":"isFullscreen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":568,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L568"}],"signatures":[{"id":868,"name":"isFullscreen","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":871,"name":"isMaximized","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":618,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L618"}],"signatures":[{"id":872,"name":"isMaximized","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":869,"name":"isMinimized","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":593,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L593"}],"signatures":[{"id":870,"name":"isMinimized","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":875,"name":"isResizable","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":668,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L668"}],"signatures":[{"id":876,"name":"isResizable","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":877,"name":"isVisible","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":693,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L693"}],"signatures":[{"id":878,"name":"isVisible","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":988,"name":"listen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":343,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L343"}],"signatures":[{"id":989,"name":"listen","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an event emitted by the backend that is tied to the webview window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst unlisten = await appWindow.listen('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```"}]},{"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."}]}]},"typeParameter":[{"id":990,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":991,"name":"event","kind":32768,"kindString":"Parameter","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":992,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler."}]},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":811,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":835,"name":"WebviewWindowHandle.listen"}}],"inheritedFrom":{"type":"reference","id":834,"name":"WebviewWindowHandle.listen"}},{"id":894,"name":"maximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":902,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L902"}],"signatures":[{"id":895,"name":"maximize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":900,"name":"minimize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":977,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L977"}],"signatures":[{"id":901,"name":"minimize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":965,"name":"onCloseRequested","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1722,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1722"}],"signatures":[{"id":966,"name":"onCloseRequested","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":967,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reflection","declaration":{"id":968,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"window.ts","line":1723,"character":13,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1723"}],"signatures":[{"id":969,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":970,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1007,"name":"CloseRequestedEvent"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}]}}]}}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":980,"name":"onFileDropEvent","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1855,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1855"}],"signatures":[{"id":981,"name":"onFileDropEvent","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":982,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1081,"name":"FileDropEvent"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":971,"name":"onFocusChanged","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1754,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1754"}],"signatures":[{"id":972,"name":"onFocusChanged","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":973,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":977,"name":"onMenuClicked","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1824,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1824"}],"signatures":[{"id":978,"name":"onMenuClicked","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":979,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":962,"name":"onMoved","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1694,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1694"}],"signatures":[{"id":963,"name":"onMoved","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":964,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1051,"name":"PhysicalPosition"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":959,"name":"onResized","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1671,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1671"}],"signatures":[{"id":960,"name":"onResized","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":961,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1032,"name":"PhysicalSize"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":974,"name":"onScaleChanged","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1796,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1796"}],"signatures":[{"id":975,"name":"onScaleChanged","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":976,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1078,"name":"ScaleFactorChanged"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":983,"name":"onThemeChanged","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1905,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1905"}],"signatures":[{"id":984,"name":"onThemeChanged","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":985,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":1071,"name":"Theme"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":993,"name":"once","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":376,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L376"}],"signatures":[{"id":994,"name":"once","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Listen to an one-off event emitted by the backend that is tied to the webview window."}],"blockTags":[{"tag":"@example","content":[{"kind":"code","text":"```typescript\nimport { appWindow } from '@tauri-apps/api/window';\nconst unlisten = await appWindow.once('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```"}]},{"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."}]}]},"typeParameter":[{"id":995,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":996,"name":"event","kind":32768,"kindString":"Parameter","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":997,"name":"handler","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Event handler."}]},"type":{"type":"reference","id":1126,"typeArguments":[{"type":"reference","id":816,"name":"T"}],"name":"EventCallback"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":1131,"name":"UnlistenFn"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","id":840,"name":"WebviewWindowHandle.once"}}],"inheritedFrom":{"type":"reference","id":839,"name":"WebviewWindowHandle.once"}},{"id":861,"name":"outerPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":491,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L491"}],"signatures":[{"id":862,"name":"outerPosition","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":1051,"name":"PhysicalPosition"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":865,"name":"outerSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":543,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L543"}],"signatures":[{"id":866,"name":"outerSize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":1032,"name":"PhysicalSize"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":885,"name":"requestUserAttention","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":812,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L812"}],"signatures":[{"id":886,"name":"requestUserAttention","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":887,"name":"requestType","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":1062,"name":"UserAttentionType"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":857,"name":"scaleFactor","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":441,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L441"}],"signatures":[{"id":858,"name":"scaleFactor","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":913,"name":"setAlwaysOnTop","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1130,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1130"}],"signatures":[{"id":914,"name":"setAlwaysOnTop","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":915,"name":"alwaysOnTop","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":916,"name":"setContentProtected","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1158,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1158"}],"signatures":[{"id":917,"name":"setContentProtected","kind":4096,"kindString":"Call signature","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"}]}]},"parameters":[{"id":918,"name":"protected_","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":942,"name":"setCursorGrab","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1478,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1478"}],"signatures":[{"id":943,"name":"setCursorGrab","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":944,"name":"grab","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":948,"name":"setCursorIcon","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1538,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1538"}],"signatures":[{"id":949,"name":"setCursorIcon","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":950,"name":"icon","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The new cursor icon."}]},"type":{"type":"reference","id":668,"name":"CursorIcon"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":951,"name":"setCursorPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1565,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1565"}],"signatures":[{"id":952,"name":"setCursorPosition","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":953,"name":"position","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The new cursor position."}]},"type":{"type":"union","types":[{"type":"reference","id":1051,"name":"PhysicalPosition"},{"type":"reference","id":1043,"name":"LogicalPosition"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":945,"name":"setCursorVisible","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1511,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1511"}],"signatures":[{"id":946,"name":"setCursorVisible","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":947,"name":"visible","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":910,"name":"setDecorations","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1103,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1103"}],"signatures":[{"id":911,"name":"setDecorations","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":912,"name":"decorations","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should have borders and bars."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":934,"name":"setFocus","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1376,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1376"}],"signatures":[{"id":935,"name":"setFocus","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":931,"name":"setFullscreen","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1350,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1350"}],"signatures":[{"id":932,"name":"setFullscreen","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":933,"name":"fullscreen","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the window should go to fullscreen or not."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":936,"name":"setIcon","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1409,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1409"}],"signatures":[{"id":937,"name":"setIcon","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":938,"name":"icon","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"Icon bytes or path to the icon file."}]},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","name":"Uint8Array","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array","qualifiedName":"Uint8Array","package":"typescript"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":954,"name":"setIgnoreCursorEvents","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1609,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1609"}],"signatures":[{"id":955,"name":"setIgnoreCursorEvents","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":956,"name":"ignore","kind":32768,"kindString":"Parameter","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","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":925,"name":"setMaxSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1265,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1265"}],"signatures":[{"id":926,"name":"setMaxSize","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":927,"name":"size","kind":32768,"kindString":"Parameter","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","id":1032,"name":"PhysicalSize"},{"type":"reference","id":1024,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":922,"name":"setMinSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1223,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1223"}],"signatures":[{"id":923,"name":"setMinSize","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":924,"name":"size","kind":32768,"kindString":"Parameter","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","id":1032,"name":"PhysicalSize"},{"type":"reference","id":1024,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":928,"name":"setPosition","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1307,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1307"}],"signatures":[{"id":929,"name":"setPosition","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":930,"name":"position","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The new position, in logical or physical pixels."}]},"type":{"type":"union","types":[{"type":"reference","id":1051,"name":"PhysicalPosition"},{"type":"reference","id":1043,"name":"LogicalPosition"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":888,"name":"setResizable","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":849,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L849"}],"signatures":[{"id":889,"name":"setResizable","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":890,"name":"resizable","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":919,"name":"setSize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1185,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1185"}],"signatures":[{"id":920,"name":"setSize","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":921,"name":"size","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The logical or physical inner size."}]},"type":{"type":"union","types":[{"type":"reference","id":1032,"name":"PhysicalSize"},{"type":"reference","id":1024,"name":"LogicalSize"}]}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":939,"name":"setSkipTaskbar","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1443,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1443"}],"signatures":[{"id":940,"name":"setSkipTaskbar","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":941,"name":"skip","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"true to hide window icon, false to show it."}]},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":891,"name":"setTitle","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":876,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L876"}],"signatures":[{"id":892,"name":"setTitle","kind":4096,"kindString":"Call signature","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."}]}]},"parameters":[{"id":893,"name":"title","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"The new title"}]},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":904,"name":"show","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1027,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1027"}],"signatures":[{"id":905,"name":"show","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":957,"name":"startDragging","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1635,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1635"}],"signatures":[{"id":958,"name":"startDragging","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":881,"name":"theme","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":748,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L748"}],"signatures":[{"id":882,"name":"theme","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":1071,"name":"Theme"}]}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":879,"name":"title","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":718,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L718"}],"signatures":[{"id":880,"name":"title","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":898,"name":"toggleMaximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":952,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L952"}],"signatures":[{"id":899,"name":"toggleMaximize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":896,"name":"unmaximize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":927,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L927"}],"signatures":[{"id":897,"name":"unmaximize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":902,"name":"unminimize","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"window.ts","line":1002,"character":8,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L1002"}],"signatures":[{"id":903,"name":"unminimize","kind":4096,"kindString":"Call signature","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."}]}]},"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[854]},{"title":"Properties","children":[986,987]},{"title":"Methods","children":[1002,883,908,998,906,859,863,873,867,871,869,875,877,988,894,900,965,980,971,977,962,959,974,983,993,861,865,885,857,913,916,942,948,951,945,910,934,931,936,954,925,922,928,888,919,939,891,904,957,881,879,898,896,902]}],"sources":[{"fileName":"window.ts","line":429,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L429"}],"extendedTypes":[{"type":"reference","id":828,"name":"WebviewWindowHandle"}],"extendedBy":[{"type":"reference","id":670,"name":"WebviewWindow"}]},{"id":1073,"name":"Monitor","kind":256,"kindString":"Interface","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":1074,"name":"name","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Human-readable name of the monitor"}]},"sources":[{"fileName":"window.ts","line":80,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L80"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"}]}},{"id":1076,"name":"position","kind":1024,"kindString":"Property","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":84,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L84"}],"type":{"type":"reference","id":1051,"name":"PhysicalPosition"}},{"id":1077,"name":"scaleFactor","kind":1024,"kindString":"Property","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":86,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L86"}],"type":{"type":"intrinsic","name":"number"}},{"id":1075,"name":"size","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The monitor's resolution."}]},"sources":[{"fileName":"window.ts","line":82,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L82"}],"type":{"type":"reference","id":1032,"name":"PhysicalSize"}}],"groups":[{"title":"Properties","children":[1074,1076,1077,1075]}],"sources":[{"fileName":"window.ts","line":78,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L78"}]},{"id":1078,"name":"ScaleFactorChanged","kind":256,"kindString":"Interface","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":1079,"name":"scaleFactor","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The new window scale factor."}]},"sources":[{"fileName":"window.ts","line":96,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L96"}],"type":{"type":"intrinsic","name":"number"}},{"id":1080,"name":"size","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The new window size"}]},"sources":[{"fileName":"window.ts","line":98,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L98"}],"type":{"type":"reference","id":1032,"name":"PhysicalSize"}}],"groups":[{"title":"Properties","children":[1079,1080]}],"sources":[{"fileName":"window.ts","line":94,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L94"}]},{"id":1090,"name":"WindowOptions","kind":256,"kindString":"Interface","flags":{},"comment":{"summary":[{"kind":"text","text":"Configuration for the window to create."}],"blockTags":[{"tag":"@since","content":[{"kind":"text","text":"1.0.0"}]}]},"children":[{"id":1116,"name":"acceptFirstMouse","kind":1024,"kindString":"Property","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":2132,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2132"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1119,"name":"additionalBrowserArguments","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Additional arguments for the webview. **Windows Only**"}]},"sources":[{"fileName":"window.ts","line":2147,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2147"}],"type":{"type":"intrinsic","name":"string"}},{"id":1109,"name":"alwaysOnTop","kind":1024,"kindString":"Property","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":2104,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2104"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1092,"name":"center","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Show window in the center of the screen.."}]},"sources":[{"fileName":"window.ts","line":2066,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2066"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1110,"name":"contentProtected","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Prevents the window contents from being captured by other apps."}]},"sources":[{"fileName":"window.ts","line":2106,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2106"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1108,"name":"decorations","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window should have borders and bars or not."}]},"sources":[{"fileName":"window.ts","line":2102,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2102"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1112,"name":"fileDropEnabled","kind":1024,"kindString":"Property","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":2114,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2114"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1104,"name":"focus","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window will be initially focused or not."}]},"sources":[{"fileName":"window.ts","line":2090,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2090"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1103,"name":"fullscreen","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window is in fullscreen mode or not."}]},"sources":[{"fileName":"window.ts","line":2088,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2088"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1096,"name":"height","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The initial height."}]},"sources":[{"fileName":"window.ts","line":2074,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2074"}],"type":{"type":"intrinsic","name":"number"}},{"id":1115,"name":"hiddenTitle","kind":1024,"kindString":"Property","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":2128,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2128"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1100,"name":"maxHeight","kind":1024,"kindString":"Property","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":2082,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2082"}],"type":{"type":"intrinsic","name":"number"}},{"id":1099,"name":"maxWidth","kind":1024,"kindString":"Property","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":2080,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2080"}],"type":{"type":"intrinsic","name":"number"}},{"id":1106,"name":"maximized","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window should be maximized upon creation or not."}]},"sources":[{"fileName":"window.ts","line":2098,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2098"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1098,"name":"minHeight","kind":1024,"kindString":"Property","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":2078,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2078"}],"type":{"type":"intrinsic","name":"number"}},{"id":1097,"name":"minWidth","kind":1024,"kindString":"Property","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":2076,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2076"}],"type":{"type":"intrinsic","name":"number"}},{"id":1101,"name":"resizable","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window is resizable or not."}]},"sources":[{"fileName":"window.ts","line":2084,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2084"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1111,"name":"skipTaskbar","kind":1024,"kindString":"Property","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":2108,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2108"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1117,"name":"tabbingIdentifier","kind":1024,"kindString":"Property","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":2139,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2139"}],"type":{"type":"intrinsic","name":"string"}},{"id":1113,"name":"theme","kind":1024,"kindString":"Property","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":2120,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2120"}],"type":{"type":"reference","id":1071,"name":"Theme"}},{"id":1102,"name":"title","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Window title."}]},"sources":[{"fileName":"window.ts","line":2086,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2086"}],"type":{"type":"intrinsic","name":"string"}},{"id":1114,"name":"titleBarStyle","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The style of the macOS title bar."}]},"sources":[{"fileName":"window.ts","line":2124,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2124"}],"type":{"type":"reference","id":1072,"name":"TitleBarStyle"}},{"id":1105,"name":"transparent","kind":1024,"kindString":"Property","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":2096,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2096"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1091,"name":"url","kind":1024,"kindString":"Property","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,...`"},{"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":2064,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2064"}],"type":{"type":"intrinsic","name":"string"}},{"id":1118,"name":"userAgent","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The user agent for the webview."}]},"sources":[{"fileName":"window.ts","line":2143,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2143"}],"type":{"type":"intrinsic","name":"string"}},{"id":1107,"name":"visible","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the window should be immediately visible upon creation or not."}]},"sources":[{"fileName":"window.ts","line":2100,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2100"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1095,"name":"width","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The initial width."}]},"sources":[{"fileName":"window.ts","line":2072,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2072"}],"type":{"type":"intrinsic","name":"number"}},{"id":1093,"name":"x","kind":1024,"kindString":"Property","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":2068,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2068"}],"type":{"type":"intrinsic","name":"number"}},{"id":1094,"name":"y","kind":1024,"kindString":"Property","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":2070,"character":2,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2070"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[1116,1119,1109,1092,1110,1108,1112,1104,1103,1096,1115,1100,1099,1106,1098,1097,1101,1111,1117,1113,1102,1114,1105,1091,1118,1107,1095,1093,1094]}],"sources":[{"fileName":"window.ts","line":2056,"character":10,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2056"}]},{"id":668,"name":"CursorIcon","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"window.ts","line":234,"character":12,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L234"}],"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":1081,"name":"FileDropEvent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"The file drop event types."}]},"sources":[{"fileName":"window.ts","line":102,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L102"}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":1082,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1084,"name":"paths","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":103,"character":21,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L103"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":1083,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":103,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L103"}],"type":{"type":"literal","value":"hover"}}],"groups":[{"title":"Properties","children":[1084,1083]}],"sources":[{"fileName":"window.ts","line":103,"character":4,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L103"}]}},{"type":"reflection","declaration":{"id":1085,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1087,"name":"paths","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":104,"character":20,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L104"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":1086,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":104,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L104"}],"type":{"type":"literal","value":"drop"}}],"groups":[{"title":"Properties","children":[1087,1086]}],"sources":[{"fileName":"window.ts","line":104,"character":4,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L104"}]}},{"type":"reflection","declaration":{"id":1088,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":1089,"name":"type","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"window.ts","line":105,"character":6,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L105"}],"type":{"type":"literal","value":"cancel"}}],"groups":[{"title":"Properties","children":[1089]}],"sources":[{"fileName":"window.ts","line":105,"character":4,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L105"}]}}]}},{"id":1071,"name":"Theme","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"window.ts","line":70,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L70"}],"type":{"type":"union","types":[{"type":"literal","value":"light"},{"type":"literal","value":"dark"}]}},{"id":1072,"name":"TitleBarStyle","kind":4194304,"kindString":"Type alias","flags":{},"sources":[{"fileName":"window.ts","line":71,"character":5,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L71"}],"type":{"type":"union","types":[{"type":"literal","value":"visible"},{"type":"literal","value":"transparent"},{"type":"literal","value":"overlay"}]}},{"id":1023,"name":"appWindow","kind":32,"kindString":"Variable","flags":{},"comment":{"summary":[{"kind":"text","text":"The WebviewWindow for the current window."}]},"sources":[{"fileName":"window.ts","line":2032,"character":4,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2032"}],"type":{"type":"reference","id":670,"name":"WebviewWindow"}},{"id":1069,"name":"availableMonitors","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":2221,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2221"}],"signatures":[{"id":1070,"name":"availableMonitors","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"array","elementType":{"type":"reference","id":1073,"name":"Monitor"}}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":1065,"name":"currentMonitor","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":2172,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2172"}],"signatures":[{"id":1066,"name":"currentMonitor","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"reference","id":1073,"name":"Monitor"},{"type":"literal","value":null}]}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]},{"id":1021,"name":"getAll","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":292,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L292"}],"signatures":[{"id":1022,"name":"getAll","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"array","elementType":{"type":"reference","id":670,"name":"WebviewWindow"}}}]},{"id":1019,"name":"getCurrent","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":280,"character":9,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L280"}],"signatures":[{"id":1020,"name":"getCurrent","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","id":670,"name":"WebviewWindow"}}]},{"id":1067,"name":"primaryMonitor","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"window.ts","line":2197,"character":15,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L2197"}],"signatures":[{"id":1068,"name":"primaryMonitor","kind":4096,"kindString":"Call signature","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"}]}]},"type":{"type":"reference","typeArguments":[{"type":"union","types":[{"type":"reference","id":1073,"name":"Monitor"},{"type":"literal","value":null}]}],"name":"Promise","externalUrl":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise","qualifiedName":"Promise","package":"typescript"}}]}],"groups":[{"title":"Enumerations","children":[1062]},{"title":"Classes","children":[1007,1043,1024,1051,1032,670,828,853]},{"title":"Interfaces","children":[1073,1078,1090]},{"title":"Type Aliases","children":[668,1081,1071,1072]},{"title":"Variables","children":[1023]},{"title":"Functions","children":[1069,1065,1021,1019,1067]}],"sources":[{"fileName":"window.ts","line":65,"character":0,"url":"https://github.com/lorenzolewis/tauri/blob/852e11e1/tooling/api/src/window.ts#L65"}]}],"groups":[{"title":"Modules","children":[1,12,24,30,72,107,206,227,332,346,359,374,450,456,627,645,667]}]} \ No newline at end of file diff --git a/tooling/api/package.json b/tooling/api/package.json index 270a855167e5..e6fa18d40b3f 100644 --- a/tooling/api/package.json +++ b/tooling/api/package.json @@ -11,7 +11,7 @@ "./package.json": "./package.json" }, "scripts": { - "build": "yarn tsup && node ./scripts/after-build.cjs", + "build": "yarn tsup && node ./scripts/after-build.cjs && yarn generate-docs", "npm-pack": "yarn build && cd ./dist && npm pack", "npm-publish": "yarn build && cd ./dist && yarn publish --access public --loglevel silly", "lint": "eslint --ext ts \"./src/**/*.ts\"",