Skip to main content
WASIOptions - wasi - Node documentation
interface WASIOptions

Usage in Deno

import { type WASIOptions } from "node:wasi";

Deno compatibility

This symbol is a non-functional stub.

Properties

optional
args: string[] | undefined

An array of strings that the WebAssembly application will see as command line arguments. The first argument is the virtual path to the WASI command itself.

optional
env: object | undefined

An object similar to process.env that the WebAssembly application will see as its environment.

optional
preopens: Dict<string> | undefined

This object represents the WebAssembly application's sandbox directory structure. The string keys of preopens are treated as directories within the sandbox. The corresponding values in preopens are the real paths to those directories on the host machine.

optional
returnOnExit: boolean | undefined

By default, when WASI applications call __wasi_proc_exit() wasi.start() will return with the exit code specified rather than terminatng the process. Setting this option to false will cause the Node.js process to exit with the specified exit code instead.

optional
stdin: number | undefined

The file descriptor used as standard input in the WebAssembly application.

optional
stdout: number | undefined

The file descriptor used as standard output in the WebAssembly application.

optional
stderr: number | undefined

The file descriptor used as standard error in the WebAssembly application.

version: "unstable" | "preview1"

The version of WASI requested. Currently the only supported versions are 'unstable' and 'preview1'. This option is mandatory.