Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 1.77 KB

README.md

File metadata and controls

79 lines (61 loc) · 1.77 KB
Raw

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.