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

wasabio

v1.3.0

Published

WebAssembly and SharedArrayBuffer IO. Pronounced 'wassabee-yo'.

Downloads

19

Readme

wasabio

WebAssembly and SharedArrayBuffer IO. Pronounced "wassabee-yo".

Purpose

wasabio offers several utility APIs with familiar interfaces, and implemented to work over a single SharedArrayBuffer and inside a TS-wrapped WASM module.

wasabio provides infrastructure for multi threaded applications running in web browsers, enabling safe cross-worker communication and shared state.

wasabio can be used in bundlers like Webpack to allow for an exchange between node core modules and its own implementations to seamlessly run in the browser.

Currently wasabio provides:

  • Node's FileSystem API (implemented on top of an in-memory POSIX filesystem)
  • LocalStorage API (implemented on top of an in-memory key-value store)
  • Node's EventEmitter API (implemented on top of a SharedArrayBuffer)
  • Low level Locks, Buses, Channels, and various other utilities

Usage

API

All APIs are spec-compatible with their original counterparts.

note: library needs to be initialized before use, see below.

import {
	localStorage, // in-memory key-value store for cross worker state storage
	EventEmitter, // lets you make named emitter for cross worker communication
	readFile,
	writeFile,
	appendFile,
	readFileSync,
	writeFileSync,
	appendFileSync,
	// ... Node FS api
} from "wasabio";

Some utility functions are also provided:

// return true if library is initialized
available(): boolean;
// serializes memory to a buffer, sets the thread counter to 0
serialize(memory: WebAssembly.Memory): Uint8Array;
// deserializes buffer to memory, sets the correct buffer size
deserialize(buffer: Uint8Array): WebAssembly.Memory;
// compresses serialized wasabio memory buffer into a zip buffer
compress(buffer: Uint8Array): Promise<Uint8Array>
// decompresses zip buffer into serialized wasabio memory buffer
decompress(buffer: Uint8Array): Promise<Uint8Array>

Initialization

From New Memory

Initialize wasabio on the first thread (usually the main thread) like so:

// main.ts
import { initialize } from "wasabio";
const mem = await initialize();
// some time later
worker.postMessage(mem);

On other threads (workers, frames, etc.) initialize wasabio like so:

// worker.ts
import { initialize } from "wasabio";
addEventListener("message", async ({ data }) => {
	initialize(data, { sync: true }); // sync as an option
});

From Existing Memory

Initialize wasabio on the first thread (usually the main thread) like so:

// main.ts
import { initialize } from "wasabio";
const cold = getSharedArrayBufferFromSomewhere();
const hot = await initialize(cold, { reboot: true });
// some time later
worker.postMessage(hot);

On other threads (workers, frames, etc.) initialize wasabio like so:

// worker.ts
import { initialize } from "wasabio";
addEventListener("message", async ({ data }) => {
	initialize(data, { reboot: false });
});

In this case, reboot signifies that the library is being initialized from cold storage and thread-local state should be reset.