AssemblyScript / node

Implementations of the node.js APIs for use with AssemblyScript.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AS node

Implementations of the node.js APIs for AssemblyScript, utilizing WASI.

Introduction

This library aims to provide a convenient node.js-like environment for AssemblyScript programs. Please note that it is still in its early stages and that both the library and WASI are not even close to be finalized.

As always, if the idea sounds appealing to you, feel free to improve existing APIs or to contribute additional ones.

Instructions

Install the library components as a dependency of your project

$> npm install --save-dev AssemblyScript/node

and include it in your build step to gain access to the implementations it provides:

$> asc --lib ./node_modules/@assemblyscript/node/assembly [...]

Doing so will automatically register common globals like the Buffer class and enables requiring for example the filesystem module through import * as fs from "fs".

Documentation

Building

To run the tests, first make sure that development dependencies are installed, then run:

$> npm test

One of the dependencies is node-wasi, which is a native module. If you are running into issues when compiling it (on Windows), make sure that node-wasi supports your version of node.js, that your machine can build native modules in the first place and that your version of npm is recent (npm install npm@latest -g).

About

Implementations of the node.js APIs for use with AssemblyScript.

License:Apache License 2.0


Languages

Language:TypeScript 87.2%Language:JavaScript 12.8%