http-assert-value - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "http-assert-value",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "assert values with status codes",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # http-assert of typed values
 
-### Install
+## Install
 ```bash
@@ -8,6 +8,14 @@ npm install http-assert-value --save
 
-### Example
+## Usage
 ```js
 const assert = require('http-assert-value');
 
+// Common assert interface
+assert(+0 === -0, 'Zeros are not equal', 500, 'ZNE', {
+    leftOperand: +0,
+    reghtOperand: -0,
+    operation: '==='
+});                                        // Ok
+
+// Assert typed values
 assert.identity('green-mile');             // Ok
@@ -18,2 +26,3 @@ assert.float('3.14');                      // Ok
 
+// Assert by JSON schema
 // @see: http://json-schema.org/
@@ -34,1 +43,74 @@ assert.bySchema('1', { type: 'integer' }); // Ok
 ```
+
+## API
+
+### assert(value, message, code, shortMessage, options={})
+Assert value with http-specific error data
+
+* value `Any` - asserting value
+* message `String` - error text
+* code `Number` - error http-code
+* shortMessage `String` - three-letter error code
+* \[options\] `Object` - error additional information
+
+### assert.identity(value, field = 'Identity')
+Assert slug or unique identity value
+
+* value `String|Array<String>` - asserting value
+* \[field\] `String` - name of the parameter containing value
+
+### assert.float(value, field = 'Float')
+Assert float value
+
+* value `String|Array<String>` - asserting value
+* \[field\] `String` - name of the parameter containing value
+
+### assert.positiveInt(value, field = 'Positive integer')
+Assert positive integer value
+
+* value `String|Array<String>` - asserting value
+* \[field\] `String` - name of the parameter containing value
+
+### assert.text(value, field = 'Text')
+Assert text, like search request
+
+* value `String|Array<String>` - asserting value
+* \[field\] `String` - name of the parameter containing value
+
+### assert.bySchema(value, schema, options = {})
+Assert object by schema
+
+* value `Any|Array<Any>` - asserting value
+* schema `Object` - asserting value
+* \[options\] `Object` - ajv constructor options
+
+### assert.tryIdentity(value, field = 'Identity')
+Assert slug or unique identity value, when value is defined
+
+* value `String|Array<String>` - asserting value
+* \[field\] `String` - name of the parameter containing value
+
+### assert.tryFloat(value, field = 'Float')
+Assert float value, when value is defined
+
+* value `String|Array<String>` - asserting value
+* \[field\] `String` - name of the parameter containing value
+
+### assert.tryPositiveInt(value, field = 'Positive integer')
+Assert positive integer value, when value is defined
+
+* value `String|Array<String>` - asserting value
+* \[field\] `String` - name of the parameter containing value
+
+### assert.tryText(value, field = 'Text')
+Assert text, like search request, when value is defined
+
+* value `String|Array<String>` - asserting value
+* \[field\] `String` - name of the parameter containing value
+
+### assert.tryBySchema(value, schema, options = {})
+Assert object by schema, when value is defined
+
+* value `Any|Array<Any>` - asserting value
+* schema `Object` - asserting value
+* \[options\] `Object` - ajv constructor options

No alert changes

Improved metrics

Total package byte prevSize

20116

increased by22.35%

Number of package files

6

increased by20%

Number of lines in readme file

114

increased by256.25%

No dependency changes