Interface VMRequire

index.d.ts:83–111

 *  Require options for a VM
 */
export interface VMRequire {
  /**
   * Array of allowed built-in modules, accepts ["*"] for all. Using "*" increases the attack surface and potential
   * new modules allow to escape the sandbox. (default: none)
   */
  builtin?: readonly string[];
  /*
   * `host` (default) to require modules in host and proxy them to sandbox. `sandbox` to load, compile and
   * require modules in sandbox or a callback which chooses the context based on the filename.
   * Built-in modules except `events` always required in host and proxied to sandbox
   */
  context?: "host" | "sandbox" | PathContextCallback;
  /** `true`, an array of allowed external modules or an object with external options (default: `false`) */
  external?: boolean | readonly string[] | { modules: readonly string[], transitive: boolean };
  /** Array of modules to be loaded into NodeVM on start. */
  import?: readonly string[];
  /** Restricted path(s) where local modules can be required (default: every path). */
  root?: string | readonly string[];
  /** Collection of mock modules (both external or built-in). */
  mock?: any;
  /* An additional lookup function in case a module wasn't found in one of the traditional node lookup paths. */
  resolve?: (moduleName: string, parentDirname: string) => string | { path: string, module?: string } | undefined;
  /** Custom require to require host and built-in modules. */
  customRequire?: HostRequire;
  /** Load modules in strict mode. (default: true) */
  strict?: boolean;
  /** FileSystem to load files from */
  fs?: VMFileSystemInterface;
}

/**
 * A custom compiler function for all of the JS that comes