1 unstable release

0.1.0 Aug 21, 2023

#1123 in WebAssembly

Apache-2.0

50KB
532 lines

deterministic-bloom Logo

deterministic-bloom-wasm

Crate npm Code Coverage Build Status License Docs Discord

⚠️ Work in progress ⚠️

Description.

Outline

Set-up

We'll use wasm-pack for building, testing, and publishing our Wasm project.

Build for Javascript

The wasm-pack build command will compile the code in this directory into Wasm and generate a pkg folder by default, containing the Wasm binary, a Javascript-wrapper file, the deterministic-bloom-wasm README (and version), and a package.json file.

  • Targetting node:

    wasm-pack build --target nodejs
    
  • Targetting browswers:

    wasm-pack build --target web
    
  • Targetting bundlers like webpack:

    wasm-pack build --target bundler
    

Testing the Project

For running tests in the current directory, use one of these commands:

  • Run tests expected to execute in Node.js:
wasm-pack test --node
  • Run browser tests in a headless browwer:
wasm-pack test --headless --firefox --chrome --safari

Note: Make sure you have the appropriate browser installed when running locally.

Publishing a Package

Once you've built the package, which lives under pkg by default (or a sub-directory of your choosing), you can pack and publish it to npm via (given credentials):

wasm-pack publish

License

This project is licensed under the Apache License 2.0, or http://www.apache.org/licenses/LICENSE-2.0.

Dependencies

~3–6.5MB
~121K SLoC