Skip to content

Commit 63cd9f4

Browse files
caidobotcaidobot
committed
Update SDK Documentation
1 parent c72694a commit 63cd9f4

22 files changed

Lines changed: 8723 additions & 582 deletions

File tree

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

Lines changed: 2047 additions & 0 deletions
Large diffs are not rendered by default.

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

Lines changed: 4 additions & 4 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

‎src/reference/modules/index.md‎

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,33 @@
1-
# @caido/quickjs-types
1+
# QuickJS Modules
2+
3+
Here is the reference of the modules available in our engine.
4+
5+
This documentation is auto-generated from the Typescript typing ([`@caido/quickjs-types`](https://www.npmjs.com/package/@caido/quickjs-types)) which is the source of truth.
6+
7+
Some elements are similar to `Node.JS`, but some imports will be different and start with `caido:`.
28

39
## Modules
410

5-
| Module | Description |
6-
| ------ | ------ |
7-
| [caido/http](caido/http.md) | - |
8-
| [extra/console](extra/console.md) | - |
9-
| [extra/os](extra/os.md) | - |
10-
| [extra/sqlite](extra/sqlite.md) | - |
11-
| [extra/timers](extra/timers.md) | - |
12-
| [llrt/abort](llrt/abort.md) | - |
13-
| [llrt/buffer](llrt/buffer.md) | - |
14-
| [llrt/child\_process](llrt/child_process.md) | - |
15-
| [llrt/dom-events](llrt/dom-events.md) | - |
16-
| [llrt/fs](llrt/fs/index.md) | - |
17-
| [llrt/globals](llrt/globals/index.md) | - |
18-
| [llrt/net](llrt/net.md) | - |
19-
| [llrt/path](llrt/path/index.md) | - |
20-
| [llrt/process](llrt/process/index.md) | - |
21-
| [llrt/stream](llrt/stream/index.md) | - |
11+
| Module | Description | Import | Global |
12+
| ---------------------------------------- | ------------------------ | ------------------ | ------ |
13+
| [abort](llrt/abort.md) | Abort signaling | N/A | ✔︎ |
14+
| [buffer](llrt/buffer.md) | Buffers | `buffer` | ✔︎ |
15+
| [child_process](llrt/child_process.md) | Process spawning | `child_process` | ✘ |
16+
| [console](extra/console.md) | Console logging | N/A | ✔︎ |
17+
| [crypto](caido/crypto.md) | Cryptographic primitives | `crypto` | ✘ |
18+
| [dom-events](llrt/dom-events.md) | Event Listeners | N/A | ✔︎ |
19+
| [dns](llrt/dns.md) | DNS | `dns` | ✘ |
20+
| [events](llrt/events.md) | Event Emitter | `events` | ✘ |
21+
| [fs](llrt/fs/index.md) | File system | `fs`, `fs/promise` | ✘ |
22+
| [http](caido/http.md) | Fetch implementation | `caido:http` | ✘ |
23+
| [https](llrt/https.md) | HTTPS | `https` | ✘ |
24+
| [globals](llrt/globals/index.md) | Global classes | N/A | ✔︎ |
25+
| [net](llrt/net.md) | Sockets | `net` | ✘ |
26+
| [os](extra/os.md) | OS information | `os` | ✘ |
27+
| [path](llrt/path/index.md) | Path transformation | `path` | ✘ |
28+
| [sqlite](extra/sqlite.md) | SQlite access | `sqlite` | ✘ |
29+
| [stream](llrt/stream/stream.md) | Streams (basic) | `stream` | ✔︎ |
30+
| [stream/web](llrt/web/index.md) | Streams Web | `stream/web` | ✘ |
31+
| [string_decoder](llrt/string_decoder.md) | String Decoder | `string_decoder` | ✘ |
32+
| [timers](extra/timers.md) | Timers | N/A | ✔︎ |
33+
| [url](llrt/url/index.md) | URL utilities | `url` | ✔︎ |

‎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) \| [`Buffer`](#buffer) \| `ArrayBuffer` \| `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) \| [`Buffer`](#buffer) \| `ArrayBuffer` \| `SharedArrayBuffer` | A value to calculate the length of. |
16691669
| `encoding?` | [`BufferEncoding`](#bufferencoding) | If `string` is a string, this is its encoding. |
16701670

16711671
###### Returns

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ use the [spawn](#spawn) method to create instances of `ChildProcess`.
1313

1414
#### Extends
1515

16-
- [`EventEmitter`](globals/index.md#eventemitter)
16+
- [`EventEmitter`](events.md#eventemitter)
1717

1818
#### Extended by
1919

@@ -32,7 +32,7 @@ use the [spawn](#spawn) method to create instances of `ChildProcess`.
3232

3333
###### Inherited from
3434

35-
[`EventEmitter`](globals/index.md#eventemitter).[`constructor`](globals/index.md#constructor)
35+
[`EventEmitter`](events.md#eventemitter).[`constructor`](events.md#constructor)
3636

3737
#### Properties
3838

@@ -143,7 +143,7 @@ events.EventEmitter
143143

144144
###### Overrides
145145

146-
[`EventEmitter`](globals/index.md#eventemitter).[`addListener`](globals/index.md#addlistener)
146+
[`EventEmitter`](events.md#eventemitter).[`addListener`](events.md#addlistener)
147147

148148
###### Call Signature
149149

@@ -265,7 +265,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
265265

266266
###### Overrides
267267

268-
[`EventEmitter`](globals/index.md#eventemitter).[`emit`](globals/index.md#emit)
268+
[`EventEmitter`](events.md#eventemitter).[`emit`](events.md#emit)
269269

270270
###### Call Signature
271271

@@ -353,7 +353,7 @@ console.log(myEE.eventNames());
353353

354354
###### Inherited from
355355

356-
[`EventEmitter`](globals/index.md#eventemitter).[`eventNames`](globals/index.md#eventnames)
356+
[`EventEmitter`](events.md#eventemitter).[`eventNames`](events.md#eventnames)
357357

358358
##### kill()
359359

@@ -451,7 +451,7 @@ Alias for `emitter.removeListener()`.
451451

452452
###### Inherited from
453453

454-
[`EventEmitter`](globals/index.md#eventemitter).[`off`](globals/index.md#off)
454+
[`EventEmitter`](events.md#eventemitter).[`off`](events.md#off)
455455

456456
##### on()
457457

@@ -499,7 +499,7 @@ myEE.emit('foo');
499499

500500
###### Overrides
501501

502-
[`EventEmitter`](globals/index.md#eventemitter).[`on`](globals/index.md#on)
502+
[`EventEmitter`](events.md#eventemitter).[`on`](events.md#on)
503503

504504
###### Call Signature
505505

@@ -600,7 +600,7 @@ v0.3.0
600600

601601
###### Overrides
602602

603-
[`EventEmitter`](globals/index.md#eventemitter).[`once`](globals/index.md#once)
603+
[`EventEmitter`](events.md#eventemitter).[`once`](events.md#once)
604604

605605
###### Call Signature
606606

@@ -685,7 +685,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
685685

686686
###### Overrides
687687

688-
[`EventEmitter`](globals/index.md#eventemitter).[`prependListener`](globals/index.md#prependlistener)
688+
[`EventEmitter`](events.md#eventemitter).[`prependListener`](events.md#prependlistener)
689689

690690
###### Call Signature
691691

@@ -768,7 +768,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
768768

769769
###### Overrides
770770

771-
[`EventEmitter`](globals/index.md#eventemitter).[`prependOnceListener`](globals/index.md#prependoncelistener)
771+
[`EventEmitter`](events.md#eventemitter).[`prependOnceListener`](events.md#prependoncelistener)
772772

773773
###### Call Signature
774774

@@ -921,7 +921,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
921921

922922
###### Inherited from
923923

924-
[`EventEmitter`](globals/index.md#eventemitter).[`removeListener`](globals/index.md#removelistener)
924+
[`EventEmitter`](events.md#eventemitter).[`removeListener`](events.md#removelistener)
925925

926926
## Interfaces
927927

0 commit comments

Comments
 (0)