HAR Validator

Extremely fast HTTP Archive (HAR) validator using JSON Schema.

Install

1# to use in cli
2npm install --global har-validator
3
4# to use as a module
5npm install --save har-validator

Usage

  Usage: har-validator [options] <files ...>

  Options:

    -h, --help           output usage information
    -V, --version        output the version number
    -s, --schema [name]  validate schema name (log, request, response, etc ...)

Example

1har-validator har.json
2
3har-validator --schema request request.json

API

Note: as of v2.0.0 this module defaults to Promise based API. For backward comptability with v1.x an async/callback API is provided

Validate(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a full HAR object

1validate(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.log(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a log object

1validate.log(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.cache(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a cache object

1validate.cache(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.cacheEntry(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a "beforeRequest" or "afterRequest" objects

1validate.cacheEntry(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.content(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a content object

1validate.content(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.cookie(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a cookie object

1validate.cookie(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.creator(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a creator object

1validate.creator(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.entry(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) an entry object

1validate.entry(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.log(data)

alias of Validate(data)

Validate.page(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a page object

1validate.page(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.pageTimings(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a pageTimings object

1validate.pageTimings(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.postData(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a postData object

1validate.postData(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.record(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a record object

1validate.record(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.request(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a request object

1validate.request(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.response(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a response object

1validate.cacheEntry(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

Validate.timings(data)

Returns a promise that resolves to the valid object.

• data: Object (Required) a timings object

1validate.timings(data)
2  .then(data => console.log('horray!'))
3  .catch(console.error)

---

Callback API

Validate(data [, callback])

Returns true or false.

1var HAR = require('./har.json');
2var validate = require('har-validator/lib/async');
3
4validate(HAR, function (e, valid) {
5  if (e) console.log(e.errors)
6
7  if (valid) console.log('horray!');
8});
9

The async API provides exactly the same methods as the Promise API

---

Support

Donations are welcome to help support the continuous development of this project.

License

ISC License © Ahmad Nassri