npmpackage.info

Gathering detailed insights and metrics for modern-wasm-starter

modern-wasm-starter - 0.0.25 | npmpackage.info

modern-wasm-starter

🛸 Run C++ code on web and create blazingly fast websites! A starter template to easily create WebAssembly packages using type-safe C++ bindings with automatic TypeScript declarations.

0.0.25

250

Unlicense

TypeScript

562.72 kB

2.8

Installations

npm install modern-wasm-starter

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

12.22.6

NPM Version

6.14.15 Pull Requests

Open

1

Total

25

Closed

1

Merged

23

Issues

Open

1

Total

2

Closed

1

Releases

Update dependencies and fix linker warnings

v0.0.25

Updated on Oct 09, 2021

Update dependencies

v0.0.17

Updated on Jan 20, 2021

View All 2 releases

Languages

TypeScript

CMake

C++

TypeScript (47.19%)

CMake (29.91%)

C++ (22.29%)

C (0.61%)

Developer

TheLartians

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Unlicense License

250 Stars

36 Commits

13 Forks

8 Watchers

3 Branches

1 Contributors

Updated on Apr 09, 2025

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

0.0.25

Package Id

modern-wasm-starter@0.0.25

Unpacked Size

562.72 kB

Size

179.29 kB

File Count

NPM Version

6.14.15

Node Version

12.22.6

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

typescript

Dev Dependencies

@types/jest jest prettier ts-jest typescript

Modern WASM Starter

A starter template to easily create WebAssembly packages for npm using type-safe C++ code with automatic declarations. This project should take care of most of the boilerplate code required to create a modern and type-safe WebAssembly project.

Features

Integrated node.js packaging and dependency management through npm
Type safety through TypeScript
CMake build system
Integrated C++ dependency management using CPM.cmake
Automatic bindings and typescript declarations using the Glue library
Integrated test suite using jest
Code formatting enforced through prettier and Format.cmake
Semi-automatic memory management using scopes
A GitHub action to automatically update the npm release for each commit to master

Usage

Get started

Use this repo as a template to quickly start your own projects!

Build WebAssembly code

To be able to build WebAssembly code from C++ using Emscripten, you must first install and activate the emsdk. To compile the C++ code to WebAssembly, run the following command from the project's root directory.

1npm install

This will create the files source/WasmModule.js and source/WasmModule.d.ts from the C++ code in the wasm directory and transpile everything into a JavaScript module in the dist directory. To build your code as wasm, add it as a CPM.cmake dependency in the CMakeLists.txt file and define the bindings in the wasmGlue.cpp source file. To update the wasm and TypeScript declarations, you can run npm run build:wasm.

Run tests

The following command will build and run the test suite.

1npm test

For rapid developing, tests can also be started in watch mode, which will automatically run on any code change to the TypeScript or JavaScript sources.

1npm start

Fix code style

The following command will run prettier on the TypeScript and clang-format on the C++ source code.

npm run fix:style

Writing bindings

This starter uses the Glue project to create bindings and declarations. Update the wasmGlue.cpp source files to expose new classes or functions. See the Glue or EmGlue projects for documentation and examples.

Memory management

As JavaScript has no destructors, any created C++ objects must be deleted manually, or they will be leaked. To simplify this, the project introduces memory scopes that semi-automatically take care of memory management. The usage is illustrated below.

1import { withGreeter } from "modern-wasm-starter";
2
3// `withGreeter()` will run the callback asynchronously in a memory scope and return the result in a `Promise`
4withGreeter(greeterModule => {
5  // construct a new C++ `Greeter` instance
6  const greeter = new greeterModule.Greeter("Wasm");
7
8  // call a member function
9  console.log(greeter.greet(greeterModule.LanguageCode.EN));
10  
11  // any created C++ objects will be destroyed after the function exits, unless they are persisted
12});

To see additional techniques, such as synchronous scopes or persisting and removing values outside of the scope, check out the tests or API.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More