npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

js-wasm-tools

v1.3.1

Published

JavaScript version of wasm-tools, low level tooling for WebAssembly in Rust

Downloads

48

Readme

js-wasm-tools

js-wasm-tools compiles some of the API of wasm-tools to JavaScript and WebAssembly via wasm-bindgen. This offers low level tooling for WebAssembly in JavaScript, such as parsing WAT (WebAssembly Text Format) into bytes, translating the WebAssembly binary format to text, and more.

Install

npm install js-wasm-tools

Playground

You can try it out live on StackBlitz.com.

Usage

Using Vite:

import initWasmTools, * as wasmTools from 'js-wasm-tools';
import WASM_TOOLS_WASM_URL from 'js-wasm-tools/wasm_tools_js_bg.wasm?url';

await initWasmTools(WASM_TOOLS_WASM_URL);

const source = '(module)';

const binary = wasmTools.parseWat(source);

With Node.js:

import initWasmTools, * as wasmTools from 'js-wasm-tools';
import fs from 'node:fs';
import path from 'node:path';
import * as url from 'node:url';

const __dirname = url.fileURLToPath(new URL('.', import.meta.url));

const bytes = fs.readFileSync(path.join(__dirname, 'node_modules/js-wasm-tools/dist/js_wasm_tools_bg.wasm'));

await initWasmTools(bytes);

const source = '(module)';

const binary = wasmTools.parseWat(source);

console.log(binary);

API

parseWat(source: string): Uint8Array

Parses a string as the WebAssembly Text format, returning the WebAssembly binary format.

parseBytes(bytes: Uint8Array): Uint8Array

Parses bytes as either the WebAssembly Text format, or a binary WebAssembly module.

This function will attempt to interpret the given bytes as one of two options:

  • A utf-8 string which is a *.wat file to be parsed
  • A binary WebAssembly file starting with b"\0asm"
const encoder = new TextEncoder();

const bytes = wasmTools.parseWat(encoder.encode('(module)'));

expect(bytes).toEqual([0, 97, 115, 109, 1, 0, 0, 0]);
const bytes = wasmTools.parseWat([0, 97, 115, 109, 1, 0, 0, 0]);

expect(bytes).toEqual([0, 97, 115, 109, 1, 0, 0, 0]);

printBytes(bytes: Uint8Array): string

Prints a Wasm binary blob into a string which is its textual representation.

const wat = wasmTools.printBytes(new Uint8Array([0, 97, 115, 109, 1, 0, 0, 0]));

expect(wat).toEqual('(module)');

desugarWat(source: string): { wat: string, bytes: Uint8Array }

Parses a string as the WebAssembly Text format, and desugars the module, e.g. unfolding expressions.

const { wat, bytes } = wasmTools.desugarWat(`
  (module
    (func $foo
      (call $bar (i32.const 1) (i32.const 2))
    )
    (func $bar (param i32 i32))
  )
`);

expect(wat).toEqual(`
  (module
    (type (;0;) (func))
    (type (;1;) (func (param i32 i32)))
    (func $foo (;0;) (type 0)
      i32.const 1
      i32.const 2
      call $bar
    )
    (func $bar (;1;) (type 1) (param i32 i32))
  )
`);

validate(bytes: Uint8Array): Types

Test whether the given buffer contains a valid WebAssembly module or component, analogous to WebAssembly.validate in the JS API.

Upon success returns the type information for the top-level module or component.

const encoder = new TextEncoder();

const types = wasmTools.validate(
  encoder.encode(`
    (module
      (func $foo (result f32)
        f32.const 1
      )
      (func $bar (param i32 i32))
    )
  `)
);

expect(types).toEqual({
  types: [
    {
      type: 'Func',
      params: [],
      results: ['f32'],
    },
    {
      type: 'Func',
      params: ['i32', 'i32'],
      results: [],
    },
  ],
  functions: [
    {
      params: [],
      results: ['f32'],
    },
    {
      params: ['i32', 'i32'],
      results: [],
    },
  ],
  globals: [],
  memories: [],
  tables: [],
  elements: [],
});