JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 38433
  • Score
    100M100P100Q153248F
  • License MIT

Common interface to load wasm module into isomorphic environment

Package Exports

  • emscripten-wasm-loader

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (emscripten-wasm-loader) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Build Status Build status codecov npm Greenkeeper badge

Emscripten-wasm-loader

Wraps up common initialization logic with predefined preprocessor object. This module intended to support specific scoped usecase for wasm binary built with MODULARIZED and SINGLE_FILE.

Usage

import { getModuleLoader } from 'emscripten-wasm-loader';

const loader = getModuleLoader(factoryLoader, require('wasm/wasmlibaray'), { additional: ''});

getModuleLoader is higher order function returns actual module loader.

getModuleLoader<T, R extends AsmRuntimeType>(
  factoryLoader: (runtime: R) => T,
  runtimeModule: runtimeModuleType,
  module?: Record<string, any>
) => moduleLoaderType<T>;

/**
 * Asynchronously load and initialize asm module.
 *
 * @returns {T} Factory function manages lifecycle of hunspell and virtual files.
 */
type moduleLoaderType<T> = () => Promise<T>;

factoryLoader is callback function to be called to create actual instance of module using initialized wasm binary runtime for customized init steps for each consumer. runtimeModule is function loaded via require to emscripten preamble js for wasm binaries. It expects wasm binary should be built with MODULARIZE=1 with SINGLE_FILE=1 option. Lastly module is object to be inherited when execute runtimeModule. Emscripten's modularized preamble construct scoped wasm runtime module named Module, allows to have predefined object if needed. Internally getModuleLoader augments given object and set default interfaces like initializeRuntime.