isolation/types/context.d.ts

How often do you see libraries which mutates global variables Or how often do you check libraries actions ? This library provides script isolation in custom contexts to solve this kind of issues.

import type { Context, CreateContextOptions } from 'node:vm';

/**
 * @example <caption>Context usage example</caption>
 * const realm = new Isolation('a - b', { type: 'iso' });
 * realm.execute({ a: 1000, b: 10 }); // Output: 990
 * realm.execute({ a: 1000, b: 20 }); // Output: 980
 */
export type TContextify = {
  /**
   * @example <caption>This will affect on future contexts</caption>
   * // Default config:
   * const OPTIONS = { codeGeneration: { strings: false, wasm: false } };
   */
  OPTIONS: CreateContextOptions;

  /**
   * @example <caption>Empty frozen object</caption>
   * const EMPTY = {};
   */
  EMPTY: Context;

  /**
   * @example <caption>Global variables such as timers and others</caption>
   * const COMMON = { setTimeout, Event, ...other };
   */
  COMMON: Context;

  /**
   * @example <caption>Nodejs global variables</caption>
   * const NODE = { global, console, process, ...COMMON };
   */
  NODE: Context;

  /**
   * @example <caption>You can create custom context</caption>
   * const ctx = Isolation.contextify({ console, a: 1000, b: 10  });
   **/
  (ctx?: Context | Object, preventEscape?: boolean): Context;
};