Postman Collection SDK

https://github.com/postmanlabs/postman-collection
Admin
Postman Collection SDK is a Node.js module that enables developers to programmatically create,...
Tokens:169,033
Snippets:1,576
Trust Score:10
License:Apache-2.0
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### getPathWithQuery example

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Example output of the getPathWithQuery method, showing the complete path including the query string.

```javascript
/something/postman?hi=notbye
```

--------------------------------

### Add an item to a folder

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Shows how to create a collection, add a folder (ItemGroup), and add an Item with a GET request. The example logs the folder and the request URL to the console.

```javascript
const { Collection, Item } = require('postman-collection');

const myCollection = new Collection({ info: { name: 'Demo' } });
const folder = new ItemGroup({ name: 'Folder A' });
myCollection.items.add(folder);

folder.items.add(new Item({
  name: 'Send a GET request',
  request: { url: 'https://postman-echo.com/get', method: 'GET' }
}));

console.log(myCollection.items.one('Folder A'));
console.log(folder.items.one('Send a GET request').request.url.toString());
```

--------------------------------

### Script usage example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/09-event.md

Example usage of the Script class. Creates a script with type and exec, then calls toSource() and isEmpty() to show their outputs.

```javascript
const { Script } = require('postman-collection');
const script = new Script({
  type: 'text/javascript',
  exec: 'console.log(new Date())'
});
console.log(script.toSource()); // console.log(new Date())
console.log(script.isEmpty());  // false
```

--------------------------------

### Install postman-collection with npm

Source: https://github.com/postmanlabs/postman-collection/blob/develop/README.md

Installs the postman-collection SDK via npm and saves it to the project's package.json.

```terminal
> npm install postman-collection --save
```

--------------------------------

### Certificate canApplyTo usage example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/11-security.md

Example of using canApplyTo with https and http URLs, showing true and false results.

```javascript
console.log(certificate.canApplyTo('https://example.com/api')); // true
console.log(certificate.canApplyTo('http://example.com/api'));  // false (non-https)
```

--------------------------------

### Getting the proxy URL

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/11-security.md

Example of calling getProxyUrl on a configured proxy. Outputs the URL with credentials when authenticate is set.

```javascript
console.log(proxy.getProxyUrl()); // http://proxy_username:proxy_password@proxy.com:8080
```

--------------------------------

### Get response content info

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/04-response.md

Example of calling contentInfo() to retrieve content type, charset, and file name from a response.

```javascript
const info = res.contentInfo();
console.log(info.contentType, info.charset, info.fileName);
```

--------------------------------

### FormParam creation and toString() example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/06-header.md

Example of creating a FormParam instance and logging its string representation. The toString() method returns `${key}=${value}`.

```javascript
const { FormParam } = require('postman-collection');
const fp = new FormParam({ key: 'file', value: '/path/to/file.txt', type: 'file' });
console.log(fp.toString());  // file=/path/to/file.txt
```

--------------------------------

### syncVariablesTo example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Example of using syncVariablesTo to export variables to a new object. The method delegates to VariableList#syncToObject.

```javascript
const out = coll.syncVariablesTo();
console.log(out.baseUrl);
```

--------------------------------

### Create a Certificate instance

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/11-security.md

Example of creating a Certificate instance with name, matches, key, cert, and passphrase options.

```javascript
const { Certificate } = require('postman-collection');
const certificate = new Certificate({
  name: 'Certificate for example.com',
  matches: ['https://example.com/*'],
  key: { src: '/User/path/to/certificate/key' },
  cert: { src: '/User/path/to/certificate' },
  passphrase: 'iampassphrase'
});
```

--------------------------------

### Create VariableScope and get a variable

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/08-variable-scope.md

Create a VariableScope instance with a name and values, then retrieve a variable using get().

```js
const { VariableScope } = require('postman-collection');

const env = new VariableScope({
  name: 'my-env',
  values: [{ key: 'host', value: 'postman-echo.com' }]
});
console.log(env.get('host')); // postman-echo.com
```

--------------------------------

### Create a Header instance

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Create a new Header instance with a key-value pair and log its string representation. The example shows the required require statement and the constructor usage.

```javascript
var Header = require('postman-collection').Header,
    header = new Header({
        key: 'Content-Type',
        value: 'application/xml'
    });

console.log(header.toString()) // prints the string representation of the Header.
```

--------------------------------

### PropertyList accessor example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/02-property.md

Example of using map, count, and has on a PropertyList. map returns an array of keys, count returns the number of members, and has checks presence and optionally value equality.

```javascript
const names = list.map(h => h.key);          // ['A','B']
console.log(list.count());                   // 2
console.log(list.has('A'));                  // true
console.log(list.has('A', '10'));            // true (value of A after upsert)
```

--------------------------------

### Header helper usage example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/03-request.md

Example usage of addHeader, upsertHeader, and removeHeader on a request object. Demonstrates adding a custom header, updating its value, and removing it.

```javascript
req.addHeader({ key: 'X-Custom', value: 'yes' });
req.upsertHeader({ key: 'X-Custom', value: 'no' });  // updates value
req.removeHeader('X-Custom');
```

