get doc working again

Author: justjake

doc/@jitl/quickjs-ffi-types/exports.md

@@ -0,0 +1,354 @@
+[quickjs-emscripten](../../packages.md) • **@jitl/quickjs-ffi-types** • [Readme](index.md) \| [Exports](exports.md)
+
+***
+
+[quickjs-emscripten](../../packages.md) / @jitl/quickjs-ffi-types
+
+# @jitl/quickjs-ffi-types
+
+## Contents
+
+- [Interfaces](exports.md#interfaces)
+- [Type Aliases](exports.md#type-aliases)
+  - [BorrowedHeapCharPointer](exports.md#borrowedheapcharpointer)
+  - [EitherModule](exports.md#eithermodule)
+  - [JSBorrowedCharPointer](exports.md#jsborrowedcharpointer)
+  - [JSContextPointer](exports.md#jscontextpointer)
+  - [JSContextPointerPointer](exports.md#jscontextpointerpointer)
+  - [JSModuleDefPointer](exports.md#jsmoduledefpointer)
+  - [JSRuntimePointer](exports.md#jsruntimepointer)
+  - [JSValueConstPointer](exports.md#jsvalueconstpointer)
+  - [JSValueConstPointerPointer](exports.md#jsvalueconstpointerpointer)
+  - [JSValuePointer](exports.md#jsvaluepointer)
+  - [JSValuePointerPointer](exports.md#jsvaluepointerpointer)
+  - [JSVoidPointer](exports.md#jsvoidpointer)
+  - [OwnedHeapCharPointer](exports.md#ownedheapcharpointer)
+  - [QTS\_C\_To\_HostCallbackFuncPointer](exports.md#qts-c-to-hostcallbackfuncpointer)
+  - [QTS\_C\_To\_HostInterruptFuncPointer](exports.md#qts-c-to-hostinterruptfuncpointer)
+  - [QTS\_C\_To\_HostLoadModuleFuncPointer](exports.md#qts-c-to-hostloadmodulefuncpointer)
+  - [QuickJSVariant](exports.md#quickjsvariant)
+- [Variables](exports.md#variables)
+  - [EvalFlags](exports.md#evalflags)
+- [Functions](exports.md#functions)
+  - [assertSync()](exports.md#assertsync)
+
+## Interfaces
+
+- [EmscriptenModule](interfaces/EmscriptenModule.md)
+- [EmscriptenModuleLoader](interfaces/EmscriptenModuleLoader.md)
+- [QuickJSAsyncEmscriptenModule](interfaces/QuickJSAsyncEmscriptenModule.md)
+- [QuickJSAsyncFFI](interfaces/QuickJSAsyncFFI.md)
+- [QuickJSAsyncVariant](interfaces/QuickJSAsyncVariant.md)
+- [QuickJSEmscriptenModule](interfaces/QuickJSEmscriptenModule.md)
+- [QuickJSFFI](interfaces/QuickJSFFI.md)
+- [QuickJSSyncVariant](interfaces/QuickJSSyncVariant.md)
+
+## Type Aliases
+
+### BorrowedHeapCharPointer
+
+> **BorrowedHeapCharPointer**: `Pointer`\<`"const char"` \| `"char"` \| `"js const char"`\>
+
+Used internally for Javascript-to-C calls that may contain strings too large
+for the Emscripten stack.
+
+#### Source
+
+[ffi-types.ts:77](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L77)
+
+***
+
+### EitherModule
+
+> **EitherModule**: [`QuickJSEmscriptenModule`](interfaces/QuickJSEmscriptenModule.md) \| [`QuickJSAsyncEmscriptenModule`](interfaces/QuickJSAsyncEmscriptenModule.md)
+
+#### Source
+
+[emscripten-types.ts:165](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/emscripten-types.ts#L165)
+
+***
+
+### JSBorrowedCharPointer
+
+> **JSBorrowedCharPointer**: `Pointer`\<`"js const char"`\>
+
+Used internally for Javascript-to-C calls that may contain strings too large
+for the Emscripten stack.
+
+#### Source
+
+[ffi-types.ts:89](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L89)
+
+***
+
+### JSContextPointer
+
+> **JSContextPointer**: `Pointer`\<`"JSContext"`\>
+
+`JSContext*`.
+
+#### Source
+
+[ffi-types.ts:19](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L19)
+
+***
+
+### JSContextPointerPointer
+
+> **JSContextPointerPointer**: `Pointer`\<`"JSContext"`\>
+
+`JSContext**`. Used internally for execute pending jobs.
+
+#### Source
+
+[ffi-types.ts:24](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L24)
+
+***
+
+### JSModuleDefPointer
+
+> **JSModuleDefPointer**: `Pointer`\<`"JSModuleDef"`\>
+
+`JSModuleDef*`.
+
+#### Source
+
+[ffi-types.ts:29](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L29)
+
+***
+
+### JSRuntimePointer
+
+> **JSRuntimePointer**: `Pointer`\<`"JSRuntime"`\>
+
+`JSRuntime*`.
+
+#### Source
+
+[ffi-types.ts:14](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L14)
+
+***
+
+### JSValueConstPointer
+
+> **JSValueConstPointer**: `Pointer`\<`"JSValueConst"`\>
+
+`JSValueConst*
+See [[JSValueConst]] and [[StaticJSValue]].
+
+#### Source
+
+[ffi-types.ts:41](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L41)
+
+***
+
+### JSValueConstPointerPointer
+
+> **JSValueConstPointerPointer**: `Pointer`\<`"JSValueConst[]"`\>
+
+Used internally for Javascript-to-C function calls.
+
+#### Source
+
+[ffi-types.ts:51](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L51)
+
+***
+
+### JSValuePointer
+
+> **JSValuePointer**: `Pointer`\<`"JSValue"`\>
+
+`JSValue*`.
+See [[JSValue]].
+
+#### Source
+
+[ffi-types.ts:35](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L35)
+
+***
+
+### JSValuePointerPointer
+
+> **JSValuePointerPointer**: `Pointer`\<`"JSValue[]"`\>
+
+Used internally for Javascript-to-C function calls.
+
+#### Source
+
+[ffi-types.ts:46](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L46)
+
+***
+
+### JSVoidPointer
+
+> **JSVoidPointer**: `Pointer`\<`any`\>
+
+Opaque pointer that was allocated by js_malloc.
+
+#### Source
+
+[ffi-types.ts:94](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L94)
+
+***
+
+### OwnedHeapCharPointer
+
+> **OwnedHeapCharPointer**: `Pointer`\<`"char"`\>
+
+Used internally for Javascript-to-C calls that may contain strings too large
+for the Emscripten stack.
+
+#### Source
+
+[ffi-types.ts:83](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L83)
+
+***
+
+### QTS\_C\_To\_HostCallbackFuncPointer
+
+> **QTS\_C\_To\_HostCallbackFuncPointer**: `Pointer`\<`"C_To_HostCallbackFunc"`\>
+
+Used internally for C-to-Javascript function calls.
+
+#### Source
+
+[ffi-types.ts:61](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L61)
+
+***
+
+### QTS\_C\_To\_HostInterruptFuncPointer
+
+> **QTS\_C\_To\_HostInterruptFuncPointer**: `Pointer`\<`"C_To_HostInterruptFunc"`\>
+
+Used internally for C-to-Javascript interrupt handlers.
+
+#### Source
+
+[ffi-types.ts:66](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L66)
+
+***
+
+### QTS\_C\_To\_HostLoadModuleFuncPointer
+
+> **QTS\_C\_To\_HostLoadModuleFuncPointer**: `Pointer`\<`"C_To_HostLoadModuleFunc"`\>
+
+Used internally for C-to-Javascript module loading.
+
+#### Source
+
+[ffi-types.ts:71](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L71)
+
+***
+
+### QuickJSVariant
+
+> **QuickJSVariant**: [`QuickJSSyncVariant`](interfaces/QuickJSSyncVariant.md) \| [`QuickJSAsyncVariant`](interfaces/QuickJSAsyncVariant.md)
+
+#### Source
+
+[variant-types.ts:49](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/variant-types.ts#L49)
+
+## Variables
+
+### EvalFlags
+
+> **EvalFlags**: `Object`
+
+Bitfield options for JS_Eval() C function.
+
+#### Type declaration
+
+##### JS\_EVAL\_FLAG\_BACKTRACE\_BARRIER
+
+> **JS\_EVAL\_FLAG\_BACKTRACE\_BARRIER**: `number`
+
+don't include the stack frames before this eval in the Error() backtraces
+
+##### JS\_EVAL\_FLAG\_COMPILE\_ONLY
+
+> **JS\_EVAL\_FLAG\_COMPILE\_ONLY**: `number`
+
+compile but do not run. The result is an object with a
+JS_TAG_FUNCTION_BYTECODE or JS_TAG_MODULE tag. It can be executed
+with JS_EvalFunction().
+
+##### JS\_EVAL\_FLAG\_STRICT
+
+> **JS\_EVAL\_FLAG\_STRICT**: `number`
+
+force 'strict' mode
+
+##### JS\_EVAL\_FLAG\_STRIP
+
+> **JS\_EVAL\_FLAG\_STRIP**: `number`
+
+force 'strip' mode
+
+##### JS\_EVAL\_TYPE\_DIRECT
+
+> **JS\_EVAL\_TYPE\_DIRECT**: `number`
+
+direct call (internal use)
+
+##### JS\_EVAL\_TYPE\_GLOBAL
+
+> **JS\_EVAL\_TYPE\_GLOBAL**: `number`
+
+global code (default)
+
+##### JS\_EVAL\_TYPE\_INDIRECT
+
+> **JS\_EVAL\_TYPE\_INDIRECT**: `number`
+
+indirect call (internal use)
+
+##### JS\_EVAL\_TYPE\_MASK
+
+> **JS\_EVAL\_TYPE\_MASK**: `number`
+
+##### JS\_EVAL\_TYPE\_MODULE
+
+> **JS\_EVAL\_TYPE\_MODULE**: `number`
+
+module code
+
+#### Source
+
+[ffi-types.ts:99](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L99)
+
+## Functions
+
+### assertSync()
+
+> **assertSync**\<`Args`, `R`\>(`fn`): (...`args`) => `R`
+
+#### Type parameters
+
+• **Args** extends `any`[]
+
+• **R**
+
+#### Parameters
+
+• **fn**: (...`args`) => `R`
+
+#### Returns
+
+`Function`
+
+> ##### Parameters
+>
+> • ...**args**: `Args`
+>
+> ##### Returns
+>
+> `R`
+>
+
+#### Source
+
+[ffi-types.ts:106](https://github.com/justjake/quickjs-emscripten/blob/main/packages/quickjs-ffi-types/src/ffi-types.ts#L106)
+
+***
+
+Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/)

doc/@jitl/quickjs-ffi-types/index.md

@@ -0,0 +1,13 @@
+[quickjs-emscripten](../../packages.md) • **@jitl/quickjs-ffi-types** • [Readme](index.md) \| [Exports](exports.md)
+
+***
+
+# @jitl/quickjs-ffi-types
+
+This is an internal package, part of [quickjs-emscripten](https://github.com/justjake/quickjs-emscripten).
+
+See the main package for documentation.
+
+***
+
+Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/)