Interface DuckDBModule

interface DuckDBModule {
    FAST_MEMORY: number;
    FHEAP: Float64Array;
    HEAP: Int32Array;
    HEAP16: Int16Array;
    HEAP32: Int32Array;
    HEAP64: BigInt64Array;
    HEAP8: Int8Array;
    HEAPF32: Float32Array;
    HEAPF64: Float64Array;
    HEAPU16: Uint16Array;
    HEAPU32: Uint32Array;
    HEAPU64: BigUint64Array;
    HEAPU8: Uint8Array;
    IHEAP: Int32Array;
    PThread: PThread;
    TOTAL_MEMORY: number;
    TOTAL_STACK: number;
    arguments: string[];
    ccall: (<I, R>(ident, returnType, argTypes, args, opts?) => ReturnToType<R>);
    environment: EnvironmentType;
    filePackagePrefixURL: string;
    logReadFiles: boolean;
    noExitRuntime: boolean;
    noInitialRun: boolean;
    onAbort: ((what) => void);
    onRuntimeInitialized: (() => void);
    postRun: (() => void)[];
    preInit: (() => void)[];
    preRun: (() => void)[];
    preinitializedWebGLContext: WebGLRenderingContext;
    preloadedAudios: any;
    preloadedImages: any;
    stackAlloc: ((size) => number);
    stackRestore: ((ptr) => void);
    stackSave: (() => number);
    wasmBinary: ArrayBuffer;
    _free(ptr): void;
    _malloc(size): number;
    addOnExit(cb): void;
    addOnInit(cb): void;
    addOnPostRun(cb): void;
    addOnPreMain(cb): void;
    addOnPreRun(cb): void;
    destroy(object): void;
    getPreloadedPackage(remotePackageName, remotePackageSize): ArrayBuffer;
    instantiateWasm(imports, successCallback): WebAssemblyExports;
    locateFile(url, scriptDirectory): string;
    onCustomMessage(event): void;
    print(str): void;
    printErr(str): void;
}

Hierarchy

  • EmscriptenModule
    • DuckDBModule

Properties

FAST_MEMORY FHEAP HEAP HEAP16 HEAP32 HEAP64 HEAP8 HEAPF32 HEAPF64 HEAPU16 HEAPU32 HEAPU64 HEAPU8 IHEAP PThread TOTAL_MEMORY TOTAL_STACK arguments ccall environment filePackagePrefixURL logReadFiles noExitRuntime noInitialRun onAbort onRuntimeInitialized postRun preInit preRun preinitializedWebGLContext preloadedAudios preloadedImages stackAlloc stackRestore stackSave wasmBinary

Methods

_free _malloc addOnExit addOnInit addOnPostRun addOnPreMain addOnPreRun destroy getPreloadedPackage instantiateWasm locateFile onCustomMessage print printErr

Properties

FAST_MEMORY

FAST_MEMORY: number

FHEAP

FHEAP: Float64Array

HEAP

HEAP: Int32Array

HEAP16

HEAP16: Int16Array

HEAP32

HEAP32: Int32Array

HEAP64

HEAP64: BigInt64Array

HEAP8

HEAP8: Int8Array

HEAPF32

HEAPF32: Float32Array

HEAPF64

HEAPF64: Float64Array

HEAPU16

HEAPU16: Uint16Array

HEAPU32

HEAPU32: Uint32Array

HEAPU64

HEAPU64: BigUint64Array

HEAPU8

HEAPU8: Uint8Array

IHEAP

IHEAP: Int32Array

PThread

PThread: PThread

TOTAL_MEMORY

TOTAL_MEMORY: number

TOTAL_STACK

TOTAL_STACK: number

arguments

arguments: string[]

ccall

ccall: (<I, R>(ident, returnType, argTypes, args, opts?) => ReturnToType<R>)

Type declaration

    • <I, R>(ident, returnType, argTypes, args, opts?): ReturnToType<R>

    • Type Parameters

      • I extends (null | JSType)[] | []
      • R extends null | JSType

      Parameters

      • ident: string
      • returnType: R
      • argTypes: I
      • args: Extract<{
            [P in string | number | symbol]: StringToType<I[P<P>]>
        }, any[]>
      • Optional opts: CCallOpts

      Returns ReturnToType<R>

