Skip to content

Commit 829c713

Browse files
authored
chore(docs): Update Rust & TS docs (tauri-apps#573)
Co-authored-by: tauri-bot <[email protected]>
1 parent 418a367 commit 829c713

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+390
-358
lines changed

docs/api/cli.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ import Command from '@theme/Command'
1212
```
1313
1414
USAGE:
15-
cargo-tauri info
15+
cargo-tauri info [OPTIONS]
1616
1717
OPTIONS:
1818
-h, --help Print help information
19+
-v, --verbose Enables verbose logging
1920
-V, --version Print version information
2021
```
2122

@@ -62,6 +63,9 @@ OPTIONS:
6263
-t, --tauri-path <TAURI_PATH>
6364
Path of the Tauri project to use (relative to the cwd)
6465
66+
-v, --verbose
67+
Enables verbose logging
68+
6569
-V, --version
6670
Print version information
6771
@@ -86,6 +90,7 @@ OPTIONS:
8690
-h, --help Print help information
8791
-n, --name <PLUGIN_NAME> Name of your Tauri plugin
8892
-t, --tauri-path <TAURI_PATH> Path of the Tauri project to use (relative to the cwd)
93+
-v, --verbose Enables verbose logging
8994
-V, --version Print version information
9095
```
9196

@@ -109,6 +114,7 @@ OPTIONS:
109114
-r, --runner <RUNNER> Binary to use to run the application
110115
--release Run the code in release mode
111116
-t, --target <TARGET> Target triple to build against
117+
-v, --verbose Enables verbose logging
112118
-V, --version Print version information
113119
```
114120

docs/api/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ In addition to the JSON defined on the `tauri.conf.json` file, Tauri reads a pla
219219
{ property: "pattern", optional: true, type: "PatternKind", description: `The pattern to use.` },
220220
{ property: "security", optional: true, type: "SecurityConfig", description: `Security configuration.`, child: <Properties anchorRoot="tauri.security" rows={[
221221
{ property: "csp", optional: true, type: "Csp", description: `The Content Security Policy that will be injected on all HTML files on the built application. If [\`dev_csp\`](SecurityConfig.dev_csp) is not specified, this value is also injected on dev. This is a really important part of the configuration since it helps you ensure your WebView is secured. See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP">https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP</a>.`, child: <Properties anchorRoot="tauri.security.csp" rows={[]}/> },
222-
{ property: "dangerousDisableAssetCspModification", optional: true, type: "boolean", description: `Disables the Tauri-injected CSP sources. At compile time, Tauri parses all the frontend assets and changes the Content-Security-Policy to only allow loading of your own scripts and styles by injecting nonce and hash sources. This stricts your CSP, which may introduce issues when using along with other flexing sources. **WARNING:** Only disable this if you know what you are doing and have properly configured the CSP. Your application might be vulnerable to XSS attacks without this Tauri protection.` },
222+
{ property: "dangerousDisableAssetCspModification", optional: true, type: "DisabledCspModificationKind", description: `Disables the Tauri-injected CSP sources. At compile time, Tauri parses all the frontend assets and changes the Content-Security-Policy to only allow loading of your own scripts and styles by injecting nonce and hash sources. This stricts your CSP, which may introduce issues when using along with other flexing sources. This configuration option allows both a boolean and a list of strings as value. A boolean instructs Tauri to disable the injection for all CSP injections, and a list of strings indicates the CSP directives that Tauri cannot inject. **WARNING:** Only disable this if you know what you are doing and have properly configured the CSP. Your application might be vulnerable to XSS attacks without this Tauri protection.` },
223223
{ property: "devCsp", optional: true, type: "Csp", description: `The Content Security Policy that will be injected on all HTML files on development. This is a really important part of the configuration since it helps you ensure your WebView is secured. See <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP">https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP</a>.`, child: <Properties anchorRoot="tauri.security.devCsp" rows={[]}/> },
224224
{ property: "freezePrototype", optional: true, type: "boolean", description: `Freeze the \`Object.prototype\` when using the custom protocol.` },
225225
]}/> },

docs/api/js/classes/http.Body.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The body object to be used on POST and PUT requests.
1414

1515
#### Defined in
1616

17-
[http.ts:70](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L70)
17+
[http.ts:75](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L75)
1818

1919
___
2020

@@ -24,7 +24,7 @@ ___
2424

2525
#### Defined in
2626

27-
[http.ts:69](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L69)
27+
[http.ts:74](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L74)
2828

2929
## Methods
3030

@@ -48,7 +48,7 @@ The body object ready to be used on the POST and PUT requests.
4848

4949
#### Defined in
5050

51-
[http.ts:155](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L155)
51+
[http.ts:160](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L160)
5252

5353
___
5454

@@ -92,7 +92,7 @@ The body object ready to be used on the POST and PUT requests.
9292

9393
#### Defined in
9494

95-
[http.ts:105](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L105)
95+
[http.ts:110](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L110)
9696

9797
___
9898

@@ -116,7 +116,7 @@ The body object ready to be used on the POST and PUT requests.
116116

117117
#### Defined in
118118

119-
[http.ts:133](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L133)
119+
[http.ts:138](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L138)
120120

121121
___
122122

@@ -140,4 +140,4 @@ The body object ready to be used on the POST and PUT requests.
140140

141141
#### Defined in
142142

143-
[http.ts:144](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L144)
143+
[http.ts:149](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L149)

docs/api/js/classes/http.Client.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
#### Defined in
1414

15-
[http.ts:225](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L225)
15+
[http.ts:230](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L230)
1616

1717
## Methods
1818

@@ -43,7 +43,7 @@ A promise resolving to the response.
4343

4444
#### Defined in
4545

46-
[http.ts:369](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L369)
46+
[http.ts:374](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L374)
4747

4848
___
4949

@@ -59,7 +59,7 @@ Drops the client instance.
5959

6060
#### Defined in
6161

62-
[http.ts:236](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L236)
62+
[http.ts:241](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L241)
6363

6464
___
6565

@@ -90,7 +90,7 @@ A promise resolving to the response.
9090

9191
#### Defined in
9292

93-
[http.ts:297](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L297)
93+
[http.ts:302](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L302)
9494

9595
___
9696

@@ -121,7 +121,7 @@ A promise resolving to the response.
121121

122122
#### Defined in
123123

124-
[http.ts:354](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L354)
124+
[http.ts:359](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L359)
125125

126126
___
127127

@@ -153,7 +153,7 @@ A promise resolving to the response.
153153

154154
#### Defined in
155155

156-
[http.ts:313](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L313)
156+
[http.ts:318](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L318)
157157

158158
___
159159

@@ -185,7 +185,7 @@ A promise resolving to the response.
185185

186186
#### Defined in
187187

188-
[http.ts:334](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L334)
188+
[http.ts:339](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L339)
189189

190190
___
191191

@@ -215,4 +215,4 @@ A promise resolving to the response.
215215

216216
#### Defined in
217217

218-
[http.ts:252](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L252)
218+
[http.ts:257](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L257)

docs/api/js/classes/http.Response.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The response data.
2222

2323
#### Defined in
2424

25-
[http.ts:211](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L211)
25+
[http.ts:216](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L216)
2626

2727
___
2828

@@ -34,7 +34,7 @@ The response headers.
3434

3535
#### Defined in
3636

37-
[http.ts:207](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L207)
37+
[http.ts:212](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L212)
3838

3939
___
4040

@@ -46,7 +46,7 @@ A boolean indicating whether the response was successful (status in the range 20
4646

4747
#### Defined in
4848

49-
[http.ts:205](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L205)
49+
[http.ts:210](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L210)
5050

5151
___
5252

@@ -58,7 +58,7 @@ The response raw headers.
5858

5959
#### Defined in
6060

61-
[http.ts:209](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L209)
61+
[http.ts:214](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L214)
6262

6363
___
6464

@@ -70,7 +70,7 @@ The response status code.
7070

7171
#### Defined in
7272

73-
[http.ts:203](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L203)
73+
[http.ts:208](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L208)
7474

7575
___
7676

@@ -82,4 +82,4 @@ The request URL.
8282

8383
#### Defined in
8484

85-
[http.ts:201](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/http.ts#L201)
85+
[http.ts:206](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/http.ts#L206)

docs/api/js/classes/shell.Child.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
#### Defined in
2020

21-
[shell.ts:183](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L183)
21+
[shell.ts:183](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L183)
2222

2323
## Properties
2424

@@ -30,7 +30,7 @@ The child process `pid`.
3030

3131
#### Defined in
3232

33-
[shell.ts:181](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L181)
33+
[shell.ts:181](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L181)
3434

3535
## Methods
3636

@@ -48,7 +48,7 @@ A promise indicating the success or failure of the operation.
4848

4949
#### Defined in
5050

51-
[shell.ts:218](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L218)
51+
[shell.ts:218](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L218)
5252

5353
___
5454

@@ -80,4 +80,4 @@ A promise indicating the success or failure of the operation.
8080

8181
#### Defined in
8282

83-
[shell.ts:201](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L201)
83+
[shell.ts:201](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L201)

docs/api/js/classes/shell.Command.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Creates a new `Command` instance.
4949

5050
#### Defined in
5151

52-
[shell.ts:266](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L266)
52+
[shell.ts:266](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L266)
5353

5454
## Properties
5555

@@ -61,7 +61,7 @@ Event emitter for the `stderr`. Emits the `data` event.
6161

6262
#### Defined in
6363

64-
[shell.ts:256](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L256)
64+
[shell.ts:256](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L256)
6565

6666
___
6767

@@ -73,7 +73,7 @@ Event emitter for the `stdout`. Emits the `data` event.
7373

7474
#### Defined in
7575

76-
[shell.ts:254](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L254)
76+
[shell.ts:254](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L254)
7777

7878
## Methods
7979

@@ -100,7 +100,7 @@ A promise resolving to the child process output.
100100

101101
#### Defined in
102102

103-
[shell.ts:343](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L343)
103+
[shell.ts:343](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L343)
104104

105105
___
106106

@@ -129,7 +129,7 @@ The `this` instance for chained calls.
129129

130130
#### Defined in
131131

132-
[shell.ts:173](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L173)
132+
[shell.ts:173](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L173)
133133

134134
___
135135

@@ -147,7 +147,7 @@ A promise resolving to the child process handle.
147147

148148
#### Defined in
149149

150-
[shell.ts:306](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L306)
150+
[shell.ts:306](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L306)
151151

152152
___
153153

@@ -177,4 +177,4 @@ const output = await command.execute()
177177

178178
#### Defined in
179179

180-
[shell.ts:291](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L291)
180+
[shell.ts:291](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L291)

docs/api/js/classes/shell.EventEmitter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ The `this` instance for chained calls.
5151

5252
#### Defined in
5353

54-
[shell.ts:173](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/shell.ts#L173)
54+
[shell.ts:173](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/shell.ts#L173)

docs/api/js/classes/window.LogicalPosition.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A position represented in logical pixels.
2121

2222
#### Defined in
2323

24-
[window.ts:165](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/window.ts#L165)
24+
[window.ts:165](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/window.ts#L165)
2525

2626
## Properties
2727

@@ -31,7 +31,7 @@ A position represented in logical pixels.
3131

3232
#### Defined in
3333

34-
[window.ts:161](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/window.ts#L161)
34+
[window.ts:161](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/window.ts#L161)
3535

3636
___
3737

@@ -41,7 +41,7 @@ ___
4141

4242
#### Defined in
4343

44-
[window.ts:162](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/window.ts#L162)
44+
[window.ts:162](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/window.ts#L162)
4545

4646
___
4747

@@ -51,4 +51,4 @@ ___
5151

5252
#### Defined in
5353

54-
[window.ts:163](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/window.ts#L163)
54+
[window.ts:163](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/window.ts#L163)

docs/api/js/classes/window.LogicalSize.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A size represented in logical pixels.
2121

2222
#### Defined in
2323

24-
[window.ts:136](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/window.ts#L136)
24+
[window.ts:136](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/window.ts#L136)
2525

2626
## Properties
2727

@@ -31,7 +31,7 @@ A size represented in logical pixels.
3131

3232
#### Defined in
3333

34-
[window.ts:134](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/window.ts#L134)
34+
[window.ts:134](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/window.ts#L134)
3535

3636
___
3737

@@ -41,7 +41,7 @@ ___
4141

4242
#### Defined in
4343

44-
[window.ts:132](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/window.ts#L132)
44+
[window.ts:132](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/window.ts#L132)
4545

4646
___
4747

@@ -51,4 +51,4 @@ ___
5151

5252
#### Defined in
5353

54-
[window.ts:133](https://github.com/tauri-apps/tauri/blob/cf22f4c/tooling/api/src/window.ts#L133)
54+
[window.ts:133](https://github.com/tauri-apps/tauri/blob/86d82af/tooling/api/src/window.ts#L133)

0 commit comments

Comments
 (0)