clay-errors
==========

[![Build Status][bd_travis_shield_url]][bd_travis_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/realglobe-Inc/clay-errors
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/clay-errors
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/clay-errors.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/clay-errors
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/clay-errors.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/clay-errors/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/clay-errors
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/clay-errors.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/clay-errors.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/clay-errors
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/clay-errors.svg
[bd_npm_url]: http://www.npmjs.org/package/clay-errors
[bd_npm_shield_url]: http://img.shields.io/npm/v/clay-errors.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Custom error classes for ClayDB

Installation
-----

``bash
$ npm install clay-errors --save
`

Usage
---------

`javascript
'use strict'

const { NotFoundError } = require('clay-errors')

{
const doThrow = () => {
throw new NotFoundError({})
}

doThrow()
}

`

API
---------

clay-errors@3.0.1

Custom error classes for ClayDB

+ Functions
+ NotFoundError Class
+ new NotFoundError(message, detail)
+ PolicyError Class
+ new PolicyError(message, detail)
+ SituationError Class
+ new SituationError(message, detail)

Functions

NotFoundError Class

Resource not found error

Extends:

+ Error

$3

Constructor of NotFoundError class

| Param | Type | Description |
| ----- | --- | -------- |
| message | string | Error message |
| detail | Object | Error detail |

PolicyError Class

Policy validation error

Extends:

+ Error

$3

Constructor of PolicyError class

| Param | Type | Description |
| ----- | --- | -------- |
| message | string | Error message |
| detail | Object | Error detail |

SituationError Class

Situation error

Extends:

+ Error`

$3

Constructor of SituationError class

| Param | Type | Description |
| ----- | --- | -------- |
| message | string | Error message |
| detail | Object | Error detail |

License
-------
This software is released under the Apache-2.0 License.

Links
------

+ [ClayDB][clay_d_b_url]
+ [Realglobe, Inc.][realglobe,_inc__url]

[clay_d_b_url]: https://github.com/realglobe-Inc/claydb
[realglobe,_inc__url]: http://realglobe.jp