--------------------------------

### Cookie constructor parameter example (JSON definition)

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Example object structure for creating a new Cookie instance. Shows all properties including key, value, expires, maxAge, domain, path, secure, httpOnly, session, and extensions. Note the missing comma after maxAge in the source.

```javascript
{
    key: 'my-cookie-name',
    expires: '1464769543832', // UNIX timestamp, in *milliseconds*
    maxAge: '300'  // In seconds. In this case, the Cookie is valid for 5 minutes
    domain: 'something.example.com',
    path: '/',
    secure: false,
    httpOnly: true,
    session: false,
    value: 'my-cookie-value',
    extensions: [{
        key: 'Priority',
        value: 'HIGH'
    }]
}
```

--------------------------------

### Using resolveOne to find a certificate

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/11-security.md

Example of creating a CertificateList and calling resolveOne with a URL. Logs the resolved certificate's name if found.

```javascript
const list = new CertificateList({}, [certificate]);
const resolved = list.resolveOne('https://example.com/x');
resolved && console.log(resolved.name);
```

--------------------------------

### syncVariablesFrom example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Example of using syncVariablesFrom to update a variable value. The method delegates to VariableList#syncFromObject.

```javascript
coll.syncVariablesFrom({ baseUrl: 'https://httpbin.org' });
console.log(coll.variables.one('baseUrl').valueOf()); // https://httpbin.org
```

--------------------------------

### ItemGroup constructor example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Shows how to create a Collection and add ItemGroups and Items. Demonstrates that definitions with an 'item' key become nested ItemGroups, while others become Items.

```javascript
const { Collection, ItemGroup } = require('postman-collection');

const myCollection = new Collection();
myCollection.items.add(new ItemGroup({ name: 'This is a blank folder' }));
myCollection.items.add([
  { name: 'GET Request', request: 'https://postman-echo.com/get' },
  { name: 'PUT Request', request: 'https://postman-echo.com/put' }
]); // both become Items — neither has an 'item' key

// a definition WITH an 'item' key becomes a nested ItemGroup:
myCollection.items.add({ name: 'Nested', item: [{ request: 'https://postman-echo.com/headers' }] });
```

--------------------------------

### Build a collection programmatically with environment

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Example showing how to create a Collection with an environment array, add an item, and access variables and schema URL. The environment variables are inherited by the collection's variables.

```javascript
const { Collection } = require('postman-collection');

const coll = new Collection({
  info: { name: 'My Collection' }
}, [
  { baseUrl: 'https://postman-echo.com' } // environment variables
]);

coll.items.add({ name: 'Get', request: '{{baseUrl}}/get' });
console.log(coll.variables.one('baseUrl').toString());
console.log(coll.toJSON().info.schema); // v2.1.0 schema URL
```

--------------------------------

### Creating a ProxyConfig instance

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/11-security.md

Example of creating a ProxyConfig with host, match, port, protocol, tunnel, authenticate, username, and password. Requires the postman-collection module.

```javascript
const { ProxyConfig } = require('postman-collection');
const proxy = new ProxyConfig({
  host: 'proxy.com',
  match: 'http+https://example.com/*',
  port: 8080,
  protocol: 'http',
  tunnel: true,
  authenticate: true,
  username: 'proxy_username',
  password: 'proxy_password'
});
```

--------------------------------

### Example usage of listeners with inheritance

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/09-event.md

Creates EventList instances for a collection and an item, then calls listeners('test') to retrieve inherited and own events. The example shows how parent events are included.

```javascript
const collectionEvents = new EventList(collection, [
  { listen: 'test', script: 'console.log("collection test")' }
]);
const itemEvents = new EventList(item, [
  { listen: 'test', script: 'console.log("item test")' }
]);
itemEvents.eachParent = itemEvents.eachParent; // (parents resolved through __parent chain)
console.log(itemEvents.listeners('test').map(e => e.script.toSource()));
```

--------------------------------

### Query param helper usage example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/03-request.md

Example usage of addQueryParams and removeQueryParams. Adds parameters 'a=1&b=2', removes 'a', then logs the resulting query string 'b=2'.

```javascript
req.addQueryParams('a=1&b=2');
req.removeQueryParams(['a']);
console.log(req.url.getQueryString()); // b=2
```

--------------------------------

### Create Url from string and inspect properties

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/05-url.md

Create a Url instance from a string and access its decomposed properties. The example shows protocol, host, port, and hash, and the re-serialized URL.

```javascript
const { Url } = require('postman-collection');
const url = new Url('https://user:pass@postman-echo.com:8080/get?a=1#frag');
console.log(url.protocol, url.host, url.port, url.hash); // 'https' ['postman-echo','com'] '8080' 'frag'
console.log(url.toString()); // https://user:pass@postman-echo.com:8080/get?a=1#frag
```

--------------------------------

### oneDeep example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Searches for an item by name and logs its request URL if found.

```javascript
const found = myCollection.oneDeep('Send a GET request');
found && console.log(found.request.url.toString());
```

