• Stars
    star
    257
  • Rank 158,728 (Top 4 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 6 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Move a WebAssembly module into its own thread

wasm-worker

Build Status npm version npm downloads MIT Donate

Move a WebAssembly module into its own thread

wasm-worker only supports browser environments, since it uses Web Workers. For use in a NodeJS environment, Web Workers must be polyfilled using a library like node-webworker.

Installation

You can install wasm-worker using npm:

npm install --save wasm-worker

If you aren't using npm in your project, you can include wasmWorker using UMD build in the dist folder with <script> tag.

Usage

Once you have installed wasm-worker, supposing a CommonJS environment, you can import and use it in this way:

import wasmWorker from 'wasm-worker';

// supposing an "add.wasm" module that exports a single function "add"
wasmWorker('add.wasm')
  .then(module => {
    return module.exports.add(1, 2);
  })
  .then(sum => {
    console.log('1 + 2 = ' + sum);
  })
  .catch(ex => {
    // ex is a string that represents the exception
    console.error(ex);
  });

// you can also run js functions inside the worker
// to access importObject for example
wasmWorker('add.wasm')
  .then(module => {
    return module.run(({
      // module,
      // importObject,
      instance,
      params
    }) => {
      // here is sync
      const sum = instance.exports.add(...params);
      return '1 + 2 = ' + sum;
    }, [1, 2]);
  })
  .then(result => {
    console.log(result);
  });

API

type JsCallback = (context: {
  module: WebAssembly.Module,
  instance: WebAssembly.Instance,
  importObject: importObject,
  params: any,
}) => any;

type WasmWorkerModule = {
  exports: {
    [export: string]: (...any: Array<any>) => Promise<any>
  },
  // run a js function inside the worker and provides it the given params
  // ⚠️ Caveat: the function you pass cannot rely on its surrounding scope, since it is executed in an isolated context.
  // Please use the "params" parameter to provide some values to the callback
  run: (callback: JsCallback, params?: any) => Promise<any>
};

type Options = {
  // the first 3 properties are used to create the Web Worker
  // https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker#Parameters
  name: string,
  type: 'classic' | 'module',
  credentials: 'omit' | 'same-origin' | 'include',
  
  // the getImportObject function is used to get the options to instantiate the WebAssembly Module
  // ⚠️ Caveat: the function you pass cannot rely on its surrounding scope, since it is executed in an isolated context.
  // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiate#Primary_overload_%E2%80%94_taking_wasm_binary_code
  getImportObject: () => importObject,
};

wasmWorker(url: string, options?: Options): Promise<WasmWorkerModule> // browser only
wasmWorker(bufferSource: TypedArray | ArrayBuffer, options?: Options): Promise<WasmWorkerModule>

Browser support

wasm-worker uses fetch, Worker and obviously WebAssembly APIs, they are broadly supported by major browser engines but you would like to polyfill them to support old versions.

if (!window.fetch || !window.Worker || !window.WebAssembly) {
    ...
} else {
    ...
}

CSP

If your app has a Content-Security-Policy, wasm-worker require worker-src data: and script-src data: in your config.

Inspiration

This project is inspired by greenlet.

Change Log

This project adheres to Semantic Versioning.
Every release, along with the migration instructions, is documented on the Github Releases page.

Authors

Matteo Basso

Copyright and License

Copyright (c) 2018, Matteo Basso.

wasm-worker source code is licensed under the MIT License.

More Repositories

1

awesome-wasm

😎 Curated list of awesome things regarding WebAssembly (wasm) ecosystem.
8,801
star
2

asm-dom

A minimal WebAssembly virtual DOM to build C++ SPA (Single page applications)
C++
2,794
star
3

react-decoration

A collection of decorators for React Components
JavaScript
630
star
4

react-wasm

Declarative WebAssembly instantiation for React
JavaScript
447
star
5

gccx

Transforms CPX (JSX like syntax) into asm-dom Virtual DOM
JavaScript
261
star
6

natural-regex

Create regex from natural language
JavaScript
152
star
7

refraction

A guard that represents a central point of control in your application
JavaScript
151
star
8

ienumerable

Deep immutable, Lightweight Enumerable with superpowers
JavaScript
66
star
9

react-browser-detection

React component to detect browser
JavaScript
57
star
10

react-cssom

Css selector for React Components
JavaScript
57
star
11

asm-dom-boilerplate

A simple boilerplate to start using asm-dom without configuration.
Makefile
52
star
12

styled-components-test-utils

Test utils for styled-components compatible with jest, expect, chai and jasmine
JavaScript
46
star
13

react-https-redirect

Force a redirect to HTTPS when not on a local web server
JavaScript
34
star
14

react-http-request

React component exposes network request functionality
JavaScript
19
star
15

script-wasm

Require WebAssembly modules using script tag
JavaScript
14
star
16

watpl

Create WebAssembly modules using template strings
JavaScript
13
star
17

mandrake

Facility, Prosperity and Maintainability.
Elixir
9
star
18

refraction-react

React bindings for refraction
JavaScript
6
star
19

make-watch

Continuously run Make in watch mode
JavaScript
4
star
20

awesome-refraction

A collection of awesome things regarding Refraction ecosystem
4
star
21

spaceSurvival

A simple, free, open source game designed with Phaser.io
JavaScript
3
star
22

refraction-player

An events player for refraction
JavaScript
2
star
23

natural-regex-cli

Command line tool for natural-regex
JavaScript
2
star
24

npm-react-boilerplate

Minimal dev environment to build React modules
JavaScript
1
star
25

emscripten-issue-6442

Makefile
1
star
26

cleanChat

A simple free chat
JavaScript
1
star
27

se-assignment-8

Software Engineering course @ USI - Assignment 8
Java
1
star