valido - npm Package Compare versions

Comparing version 2.0.3 to 2.0.5

package.json

 {
   "name": "valido",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "Validation provider",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,2 +0,276 @@
-# Validation provider
-[![Circle CI](https://circleci.com/gh/moooji/validation-provider.svg?style=svg&circle-token=c28dc3c48a0ae714054de74d3a3f7746ccf9ee1e)](https://circleci.com/gh/moooji/validation-provider)
+# Valido
+General purpose check and validation library.
+
+The focus is on providing selected, well tested checks and a convenient API. The library is inspired by other projects, like is_js and joi in terms of the API, but completely written from ground up to be easily extendable and testable.
+
+Contributions are welcome.
+
+[![Teamcity](https://teamcity.moooji.com/app/rest/builds/buildType:(id:Valido_Main)/statusIcon?guest=1)](https://teamcity.moooji.com/app/rest/builds/buildType:(id:Valido_Main)/statusIcon?guest=1)
+
+## Installing
+`npm install valido`
+
+## Usage
+````
+const is = require('valido');
+
+is.uri('http://www.test.com');
+--> true
+
+is.all.uri(['http://www.test.com', 123]);
+--> false
+
+is.optional.uri(null);
+--> true
+
+is.optional.uri('http://www.test.com');
+--> true
+
+is.optional.uri(123);
+--> false
+````
+
+### all
+Will return true if all elements in the list validate to true.
+
+````
+is.all.number([007, 123]);
+--> true
+
+is.all.number(['abc', 123]);
+--> false
+````
+
+### optional
+Will return true if the provided value is either null/undefined or validates to true.
+
+````
+is.optional.number(null);
+--> true
+
+is.optional.number(123);
+--> true
+
+is.optional.number('abc');
+--> false
+````
+---
+
+### array(value:any)
+Checks if value is an array.
+
+````
+is.array([]);
+--> true
+````
+
+### boolean(value:any)
+Checks if value is a boolean.
+
+````
+is.boolean(true);
+--> true
+
+is.boolean(0);
+--> false
+````
+
+### buffer(value:any)
+Checks if value is a buffer.
+
+````
+is.buffer(new Buffer('abc'));
+--> true
+
+is.buffer('abc');
+--> false
+````
+
+### date(value:any)
+Checks if value is a date object.
+
+````
+is.date(new Date());
+--> true
+
+is.date('2016-01-01');
+--> false
+````
+
+### existy(value:any)
+Checks if value is not null and not undefined.
+
+````
+is.existy(123);
+--> true
+
+is.existy(null);
+--> false
+````
+
+### finite(value:any)
+Checks if value is finite.
+
+````
+is.finite(123);
+--> true
+
+is.finite(2e64);
+--> true
+
+is.finite(Infinity);
+--> false
+````
+
+### function(value:any)
+Checks if value is a function.
+
+````
+is.function(() => {});
+--> true
+
+is.function(function(){});
+--> true
+
+is.function('function');
+--> false
+````
+
+### hexColor(value:any)
+Checks if value is a hex color.
+
+````
+is.hexColor('#ff3366');
+--> true
+
+is.hexColor('#fff');
+--> true
+
+is.hexColor('cc33cc');
+--> false
+
+is.hexColor('fff');
+--> false
+````
+
+### integer(value:any)
+Checks if value is an integer.
+
+````
+is.integer(123);
+--> true
+
+is.integer(-1);
+--> true
+
+is.integer(2e64);
+--> true
+
+is.hexColor(1.1);
+--> false
+````
+
+### natural(value:any, option:object)
+Checks if value is a natural number.
+
+````
+is.natural(123);
+--> true
+
+is.natural(0);
+--> true
+
+is.natural(0, { disallowZero: true });
+--> false
+
+is.natural(1.1);
+--> false
+
+is.natural(-1);
+--> false
+````
+
+### null(value:any)
+Checks if value is null.
+
+````
+is.null(null);
+--> true
+
+is.null(0);
+--> false
+
+is.null(undefined);
+--> false
+````
+
+### plainObject(value:any)
+Checks if value is a plain object (prototype is Object).
+
+````
+is.plainObject({});
+--> true
+
+is.plainObject(Object.assign({}));
+--> true
+
+is.plainObject(new Object({});
+--> true
+
+is.plainObject(function(){});
+--> false
+````
+
+### string(value:any, options:object)
+Checks if value is a string.
+
+````
+is.string('abc');
+--> true
+
+is.string('abc', { startsWith: 'a' });
+--> true
+
+is.string('abc', { endsWith: 'b' });
+--> false
+
+is.string(123);
+--> false
+````
+
+### undefined(value:any)
+Checks if value is undefined.
+
+````
+is.undefined(undefined);
+--> true
+
+is.undefined(null);
+--> false
+````
+
+### uri(value:any, options:object)
+Checks if value is a URI according to RFC 3986.
+
+````
+is.uri('https://8.8.8.8:3128');
+--> true
+
+is.uri('https://localhost:80');
+--> true
+
+is.uri('mongodb://db.server.com:1234');
+--> true
+
+is.uri('https://user:[e-mail]:8080/index.html?param=2&yy=abc');
+--> true
+
+is.uri('https://www.test.com/', { endsWith: '/' });
+--> true
+
+is.uri('https://www.test.com/', { startsWith: 'https://www.other.com' });
+--> false
+
+is.uri('google.com');
+--> false
+````

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

53200

increased by7.6%

Number of lines in readme file

276

increased by13700%

No dependency changes