@basekits/kit-validator

Validation functions kit for basekits.

Usage no npm install needed!

<script type="module">
  import basekitsKitValidator from 'https://cdn.skypack.dev/@basekits/kit-validator';
</script>

README

@basekits/kit-validator

Validation functions kit for basekits.

Install

npm i @basekits/kit-type @basekits/kit-error @basekits/kit-validator

Usage

const kit = require('@basekits/core')
const type = require('@basekits/kit-type')
const error = require('@basekits/kit-error')
const validator = require('@basekits/kit-validator')
kit.addKit(type)
kit.addKit(error)
kit.addKit(validator)

Available Items

The following methods will be available after adding this kit:

.isEmpty(value)

Return true if value is an empty object, array, string, numeric 0, null or boolean false. Returns false otherwise.


.isNotEmpty(value)

Exactly opposite of the .isEmpty() method.


.isEqual(value, otherValue)

Performs a deep strict equality check to detect value and otherValue are equal. Returns a boolean.

kit.isEqual('hey', 'hey') // returns true
kit.isEqual(
  {a: {b: {c: 'hey', d: 'dey'}}, b: 'bey'},
  {a: {b: {c: 'hey', d: 'dey'}}, b: 'bey'}
) // returns true
kit.isEqual(
  {a: {b: {c: 'hey', d: 'dey'}}, b: 'bey'},
  {a: {b: {c: 'cey', d: 'dey'}}, b: 'bey'}
) // returns false

.isUUID(value)

Returns true if the value is an RFC compliant UUID.

kit.isUUID('109156be-c4fb-41ea-b1b4-efe1671c5836') // returns true
kit.isUUID('109156be-c4fb-41ea-b1b4-efe1671a') // returns false

.isEmail(value)

Returns true if the value is an email.


.isURL(value, opts)

Returns true if the value is a URL. Default options are

const defaultOpts = {
  allowLocal: false,
  allowDataUrl: false,
  schemes: ['http', 'https']
}
kit.isURL('http://github.com') // returns true
kit.isURL('ftp://github.com') // returns false
kit.isURL('ftp://github.com', {schemes: ['ftp', 'https']}) // returns true

Taken from: https://github.com/ansman/validate.js/blob/master/validate.js#L1097