Skip to content

Commit 8fed831

Browse files
authored
chore(docs): Update Rust & TS docs (tauri-apps#656)
Co-authored-by: tauri-bot <[email protected]>
1 parent 6258e86 commit 8fed831

Some content is hidden

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

60 files changed

+367
-367
lines changed

docs/api/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration
22

3-
The tauri.conf.json is a file generated by the [`tauri init`](https://tauri.studio/v1/api/cli#init) command that lives in your Tauri application source directory (src-tauri).
3+
The tauri.conf.json is a file generated by the [`tauri init`](https://tauri.app/v1/api/cli#init) command that lives in your Tauri application source directory (src-tauri).
44

55
Once generated, you may modify it at will to customize your Tauri application.
66

@@ -496,7 +496,7 @@ Type: `object`
496496
| <div className="anchor-with-padding" id="shellallowlistconfig.scope">`scope`<a class="hash-link" href="#shellallowlistconfig.scope"></a></div> | [`ShellAllowlistScope`](#shellallowlistscope) | [] | Access scope for the binary execution APIs. Sidecars are automatically enabled. |
497497
| <div className="anchor-with-padding" id="shellallowlistconfig.all">`all`<a class="hash-link" href="#shellallowlistconfig.all"></a></div> | `boolean` | `false` | Use this flag to enable all shell API features. |
498498
| <div className="anchor-with-padding" id="shellallowlistconfig.execute">`execute`<a class="hash-link" href="#shellallowlistconfig.execute"></a></div> | `boolean` | `false` | Enable binary execution. |
499-
| <div className="anchor-with-padding" id="shellallowlistconfig.sidecar">`sidecar`<a class="hash-link" href="#shellallowlistconfig.sidecar"></a></div> | `boolean` | `false` | Enable sidecar execution, allowing the JavaScript layer to spawn a sidecar command, an executable that is shipped with the application. For more information see <https://tauri.studio/v1/guides/building/sidecar>. |
499+
| <div className="anchor-with-padding" id="shellallowlistconfig.sidecar">`sidecar`<a class="hash-link" href="#shellallowlistconfig.sidecar"></a></div> | `boolean` | `false` | Enable sidecar execution, allowing the JavaScript layer to spawn a sidecar command, an executable that is shipped with the application. For more information see <https://tauri.app/v1/guides/building/sidecar>. |
500500
| <div className="anchor-with-padding" id="shellallowlistconfig.open">`open`<a class="hash-link" href="#shellallowlistconfig.open"></a></div> | [`ShellAllowlistOpen`](#shellallowlistopen) | `false` | Open URL with the user's default application. |
501501

502502

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:75](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L75)
17+
[http.ts:75](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L75)
1818

1919
___
2020

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

2525
#### Defined in
2626

27-
[http.ts:74](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L74)
27+
[http.ts:74](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L74)
2828

2929
## Methods
3030

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

5555
#### Defined in
5656

57-
[http.ts:176](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L176)
57+
[http.ts:176](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L176)
5858

5959
___
6060

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

9898
#### Defined in
9999

100-
[http.ts:108](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L108)
100+
[http.ts:108](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L108)
101101

102102
___
103103

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

131131
#### Defined in
132132

133-
[http.ts:144](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L144)
133+
[http.ts:144](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L144)
134134

135135
___
136136

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

161161
#### Defined in
162162

163-
[http.ts:160](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L160)
163+
[http.ts:160](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L160)

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

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

1313
#### Defined in
1414

15-
[http.ts:246](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L246)
15+
[http.ts:246](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L246)
1616

1717
## Methods
1818

@@ -50,7 +50,7 @@ A promise resolving to the response.
5050

5151
#### Defined in
5252

53-
[http.ts:456](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L456)
53+
[http.ts:456](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L456)
5454

5555
___
5656

@@ -73,7 +73,7 @@ await client.drop();
7373

7474
#### Defined in
7575

76-
[http.ts:263](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L263)
76+
[http.ts:263](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L263)
7777

7878
___
7979

@@ -115,7 +115,7 @@ A promise resolving to the response.
115115

116116
#### Defined in
117117

118-
[http.ts:343](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L343)
118+
[http.ts:343](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L343)
119119

120120
___
121121

@@ -130,7 +130,7 @@ Makes a PATCH request.
130130
import { getClient, Body } from '@tauri-apps/api/http';
131131
const client = await getClient();
132132
const response = await client.patch('http://localhost:3003/users/1', {
133-
body: Body.json({ email: 'contact@tauri.studio' })
133+
body: Body.json({ email: 'contact@tauri.app' })
134134
});
135135
```
136136

@@ -155,7 +155,7 @@ A promise resolving to the response.
155155

156156
#### Defined in
157157

158-
[http.ts:435](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L435)
158+
[http.ts:435](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L435)
159159

160160
___
161161

@@ -201,7 +201,7 @@ A promise resolving to the response.
201201

202202
#### Defined in
203203

204-
[http.ts:372](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L372)
204+
[http.ts:372](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L372)
205205

206206
___
207207

@@ -248,7 +248,7 @@ A promise resolving to the response.
248248

249249
#### Defined in
250250

251-
[http.ts:407](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L407)
251+
[http.ts:407](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L407)
252252

253253
___
254254

@@ -288,4 +288,4 @@ A promise resolving to the response.
288288

289289
#### Defined in
290290

291-
[http.ts:288](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L288)
291+
[http.ts:288](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L288)

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:232](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L232)
25+
[http.ts:232](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L232)
2626

2727
___
2828

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

3535
#### Defined in
3636

37-
[http.ts:228](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L228)
37+
[http.ts:228](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L228)
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:226](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L226)
49+
[http.ts:226](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L226)
5050

5151
___
5252

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

5959
#### Defined in
6060

61-
[http.ts:230](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L230)
61+
[http.ts:230](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L230)
6262

6363
___
6464

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

7171
#### Defined in
7272

73-
[http.ts:224](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L224)
73+
[http.ts:224](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L224)
7474

7575
___
7676

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

8383
#### Defined in
8484

85-
[http.ts:222](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/http.ts#L222)
85+
[http.ts:222](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/http.ts#L222)

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/dc432ef/tooling/api/src/shell.ts#L183)
21+
[shell.ts:183](https://github.com/tauri-apps/tauri/blob/13c2fc1/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/dc432ef/tooling/api/src/shell.ts#L181)
33+
[shell.ts:181](https://github.com/tauri-apps/tauri/blob/13c2fc1/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:219](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L219)
51+
[shell.ts:219](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L219)
5252

5353
___
5454

@@ -81,4 +81,4 @@ A promise indicating the success or failure of the operation.
8181

8282
#### Defined in
8383

84-
[shell.ts:202](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L202)
84+
[shell.ts:202](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L202)

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

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

5151
#### Defined in
5252

53-
[shell.ts:268](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L268)
53+
[shell.ts:268](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L268)
5454

5555
## Properties
5656

@@ -62,7 +62,7 @@ Event emitter for the `stderr`. Emits the `data` event.
6262

6363
#### Defined in
6464

65-
[shell.ts:258](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L258)
65+
[shell.ts:258](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L258)
6666

6767
___
6868

@@ -74,7 +74,7 @@ Event emitter for the `stdout`. Emits the `data` event.
7474

7575
#### Defined in
7676

77-
[shell.ts:256](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L256)
77+
[shell.ts:256](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L256)
7878

7979
## Methods
8080

@@ -102,7 +102,7 @@ A promise resolving to the child process output.
102102

103103
#### Defined in
104104

105-
[shell.ts:347](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L347)
105+
[shell.ts:347](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L347)
106106

107107
___
108108

@@ -131,7 +131,7 @@ The `this` instance for chained calls.
131131

132132
#### Defined in
133133

134-
[shell.ts:173](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L173)
134+
[shell.ts:173](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L173)
135135

136136
___
137137

@@ -149,7 +149,7 @@ A promise resolving to the child process handle.
149149

150150
#### Defined in
151151

152-
[shell.ts:309](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L309)
152+
[shell.ts:309](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L309)
153153

154154
___
155155

@@ -180,4 +180,4 @@ const output = await command.execute();
180180

181181
#### Defined in
182182

183-
[shell.ts:294](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/shell.ts#L294)
183+
[shell.ts:294](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/shell.ts#L294)

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/dc432ef/tooling/api/src/shell.ts#L173)
54+
[shell.ts:173](https://github.com/tauri-apps/tauri/blob/13c2fc1/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:174](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/window.ts#L174)
24+
[window.ts:174](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/window.ts#L174)
2525

2626
## Properties
2727

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

3232
#### Defined in
3333

34-
[window.ts:170](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/window.ts#L170)
34+
[window.ts:170](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/window.ts#L170)
3535

3636
___
3737

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

4242
#### Defined in
4343

44-
[window.ts:171](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/window.ts#L171)
44+
[window.ts:171](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/window.ts#L171)
4545

4646
___
4747

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

5252
#### Defined in
5353

54-
[window.ts:172](https://github.com/tauri-apps/tauri/blob/dc432ef/tooling/api/src/window.ts#L172)
54+
[window.ts:172](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/window.ts#L172)

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/dc432ef/tooling/api/src/window.ts#L136)
24+
[window.ts:136](https://github.com/tauri-apps/tauri/blob/13c2fc1/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/dc432ef/tooling/api/src/window.ts#L134)
34+
[window.ts:134](https://github.com/tauri-apps/tauri/blob/13c2fc1/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/dc432ef/tooling/api/src/window.ts#L132)
44+
[window.ts:132](https://github.com/tauri-apps/tauri/blob/13c2fc1/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/dc432ef/tooling/api/src/window.ts#L133)
54+
[window.ts:133](https://github.com/tauri-apps/tauri/blob/13c2fc1/tooling/api/src/window.ts#L133)

0 commit comments

Comments
 (0)