--------------------------------

### ProxyConfigList resolve usage example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/11-security.md

Example usage of ProxyConfigList and its resolve method. Creates a proxy list with two proxy definitions and resolves a URL to check if it matches an enabled proxy.

```javascript
const { ProxyConfigList } = require('postman-collection');
const proxies = new ProxyConfigList({}, [
  { match: 'https://example.com/*', host: 'proxy.com', port: 8080, tunnel: true },
  { match: 'http+https://example2.com/*', host: 'proxy2.com' }
]);
proxies.resolve('https://example.com/x') && console.log('proxied');
```

--------------------------------

### Using createFromNode and timingPhases

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/04-response.md

Example usage of createFromNode and timingPhases with postman-request. Creates a Response from the node response and logs status, code, and timing phases.

```javascript
const { request } = require('postman-request');
request({ url: 'https://postman-echo.com/get' }, (err, httpResponse, body) => {
  const res = Response.createFromNode(httpResponse);
  console.log(res.status, res.code, Response.timingPhases(httpResponse.timings));
});
```

--------------------------------

### Using getAuth()

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Example usage of getAuth(). Logs the auth type and parameters if an auth is present.

```javascript
const auth = item.getAuth();
if (auth) { console.log(auth.type, auth.parameters().all()); }
```

--------------------------------

### Load a collection from a JSON file

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Example showing how to create a Collection instance from a JSON file. Requires the 'postman-collection' package and Node.js fs module. The collection name and item count are logged.

```javascript
const fs = require('fs');
const { Collection } = require('postman-collection');

const myCollection = new Collection(JSON.parse(fs.readFileSync('sample-collection.json').toString()));
console.log(myCollection.name);          // from info.name
console.log(myCollection.items.count()); // number of root items/folders
```

--------------------------------

### forEachItem example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Iterates over all descendant items, logging each item's name and its parent group's name.

```javascript
myCollection.forEachItem(function (item, parent) {
  console.log(item.name, 'in', parent && parent.name);
});
```

--------------------------------

### GET request with basic auth credentials

Source: https://github.com/postmanlabs/postman-collection/blob/develop/docs/concepts.md

Demonstrates a GET request with basic authentication. The auth object uses type basic and includes credentials; see the RequestAuth API for supported auth types.

```json
{
    "url": "https://echo.getpostman.com/basic-auth",
    "method": "GET",
    "auth": {
        "type": "basic",
        "basic": {
            "username": "fred",
            "password": "hunter2"
        }
    }
}
```

--------------------------------

### Create PropertyList with Header and add items

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/02-property.md

Example of creating a PropertyList with Header type and populating it. The list is case-insensitive by default, so 'accept' matches 'Accept'. The add method wraps the object with the Header type.

```javascript
const { PropertyList, Header } = require('postman-collection');
const headers = new PropertyList(Header, request, [
  { key: 'Content-Type', value: 'application/json' }
]);
headers.add({ key: 'Accept', value: 'application/json' });
console.log(headers.one('accept')); // case-insensitive lookup works
```

--------------------------------

### Using describe on a Collection

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/02-property.md

Example usage of the describe method on a Collection instance. Creates a collection with a name, calls describe to set a description, and logs the description text.

```javascript
const { Collection } = require('postman-collection');
const c = new Collection({ info: { name: 'x' } });
c.describe('Hey! This is a cool collection.');
console.log(c.description.toString()); // Hey! This is a cool collection.
```

--------------------------------

### PropertyList mutation example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/02-property.md

Example of using upsert, insert, and remove on a PropertyList. upsert updates an existing member and returns false. insert places a new item before the specified member. remove deletes by id. The final list order is preserved.

```javascript
const list = new PropertyList(Header, null, [
  { key: 'A', value: '1' },
  { key: 'B', value: '2' }
]);
list.upsert({ key: 'A', value: '10' });  // updates A; returns false
list.insert({ key: 'C', value: '3' }, 'B'); // insert before B
list.remove('C');
console.log(list.all().map(h => h.key)); // ['A','B'] (order preserved after operations)
```

--------------------------------

### Using MutationTracker.track

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/08-variable-scope.md

Example of using track to record set and unset mutations, then count them. Outputs 3.

```javascript
const tracker = new MutationTracker();
tracker.track('set', 'name', 'Bruce Wayne');
tracker.track('set', 'password', 'secret123', { secret: true });
tracker.track('unset', 'age');
console.log(tracker.count()); // 3
```

--------------------------------

### Create a blank collection and write to file

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Creates a blank collection with a name and writes it to a file. Uses the 'fs' module and the 'postman-collection' package. The example writes the collection's string representation to 'myCollection.postman_collection'.

```javascript
var fs = require('fs'),
    Collection = require('postman-collection').Collection,
    mycollection;

myCollection = new Collection({
    info: {
        name: "my Collection"
    }
});

// log the collection to console to see its contents
fs.writeFileSync('myCollection.postman_collection', myCollection.toString());
```

--------------------------------

### Testing URLs with proxy.test

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/11-security.md

