diff --git a/README.md b/README.md index bff4006..e93d98d 100755 --- a/README.md +++ b/README.md @@ -37,10 +37,4 @@ is.UUID("A987FBC9-4BED-3078-CF07-9141BA07C9F3", 3); // => True is.UUID("xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3", 3); // => False ``` -## Throw `exception` on false - -If you want to throw an `exception` on `false` then check out `oslllo-validator-exception` [HERE](https://github.com/oslllo/validator-exception) - -![](./docs/images/cover-exception-small.png) - --- diff --git a/docs/_sidebar.md b/docs/_sidebar.md index ff0d739..e7709a1 100755 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,136 +1,135 @@ -* Getting Started +- Getting Started - * [Introduction](getting-started/introduction.md) - * [Prerequisites](getting-started/prerequisites.md) - * [Installation](getting-started/installation.md) - * [Basic Usage](getting-started/basic-usage/basic-usage.md) - * [Validators](getting-started/basic-usage/validators.md) - * [`actualNaN()`](#actualNaN) - * [`alpha()`](#alpha) - * [`alphanumeric()`](#alphanumeric) - * [`args()`](#args) - * [`argsEmpty()`](#argsEmpty) - * [`array()`](#array) - * [`arrayEmpty()`](#arrayEmpty) - * [`arrayLike()`](#arrayLike) - * [`ascii()`](#ascii) - * [`base32()`](#base32) - * [`base64()`](#base64) - * [`BIC()`](#BIC) - * [`bigint()`](#bigint) - * [`bool()`](#bool) - * [`btcAddress()`](#btcAddress) - * [`buffer()`](#buffer) - * [`byteLength()`](#byteLength) - * [`creditCard()`](#currency) - * [`currency()`](#currency) - * [`dataURI()`](#dataURI) - * [`date()`](#date) - * [`dateAfter()`](#dateAfter) - * [`dateBefore()`](#dateBefore) - * [`dateValid()`](#dateValid) - * [`decimal()`](#decimal) - * [`defined()`](#defined) - * [`divisibleBy()`](#divisibleBy) - * [`EAN()`](#EAN) - * [`element()`](#element) - * [`email()`](#email) - * [`empty()`](#empty) - * [`equal()`](#equal) - * [`error()`](#error) - * [`ethereumAddress()`](#ethereumAddress) - * [`even()`](#false) - * [`false()`](#false) - * [`float()`](#float) - * [`fn()`](#fn) - * [`FQDN()`](#FQDN) - * [`fullWidth()`](#fullWidth) - * [`greaterThan()`](#greaterThan) - * [`greaterThanOrEqualTo()`](#greaterThanOrEqualTo) - * [`halfWidth()`](#halfWidth) - * [`hash()`](#hash) - * [`hex()`](#hex) - * [`hexadecimal()`](#hexadecimal) - * [`hexColor()`](#hexColor) - * [`hosted()`](#hosted) - * [`HSL()`](#HSL) - * [`IBAN()`](#IBAN) - * [`identityCard()`](#identityCard) - * [`IMEI()`](#IMEI) - * [`infinite()`](#infinite) - * [`instance()`](#instance) - * [`integer()`](#integer) - * [`IP()`](#IP) - * [`IPRange()`](#IPRange) - * [`ISBN()`](#ISBN) - * [`ISIN()`](#ISIN) - * [`ISO31661Alpha2()`](#ISO31661Alpha2) - * [`ISO31661Alpha3()`](#ISO31661Alpha3) - * [`ISO8601()`](#ISO8601) - * [`ISRC()`](#ISRC) - * [`ISSN()`](#ISSN) - * [`JSON()`](#JSON) - * [`JWT()`](#JWT) - * [`latLong()`](#latLong) - * [`lessThan()`](#lessThan) - * [`lessThanOrEqualTo()`](#lessThanOrEqualTo) - * [`locale()`](#locale) - * [`lowercase()`](#lowercase) - * [`MACAddress()`](#MACAddress) - * [`magnetURI()`](#magnetURI) - * [`maximum()`](#maximum) - * [`MD5()`](#MD5) - * [`mimeType()`](#mimeType) - * [`minimum()`](#minimum) - * [`mobilePhone()`](#mobilePhone) - * [`mongoId()`](#mongoId) - * [`multibyte()`](#multibyte) - * [`nan()`](#nan) - * [`null()`](#null) - * [`number()`](#number) - * [`object()`](#object) - * [`objectLiteral()`](#objectLiteral) - * [`octal()`](#octal) - * [`odd()`](#odd) - * [`passportNumber()`](#passportNumber) - * [`pathToDir()`](#pathToDir) - * [`pathToFile()`](#pathToFile) - * [`portNumber()`](#portNumber) - * [`postalCode()`](#postalCode) - * [`primitive()`](#primitive) - * [`regexp()`](#regexp) - * [`RFC3339()`](#RFC3339) - * [`rgbColor()`](#rgbColor) - * [`semVer()`](#semVer) - * [`slug()`](#slug) - * [`string()`](#string) - * [`stringBool()`](#stringBool) - * [`stringContains()`](#stringContains) - * [`stringDecimal()`](#stringDecimal) - * [`stringEmpty()`](#stringEmpty) - * [`stringEquals()`](#stringEquals) - * [`stringIn()`](#stringIn) - * [`stringInteger()`](#stringInteger) - * [`stringLength()`](#stringLength) - * [`stringMatches()`](#stringMatches) - * [`stringNumeric()`](#stringNumeric) - * [`surrogatePair()`](#surrogatePair) - * [`svg()`](#svg) - * [`symbol()`](#symbol) - * [`taxID()`](#taxID) - * [`true()`](#true) - * [`type()`](#type) - * [`undefined()`](#undefined) - * [`uppercase()`](#uppercase) - * [`URL()`](#URL) - * [`UUID()`](#UUID) - * [`variableWidth()`](#variableWidth) - * [`whitelisted()`](#whitelisted) - * [`within()`](#within) - * [Exceptions](getting-started/basic-usage/exceptions.md) + - [Introduction](getting-started/introduction.md) + - [Prerequisites](getting-started/prerequisites.md) + - [Installation](getting-started/installation.md) + - [Basic Usage](getting-started/basic-usage/basic-usage.md) + - [Validators](getting-started/basic-usage/validators.md) + - [`actualNaN()`](#actualNaN) + - [`alpha()`](#alpha) + - [`alphanumeric()`](#alphanumeric) + - [`args()`](#args) + - [`argsEmpty()`](#argsEmpty) + - [`array()`](#array) + - [`arrayEmpty()`](#arrayEmpty) + - [`arrayLike()`](#arrayLike) + - [`ascii()`](#ascii) + - [`base32()`](#base32) + - [`base64()`](#base64) + - [`BIC()`](#BIC) + - [`bigint()`](#bigint) + - [`bool()`](#bool) + - [`btcAddress()`](#btcAddress) + - [`buffer()`](#buffer) + - [`byteLength()`](#byteLength) + - [`creditCard()`](#currency) + - [`currency()`](#currency) + - [`dataURI()`](#dataURI) + - [`date()`](#date) + - [`dateAfter()`](#dateAfter) + - [`dateBefore()`](#dateBefore) + - [`dateValid()`](#dateValid) + - [`decimal()`](#decimal) + - [`defined()`](#defined) + - [`divisibleBy()`](#divisibleBy) + - [`EAN()`](#EAN) + - [`element()`](#element) + - [`email()`](#email) + - [`empty()`](#empty) + - [`equal()`](#equal) + - [`error()`](#error) + - [`ethereumAddress()`](#ethereumAddress) + - [`even()`](#false) + - [`false()`](#false) + - [`float()`](#float) + - [`fn()`](#fn) + - [`FQDN()`](#FQDN) + - [`fullWidth()`](#fullWidth) + - [`greaterThan()`](#greaterThan) + - [`greaterThanOrEqualTo()`](#greaterThanOrEqualTo) + - [`halfWidth()`](#halfWidth) + - [`hash()`](#hash) + - [`hex()`](#hex) + - [`hexadecimal()`](#hexadecimal) + - [`hexColor()`](#hexColor) + - [`hosted()`](#hosted) + - [`HSL()`](#HSL) + - [`IBAN()`](#IBAN) + - [`identityCard()`](#identityCard) + - [`IMEI()`](#IMEI) + - [`infinite()`](#infinite) + - [`instance()`](#instance) + - [`integer()`](#integer) + - [`IP()`](#IP) + - [`IPRange()`](#IPRange) + - [`ISBN()`](#ISBN) + - [`ISIN()`](#ISIN) + - [`ISO31661Alpha2()`](#ISO31661Alpha2) + - [`ISO31661Alpha3()`](#ISO31661Alpha3) + - [`ISO8601()`](#ISO8601) + - [`ISRC()`](#ISRC) + - [`ISSN()`](#ISSN) + - [`JSON()`](#JSON) + - [`JWT()`](#JWT) + - [`latLong()`](#latLong) + - [`lessThan()`](#lessThan) + - [`lessThanOrEqualTo()`](#lessThanOrEqualTo) + - [`locale()`](#locale) + - [`lowercase()`](#lowercase) + - [`MACAddress()`](#MACAddress) + - [`magnetURI()`](#magnetURI) + - [`maximum()`](#maximum) + - [`MD5()`](#MD5) + - [`mimeType()`](#mimeType) + - [`minimum()`](#minimum) + - [`mobilePhone()`](#mobilePhone) + - [`mongoId()`](#mongoId) + - [`multibyte()`](#multibyte) + - [`nan()`](#nan) + - [`null()`](#null) + - [`number()`](#number) + - [`object()`](#object) + - [`objectLiteral()`](#objectLiteral) + - [`octal()`](#octal) + - [`odd()`](#odd) + - [`passportNumber()`](#passportNumber) + - [`pathToDir()`](#pathToDir) + - [`pathToFile()`](#pathToFile) + - [`portNumber()`](#portNumber) + - [`postalCode()`](#postalCode) + - [`primitive()`](#primitive) + - [`regexp()`](#regexp) + - [`RFC3339()`](#RFC3339) + - [`rgbColor()`](#rgbColor) + - [`semVer()`](#semVer) + - [`slug()`](#slug) + - [`string()`](#string) + - [`stringBool()`](#stringBool) + - [`stringContains()`](#stringContains) + - [`stringDecimal()`](#stringDecimal) + - [`stringEmpty()`](#stringEmpty) + - [`stringEquals()`](#stringEquals) + - [`stringIn()`](#stringIn) + - [`stringInteger()`](#stringInteger) + - [`stringLength()`](#stringLength) + - [`stringMatches()`](#stringMatches) + - [`stringNumeric()`](#stringNumeric) + - [`surrogatePair()`](#surrogatePair) + - [`svg()`](#svg) + - [`symbol()`](#symbol) + - [`taxID()`](#taxID) + - [`true()`](#true) + - [`type()`](#type) + - [`undefined()`](#undefined) + - [`uppercase()`](#uppercase) + - [`URL()`](#URL) + - [`UUID()`](#UUID) + - [`variableWidth()`](#variableWidth) + - [`whitelisted()`](#whitelisted) + - [`within()`](#within) -* Miscellaneous +- Miscellaneous - * [Changelog](miscellaneous/changelog.md) - * [Testing](miscellaneous/testing.md) - * [License](miscellaneous/license.md) + - [Changelog](miscellaneous/changelog.md) + - [Testing](miscellaneous/testing.md) + - [License](miscellaneous/license.md) diff --git a/docs/getting-started/basic-usage/basic-usage.md b/docs/getting-started/basic-usage/basic-usage.md index 25eca84..92cd8d8 100755 --- a/docs/getting-started/basic-usage/basic-usage.md +++ b/docs/getting-started/basic-usage/basic-usage.md @@ -2,7 +2,6 @@ --- - ### **Validator** - If you are using | [`oslllo-validator`](https://www.npmjs.com/package/oslllo-validator) ![](../../images/cover-small.png) @@ -47,58 +46,3 @@ https://cdn.jsdelivr.net/npm/oslllo-validator@latest/dist/oslllo-validator.js ``` --- - -### **Validator Exception** - If you are using | [`oslllo-validator-exception`](https://www.npmjs.com/package/oslllo-validator-exception) - -![](../../images/cover-exception-small.png) - -## Node / Bundler - -```js -const assert = require("oslllo-validator-exception"); -``` - -## Browser / Client-side - -Both `minified` and `unminified` versions are available. - -> You can fetch the already built files via the `jsdelivr` CDN or by building them `locally` - ---- - -### CDN - -- [**jsdelivr**](https://www.jsdelivr.com/package/npm/oslllo-validator-exception?path=dist) - -Minified - -```txt -https://cdn.jsdelivr.net/npm/oslllo-validator-exception@latest/dist/oslllo-validator-exception.min.js -``` - -Un-minified - -```txt -https://cdn.jsdelivr.net/npm/oslllo-validator-exception@latest/dist/oslllo-validator-exception.js -``` - -### Usage - -```js - - -``` - ---- - -### Build Locally - -1. Clone the [repository](https://github.com/oslllo/validator-exception) to your local machine. -2. Run `npm install --dev`. -3. Run `npm run build`. - -The built client-side files will be located in the `dist` folder. - ----- diff --git a/docs/getting-started/basic-usage/exceptions.md b/docs/getting-started/basic-usage/exceptions.md deleted file mode 100755 index 00fa352..0000000 --- a/docs/getting-started/basic-usage/exceptions.md +++ /dev/null @@ -1,4 +0,0 @@ -# Throw Exceptions - -If you want to throw an `exception` on `false` then check out `oslllo-validator-exception` [HERE](https://github.com/oslllo/validator-exception) -![](../../images/cover-exception-small.png) diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md index 7ada673..5bd13a1 100755 --- a/docs/getting-started/introduction.md +++ b/docs/getting-started/introduction.md @@ -1,4 +1,3 @@ - ![Cover Image](../images/cover.png) [![build](https://img.shields.io/travis/oslllo/validator)](https://travis-ci.com/github/oslllo/validator) @@ -32,15 +31,6 @@ const is = require("oslllo-validator"); is.UUID("A987FBC9-4BED-3078-CF07-9141BA07C9F3", 3); // => True is.UUID("xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3", 3); // => False - ``` --- - -## Throw `exception` on false - -If you want to throw an `exception` on `false` then check out `oslllo-validator-exception` [HERE](https://github.com/oslllo/validator-exception) - -![](../images/cover-exception-small.png) - ---- diff --git a/docs/images/cover-exception-small.png b/docs/images/cover-exception-small.png deleted file mode 100755 index 6359a6c..0000000 Binary files a/docs/images/cover-exception-small.png and /dev/null differ diff --git a/docs/images/cover-exception.png b/docs/images/cover-exception.png deleted file mode 100755 index 3bbe56b..0000000 Binary files a/docs/images/cover-exception.png and /dev/null differ