Skip to content

Commit f6793cc

Browse files
upgrade typedoc
1 parent 801e1cb commit f6793cc

File tree

30 files changed

+387
-210
lines changed

30 files changed

+387
-210
lines changed

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@
99
* ["esp32-javascript/modules/esp32-javascript/boot"](modules/_esp32_javascript_modules_esp32_javascript_boot_.md)
1010
* ["esp32-javascript/modules/esp32-javascript/config"](modules/_esp32_javascript_modules_esp32_javascript_config_.md)
1111
* ["esp32-javascript/modules/esp32-javascript/configserver"](modules/_esp32_javascript_modules_esp32_javascript_configserver_.md)
12+
* ["esp32-javascript/modules/esp32-javascript/firmware-config"](modules/_esp32_javascript_modules_esp32_javascript_firmware_config_.md)
1213
* ["esp32-javascript/modules/esp32-javascript/global"](modules/_esp32_javascript_modules_esp32_javascript_global_.md)
1314
* ["esp32-javascript/modules/esp32-javascript/http"](modules/_esp32_javascript_modules_esp32_javascript_http_.md)
1415
* ["esp32-javascript/modules/esp32-javascript/index"](modules/_esp32_javascript_modules_esp32_javascript_index_.md)
16+
* ["esp32-javascript/modules/esp32-javascript/self-test"](modules/_esp32_javascript_modules_esp32_javascript_self_test_.md)
17+
* ["esp32-javascript/modules/esp32-javascript/self-test-firmware-config"](modules/_esp32_javascript_modules_esp32_javascript_self_test_firmware_config_.md)
1518
* ["esp32-javascript/modules/esp32-javascript/stringbuffer"](modules/_esp32_javascript_modules_esp32_javascript_stringbuffer_.md)
1619
* ["esp32-javascript/modules/esp32-js-eventloop/index"](modules/_esp32_javascript_modules_esp32_js_eventloop_index_.md)
1720
* ["esp32-javascript/urlparse"](modules/_esp32_javascript_urlparse_.md)

docs/classes/_esp32_javascript_modules_esp32_javascript_http_.eventemitter.md

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

2424
**listener**: *object*
2525

26-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:49](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L49)*
26+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:49](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L49)*
2727

2828
#### Type declaration:
2929

@@ -35,7 +35,7 @@
3535

3636
**emit**(`event`: string): *void*
3737

38-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:53](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L53)*
38+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:53](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L53)*
3939

4040
**Parameters:**
4141

@@ -51,7 +51,7 @@ ___
5151

5252
**on**(`event`: string, `cb`: function): *void*
5353

54-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:50](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L50)*
54+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:50](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L50)*
5555

5656
**Parameters:**
5757

docs/classes/_esp32_javascript_modules_esp32_javascript_http_.xmlhttprequest.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,87 +34,87 @@
3434

3535
**method**: *string* = "GET"
3636

37-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:484](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L484)*
37+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:484](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L484)*
3838

3939
___
4040

4141
### `Optional` onerror
4242

4343
**onerror**? : *undefined | function*
4444

45-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:492](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L492)*
45+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:492](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L492)*
4646

4747
___
4848

4949
### `Optional` onload
5050

5151
**onload**? : *undefined | function*
5252

53-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:493](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L493)*
53+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:493](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L493)*
5454

5555
___
5656

5757
### `Private` `Optional` reponseHeaders
5858

5959
**reponseHeaders**? : *undefined | string*
6060

61-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:485](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L485)*
61+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:485](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L485)*
6262

6363
___
6464

6565
### `Private` `Optional` requestHeaders
6666

6767
**requestHeaders**? : *[StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)*
6868

69-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:486](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L486)*
69+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:486](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L486)*
7070

7171
___
7272

7373
### `Private` `Optional` responseText
7474

7575
**responseText**? : *undefined | string*
7676

77-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:490](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L490)*
77+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:490](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L490)*
7878

7979
___
8080

8181
### `Private` `Optional` responseURL
8282

8383
**responseURL**? : *undefined | string*
8484

85-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:489](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L489)*
85+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:489](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L489)*
8686

8787
___
8888

8989
### `Private` `Optional` status
9090

9191
**status**? : *undefined | number*
9292

93-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:487](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L487)*
93+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:487](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L487)*
9494

9595
___
9696

9797
### `Private` `Optional` statusText
9898