Example of using the test method. Shows true for a matching URL and false for a non-matching URL.

```javascript
console.log(proxy.test('https://example.com/anything')); // true
console.log(proxy.test('https://other.com/'));           // false
```

--------------------------------

### Iterate over test events

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Example of iterating over test events and logging their script source if present.

```javascript
item.getEvents('test').forEach(event => {
  event.script && console.log(event.script.toSource());
});
```

--------------------------------

### Set and unset protocol profile behavior

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Example of setting, reading, and unsetting a protocol profile behavior. The resolved behavior shows the merged result.

```javascript
item.setProtocolProfileBehavior('strictSSL', false);
console.log(item.getProtocolProfileBehaviorResolved()); // { strictSSL: false }
item.unsetProtocolProfileBehavior('strictSSL');
```

--------------------------------

### Add and remove query parameters

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/05-url.md

Add and remove query parameters, then get the resulting query string. The example shows adding 'b=2&c=3' and removing 'b', leaving 'a=1&c=3'.

```javascript
url.addQueryParams('b=2&c=3');
url.removeQueryParams(['b']);
console.log(url.getQueryString()); // a=1&c=3
```

--------------------------------

### Replace dynamic variables with Property.replaceSubstitutions

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/configuration.md

Use this example to see how dynamic variables like {{$guid}} and {{$timestamp}} are resolved via Property.replaceSubstitutions. The empty object passed as the second argument means no custom variables are provided, so only the built-in defaults are available. This prints a string with a UUID and Unix timestamp substituted in.

```JavaScript
const { Property } = require('postman-collection');
console.log(Property.replaceSubstitutions('id={{$guid}} at {{$timestamp}}', {}));
```

--------------------------------

### Use oauth1 auth type

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/03-request.md

Example of switching to oauth1 auth type and providing its parameters. The ellipsis indicates additional parameters.

```javascript
auth.use('oauth1', { consumerKey: 'ck', consumerSecret: 'cs', ... });
```

--------------------------------

### Authorize request using basic auth

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/01-collection.md

Example of authorizing a request using basic auth. Logs the auth type after setting.

```javascript
item.authorizeRequestUsing('basic', { username: 'postman', password: 'password' });
console.log(item.request.auth.type); // 'basic'
```

--------------------------------

### get(key)

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Gets the value of a variable by its key.

```APIDOC
## variableScope.get(key)

### Description
Gets the value of a variable by its key.

### Method
`get(key)`

### Parameters
- **key** (String) - Required - The name of the variable to get.

### Returns
- **\*** - The value of the variable.
```

--------------------------------

### Create Description with content and type

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/10-description-version.md

Create a Description instance with content and type, then print its string representation.

```javascript
const { Description } = require('postman-collection');
const d = new Description({
  content: '<h1>Hello World</h1>',
  type: 'text/html'
});
console.log(d.toString()); // <h1>Hello World</h1>
```

--------------------------------

### Add a description to a Collection instance

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Shows how to add a description to a Collection instance using the Description constructor with an object containing content and type, and also using the .describe method. The example uses the postman-collection SDK.

```javascript
 var SDK = require('postman-collection'),
    Collection = SDK.Collection,
    Description = SDK.Description,
    mycollection;

// create a blank collection
myCollection = new Collection();
myCollection.description = new Description({
    content: '&lt;h1&gt;Hello World&lt;/h1&gt;&lt;p&gt;I am a Collection&lt;/p&gt;',
    type: 'text/html'
});

// alternatively, you could also use the `.describe` method of any property to set or update the description of the
// property.
myCollection.describe('Hey! This is a cool collection.');
```

--------------------------------

### Create PropertyBase instance and access meta

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/02-property.md

Creates a PropertyBase instance with a meta key (_postman_id) and a description. meta() returns the unprefixed meta keys, and description remains a plain string because PropertyBase does not wrap it.

```javascript
const { PropertyBase } = require('postman-collection');
const pb = new PropertyBase({ _postman_id: 'abc', description: 'hello' });
console.log(pb.meta());          // { postman_id: 'abc' }
console.log(pb.description);     // still a plain string (not wrapped — subclasses wrap it)
```

--------------------------------

### Collection JSON definition example

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

JSON definition of an example collection. Shows the structure accepted by `new Collection(...)` and exported by `toJSON` or `Property#toObjectResolved`. Note the missing comma after the `info` object and the use of `variables` (not `variable`) in the example.

```js
{
    "info": {
        "name": "My Postman Collection",
        "version": "1.0.0"
    }
    "item": [{
        "request": "{{base-url}}/get"
    }],
    "variables": [{
        "id": "base-url",
        "value": "https://postman-echo.com"
    }]
}
```

--------------------------------

### Load a Collection JSON file from disk

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Loads a collection from a JSON file on disk using the postman-collection library. Requires the 'fs' module and the 'postman-collection' package. The example reads the file, converts it to a string, and passes it to the Collection constructor.

