apemanerror/README.md

Error parser for apeman.

apemanerror
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/apeman-labo/apemanerror
[bd_travis_url]: http://travis-ci.org/apeman-labo/apemanerror
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-labo/apemanerror.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-labo/apemanerror
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-labo/apemanerror.svg?token=
[bd_license_url]: https://github.com/apeman-labo/apemanerror/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-labo/apemanerror
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-labo/apemanerror.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-labo/apemanerror.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-labo/apemanerror
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-labo/apemanerror.svg
[bd_npm_url]: http://www.npmjs.org/package/apemanerror
[bd_npm_shield_url]: http://img.shields.io/npm/v/apemanerror.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Error parser for apeman.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install apemanerror --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

Create error object with tv4 result.

```javascript
'use strict'

const { fromTv4 } = require('apemanerror')

// Error for tv4

const tv4 = require('tv4')

let schema = {
  'properties': {
    'id': {
      'description': 'The unique identifier for a product',
      'type': 'integer'
    },
    'name': {
      'description': 'Name of the product',
      'type': 'string'
    }
  },
  'required': [
    'id',
    'name'
  ]
}
let values = {
  name: 'foo',
  id: 'abc'
}

let result = tv4.validateMultiple(values, schema)
let error = fromTv4(result.errors)

console.log(error)

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/apeman-labo/apemanerror/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [apeman][apeman_url]

[apeman_url]: https://github.com/apeman-labo/apeman

<!-- Links End -->