Skip to content

Commit 7160740

Browse files
caidobotcaidobot
committed
Update SDK Documentation
1 parent c72694a commit 7160740

15 files changed

Lines changed: 145 additions & 283 deletions

File tree

‎src/reference/modules/caido/http.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) encapsulates i
1616

1717
##### Constructor
1818

19-
> **new Blob**(`parts`: (`string` \| `ArrayBuffer` \| [`Blob`](#blob))[], `opts?`: [`BlobOpts`](#blobopts)): [`Blob`](#blob)
19+
> **new Blob**(`parts`: (`string` \| [`Blob`](#blob) \| `ArrayBuffer`)[], `opts?`: [`BlobOpts`](#blobopts)): [`Blob`](#blob)
2020
2121
Creates a new `Blob` object containing a concatenation of the given sources.
2222

@@ -29,7 +29,7 @@ String sources are also copied into the `Blob`.
2929

3030
| Parameter | Type |
3131
| ------ | ------ |
32-
| `parts` | (`string` \| `ArrayBuffer` \| [`Blob`](#blob))[] |
32+
| `parts` | (`string` \| [`Blob`](#blob) \| `ArrayBuffer`)[] |
3333
| `opts?` | [`BlobOpts`](#blobopts) |
3434

3535
###### Returns
@@ -116,15 +116,15 @@ A [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) encapsulates i
116116

117117
##### Constructor
118118

119-
> **new File**(`data`: (`string` \| `ArrayBuffer` \| [`Blob`](#blob))[], `fileName`: `string`, `opts?`: [`FileOpts`](#fileopts)): [`File`](#file)
119+
> **new File**(`data`: (`string` \| [`Blob`](#blob) \| `ArrayBuffer`)[], `fileName`: `string`, `opts?`: [`FileOpts`](#fileopts)): [`File`](#file)
120120
121121
Returns a newly constructed File.
122122

123123
###### Parameters
124124

125125
| Parameter | Type |
126126
| ------ | ------ |
127-
| `data` | (`string` \| `ArrayBuffer` \| [`Blob`](#blob))[] |
127+
| `data` | (`string` \| [`Blob`](#blob) \| `ArrayBuffer`)[] |
128128
| `fileName` | `string` |
129129
| `opts?` | [`FileOpts`](#fileopts) |
130130

@@ -539,9 +539,9 @@ Contains the mode of the request
539539

540540
##### signal
541541

542-
> `readonly` **signal**: [`AbortSignal`](../llrt/abort.md#abortsignal)
542+
> `readonly` **signal**: `AbortSignal`
543543
544-
Returns the [AbortSignal](../llrt/abort.md#abortsignal) associated with the request
544+
Returns the AbortSignal associated with the request
545545

546546
##### text()
547547

@@ -817,7 +817,7 @@ however no validation of the type format is performed.
817817
818818
##### signal?
819819

820-
> `optional` **signal**: [`AbortSignal`](../llrt/abort.md#abortsignal)
820+
> `optional` **signal**: `AbortSignal`
821821
822822
##### url?
823823

@@ -865,7 +865,7 @@ however no validation of the type format is performed.
865865

866866
##### signal?
867867

868-
> `readonly` `optional` **signal**: [`AbortSignal`](../llrt/abort.md#abortsignal)
868+
> `readonly` `optional` **signal**: `AbortSignal`
869869
870870
##### status?
871871

‎src/reference/modules/extra/console.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,4 @@ Usually used for unexpected behaviors.
9191

9292
### console
9393

94-
> **console**: [`Console`](#console)
94+
> **console**: `Console`

‎src/reference/modules/extra/timers.md‎

Lines changed: 86 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,35 +23,71 @@ scheduled actions.
2323

2424
### clearInterval()
2525

26+
#### Call Signature
27+
28+
> **clearInterval**(`id`: `number` \| `undefined`): `void`
29+
30+
[MDN Reference](https://developer.mozilla.org/docs/Web/API/clearInterval)
31+
32+
##### Parameters
33+
34+
| Parameter | Type |
35+
| ------ | ------ |
36+
| `id` | `number` \| `undefined` |
37+
38+
##### Returns
39+
40+
`void`
41+
42+
#### Call Signature
43+
2644
> **clearInterval**(`interval`: [`Timeout`](#timeout)): `void`
2745
2846
Cancels a `Timeout` object created by `setInterval()`.
2947

30-
#### Parameters
48+
##### Parameters
3149

3250
| Parameter | Type |
3351
| ------ | ------ |
3452
| `interval` | [`Timeout`](#timeout) |
3553

36-
#### Returns
54+
##### Returns
3755

3856
`void`
3957

4058
***
4159

4260
### clearTimeout()
4361

62+
#### Call Signature
63+
64+
> **clearTimeout**(`id`: `number` \| `undefined`): `void`
65+
66+
[MDN Reference](https://developer.mozilla.org/docs/Web/API/clearTimeout)
67+
68+
##### Parameters
69+
70+
| Parameter | Type |
71+
| ------ | ------ |
72+
| `id` | `number` \| `undefined` |
73+
74+
##### Returns
75+
76+
`void`
77+
78+
#### Call Signature
79+
4480
> **clearTimeout**(`timeout`: [`Timeout`](#timeout)): `void`
4581
4682
Cancels a `Timeout` object created by `setTimeout()`.
4783

48-
#### Parameters
84+
##### Parameters
4985

5086
| Parameter | Type | Description |
5187
| ------ | ------ | ------ |
5288
| `timeout` | [`Timeout`](#timeout) | A `Timeout` object as returned by [setTimeout](#settimeout). |
5389

54-
#### Returns
90+
##### Returns
5591

5692
`void`
5793

@@ -86,26 +122,46 @@ for use with clearImmediate
86122

87123
### setInterval()
88124

125+
#### Call Signature
126+
127+
> **setInterval**(`handler`: `TimerHandler`, `timeout?`: `number`, ...`arguments?`: `any`[]): `number`
128+
129+
[MDN Reference](https://developer.mozilla.org/docs/Web/API/setInterval)
130+
131+
##### Parameters
132+
133+
| Parameter | Type |
134+
| ------ | ------ |
135+
| `handler` | `TimerHandler` |
136+
| `timeout?` | `number` |
137+
| ...`arguments?` | `any`[] |
138+
139+
##### Returns
140+
141+
`number`
142+
143+
#### Call Signature
144+
89145
> **setInterval**\<`TArgs`\>(`callback`: (...`args`: `TArgs`) => `void`, `ms?`: `number`): [`Timeout`](#timeout)
90146
91147
Schedules repeated execution of `callback` every `delay` milliseconds.
92148

93149
When `delay` isless than `4`, the `delay` will be set to `4`.
94150

95-
#### Type Parameters
151+
##### Type Parameters
96152

97153
| Type Parameter |
98154
| ------ |
99155
| `TArgs` *extends* `any`[] |
100156

101-
#### Parameters
157+
##### Parameters
102158

103159
| Parameter | Type | Description |
104160
| ------ | ------ | ------ |
105161
| `callback` | (...`args`: `TArgs`) => `void` | The function to call when the timer elapses. |
106162
| `ms?` | `number` | - |
107163

108-
#### Returns
164+
##### Returns
109165

110166
[`Timeout`](#timeout)
111167

@@ -115,6 +171,26 @@ for use with [clearInterval](#clearinterval)
115171

116172
### setTimeout()
117173

174+
#### Call Signature
175+
176+
> **setTimeout**(`handler`: `TimerHandler`, `timeout?`: `number`, ...`arguments?`: `any`[]): `number`
177+
178+
[MDN Reference](https://developer.mozilla.org/docs/Web/API/setTimeout)
179+
180+
##### Parameters
181+
182+
| Parameter | Type |
183+
| ------ | ------ |
184+
| `handler` | `TimerHandler` |
185+
| `timeout?` | `number` |
186+
| ...`arguments?` | `any`[] |
187+
188+
##### Returns
189+
190+
`number`
191+
192+
#### Call Signature
193+
118194
> **setTimeout**\<`TArgs`\>(`callback`: (...`args`: `TArgs`) => `void`, `ms?`: `number`): [`Timeout`](#timeout)
119195
120196
Schedules execution of a one-time `callback` after `delay` milliseconds.
@@ -126,20 +202,20 @@ time specified.
126202

127203
When `delay` is less than `4`, the `delay` will be set to `4`.
128204

129-
#### Type Parameters
205+
##### Type Parameters
130206

131207
| Type Parameter |
132208
| ------ |
133209
| `TArgs` *extends* `any`[] |
134210

135-
#### Parameters
211+
##### Parameters
136212

137213
| Parameter | Type | Description |
138214
| ------ | ------ | ------ |
139215
| `callback` | (...`args`: `TArgs`) => `void` | The function to call when the timer elapses. |
140216
| `ms?` | `number` | - |
141217

142-
#### Returns
218+
##### Returns
143219

144220
[`Timeout`](#timeout)
145221

‎src/reference/modules/llrt/abort.md‎

Lines changed: 2 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ A signal object that allows you to communicate with a DOM request (such as a Fet
5252

5353
#### Extends
5454

55-
- [`EventTarget`](dom-events.md#eventtarget)
55+
- `EventTarget`
5656

5757
#### Constructors
5858

@@ -68,7 +68,7 @@ Creates a new `AbortSignal` object instance.
6868

6969
###### Overrides
7070

71-
[`EventTarget`](dom-events.md#eventtarget).[`constructor`](dom-events.md#constructor-1)
71+
`EventTarget.constructor`
7272

7373
#### Properties
7474

@@ -92,71 +92,6 @@ A JavaScript value providing the abort reason, once the signal has aborted.
9292

9393
#### Methods
9494

95-
##### addEventListener()
96-
97-
> **addEventListener**(`type`: [`EventKey`](dom-events.md#eventkey), `listener`: [`EventListener`](dom-events.md#eventlistener), `options?`: [`AddEventListenerOptions`](dom-events.md#addeventlisteneroptions)): `void`
98-
99-
Adds a new handler for the `type` event. Any given `listener` is added only once per `type`.
100-
101-
If the `once` option is true, the `listener` is removed after the next time a `type` event is dispatched.
102-
103-
###### Parameters
104-
105-
| Parameter | Type |
106-
| ------ | ------ |
107-
| `type` | [`EventKey`](dom-events.md#eventkey) |
108-
| `listener` | [`EventListener`](dom-events.md#eventlistener) |
109-
| `options?` | [`AddEventListenerOptions`](dom-events.md#addeventlisteneroptions) |
110-
111-
###### Returns
112-
113-
`void`
114-
115-
###### Inherited from
116-
117-
[`EventTarget`](dom-events.md#eventtarget).[`addEventListener`](dom-events.md#addeventlistener)
118-
119-
##### dispatchEvent()
120-
121-
> **dispatchEvent**(`event`: [`Event`](dom-events.md#event)): `void`
122-
123-
Dispatches a synthetic event event to target
124-
125-
###### Parameters
126-
127-
| Parameter | Type |
128-
| ------ | ------ |
129-
| `event` | [`Event`](dom-events.md#event) |
130-
131-
###### Returns
132-
133-
`void`
134-
135-
###### Inherited from
136-
137-
[`EventTarget`](dom-events.md#eventtarget).[`dispatchEvent`](dom-events.md#dispatchevent)
138-
139-
##### removeEventListener()
140-
141-
> **removeEventListener**(`type`: [`EventKey`](dom-events.md#eventkey), `listener`: [`EventListener`](dom-events.md#eventlistener)): `void`
142-
143-
Removes the event listener in target's event listener list with the same type and callback
144-
145-
###### Parameters
146-
147-
| Parameter | Type |
148-
| ------ | ------ |
149-
| `type` | [`EventKey`](dom-events.md#eventkey) |
150-
| `listener` | [`EventListener`](dom-events.md#eventlistener) |
151-
152-
###### Returns
153-
154-
`void`
155-
156-
###### Inherited from
157-
158-
[`EventTarget`](dom-events.md#eventtarget).[`removeEventListener`](dom-events.md#removeeventlistener)
159-
16095
##### throwIfAborted()
16196

16297
> **throwIfAborted**(): `void`

‎src/reference/modules/llrt/buffer.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1640,7 +1640,7 @@ A `TypeError` will be thrown if `size` is not a number.
16401640

16411641
##### byteLength()
16421642

1643-
> **byteLength**(`string`: `string` \| `ArrayBuffer` \| `SharedArrayBuffer` \| [`ArrayBufferView`](globals/namespaces/QuickJS.md#arraybufferview) \| [`Buffer`](#buffer), `encoding?`: [`BufferEncoding`](#bufferencoding)): `number`
1643+
> **byteLength**(`string`: `string` \| [`ArrayBufferView`](globals/namespaces/QuickJS.md#arraybufferview) \| `ArrayBuffer` \| [`Buffer`](#buffer) \| `SharedArrayBuffer`, `encoding?`: [`BufferEncoding`](#bufferencoding)): `number`
16441644
16451645
Returns the byte length of a string when encoded using `encoding`.
16461646
This is not the same as [`String.prototype.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length), which does not account
@@ -1665,7 +1665,7 @@ er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuf
16651665

16661666
| Parameter | Type | Description |
16671667
| ------ | ------ | ------ |
1668-
| `string` | `string` \| `ArrayBuffer` \| `SharedArrayBuffer` \| [`ArrayBufferView`](globals/namespaces/QuickJS.md#arraybufferview) \| [`Buffer`](#buffer) | A value to calculate the length of. |
1668+
| `string` | `string` \| [`ArrayBufferView`](globals/namespaces/QuickJS.md#arraybufferview) \| `ArrayBuffer` \| [`Buffer`](#buffer) \| `SharedArrayBuffer` | A value to calculate the length of. |
16691669
| `encoding?` | [`BufferEncoding`](#bufferencoding) | If `string` is a string, this is its encoding. |
16701670

16711671
###### Returns

0 commit comments

Comments
 (0)