```javascript
var fs = require('fs'), // needed to read JSON file from disk
    pretty = function (obj) { // function to neatly log the collection object to console
        return require('util').inspect(obj, {colors: true});
    },
    Collection = require('postman-collection').Collection,
    myCollection;

// Load a collection to memory from a JSON file on disk (say, sample-collection.json)
myCollection = new Collection(JSON.stringify(fs.readFileSync('sample-collection.json').toString()));

// log items at root level of the collection
console.log(inspect(myCollection));
```

--------------------------------

### Create a new ProxyConfig

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Creates a new ProxyConfig instance with match, server, tunnel, and disabled options. The match pattern 'https://example*' associates the proxy with matching URLs, and the server is the proxy URL.

```javascript
var ProxyConfig = require('postman-collection').ProxyConfig,
    myProxyConfig = new ProxyConfig({
         match: 'https://example*',
         server: 'https://proxy.com',
         tunnel: true,
         disabled: false
    });
```

--------------------------------

### ProxyConfig JSON definition example

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Shows the JSON structure accepted by the ProxyConfig constructor and exported by toJSON(). The match field uses '*' as a wildcard, and disabled overrides the proxy for a particular URL.

```js
{
    match: 'https://example.com/*',
    server: 'https://proxy.com',
    tunnel: true,
    disabled: false
}
```

--------------------------------

### Create Header from string

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/06-header.md

Creates a Header instance from a 'key: value' string and demonstrates toString() and valueOf() output.

```javascript
const { Header } = require('postman-collection');
const h = new Header('Content-Type: application/xml');
console.log(h.toString());          // Content-Type: application/xml
console.log(h.valueOf());           // application/xml
```

--------------------------------

### Variable get() signature

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/07-variable.md

Signature for the get() method. Returns the value cast out of the stored form; function values are invoked first.

```js
get ()   // returns Variable.types
```

--------------------------------

### HeaderList contentSize() usage example

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/06-header.md

Example usage of contentSize() on a request's headers, logging the byte length (e.g., 43).

```javascript
console.log(request.headers.contentSize()); // e.g. 43
```

--------------------------------

### Add a description to a Collection instance using describe()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Creates a blank Collection and calls describe() to set a description, then logs the description string. The type parameter defaults to 'text/plain'.

```JavaScript
 var Collection = require('postman-collection').Collection,
    mycollection;

// create a blank collection
myCollection = new Collection();
myCollection.describe('Hey! This is a cool collection.');

console.log(myCollection.description.toString()); // read the description
```

--------------------------------

### QueryParam usage examples

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/05-url.md

Usage examples for `QueryParam.parse`, `unparse`, and `unparseSingle`. The last line shows that `unparseSingle` percent-encodes `&` in keys but preserves `=` in values.

```javascript
const { QueryParam } = require('postman-collection');
console.log(QueryParam.parse('a=1&b=2'));            // [{key:'a',value:'1'},{key:'b',value:'2'}]
console.log(QueryParam.unparse({ a: 1, b: 2 }));     // 'a=1&b=2'
console.log(QueryParam.unparseSingle({ key: 'x&y', value: 'a=b' })); // 'x%26y=a%3Db'... (value '=' preserved)
```

--------------------------------

### Item with Events (prerequest and test)

Source: https://github.com/postmanlabs/postman-collection/blob/develop/docs/concepts.md

Shows how to attach both a prerequest and a test event to an Item. The prerequest script runs before the HTTP request is sent, while the test script runs after the response is received.

```json
{
    "id": "evented-item",
    "name": "Item with Events",
    "description": "This is an Item that contains `test and `prerequest` events.",
    "request": "http://echo.getpostman.com/get",
    "event": [
        {
            "listen": "prerequest",
            "script": {
                "type": "text/javascript",
                "exec": "console.log('We are in the pre-request script, the request has not run yet!')"
            }
        },
        {
            "listen": "test",
            "script": {
                "type": "text/javascript",
                "exec": "console.log('We are using the test script now, and the request was already sent!')"
            }
        }
    ]
}
```

--------------------------------

### Build a Response from scratch

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/04-response.md

Build a Response instance from scratch with a status code, header, body, and response time. The status is derived from http-reasons, and json() parses the body.

```javascript
const { Response } = require('postman-collection');

const res = new Response({
  code: 200,
  header: [{ key: 'Content-Type', value: 'application/json' }],
  body: '{"status":"ok"}',
  responseTime: 120
});
console.log(res.status);        // 'OK' (from http-reasons)
console.log(res.json().status); // 'ok'
```

--------------------------------

### get method signature

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/08-variable-scope.md

Method signature for get. Returns the variable's value from the local scope or the first enabled match in layers, else undefined.

```js
get: function (key)   // returns *
```

--------------------------------

### Using UrlMatchPatternList to Test URLs

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/12-url-match-pattern.md

Example usage of UrlMatchPatternList's test method. It creates a list with two patterns and tests URLs, logging true for a matching URL and false for a non-matching one.

```js
const { UrlMatchPatternList } = require('postman-collection');
const list = new UrlMatchPatternList({}, ['https://*.google.com/*', 'https://example.com/*']);
console.log(list.test('https://example.com/x'));   // true
console.log(list.test('https://other.org/x'));     // false
```

--------------------------------

### Create and get a typed Variable

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/07-variable.md

Create a Variable with a number type and observe that get() returns the cast-out value (Number) while the raw stored value remains a string.

```js
const { Variable } = require('postman-collection');
const v = new Variable({ key: 'port', value: '8080', type: 'number' });
console.log(v.get());      // 8080 (Number, cast out)
console.log(v.value);      // '8080' (stored raw)
```

--------------------------------

### new Collection([definition], [environments])

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Constructor for creating a new Collection instance. It accepts an optional definition object and an optional array of environment objects.

```APIDOC
## new Collection([definition], [environments])

