Vimble

Vimble allows you to execute code in an isolated context.

import * as vimble from 'https://cdn.jsdelivr.net/npm/[email protected]/src/index.mjs';
// OR "https://ga.jspm.io/npm:[email protected]/src/index.mjs";

Or install via npm

npm install vimble

Quick Start

Using run and InjectedConsole

import run,  { InjectedConsole } from 'vimble';
const localConsole = new InjectedConsole();
await run('console.log(1 + 2);', { console: localConsole });
console.log(localConsole.result); // logs "3"

Uing runWithInjectedConsole

import { runWithInjectedConsole as run } from 'vimble';
console.log(await run('console.log(1 + 2);')); // logs "3"

API

run(code, context)

Executes JavaScript code in an isolated context with specified global variables.

Parameters:

• code (string): The JavaScript code to execute
• context (Object): Object containing global variables to inject into the execution context

Returns: Promise - Result of the executed code

Example:

import { run } from 'vimble';
// Access modified global variables
const obj = { count: 0 };
await run('obj.count += 1;', { obj });
console.log(obj.count); // outputs: 1

Global objects must be specified in the context object

import { run } from 'vimble';
// Access modified global variables
const obj = { text: "" };
await run('await fetch("https://example.com").then((response) => response.text()).then((text) => obj.text = text);', { obj, fetch});
console.log(obj.text); // outputs: 1

InjectedConsole

A custom console implementation that captures output and errors in isolated contexts.

Methods:

• log(...args): Logs messages to the output buffer
• info(...args): Alias for log
• warn(...args): Alias for log
• error(...args): Logs messages to the error buffer
• reset(): Resets output and error buffers

Properties:

• result: Gets the combined output, prioritizing errors if present
• info: Gets information about console including error and output counts

Example:

import { InjectedConsole } from 'vimble';

const console = new InjectedConsole();
console.log('Hello');
console.log('World');

// Error messages take priority
console.result; // outputs: "Hello World"
console.error('Error occurred');
console.result; // outputs: "Error occurred"

runWithInjectedConsole(code, [context])

Executes JavaScript code with a custom console implementation and returns the console output.

Parameters:

• code (string): The JavaScript code to execute
• context (Object, optional): Additional context variables to inject into the execution environment

Returns: Promise - Console output from the code execution

Example:

import { runWithInjectedConsole as run } from 'vimble';

// Capture console output
const output = await run(`
  console.log('Hello');
  console.log('World');
`);
console.log(output); // outputs: "Hello\nWorld"