https://github.com/nicholaslyang/wasup
A zero-dependency, isomorphic library for emitting WebAssembly
https://github.com/nicholaslyang/wasup
typescript wasm webassembly
Last synced: about 1 year ago
JSON representation
A zero-dependency, isomorphic library for emitting WebAssembly
- Host: GitHub
- URL: https://github.com/nicholaslyang/wasup
- Owner: NicholasLYang
- License: mit
- Created: 2021-04-25T01:54:07.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-12T03:11:44.000Z (about 4 years ago)
- Last Synced: 2025-04-10T02:16:43.953Z (about 1 year ago)
- Topics: typescript, wasm, webassembly
- Language: TypeScript
- Homepage:
- Size: 997 KB
- Stars: 40
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# wasup
wasup is a library for decoding and encoding the WebAssembly binary format.
It's zero dependency and entirely written in TypeScript.
## Getting Started
Install with npm or yarn:
```
npm install wasup
yarn add wasup
```
wasup exposes a few functions:
`decodeModule` takes in a buffer containing WebAssembly binary code and decodes it
into a JavaScript object. This translation is as simple as possible. The module object
contains fields for each section, along with an array of custom sections.
`encodeModule` takes a module object and returns WebAssembly binary code in a buffer.
It does so by figuring out the necessary size for the binary code, allocating the buffer
and encoding the module object. For the most part it assumes the module is valid. As
of right now, wasup does not try to validate the module.
`createModule` creates an empty module object for you to manipulate as you wish.
There's also [API documentation](https://nicholaslyang.github.io/wasup/) and a [binary search example program](https://github.com/NicholasLYang/wasup/tree/master/examples/binary-search).
If you want to know more about the structure of a WebAssembly module, check out the [specification](https://webassembly.github.io/spec/core/),
the [WASM reference manual](https://github.com/sunfishcode/wasm-reference-manual/blob/master/WebAssembly.md), and
[this blog post](https://horriblyunderqualified.com/posts/a-mere-mortals-guide-to-webassembly/) written by yours truly.
## Goals
Right now wasup is very bare bones. It provides a way to encode
a JavaScript representation of a WebAssembly module into a binary representation,
and it provides a way to decode a binary representation into a JavaScript representation.
In the future, I hope to add support for creating modules and validating them. I'd also like
to add support for proposals like [memory64](https://github.com/WebAssembly/memory64),
[branch hinting](https://github.com/WebAssembly/branch-hinting), etc.
## Inspiration
wasup owes a lot to [walrus](https://github.com/rustwasm/walrus), an excellent library
for manipulating WASM binaries in Rust.