### Description
Create or load an instance of Postman Collection as a JavaScript object that can be manipulated easily. A collection lets you group individual requests together, organize them into folders, store sample responses, and add metadata like name and description.

### Constructor
`new Collection([definition], [environments])`

### Parameters
- **definition** (Object|string) - Optional - Pass the initial definition of the collection (name, id, etc). The definition object is structured exactly as the collection format as defined in https://www.schema.getpostman.com/. This parameter is optional, so you can create an empty instance and add requests and other properties to build a new collection.
- **environments** (Array.<Object>) - Optional - An array of environment objects that store variable definitions inherited by the collection's variables. These are usually the ones exported from the Postman App to use with different collections.

### Example (Load a Collection JSON file from disk)
```js
var fs = require('fs'), // needed to read JSON file from disk
    pretty = function (obj) { // function to neatly log the collection object to console
        return require('util').inspect(obj, {colors: true});
    },
    Collection = require('postman-collection').Collection,
    myCollection;

// Load a collection to memory from a JSON file on disk (say, sample-collection.json)
myCollection = new Collection(JSON.stringify(fs.readFileSync('sample-collection.json').toString()));

// log items at root level of the collection
console.log(inspect(myCollection));
```

### Example (Create a blank collection and write to file)
```js
var fs = require('fs'),
    Collection = require('postman-collection').Collection,
    mycollection;

myCollection = new Collection({
    info: {
        name: "my Collection"
    }
});

// log the collection to console to see its contents
fs.writeFileSync('myCollection.postman_collection', myCollection.toString());
```
```

--------------------------------

### Create and test a UrlMatchPattern

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/12-url-match-pattern.md

Creates a UrlMatchPattern for 'https://*.google.com/*' and tests two URLs. The first matches, the second fails because the protocol is http instead of https.

```javascript
const { UrlMatchPattern } = require('postman-collection');
const p = new UrlMatchPattern('https://*.google.com/*');
console.log(p.test('https://maps.google.com/search')); // true
console.log(p.test('http://maps.google.com/search'));  // false (protocol)
```

--------------------------------

### Variable definition object example

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Example of the object representation of a Variable, showing the optional id and name fields along with the value and type. The type must be one of the values defined in Variable.types.

```json
{
    "id": "my-var-1",
    "name": "MyFirstVariable",
    "value": "Hello World",
    "type": "string"
}
```

--------------------------------

### new Url(options)

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Constructor for the Url class. Accepts a URL string or an object with URL components.

```APIDOC
## new Url(options)

### Description
Defines a URL object.

### Parameters
- **options** (Object | String) - Required - The URL string or an object representing the URL.

```

--------------------------------

### new ProxyConfigList(parent, populate)

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/11-security.md

Creates a new ProxyConfigList instance. The parent parameter is the owner object, and populate is an optional array of proxy definitions.

```APIDOC
## Constructor

### Description
Creates a new ProxyConfigList instance.

### Signature
```js
ProxyConfigList = function PostmanProxyConfigList (parent, populate)
```

### Parameters
- **parent** (Object) - Required - Owner.
- **populate** (Array) - Optional - Proxy definitions.

### Example
```js
const { ProxyConfigList } = require('postman-collection');
const proxies = new ProxyConfigList({}, [
  { match: 'https://example.com/*', host: 'proxy.com', port: 8080, tunnel: true },
  { match: 'http+https://example2.com/*', host: 'proxy2.com' }
]);
```
```

--------------------------------

### response.text()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Get the response body as a string/text.

```APIDOC
## response.text()

### Description
Get the response body as a string/text.

### Method
GET

### Endpoint
response.text()

### Parameters
None

### Response
#### Success Response (200)
- **text** (String | undefined) - The response body as a string.

#### Response Example
```js
var text = response.text();
```
```

--------------------------------

### collection.parent()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Gets the parent of the collection item.

```APIDOC
## collection.parent() ⇒ * | undefined

### Description
Returns the parent of the item.

### Method
instance method

### Returns
- (* | undefined) - The parent item, or undefined if none.
```

--------------------------------

### variableList.idx(index)

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Get a member of this list by its index.

```APIDOC
## variableList.idx(index) ⇒ PropertyList.Type

### Description
Get a member of this list by its index.

### Method
instance method

### Parameters
- **index** (Number) - Required - The index of the member to retrieve.

