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

vite-plugin-zig

v0.0.13

Published

Import WebAssembly modules compiled from Zig files.

Downloads

32

Readme

vite-plugin-zig

Import WebAssembly modules compiled from Zig files.

Prerequisites

Usage

Install with npm i -D vite-plugin-zig (or pnpm i -D or yarn i -D), then add the plugin to your vite.config.js:

// vite.config.js
import zig from 'vite-plugin-zig';

/** @type {import('vite').UserConfig} */
export default {
  plugins: [zig()],
  build: { target: 'esnext' },
};

Write your Zig code and export any symbol to be used in JS code:

// src/main.zig
export fn add(a: i32, b: i32) i32 {
    return a + b;
}

If available, top-level await can be used so that importing the module feels similar to importing a regular JS module:

// example.js
import { instantiate } from './src/main.zig';

// pass any custom importObject here, functions should be declared
// as extern in the Zig file
const importObject = {
  // ...
};
// instantiate the compiled WebAssembly module, can also be moved
// to a Worker for instantiation in another thread
const { exports, instance } = await instantiate(importObject);
// call exported functions from the exports object
console.log(exports.add(5, 37)); // 42

As a shorthand to avoid having to manually call await instantiate(), the ?instantiate query parameter can be specified in the module import to both compile and instantiate the module at import time, allowing access to instance and exports:

import { exports, instance, module } from './src/main.zig?instantiate';

// call exported functions from the exports object
console.log(exports.add(5, 37)); // 42

If your Vite config does not allow for top-level await (by setting build: { target: 'esnext' }, e.g. if the framework you're using enforces a specific target value), an alternative API is provided which instead exposes Promises (compiled and instantiated respectively depending on whether ?instantiate is used) which resolve when the compilation or instantiation of the module are complete:

// example.js
import { compiled, instantiate, module } from './src/main.zig';

(async () => {
  // `await compiled` can be used to populate the `module` import
  // manually before instantiation if necessary

  // pass any custom importObject here, functions should be declared
  // as extern in the Zig file
  const importObject = {
    // ...
  };
  // instantiate the compiled WebAssembly module, can also be moved
  // to a Worker for instantiation in another thread
  const { exports, instance } = await instantiate(importObject);
  // call exported functions from the exports object
  console.log(exports.add(5, 37)); // 42
})();
// example.js
import {
  exports,
  instance,
  instantiated,
  module,
} from './src/main.zig?instantiate';

(async () => {
  // manually await to populate the imports
  await instantiated;
  // call exported functions from the exports object
  console.log(exports.add(5, 37)); // 42
})();

To integrate with SSR frameworks such as SvelteKit, use a dynamic import:

<script>
  import { onMount } from 'svelte';

  onMount(async () => {
    const wasm = await import('$lib/main.zig?instantiate');
    await wasm.instantiated;
    console.log(wasm.exports.add(5, 37)); // 42
  });
</script>

Notes and TODOs

  • It would be great to have something similar to Rust's wasm-bindgen to generate JS glue code and type definitions

License

MIT