Installing and Running It

Run struct syntax in Node with the register hook, compile files and TypeScript projects with the CLI, or call the compiler from code.

There are two packages: the runtime, and the compiler for the proposal's syntax, which you need only to build or run code that has it.

npm install @arv/structs

npm install --save-dev @arv/structs-compiler

In Node, the compiler's load hook compiles struct syntax as modules load, in workers too:

node --import @arv/structs-compiler/register main.js

The structs command compiles a single file, or a whole TypeScript project with type checking:

npx structs transpile main.js

npx structs compile -p tsconfig.json

compile writes each file to the tsconfig's outDir (or build/), with its source map. --no-fast leaves every shared struct field access to the Proxy (see TypeScript), and --typescript keeps the types.

From code, use transpile(source, {fileName}) and compile(tsconfigPath) from @arv/structs-compiler.