Diffusion SHRINE MedCo Fork (release/1.23.1) Browse

1.23.1

har-validator

LICENSE
README.md
bin/
lib/
package.json

README.md

HAR Validator [![version][npm-version]][npm-url] [![License][npm-license]][license-url]

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

[![Build Status][travis-image]][travis-url] [![Downloads][npm-downloads]][npm-url] [![Code Climate][codeclimate-quality]][codeclimate-url] [![Coverage Status][codeclimate-coverage]][codeclimate-url] [![Dependencies][david-image]][david-url]

Install

shell
# to use in cli
npm install --global har-validator

# to use as a module
npm 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

shell
har-validator har.json

har-validator --schema request request.json

API

Note: as of [v2.0.0](https://github.com/ahmadnassri/har-validator/releases/tag/v2.0.0) this module defaults to Promise based API. *For backward comptability with v1.x an [async/callback API](#callback-api) is provided*

Validate(data)

data: Object *(Required)* a full HAR object

js
validate(data)
  .then(data => console.log('horray!'))
  .catch(console.error)

Validate.log(data)

data: Object *(Required)* a log object

js
validate.log(data)
  .then(data => console.log('horray!'))
  .catch(console.error)

Validate.cache(data)

data: Object *(Required)* a cache object

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

Validate.cacheEntry(data)

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

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

Validate.content(data)

data: Object *(Required)* a content object

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

Validate.cookie(data)

data: Object *(Required)* a cookie object

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

Validate.creator(data)

data: Object *(Required)* a creator object

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

Validate.entry(data)

data: Object *(Required)* an entry object

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

Validate.log(data)

alias of [Validate(data)](#validate-data-callback-)

Validate.page(data)

data: Object *(Required)* a page object

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

Validate.pageTimings(data)

data: Object *(Required)* a pageTimings object

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

Validate.postData(data)

data: Object *(Required)* a postData object

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

Validate.record(data)

data: Object *(Required)* a record object

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

Validate.request(data)

data: Object *(Required)* a request object

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

Validate.response(data)

data: Object *(Required)* a response object

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

Validate.timings(data)

data: Object *(Required)* a timings object

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

Callback API

Validate(data [, callback])

js
var HAR = require('./har.json');
var validate = require('har-validator/lib/async');

validate(HAR, function (e, valid) {
  if (e) console.log(e.errors)

  if (valid) console.log('horray!');
});

The async API provides exactly the same methods as the [Promise API](#promise-api)

Support

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

[![Gratipay][gratipay-image]][gratipay-url] [![PayPal][paypal-image]][paypal-url] [![Flattr][flattr-image]][flattr-url] [![Bitcoin][bitcoin-image]][bitcoin-url]