Skip to content

Commit cb0931c

Browse files
tauri-botLaegel
andauthored
chore(docs): Update Rust & TS docs (tauri-apps#256)
Co-authored-by: Laegel <[email protected]>
1 parent 780502a commit cb0931c

File tree

159 files changed

+3717
-3188
lines changed

Some content is hidden

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

159 files changed

+3717
-3188
lines changed

docs/en/api/js/classes/http.body.md

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

2020
#### Defined in
2121

22-
[http.ts:45](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L45)
22+
[http.ts:45](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L45)
2323

2424
___
2525

@@ -29,7 +29,7 @@ ___
2929

3030
#### Defined in
3131

32-
[http.ts:44](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L44)
32+
[http.ts:44](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L44)
3333

3434
## Methods
3535

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

5454
#### Defined in
5555

56-
[http.ts:93](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L93)
56+
[http.ts:93](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L93)
5757

5858
___
5959

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

7878
#### Defined in
7979

80-
[http.ts:60](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L60)
80+
[http.ts:60](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L60)
8181

8282
___
8383

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

102102
#### Defined in
103103

104-
[http.ts:71](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L71)
104+
[http.ts:71](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L71)
105105

106106
___
107107

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

126126
#### Defined in
127127

128-
[http.ts:82](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L82)
128+
[http.ts:82](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L82)

docs/en/api/js/classes/http.client.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ hide_title: true
1717

1818
#### Defined in
1919

20-
[http.ts:158](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L158)
20+
[http.ts:158](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L158)
2121

2222
## Methods
2323

@@ -48,7 +48,7 @@ A promise resolving to the response.
4848

4949
#### Defined in
5050

51-
[http.ts:299](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L299)
51+
[http.ts:299](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L299)
5252

5353
___
5454

@@ -64,7 +64,7 @@ Drops the client instance.
6464

6565
#### Defined in
6666

67-
[http.ts:169](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L169)
67+
[http.ts:169](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L169)
6868

6969
___
7070

@@ -95,7 +95,7 @@ A promise resolving to the response.
9595

9696
#### Defined in
9797

98-
[http.ts:227](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L227)
98+
[http.ts:227](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L227)
9999

100100
___
101101

@@ -126,7 +126,7 @@ A promise resolving to the response.
126126

127127
#### Defined in
128128

129-
[http.ts:284](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L284)
129+
[http.ts:284](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L284)
130130

131131
___
132132

@@ -158,7 +158,7 @@ A promise resolving to the response.
158158

159159
#### Defined in
160160

161-
[http.ts:243](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L243)
161+
[http.ts:243](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L243)
162162

163163
___
164164

@@ -190,7 +190,7 @@ A promise resolving to the response.
190190

191191
#### Defined in
192192

193-
[http.ts:264](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L264)
193+
[http.ts:264](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L264)
194194

195195
___
196196

@@ -220,4 +220,4 @@ A promise resolving to the response.
220220

221221
#### Defined in
222222

223-
[http.ts:185](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L185)
223+
[http.ts:185](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L185)

docs/en/api/js/classes/http.response.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The response data.
2727

2828
#### Defined in
2929

30-
[http.ts:145](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L145)
30+
[http.ts:145](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L145)
3131

3232
___
3333

@@ -39,7 +39,7 @@ The response headers.
3939

4040
#### Defined in
4141

42-
[http.ts:143](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L143)
42+
[http.ts:143](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L143)
4343

4444
___
4545

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

5252
#### Defined in
5353

54-
[http.ts:141](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L141)
54+
[http.ts:141](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L141)
5555

5656
___
5757

@@ -63,7 +63,7 @@ The response status code.
6363

6464
#### Defined in
6565

66-
[http.ts:139](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L139)
66+
[http.ts:139](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L139)
6767

6868
___
6969

@@ -75,4 +75,4 @@ The request URL.
7575

7676
#### Defined in
7777

78-
[http.ts:137](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/http.ts#L137)
78+
[http.ts:137](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/http.ts#L137)

docs/en/api/js/classes/shell.child.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ hide_title: true
2323

2424
#### Defined in
2525

26-
[shell.ts:133](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L133)
26+
[shell.ts:133](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L133)
2727

2828
## Properties
2929

@@ -35,7 +35,7 @@ The child process `pid`.
3535

3636
#### Defined in
3737

38-
[shell.ts:133](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L133)
38+
[shell.ts:133](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L133)
3939

4040
## Methods
4141

@@ -53,7 +53,7 @@ A promise indicating the success or failure of the operation.
5353

5454
#### Defined in
5555

56-
[shell.ts:169](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L169)
56+
[shell.ts:169](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L169)
5757

5858
___
5959

@@ -85,4 +85,4 @@ A promise indicating the success or failure of the operation.
8585

8686
#### Defined in
8787

88-
[shell.ts:153](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L153)
88+
[shell.ts:153](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L153)

docs/en/api/js/classes/shell.command.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ EventEmitter&lt;&#x27;close&#x27; \| &#x27;error&#x27;\&gt;.constructor
5454

5555
#### Defined in
5656

57-
[shell.ts:207](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L207)
57+
[shell.ts:207](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L207)
5858

5959
## Properties
6060

@@ -66,7 +66,7 @@ Event emitter for the `stderr`. Emits the `data` event.
6666

6767
#### Defined in
6868

69-
[shell.ts:207](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L207)
69+
[shell.ts:207](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L207)
7070

7171
___
7272

@@ -78,7 +78,7 @@ Event emitter for the `stdout`. Emits the `data` event.
7878

7979
#### Defined in
8080

81-
[shell.ts:205](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L205)
81+
[shell.ts:205](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L205)
8282

8383
## Methods
8484

@@ -105,7 +105,7 @@ A promise resolving to the child process output.
105105

106106
#### Defined in
107107

108-
[shell.ts:292](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L292)
108+
[shell.ts:292](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L292)
109109

110110
___
111111

@@ -134,7 +134,7 @@ EventEmitter.on
134134

135135
#### Defined in
136136

137-
[shell.ts:125](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L125)
137+
[shell.ts:125](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L125)
138138

139139
___
140140

@@ -152,7 +152,7 @@ A promise resolving to the child process handle.
152152

153153
#### Defined in
154154

155-
[shell.ts:255](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L255)
155+
[shell.ts:255](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L255)
156156

157157
___
158158

@@ -182,4 +182,4 @@ const output = await command.execute()
182182

183183
#### Defined in
184184

185-
[shell.ts:240](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/shell.ts#L240)
185+
[shell.ts:240](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/shell.ts#L240)

docs/en/api/js/classes/window.logicalposition.md

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

2727
#### Defined in
2828

29-
[window.ts:76](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L76)
29+
[window.ts:136](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L136)
3030

3131
## Properties
3232

@@ -36,7 +36,7 @@ A position represented in logical pixels.
3636

3737
#### Defined in
3838

39-
[window.ts:74](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L74)
39+
[window.ts:134](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L134)
4040

4141
___
4242

@@ -46,7 +46,7 @@ ___
4646

4747
#### Defined in
4848

49-
[window.ts:75](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L75)
49+
[window.ts:135](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L135)
5050

5151
___
5252

@@ -56,4 +56,4 @@ ___
5656

5757
#### Defined in
5858

59-
[window.ts:76](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L76)
59+
[window.ts:136](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L136)

docs/en/api/js/classes/window.logicalsize.md

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

2727
#### Defined in
2828

29-
[window.ts:47](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L47)
29+
[window.ts:107](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L107)
3030

3131
## Properties
3232

@@ -36,7 +36,7 @@ A size represented in logical pixels.
3636

3737
#### Defined in
3838

39-
[window.ts:47](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L47)
39+
[window.ts:107](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L107)
4040

4141
___
4242

@@ -46,7 +46,7 @@ ___
4646

4747
#### Defined in
4848

49-
[window.ts:45](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L45)
49+
[window.ts:105](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L105)
5050

5151
___
5252

@@ -56,4 +56,4 @@ ___
5656

5757
#### Defined in
5858

59-
[window.ts:46](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L46)
59+
[window.ts:106](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L106)

docs/en/api/js/classes/window.physicalposition.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A position represented in physical pixels.
2626

2727
#### Defined in
2828

29-
[window.ts:88](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L88)
29+
[window.ts:148](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L148)
3030

3131
## Properties
3232

@@ -36,7 +36,7 @@ A position represented in physical pixels.
3636

3737
#### Defined in
3838

39-
[window.ts:86](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L86)
39+
[window.ts:146](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L146)
4040

4141
___
4242

@@ -46,7 +46,7 @@ ___
4646

4747
#### Defined in
4848

49-
[window.ts:87](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L87)
49+
[window.ts:147](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L147)
5050

5151
___
5252

@@ -56,7 +56,7 @@ ___
5656

5757
#### Defined in
5858

59-
[window.ts:88](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L88)
59+
[window.ts:148](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L148)
6060

6161
## Methods
6262

@@ -78,4 +78,4 @@ Converts the physical position to a logical one.
7878

7979
#### Defined in
8080

81-
[window.ts:96](https://github.com/tauri-apps/tauri/blob/e663bdd/tooling/api/src/window.ts#L96)
81+
[window.ts:156](https://github.com/tauri-apps/tauri/blob/af634db/tooling/api/src/window.ts#L156)

0 commit comments

Comments
 (0)