9999
**statusText**? : *undefined | string*
100100

101-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:488](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L488)*
101+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:488](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L488)*
102102

103103
___
104104

105105
### `Private` `Optional` url
106106

107107
**url**? : *[AnchorElement](../interfaces/_esp32_javascript_urlparse_.anchorelement.md)*
108108

109-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:483](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L483)*
109+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:483](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L483)*
110110

111111
## Methods
112112

113113
### getAllResponseHeaders
114114

115115
**getAllResponseHeaders**(): *string | undefined*
116116

117-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:538](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L538)*
117+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:538](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L538)*
118118

119119
**Returns:** *string | undefined*
120120

@@ -124,7 +124,7 @@ ___
124124

125125
**open**(`method`: string, `url`: string): *void*
126126

127-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:542](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L542)*
127+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:542](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L542)*
128128

129129
**Parameters:**
130130

@@ -141,7 +141,7 @@ ___
141141

142142
**send**(`body`: string): *void*
143143

144-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:495](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L495)*
144+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:495](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L495)*
145145

146146
**Parameters:**
147147

@@ -157,7 +157,7 @@ ___
157157

158158
**setRequestHeader**(`name`: string, `value`: string): *void*
159159

160-
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:569](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/http.ts#L569)*
160+
*Defined in [esp32-javascript/modules/esp32-javascript/http.ts:569](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/http.ts#L569)*
161161

162162
**Parameters:**
163163

docs/classes/_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
\+ **new StringBuffer**(`s?`: undefined | string): *[StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)*
3535

36-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:3](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L3)*
36+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:3](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L3)*
3737

3838
**Parameters:**
3939

@@ -47,31 +47,31 @@ Name | Type |
4747

4848
### `Private` content
4949

50-
**content**: *string[]*
50+
**content**: *string | [StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)‹›[]*
5151

52-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:2](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L2)*
52+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:2](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L2)*
5353

5454
___
5555

5656
### length
5757

5858
**length**: *number*
5959

60-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:3](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L3)*
60+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:3](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L3)*
6161

6262
## Methods
6363

6464
### append
6565

66-
**append**(`s`: [StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md) | string): *[StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)*
66+
**append**(...`s`: string | [StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)‹›[]): *[StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)*
6767

68-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:35](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L35)*
68+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:35](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L35)*
6969

7070
**Parameters:**
7171

7272
Name | Type |
7373
------ | ------ |
74-
`s` | [StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md) | string |
74+
`...s` | string | [StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)‹›[] |
7575

7676
**Returns:** *[StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)*
7777

@@ -81,7 +81,7 @@ ___
8181

8282
**indexOf**(`searchString`: string, `position?`: undefined | number): *number*
8383

84-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:14](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L14)*
84+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:14](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L14)*
8585

8686
**Parameters:**
8787

@@ -98,7 +98,7 @@ ___
9898

9999
**substr**(`s`: number, `l`: number): *[StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)*
100100

101-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:97](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L97)*
101+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:98](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L98)*
102102

103103
**Parameters:**
104104

@@ -115,7 +115,7 @@ ___
115115

116116
**substring**(`s`: number, `e?`: undefined | number): *[StringBuffer](_esp32_javascript_modules_esp32_javascript_stringbuffer_.stringbuffer.md)*
117117

118-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:42](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L42)*
118+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:43](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L43)*
119119

120120
**Parameters:**
121121

@@ -132,7 +132,7 @@ ___
132132

133133
**toLowerCase**(): *string*
134134

135-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:18](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L18)*
135+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:18](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L18)*
136136

137137
**Returns:** *string*
138138

@@ -142,7 +142,7 @@ ___
142142

143143
**toString**(): *string*
144144

145-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:26](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L26)*
145+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:26](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L26)*
146146

147147
**Returns:** *string*
148148

@@ -152,6 +152,6 @@ ___
152152

153153
**toUpperCase**(): *string*
154154

155-
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:22](https://github.com/marcelkottmann/esp32-javascript/blob/e6e5921/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L22)*
155+
*Defined in [esp32-javascript/modules/esp32-javascript/stringbuffer.ts:22](https://github.com/marcelkottmann/esp32-javascript/blob/801e1cb/components/esp32-javascript/modules/esp32-javascript/stringbuffer.ts#L22)*
156156

157157
**Returns:** *string*

0 commit comments

Comments
 (0)