Skip to content

Commit 08286ab

Browse files
committed
Regenerate doc
1 parent 8dfef54 commit 08286ab

30 files changed

Lines changed: 8207 additions & 7343 deletions

‎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/extra/url.md‎

Lines changed: 0 additions & 281 deletions
This file was deleted.
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

0 commit comments

Comments
 (0)