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

dwitter-wasm

v1.0.3

Published

This script turns [WebAssembly](https://webassembly.org/) binary files into a format consumed by [Dwitter](https://www.dwitter.net/) in as short a form as possible. This should allow for fast performing Dweets, assuming you can fit something into the bina

Downloads

2

Readme

dwitter-wasm

This script turns WebAssembly binary files into a format consumed by Dwitter in as short a form as possible. This should allow for fast performing Dweets, assuming you can fit something into the binary code and do anything with it in the remaining character limit.

System Requirements

Recommended Tools and Reading

Dweet Limitations

The current version uses a minimum of 103 Dweet characters out of 140. Characters are compressed down to Unicode characters, which allows for double the characters in Dweets. This leaves you with 74 Javascript characters and WebAssembly binary characters.

To get the character count as low as possible, browser compatibility has been sacrificed. The use of WebAssembly also comes with browser limitations. Please note the compatibility on TypedArray.from(), WebAssembly.Module, and WebAssembly.Instance in order to determine which browsers your Dweet will work in. At the time of writing, you can expect the Dweet to work best on the desktop in Firefox and Chrome.

Installation

$ npm install --global dwitter-wasm

Usage

Basics

To begin, create a .wasm source file using your tools of choice. This binary file will be used to create a WebAssembly.Instance in the final output.

You must then create a .js source file, which should contain any additional Javascript code for the Dweet. The WebAssembly.Instance exports created out of the provided .wasm file will be available through the Javascript variable m. The Javascript code cannot currently contain Unicode characters.

By default, the Javascript source file will be appended onto the end of the generated code which loads the WebAssembly binary separated by a semicolon. However, if you include the string \WASM_INPUT`in the Javascript source file, the encoded WebAssembly binary will be injected instead. This method of combining the source files can be used if you would like to pass imports to the WebAssembly module or make other customizations to the WebAssembly binary loading code. An example template with the loader code size optimizations can be generated withdwitter-wasm --template`.

You must also specify an output path for the location where the final Dweet code will be contained. Since the Dweet uses specially encoded characters, you must copy the code into Dwitter using a program that supports Unicode.

Example using wat2wasm and xclip:

$ echo "(module)" >> input.wat
$ wat2wasm input.wat -o input.wasm
$ echo "console.log(m)" >> input.js
$ dwitter-wasm -w input.wasm -j input.js -o output.js
$ xclip output.js -sel clip

Using this example, the Dwitter code will be copied to your clipboard for pasting to Dwitter. The Dweet will do nothing but print m to your console.

Command Line Arguments

  • -w|--wasm-input: The .wasm file to encode and embed in Javascript code
  • -j|--js-input: The .js file to append to the generated Javascript code
  • --encode-wasm: Only perform the step where the .wasm is encoded and embedded and combined with Javascript. By default, all steps are all enabled.
  • --compress: Only perform the step where the code is compressed, using --js-input. By default, all steps are all enabled.
  • -o|--output: The resulting .js file
  • --template: Output an optimized template for input and exit
  • --version: Output the version number and exit
  • --help: Output a help string and exit

How it Works

The WebAssembly.Instance Initialization

First, the WebAssembly binary is turned into a valid Javascript string using special ASCII characters. Then, the string is turned into a Uint8Array. This format is required. The array is then passed into a WebAssembly.Module. The module is then passed into a WebAssembly.Instance. The exports are then retrieved from the instance and stored in variable m.

For the most part, this part of the process is similar to regular synchronous initialization of WebAssembly binaries. However, the Uint8Array is initialized from a string using special ASCII characters with keycodes corresponding to WebAssembly binary values. This saves on characters by eliminating the need to define the binary values in comma-separated format.

Code Compression

After the WebAssembly binary initialization code is generated, it is concatenated with the Javascript source code. At this point, the code is changed from single-width ASCII characters into double-width Unicode characters. Since a single Unicode character can contain two ASCII characters, and Dwitter counts Unicode characters as single characters, this effectively halves the code.