environment

environment: EnvironmentType

filePackagePrefixURL

filePackagePrefixURL: string

logReadFiles

logReadFiles: boolean

noExitRuntime

noExitRuntime: boolean

noInitialRun

noInitialRun: boolean

onAbort

onAbort: ((what) => void)

Type declaration

    • (what): void

    • Parameters

      • what: any

      Returns void

onRuntimeInitialized

onRuntimeInitialized: (() => void)

Type declaration

    • (): void

    • Returns void

postRun

postRun: (() => void)[]

Type declaration

    • (): void

    • Returns void

preInit

preInit: (() => void)[]

Type declaration

    • (): void

    • Returns void

preRun

preRun: (() => void)[]

Type declaration

    • (): void

    • Returns void

preinitializedWebGLContext

preinitializedWebGLContext: WebGLRenderingContext

preloadedAudios

preloadedAudios: any

preloadedImages

preloadedImages: any

stackAlloc

stackAlloc: ((size) => number)

Type declaration

    • (size): number

    • Parameters

      • size: number

      Returns number

stackRestore

stackRestore: ((ptr) => void)

Type declaration

    • (ptr): void

    • Parameters

      • ptr: number

      Returns void

stackSave

stackSave: (() => number)

Type declaration

    • (): number

    • Returns number

wasmBinary

wasmBinary: ArrayBuffer

Methods

_free

  • _free(ptr): void

  • Parameters

    • ptr: number

    Returns void

_malloc

  • _malloc(size): number

  • Parameters

    • size: number

    Returns number

addOnExit

  • addOnExit(cb): void

  • Parameters

    • cb: (() => any)
        • (): any

        • Returns any

    Returns void

addOnInit

  • addOnInit(cb): void

  • Parameters

    • cb: (() => any)
        • (): any

        • Returns any

    Returns void

addOnPostRun

  • addOnPostRun(cb): void

  • Parameters

    • cb: (() => any)
        • (): any

        • Returns any

    Returns void

addOnPreMain

  • addOnPreMain(cb): void

  • Parameters

    • cb: (() => any)
        • (): any

        • Returns any

    Returns void

addOnPreRun

  • addOnPreRun(cb): void

  • Parameters

    • cb: (() => any)
        • (): any

        • Returns any

    Returns void

destroy

  • destroy(object): void

  • Parameters

    • object: object

    Returns void

getPreloadedPackage

  • getPreloadedPackage(remotePackageName, remotePackageSize): ArrayBuffer

  • Parameters

    • remotePackageName: string
    • remotePackageSize: number

    Returns ArrayBuffer

instantiateWasm

  • instantiateWasm(imports, successCallback): WebAssemblyExports

  • Parameters

    • imports: WebAssemblyImports
    • successCallback: ((module) => void)
        • (module): void

        • Parameters

          • module: Module

          Returns void

    Returns WebAssemblyExports

locateFile

  • locateFile(url, scriptDirectory): string

  • Parameters

    • url: string
    • scriptDirectory: string

    Returns string

onCustomMessage

  • onCustomMessage(event): void

  • Parameters

    • event: MessageEvent<any>

    Returns void

print

  • print(str): void

  • Parameters

    • str: string

    Returns void

printErr

  • printErr(str): void

  • Parameters

    • str: string

    Returns void

Settings

Member Visibility

Theme

On This Page

FAST_MEMORYFHEAPHEAPHEAP16HEAP32HEAP64HEAP8HEAPF32HEAPF64HEAPU16HEAPU32HEAPU64HEAPU8IHEAPPThreadTOTAL_MEMORYTOTAL_STACKargumentsccallenvironmentfilePackagePrefixURLlogReadFilesnoExitRuntimenoInitialRunonAbortonRuntimeInitializedpostRunpreInitpreRunpreinitializedWebGLContextpreloadedAudiospreloadedImagesstackAllocstackRestorestackSavewasmBinary_free_mallocaddOnExitaddOnInitaddOnPostRunaddOnPreMainaddOnPreRundestroygetPreloadedPackageinstantiateWasmlocateFileonCustomMessageprintprintErr