Palak Handa / startUpJalsa-Backend

Blame view

node_modules/har-validator/README.md 2.82 KB
edit raw normal view history
f7563de62   Palak Handa   first commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
  # HAR Validator [![version][npm-version]][npm-url] [![License][npm-license]][license-url]
  
  > Extremely fast HTTP Archive ([HAR](https://github.com/ahmadnassri/har-spec/blob/master/versions/1.2.md)) 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]
  [![Dependency Status][dependencyci-image]][dependencyci-url]
  [![Dependencies][david-image]][david-url]
  
  ## Install
  
  ```bash
  npm install --only=production --save har-validator
  ```
  
  ## Usage
  
  I recommend using an optimized build matching your Node.js environment version, otherwise, the standard `require` would work just fine with any version of Node `>= v4.0` .
  
  ```js
  /*
   * Node 7
   */
  const validate = require('har-validator/lib/node7')
  
  /*
   * Node 6
   */
  const validate = require('har-validator/lib/node6')
  
  /*
   * Node 4 (Default)
   */
  var validate = require('har-validator')
  ```
  
  ## CLI Usage
  
  Please refer to [`har-cli`](https://github.com/ahmadnassri/har-cli) for more info.
  
  ## 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](docs/async.md) is also provided*
  
  - [async API](docs/async.md)
  - [callback API](docs/async.md)
  - [Promise API](docs/promise.md) *(default)*
  
  ----
  > :copyright: [ahmadnassri.com](https://www.ahmadnassri.com/)  · 
  > License: [ISC][license-url]  · 
  > Github: [@ahmadnassri](https://github.com/ahmadnassri)  · 
  > Twitter: [@ahmadnassri](https://twitter.com/ahmadnassri)
  
  [license-url]: http://choosealicense.com/licenses/isc/
  
  [travis-url]: https://travis-ci.org/ahmadnassri/har-validator
  [travis-image]: https://img.shields.io/travis/ahmadnassri/har-validator.svg?style=flat-square
  
  [npm-url]: https://www.npmjs.com/package/har-validator
  [npm-license]: https://img.shields.io/npm/l/har-validator.svg?style=flat-square
  [npm-version]: https://img.shields.io/npm/v/har-validator.svg?style=flat-square
  [npm-downloads]: https://img.shields.io/npm/dm/har-validator.svg?style=flat-square
  
  [codeclimate-url]: https://codeclimate.com/github/ahmadnassri/har-validator
  [codeclimate-quality]: https://img.shields.io/codeclimate/github/ahmadnassri/har-validator.svg?style=flat-square
  [codeclimate-coverage]: https://img.shields.io/codeclimate/coverage/github/ahmadnassri/har-validator.svg?style=flat-square
  
  [david-url]: https://david-dm.org/ahmadnassri/har-validator
  [david-image]: https://img.shields.io/david/ahmadnassri/har-validator.svg?style=flat-square
  
  [dependencyci-url]: https://dependencyci.com/github/ahmadnassri/har-validator
  [dependencyci-image]: https://dependencyci.com/github/ahmadnassri/har-validator/badge?style=flat-square