@venncity/errors - npm Package Compare versions

Comparing version 1.7.1 to 1.7.2

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+## [1.7.2](https://github.com/venn-city/npm-shelf/compare/@venncity/errors@1.7.1...@venncity/errors@1.7.2) (2020-05-26)
+
+**Note:** Version bump only for package @venncity/errors
+
+
+
+
+
 ## [1.7.1](https://github.com/venn-city/npm-shelf/compare/@venncity/errors@1.7.0...@venncity/errors@1.7.1) (2020-05-21)
@@ -8,0 +16,0 @@

package.json

 {
   "name": "@venncity/errors",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "author": "Venn Engineering",
@@ -32,3 +32,3 @@ "main": "src/index.js",
   },
-  "gitHead": "8285f069b31d9eaff5d9fcb4797eb3a6777420a9"
+  "gitHead": "a7a93cd663f5da53548c44de3e71e9cdd4e8b869"
 }

README.md

@@ -0,7 +1,21 @@
+### Errors
+
 ![Coverage](https://api.venn.city/production/coverage/badge?branch=master&repository=@venncity/errors)
 
-### Errors
+Provides data validation and common error objects.
 
-#### provides data validation and common errors
 
-uses VError and Joi libraries under the hood
+#### **Error types:**
+
+* VennError
+* VennUnknownError
+* VennForbiddenError
+* VennThrottlingError
+* VennServerDataValidationError
+* VennClientDataValidationError
+
+
+#### **validator.assert(value, schema, overrides)**
+
+Used to validate an object schema against a schema (using the joi dsl - https://github.com/hapijs/joi/blob/v15.0.0/lib/language.js).
+The `ValidationError` field in the overrides param lets you select what type of error will be thrown upon a validation error.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22192

increased by2.86%

Number of lines in readme file

22

increased by175%

No dependency changes