Skip to content

Sandbox for Postman Scripts to run in Node.js or browser

License

Notifications You must be signed in to change notification settings

postmanlabs/postman-sandbox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a36bff5 · Mar 27, 2025
Sep 25, 2024
Mar 27, 2025
Feb 21, 2025
Mar 27, 2025
Feb 21, 2025
Sep 30, 2020
Jun 12, 2024
Sep 30, 2020
Sep 30, 2020
Nov 2, 2023
Aug 5, 2020
Nov 30, 2016
Jan 24, 2023
Mar 27, 2025
Mar 27, 2025
Nov 30, 2016
Jul 29, 2024
Mar 27, 2025
Nov 30, 2016
Mar 27, 2025
Mar 27, 2025

Repository files navigation

Postman Sandbox Build Status codecov

Module that unifies execution of third-party JavaScript within Node.js and Browser.

This module is part of Postman Runtime Core and is not intended for independent use.

If you are looking to execute collections, you should bee using Newman

Usage

var Sandbox = require('postman-sandbox'),
    context;

Sandbox.createContext(function (err, ctx) {
    if (err) {
        return console.error(err);
    }

    ctx.execute(`// code here`, {}, {}, function (err) {
        if (err) {
            return console.error(err);
        }
        console.log('executed')
    });
});

Sandbox Environment

The following section outlines the API available inside sandbox scripts

pm

  • pm.test
  • pm.info
  • pm.vault
  • pm.globals
  • pm.cookies
  • pm.execution
  • pm.variables
  • pm.visualizer
  • pm.sendRequest
  • pm.environment
  • pm.iterationData
  • pm.collectionVariables

pre-request script specials

  • pm.request

test script specials

  • pm.request
  • pm.response

Events fired from Sandbox

  • pong
  • error
  • console
  • execution
  • execution.error
  • execution.error.*
  • execution.request.*
  • execution.result.*
  • execution.cookies.*
  • execution.skipRequest.*

Events responded to

  • ping
  • execute
  • execution.abort.*
  • execution.response.*
  • execution.cookies.*

Contributing

Debug in browser

To debug tests in Chrome's DevTools, start tests using npm run test-browser -- --debug and click DEBUG.