### Returns
- **PropertyList.Type** - The member at the given index.
```

--------------------------------

### ProxyConfigList and ProxyConfig Methods

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Documentation for the ProxyConfigList and ProxyConfig classes from the postman-collection SDK, including instance and static methods.

```APIDOC
## ProxyConfigList.eachParent(iterator, [context])

### Description
Iterates over all parents of the property list.

### Method
Instance method

### Parameters
- **iterator** (function) - Required - The iterator function called for each parent.
- **[context]** (Object) - Optional - The context to use when calling the iterator.

### Returns
No return value specified.

```

```APIDOC
## ProxyConfigList.toObject()

### Description
Converts a list of Properties into an object where key is `_postman_propertyIndexKey` and value is determined by the `valueOf` function.

### Method
Instance method

### Parameters
None

### Returns
- **Object** - The resulting object.

```

```APIDOC
## ProxyConfigList.toString()

### Description
Adds ability to convert a list to a string provided its underlying format has an unparse function defined.

### Method
Instance method

### Parameters
None

### Returns
- **String** - The string representation of the list.

```

```APIDOC
## ProxyConfigList.isProxyConfigList(obj)

### Description
Checks whether an object is a ProxyConfigList.

### Method
Static method

### Parameters
- **obj** (*) - Required - The object to check.

### Returns
- **Boolean** - True if the object is a ProxyConfigList, false otherwise.

```

```APIDOC
## new ProxyConfig([options])

### Description
Creates a new ProxyConfig instance representing the proxy configuration for a URL match.

### Constructor
`new ProxyConfig([options])`

### Parameters
- **[options]** (definition) - Optional - Specifies object with props matches, server, and tunnel.

### Example
```js
var ProxyConfig = require('postman-collection').ProxyConfig,
    myProxyConfig = new ProxyConfig({
         match: 'https://example*',
         server: 'https://proxy.com',
         tunnel: true,
         disabled: false
    });
```

```

```APIDOC
## ProxyConfig.update(options)

### Description
Updates the proxy configuration with the given options.

### Method
Instance method

### Parameters
- **options** (Object) - Required - The options to update the proxy configuration.

### Returns
No return value specified.

```

```APIDOC
## ProxyConfig.test([urlStr])

### Description
Tests whether the given URL string matches the proxy configuration's match pattern.

### Method
Instance method

### Parameters
- **[urlStr]** (String) - Optional - The URL string to test.

### Returns
- **Boolean** - True if the URL matches, false otherwise.

```

```APIDOC
## ProxyConfig.isProxyConfig(obj)

### Description
Checks whether an object is a ProxyConfig.

### Method
Static method

### Parameters
- **obj** (*) - Required - The object to check.

### Returns
- **Boolean** - True if the object is a ProxyConfig, false otherwise.

```

--------------------------------

### header.valueOf()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Instance method to get the header value.

```APIDOC
## header.valueOf() ⇒ String

### Description
Returns the value of the header.

### Returns
- **String** - The header value.
```

--------------------------------

### new VariableList(populate, environment, global)

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Constructor for the VariableList class.

```APIDOC
## new VariableList(populate, environment, global)

### Description
Creates a new VariableList instance.

### Parameters
- **populate** (Object) - Required - Initial data to populate the list.
- **environment** (Object) - Required - Environment variables.
- **global** (Object) - Required - Global variables.
```

--------------------------------

### header.toString()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Instance method to get the header as a string.

```APIDOC
## header.toString() ⇒ String

### Description
Returns the header as a string in `name:value` format.

### Returns
- **String** - The header string.
```

--------------------------------

### property.parent()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Instance method of Property to get the parent of an item.

```APIDOC
## property.parent() ⇒ <code>*</code> | <code>undefined</code>

### Description
Returns the parent of item.

### Method
instance method

### Returns
- **<code>*</code> | <code>undefined</code>** - The parent of the item.
```

--------------------------------

### variable.valueType(typeName)

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Gets or sets the type of the variable's value.

```APIDOC
## variable.valueType(typeName)

### Description
Sets or gets the type of the value. If a typeName is provided, it sets the type; otherwise, it returns the current type.

### Method
VALUETYPE

### Endpoint
variable.valueType(typeName)

### Parameters
- **typeName** (String) - Optional - The type name to set.

### Response
Returns the current type of the variable from the list of types.

```

--------------------------------

### url.getRaw() (deprecated)

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Deprecated method to get the raw URL string.

```APIDOC
## url.getRaw() (deprecated)

### Description
Returns the raw string representation of the URL. This method is deprecated.

### Returns
- **string** - The raw URL string.

```

--------------------------------

### Import Description and Version

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/10-description-version.md

Import the Description and Version classes from the postman-collection package.

```javascript
const { Description, Version } = require('postman-collection');
```

--------------------------------

### Create a Cookie instance

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/04-response.md

Creates a new Cookie instance with the given options. The options include name, expires, maxAge, domain, path, secure, httpOnly, session, value, and extensions.

```javascript
const { Cookie } = require('postman-collection');
const c = new Cookie({
  name: 'my-cookie-name',
  expires: '1464769543832',
  maxAge: '300',
  domain: 'something.example.com',
  path: '/',
  secure: false,
  httpOnly: true,
  session: false,
  value: 'my-cookie-value',
  extensions: [{ key: 'Priority', value: 'HIGH' }]
});
```

--------------------------------

### property.toJSON()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Instance method of Property to get the JSON representation of a property.

```APIDOC
## property.toJSON()

