Skip to content

Commit

Permalink
gen doc
Browse files Browse the repository at this point in the history
  • Loading branch information
justjake committed Aug 31, 2024
1 parent 2712af5 commit d1a95c6
Show file tree
Hide file tree
Showing 42 changed files with 1,820 additions and 692 deletions.
60 changes: 50 additions & 10 deletions doc/@jitl/quickjs-ffi-types/interfaces/QuickJSAsyncFFI.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ library.
- [QTS\_FreeVoidPointer](QuickJSAsyncFFI.md#qts-freevoidpointer)
- [QTS\_GetArrayBuffer](QuickJSAsyncFFI.md#qts-getarraybuffer)
- [QTS\_GetArrayBufferLength](QuickJSAsyncFFI.md#qts-getarraybufferlength)
- [QTS\_GetDebugLogEnabled](QuickJSAsyncFFI.md#qts-getdebuglogenabled)
- [QTS\_GetFalse](QuickJSAsyncFFI.md#qts-getfalse)
- [QTS\_GetFloat64](QuickJSAsyncFFI.md#qts-getfloat64)
- [QTS\_GetGlobalObject](QuickJSAsyncFFI.md#qts-getglobalobject)
Expand Down Expand Up @@ -81,6 +82,7 @@ library.
- [QTS\_RuntimeEnableModuleLoader](QuickJSAsyncFFI.md#qts-runtimeenablemoduleloader)
- [QTS\_RuntimeSetMaxStackSize](QuickJSAsyncFFI.md#qts-runtimesetmaxstacksize)
- [QTS\_RuntimeSetMemoryLimit](QuickJSAsyncFFI.md#qts-runtimesetmemorylimit)
- [QTS\_SetDebugLogEnabled](QuickJSAsyncFFI.md#qts-setdebuglogenabled)
- [QTS\_SetProp](QuickJSAsyncFFI.md#qts-setprop)
- [QTS\_SetProp\_MaybeAsync](QuickJSAsyncFFI.md#qts-setprop-maybeasync)
- [QTS\_TestStringArg](QuickJSAsyncFFI.md#qts-teststringarg)
Expand Down Expand Up @@ -123,7 +125,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:248](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L248)
[packages/quickjs-ffi-types/src/ffi-async.ts:250](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L250)

***

Expand All @@ -137,7 +139,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:246](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L246)
[packages/quickjs-ffi-types/src/ffi-async.ts:248](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L248)

***

Expand All @@ -151,7 +153,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:245](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L245)
[packages/quickjs-ffi-types/src/ffi-async.ts:247](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L247)

***

Expand Down Expand Up @@ -571,6 +573,24 @@ Set at compile time.

***

### QTS\_GetDebugLogEnabled

> **QTS\_GetDebugLogEnabled**: (`rt`) => `number`
#### Parameters

**rt**: [`JSRuntimePointer`](../exports.md#jsruntimepointer)

#### Returns

`number`

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:245](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L245)

***

### QTS\_GetFalse

> **QTS\_GetFalse**: () => [`JSValueConstPointer`](../exports.md#jsvalueconstpointer)
Expand Down Expand Up @@ -1085,7 +1105,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:247](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L247)
[packages/quickjs-ffi-types/src/ffi-async.ts:249](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L249)

***

Expand Down Expand Up @@ -1311,7 +1331,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:253](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L253)
[packages/quickjs-ffi-types/src/ffi-async.ts:255](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L255)

***

Expand All @@ -1329,7 +1349,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:255](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L255)
[packages/quickjs-ffi-types/src/ffi-async.ts:257](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L257)

***

Expand Down Expand Up @@ -1365,7 +1385,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:252](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L252)
[packages/quickjs-ffi-types/src/ffi-async.ts:254](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L254)

***

Expand All @@ -1385,7 +1405,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:254](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L254)
[packages/quickjs-ffi-types/src/ffi-async.ts:256](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L256)

***

Expand Down Expand Up @@ -1429,6 +1449,26 @@ Set at compile time.

***

### QTS\_SetDebugLogEnabled

> **QTS\_SetDebugLogEnabled**: (`rt`, `is_enabled`) => `void`
#### Parameters

**rt**: [`JSRuntimePointer`](../exports.md#jsruntimepointer)

**is\_enabled**: `number`

#### Returns

`void`

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:246](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L246)

***

### QTS\_SetProp

> **QTS\_SetProp**: (`ctx`, `this_val`, `prop_name`, `prop_value`) => `void`
Expand Down Expand Up @@ -1551,7 +1591,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:260](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L260)
[packages/quickjs-ffi-types/src/ffi-async.ts:262](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L262)

***

Expand All @@ -1571,7 +1611,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi-async.ts:256](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L256)
[packages/quickjs-ffi-types/src/ffi-async.ts:258](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-async.ts#L258)

***

Expand Down
60 changes: 50 additions & 10 deletions doc/@jitl/quickjs-ffi-types/interfaces/QuickJSFFI.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ library.
- [QTS\_FreeVoidPointer](QuickJSFFI.md#qts-freevoidpointer)
- [QTS\_GetArrayBuffer](QuickJSFFI.md#qts-getarraybuffer)
- [QTS\_GetArrayBufferLength](QuickJSFFI.md#qts-getarraybufferlength)
- [QTS\_GetDebugLogEnabled](QuickJSFFI.md#qts-getdebuglogenabled)
- [QTS\_GetFalse](QuickJSFFI.md#qts-getfalse)
- [QTS\_GetFloat64](QuickJSFFI.md#qts-getfloat64)
- [QTS\_GetGlobalObject](QuickJSFFI.md#qts-getglobalobject)
Expand Down Expand Up @@ -73,6 +74,7 @@ library.
- [QTS\_RuntimeEnableModuleLoader](QuickJSFFI.md#qts-runtimeenablemoduleloader)
- [QTS\_RuntimeSetMaxStackSize](QuickJSFFI.md#qts-runtimesetmaxstacksize)
- [QTS\_RuntimeSetMemoryLimit](QuickJSFFI.md#qts-runtimesetmemorylimit)
- [QTS\_SetDebugLogEnabled](QuickJSFFI.md#qts-setdebuglogenabled)
- [QTS\_SetProp](QuickJSFFI.md#qts-setprop)
- [QTS\_TestStringArg](QuickJSFFI.md#qts-teststringarg)
- [QTS\_Throw](QuickJSFFI.md#qts-throw)
Expand Down Expand Up @@ -114,7 +116,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:196](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L196)
[packages/quickjs-ffi-types/src/ffi.ts:198](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L198)

***

Expand All @@ -128,7 +130,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:194](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L194)
[packages/quickjs-ffi-types/src/ffi.ts:196](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L196)

***

Expand All @@ -142,7 +144,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:193](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L193)
[packages/quickjs-ffi-types/src/ffi.ts:195](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L195)

***

Expand Down Expand Up @@ -466,6 +468,24 @@ Set at compile time.

***

### QTS\_GetDebugLogEnabled

> **QTS\_GetDebugLogEnabled**: (`rt`) => `number`
#### Parameters

**rt**: [`JSRuntimePointer`](../exports.md#jsruntimepointer)

#### Returns

`number`

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:193](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L193)

***

### QTS\_GetFalse

> **QTS\_GetFalse**: () => [`JSValueConstPointer`](../exports.md#jsvalueconstpointer)
Expand Down Expand Up @@ -890,7 +910,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:195](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L195)
[packages/quickjs-ffi-types/src/ffi.ts:197](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L197)

***

Expand Down Expand Up @@ -1116,7 +1136,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:201](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L201)
[packages/quickjs-ffi-types/src/ffi.ts:203](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L203)

***

Expand All @@ -1134,7 +1154,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:203](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L203)
[packages/quickjs-ffi-types/src/ffi.ts:205](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L205)

***

Expand Down Expand Up @@ -1170,7 +1190,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:200](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L200)
[packages/quickjs-ffi-types/src/ffi.ts:202](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L202)

***

Expand All @@ -1190,7 +1210,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:202](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L202)
[packages/quickjs-ffi-types/src/ffi.ts:204](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L204)

***

Expand Down Expand Up @@ -1234,6 +1254,26 @@ Set at compile time.

***

### QTS\_SetDebugLogEnabled

> **QTS\_SetDebugLogEnabled**: (`rt`, `is_enabled`) => `void`
#### Parameters

**rt**: [`JSRuntimePointer`](../exports.md#jsruntimepointer)

**is\_enabled**: `number`

#### Returns

`void`

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:194](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L194)

***

### QTS\_SetProp

> **QTS\_SetProp**: (`ctx`, `this_val`, `prop_name`, `prop_value`) => `void`
Expand Down Expand Up @@ -1332,7 +1372,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:208](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L208)
[packages/quickjs-ffi-types/src/ffi.ts:210](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L210)

***

Expand All @@ -1352,7 +1392,7 @@ Set at compile time.

#### Source

[packages/quickjs-ffi-types/src/ffi.ts:204](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L204)
[packages/quickjs-ffi-types/src/ffi.ts:206](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi.ts#L206)

***

Expand Down
Loading

0 comments on commit d1a95c6

Please sign in to comment.