Interface VMOptions

index.d.ts:135–171

 *  Options for creating a VM
 */
export interface VMOptions {
  /**
   * `javascript` (default), `typescript`, `coffeescript` or custom compiler function (which receives the code, and it's file path).
   *  The library expects you to have compiler pre-installed if the value is set to `typescript` or `coffeescript`.
   */
  compiler?: "javascript" | "typescript" | "coffeescript" | CompilerFunction;
  /**
   * Compiler options.
   */
  compilerOptions?: Record<string, any>;
  /** VM's global object. */
  sandbox?: any;
  /**
   * Script timeout in milliseconds. Timeout is only effective on code you run through `run`.
   * Timeout is NOT effective on any method returned by VM.
   */
  timeout?: number;
  /**
   * If set to `false` any calls to eval or function constructors (`Function`, `GeneratorFunction`, etc.) will throw an
   * `EvalError` (default: `true`).
   */
  eval?: boolean;
  /**
   * If set to `false` any attempt to compile a WebAssembly module will throw a `WebAssembly.CompileError` (default: `true`).
   */
  wasm?: boolean;
  /**
   * If set to `true` any attempt to run code using async will throw a `VMError` (default: `false`).
   * @deprecated Use `allowAsync` instead.
   */
  fixAsync?: boolean;

  /**
   * If set to `false` any attempt to run code using async will throw a `VMError` (default: `true`).
   */
  allowAsync?: boolean;
}

/**
 *  Options for creating a NodeVM