EmscriptenModule.md

quickjs-emscripten • quickjs-emscripten-core • Readme | Exports

---

quickjs-emscripten / quickjs-emscripten-core / EmscriptenModule

Interface: EmscriptenModule

Typings for the features we use to interface with our Emscripten build of QuickJS.

Contents

• Extends
• Properties
  • FAST_MEMORY
  • HEAP16
  • HEAP32
  • HEAP8
  • HEAPF32
  • HEAPF64
  • HEAPU16
  • HEAPU32
  • HEAPU8
  • TOTAL_MEMORY
  • TOTAL_STACK
  • wasmBinary?
  • wasmMemory?
• Methods
  • UTF8ToString()
  • _free()
  • _malloc()
  • cwrap()
  • instantiateWasm()?
  • lengthBytesUTF8()
  • locateFile()?
  • monitorRunDependencies()?
  • stringToUTF8()

Extends

• EmscriptenModuleLoaderOptions

Properties

FAST_MEMORY

FAST_MEMORY: number

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:168

---

HEAP16

HEAP16: Int16Array

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:158

---

HEAP32

HEAP32: Int32Array

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:159

---

HEAP8

HEAP8: Int8Array

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:157

---

HEAPF32

HEAPF32: Float32Array

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:163

---

HEAPF64

HEAPF64: Float64Array

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:164

---

HEAPU16

HEAPU16: Uint16Array

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:161

---

HEAPU32

HEAPU32: Uint32Array

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:162

---

HEAPU8

HEAPU8: Uint8Array

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:160

---

TOTAL_MEMORY

TOTAL_MEMORY: number

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:167

---

TOTAL_STACK

TOTAL_STACK: number

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:166

---

wasmBinary?

wasmBinary?: ArrayBuffer

Compile this to WebAssembly.Module

Inherited from

quickjs-emscripten-core.EmscriptenModuleLoaderOptions.wasmBinary

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:104

---

wasmMemory?

wasmMemory?: Memory

If provided, use this WebAssembly.Memory instead of an automatically created one.

Inherited from

quickjs-emscripten-core.EmscriptenModuleLoaderOptions.wasmMemory

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:107

Methods

UTF8ToString()

UTF8ToString(ptr, maxBytesToRead?): string

HeapChar to JS string. https://emscripten.org/docs/api_reference/preamble.js.html#UTF8ToString

Parameters

• ptr: BorrowedHeapCharPointer

• maxBytesToRead?: number

Returns

string

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:144

---

_free()

_free(ptr): void

Parameters

• ptr: number

Returns

void

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:148

---

_malloc()

_malloc(size): number

Parameters

• size: number

Returns

number

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:147

---

cwrap()

cwrap(ident, returnType, argTypes, opts?): (...args) => any

Parameters

• ident: string

• returnType: null | ValueType

• argTypes: ValueType[]

• opts?: CCallOpts

Returns

Function

Parameters

• ...args: any[]

Returns

any

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:149

---

instantiateWasm()?

optional instantiateWasm(imports, onSuccess): Exports | Promise<Exports>

Create an instance of the WASM module, call onSuccess(instance), then return instance.exports

Parameters

• imports: Imports

• onSuccess: (instance) => void

Returns

Exports | Promise<Exports>

Inherited from

quickjs-emscripten-core.EmscriptenModuleLoaderOptions.instantiateWasm

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:110

---

lengthBytesUTF8()

lengthBytesUTF8(str): number

Parameters

• str: string

Returns

number

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:145

---

locateFile()?

optional locateFile(fileName, prefix): string

If set, this method will be called when the runtime needs to load a file, such as a .wasm WebAssembly file, .mem memory init file, or a file generated by the file packager.

The function receives two parameters:

• fileName, the relative path to the file as configured in build process, eg "emscripten-module.wasm".
• prefix (path to the main JavaScript file’s directory). This may be '' (empty string) in some cases if the Emscripten Javascript code can't locate itself. Try logging it in your environment.

It should return the actual URI or path to the requested file.

This lets you host file packages on a different location than the directory of the JavaScript file (which is the default expectation), for example if you want to host them on a CDN.

Parameters

• fileName: string

• prefix: string

Often '' (empty string)

Returns

string

Inherited from

quickjs-emscripten-core.EmscriptenModuleLoaderOptions.locateFile

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:97

---

monitorRunDependencies()?

optional monitorRunDependencies(left): void

Called by emscripten as dependencies blocking initialization are added or fulfilled. May only be called in debug builds.

Parameters

• left: number

Returns

void

Inherited from

quickjs-emscripten-core.EmscriptenModuleLoaderOptions.monitorRunDependencies

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:116

---

stringToUTF8()

stringToUTF8(str, outPtr, maxBytesToRead?): void

Write JS str to HeapChar pointer. https://emscripten.org/docs/api_reference/preamble.js.html#stringToUTF8

Parameters

• str: string

• outPtr: OwnedHeapCharPointer

• maxBytesToRead?: number

Returns

void

Source

packages/quickjs-ffi-types/src/emscripten-types.ts:139

---

Generated using typedoc-plugin-markdown and TypeDoc