# Postman Runtime [![CI](https://github.com/postmanlabs/postman-runtime/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/postmanlabs/postman-runtime/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/postmanlabs/postman-runtime/branch/develop/graph/badge.svg)](https://codecov.io/gh/postmanlabs/postman-runtime) > This is a low-level library used as the backbone for all Collection running & Request sending functionality, in > the Postman App, and allied systems ([Postman Monitoring](https://www.getpostman.com/docs/schedule_cloud_runs), [Newman](https://github.com/postmanlabs/newman)) > If you are looking to execute collections, you should be using Newman, this is very low level. ## Options Postman Runtime supports a lot of options to customize its behavior for different environments and use-cases. ```javascript var runner = new runtime.Runner(); // runtime = require('postman-runtime'); // a collection object constructed using the Postman Collection SDK. var collection = new sdk.Collection(); runner.run(collection, { // Iteration Data data: [], // Timeouts (in ms) timeout: { request: 30000, script: 5000 }, // Number of iterations iterationCount: 1, // Control flags (you can only specify one of these): // - gracefully halts on errors (errors in request scripts or while sending the request) // calls the `item` and `iteration` callbacks and does not run any further items (requests) stopOnError: true, // - abruptly halts the run on errors, and directly calls the `done` callback abortOnError: true, // - gracefully halts on errors _or_ test failures. // calls the `item` and `iteration` callbacks and does not run any further items (requests) stopOnFailure: true, // - abruptly halts the run on errors or test failures, and directly calls the `done` callback abortOnFailure: true, // Environment (a "VariableScope" from the SDK) environment: new sdk.VariableScope(), // Globals (a "VariableScope" from the SDK) globals: new sdk.VariableScope(), // Execute a folder/request using id/name or path entrypoint: { // execute a folder/request using id or name execute: 'folderName', // idOrName in case of execute and path in case of path // is chosen to specify the folder/request to be executed lookupStrategy: 'path', // execute a folder/request using a path path: ['grand_parent_folder_idOrName', 'parent_folder_idOrName'] }, // Configure delays (in ms) delay: { // between each request item: 1000, // between iterations iteration: 1000 }, // Used to fetch contents of files, certificates wherever needed fileResolver: require('fs'), // Options specific to the requester requester: { // An object compatible with the cookieJar provided by the 'postman-request' module. // To limit programmatic cookie access to only whitelisted domains, add `allowProgrammaticAccess` // method to the jar. Example: // jar.allowProgrammaticAccess = function (domain) { return domain === 'postman-echo.com'; }; cookieJar: jar, // Controls redirect behavior (only supported on Node, ignored in the browser) followRedirects: true, // Redirect with the original HTTP method (only supported on Node, ignored in the browser) followOriginalHttpMethod: false, // Maximum number of redirects to follow (only supported on Node, ignored in the browser) maxRedirects: 10, // Maximum allowed response size in bytes (only supported on Node, ignored in the browser) maxResponseSize: 1000000, // Enable to use WHATWG URL parser and encoder useWhatWGUrlParser: true, // Removes the `referer` header when a redirect happens (only supported on Node, ignored in the browser) removeRefererHeaderOnRedirect: false, // Enable or disable certificate verification (only supported on Node, ignored in the browser) strictSSL: false, // Use an insecure HTTP parser that accepts invalid HTTP headers (only supported on Node, ignored in the browser) insecureHTTPParser: false, // Enable or disable detailed request-response timings (only supported on Node, ignored in the browser) timings: true, // Enable or disable verbose level history (only supported on Node, ignored in the browser) verbose: false, // Implicitly add `Cache-Control` system header in request (only supported on Node, ignored in the browser) implicitCacheControl: true, // Implicitly add `Postman-Token` system header in request (only supported on Node, ignored in the browser) implicitTraceHeader: true, // Add system headers to all requests which cannot be overridden or disabled systemHeaders: { 'User-Agent': 'PostmanRuntime' } // Extend well known "root" CAs with the extra certificates in file. The file should consist of one or more trusted certificates in PEM format. (only supported on Node, ignored in the browser) extendedRootCA: 'path/to/extra/CA/certs.pem', // network related options network: { hostLookup: { // hosts file configuration for dns lookup type: 'hostIpMap', hostIpMap: { 'domain.com': '127.0.0.1', 'ipv6-domain.com': '::1', } }, restrictedAddresses: {'192.168.1.1': true} // Allows restricting IP/host in requests }, // Custom requesting agents (only supported on Node, ignored in the browser) agents: { http: { agentClass: http.Agent, agentOptions: { keepAlive: true, timeout: 399 } }, https: new https.Agent({ keepAlive: true }) }, // authorizer related options authorizer: { // helper to refresh oauth2 tokens during execution refreshOAuth2Token: function (id, callback) { // calls the callback with the refreshed token or an error // callback(err, token) }, } }, // Options specific to the script execution script: { // Option to set whether to send console logs in serialized format which can be parsed // using the `teleport-javascript` serialization library. serializeLogs: false, // Function to resolve packages that are used in the script. packageResolver: function ({ packages /* sdk.Script.packages */ }, callback) { return callback(null, { pkg1: { data: 'packagedata' }, pkg2: { error: 'Failed to get package' } }); } }, // A ProxyConfigList, from the SDK proxies: new sdk.ProxyConfigList(), // A function that fetches the system proxy for a given URL. systemProxy: function (url, callback) { return callback(null, {/* ProxyConfig object */}) }, // Opt-out of [proxy configured using environment variables]((https://github.com/postmanlabs/postman-request#controlling-proxy-behaviour-using-environment-variables) ) (only supported on Node, ignored in the browser) ignoreProxyEnvironmentVariables: false, // A CertificateList from the SDK certificates: new sdk.CertificateList(), // *note* Not implemented yet. // In the future, this will be used to read certificates from the OS keychain. systemCertificate: function() {} }, function (err, run) { console.log('Created a new Run!'); // Check the section below for detailed documentation on what callbacks should be. run.start(callbacks); }); ``` ## Callbacks You can pass a series of callbacks for runtime to execute as a collection is being executed. ```javascript runner.run(collection, { /* options */ }, function(err, run) { run.start({ // Called any time we see a new assertion in the test scripts assertion: function (cursor, assertions) { // cursor = { // position: Number, // iteration: Number, // length: Number, // cycles: Number, // eof: Boolean, // empty: Boolean, // bof: Boolean, // cr: Boolean, // ref: String, // scriptId: String, // eventId: String // } // assertions: array of assertion objects // assertion: { // error: Error, // index: Number, // name: String, // skipped: Number, // passed: Number // } }, // Called when the run begins start: function (err, cursor) { // err: null or Error // cursor = { // position: Number, // iteration: Number, // length: Number, // cycles: Number, // eof: Boolean, // empty: Boolean, // bof: Boolean, // cr: Boolean, // ref: String // } }, // Called before starting a new iteration beforeIteration: function (err, cursor) { /* Same as arguments for "start" */ }, // Called when an iteration is completed iteration: function (err, cursor) { /* Same as arguments for "start" */ }, // Called before running a new Item (check the postman collection v2 format for what Item means) beforeItem: function (err, cursor, item) { // err, cursor: Same as arguments for "start" // item: sdk.Item }, // Called after completion of an Item item: function (err, cursor, item, visualizer, result) { // err, cursor, item: Same as arguments for "beforeItem" // visualizer: null or object containing visualizer result that looks like this: // { // -- Tmeplate processing error // error: // // -- Data used for template processing // data:

	Stars	Issues	Version	Updated	Created
chakram	907	36	1.5.0	8 years ago	9 years ago
postman-collection	442	46	4.4.0	3 months ago	8 years ago
postman-collection-transformer	85	20	4.1.8	7 months ago	9 years ago
postman-runtime	229	18	7.39.0	a month ago	8 years ago

chakram vs postman-collection vs postman-collection-transformer vs postman-runtime

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past