### Description
Returns the JSON representation of a property, which conforms to the way it is defined in a collection. You can use this method to get the instantaneous representation of any property, including a Collection.

### Method
instance method
```

--------------------------------

### headerList.idx(index) ⇒ PropertyList.Type

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Gets a member of the list by its index.

```APIDOC
## headerList.idx(index) ⇒ PropertyList.Type

### Description
Gets a member of the list by its index.

### Method
idx

### Parameters
- **index** (Number) - Required - The index of the item.

### Returns
- **PropertyList.Type** - The item at the given index.

```

--------------------------------

### eventList.idx(index) ⇒ PropertyList.Type

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Get a member of this list by its index.

```APIDOC
## eventList.idx(index) ⇒ PropertyList.Type

### Description
Get a member of this list by its index.

### Method
idx

### Parameters
- **index** (Number) - Required - The index of the member to retrieve.

### Returns
- **PropertyList.Type** - The member at the given index.
```

--------------------------------

### Define a POST request with Request

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/03-request.md

Creates a POST request with a raw JSON body and a Content-Type header, then logs the method, URL, and headers.

```javascript
const { Request } = require('postman-collection');

const req = new Request({
  url: 'https://postman-echo.com/post',
  method: 'POST',
  header: [{ key: 'Content-Type', value: 'application/json' }],
  body: { mode: 'raw', raw: '{"hello":"world"}' }
});
console.log(req.method);                 // POST
console.log(req.url.toString());         // https://postman-echo.com/post
console.log(req.getHeaders());           // { 'Content-Type': 'application/json' }
```

--------------------------------

### Cookie.stringify(cookie)

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/04-response.md

Calls prototype.toString.call(cookie) to get the string representation.

```APIDOC
## [STATIC] Cookie.stringify(cookie)

### Description
Returns the string representation of the cookie by calling prototype.toString.call(cookie).

### Method
stringify

### Endpoint
Cookie.stringify(cookie)

### Parameters
#### Path Parameters
- **cookie** (Object) - Required - The cookie object.

### Response
#### Success Response (200)
- **string** (String) - The string representation.

#### Response Example
```js
"[object Object]"
```
```

--------------------------------

### property.meta()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Instance method of Property to get the meta keys associated with the property.

```APIDOC
## property.meta() ⇒ <code>*</code>

### Description
Returns the meta keys associated with the property.

### Method
instance method

### Returns
- **<code>*</code>** - The meta keys.
```

--------------------------------

### collection.id

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Gets or sets the unique identifier for the collection. If not specified, a UUID is auto-generated.

```APIDOC
## collection.id

### Description
Gets or sets the unique identifier for the collection. If not specified, a UUID is auto-generated.

### Method
Property access

### Returns
- **String** - The unique identifier
```

--------------------------------

### Header.create([value], [name])

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Static method to create a new Header instance.

```APIDOC
## Header.create([value], [name]) ⇒ Header

### Description
Creates a new Header instance.

### Parameters
- **value** (definition | String) - Optional - The header definition or value.
- **name** (String) - Optional - The header name.

### Returns
- **Header** - A new Header instance.
```

--------------------------------

### VariableScope.variables()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Get a copy of all variables in form of a plain object. This is useful for iteration and other use.

```APIDOC
## VariableScope.variables()

### Description
Get a copy of all variables in form of a plain object. This is useful for iteration and other use.

### Method
`variables()`

### Returns
`Object` - A plain object containing all variables.

### Example
```js
var env = new VariableScope([{
        key: 'var1',
        value: 'one'
    }, {
        key: 'var2',
        value: 2,
        type: 'number'
    }, {
        key: 'var3',
        value: true,
        type: 'boolean'
    }]),
    obj;

// get all variables consolidated as an object
obj = env.variables();

Object.keys(obj).forEach(function(varname) {
    console.log(obj[varname]); // log all variables
});
```
```

--------------------------------

### response.reason()

Source: https://github.com/postmanlabs/postman-collection/wiki/Home

Get the HTTP response reason phrase based on the current response code.

```APIDOC
## response.reason()

### Description
Get the http response reason phrase based on the current response code.

### Method
GET

### Endpoint
response.reason()

### Parameters
None

### Response
#### Success Response (200)
- **reason** (String | undefined) - The HTTP reason phrase.

#### Response Example
```js
var reason = response.reason();
```
```

--------------------------------

### Replace tokens in a template

Source: https://github.com/postmanlabs/postman-collection/blob/develop/_autodocs/api-reference/08-variable-scope.md

Example usage of replaceIn to substitute a variable in a URL template.

```js
console.log(env.replaceIn('https://{{host}}/get'));
```
Tokens:
Raw