Skip to content

Commit 606388d

Browse files
Ghustavh97Ghustavh97
committed
refactor(docs): remove oslllo-validator-exception because support is dropping
1 parent 62d76ed commit 606388d

File tree

7 files changed

+132
-209
lines changed

7 files changed

+132
-209
lines changed

‎README.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,4 @@ is.UUID("A987FBC9-4BED-3078-CF07-9141BA07C9F3", 3); // => True
3737
is.UUID("xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3", 3); // => False
3838
```
3939

40-
## Throw `exception` on false
41-
42-
If you want to throw an `exception` on `false` then check out `oslllo-validator-exception` [HERE](https://github.com/oslllo/validator-exception)
43-
44-
![](./docs/images/cover-exception-small.png)
45-
4640
---

‎docs/_sidebar.md‎

Lines changed: 132 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,136 +1,135 @@
1-
* Getting Started
1+
- Getting Started
22

3-
* [Introduction](getting-started/introduction.md)
4-
* [Prerequisites](getting-started/prerequisites.md)
5-
* [Installation](getting-started/installation.md)
6-
* [Basic Usage](getting-started/basic-usage/basic-usage.md)
7-
* [Validators](getting-started/basic-usage/validators.md)
8-
* [`actualNaN()`](#actualNaN)
9-
* [`alpha()`](#alpha)
10-
* [`alphanumeric()`](#alphanumeric)
11-
* [`args()`](#args)
12-
* [`argsEmpty()`](#argsEmpty)
13-
* [`array()`](#array)
14-
* [`arrayEmpty()`](#arrayEmpty)
15-
* [`arrayLike()`](#arrayLike)
16-
* [`ascii()`](#ascii)
17-
* [`base32()`](#base32)
18-
* [`base64()`](#base64)
19-
* [`BIC()`](#BIC)
20-
* [`bigint()`](#bigint)
21-
* [`bool()`](#bool)
22-
* [`btcAddress()`](#btcAddress)
23-
* [`buffer()`](#buffer)
24-
* [`byteLength()`](#byteLength)
25-
* [`creditCard()`](#currency)
26-
* [`currency()`](#currency)
27-
* [`dataURI()`](#dataURI)
28-
* [`date()`](#date)
29-
* [`dateAfter()`](#dateAfter)
30-
* [`dateBefore()`](#dateBefore)
31-
* [`dateValid()`](#dateValid)
32-
* [`decimal()`](#decimal)
33-
* [`defined()`](#defined)
34-
* [`divisibleBy()`](#divisibleBy)
35-
* [`EAN()`](#EAN)
36-
* [`element()`](#element)
37-
* [`email()`](#email)
38-
* [`empty()`](#empty)
39-
* [`equal()`](#equal)
40-
* [`error()`](#error)
41-
* [`ethereumAddress()`](#ethereumAddress)
42-
* [`even()`](#false)
43-
* [`false()`](#false)
44-
* [`float()`](#float)
45-
* [`fn()`](#fn)
46-
* [`FQDN()`](#FQDN)
47-
* [`fullWidth()`](#fullWidth)
48-
* [`greaterThan()`](#greaterThan)
49-
* [`greaterThanOrEqualTo()`](#greaterThanOrEqualTo)
50-
* [`halfWidth()`](#halfWidth)
51-
* [`hash()`](#hash)
52-
* [`hex()`](#hex)
53-
* [`hexadecimal()`](#hexadecimal)
54-
* [`hexColor()`](#hexColor)
55-
* [`hosted()`](#hosted)
56-
* [`HSL()`](#HSL)
57-
* [`IBAN()`](#IBAN)
58-
* [`identityCard()`](#identityCard)
59-
* [`IMEI()`](#IMEI)
60-
* [`infinite()`](#infinite)
61-
* [`instance()`](#instance)
62-
* [`integer()`](#integer)
63-
* [`IP()`](#IP)
64-
* [`IPRange()`](#IPRange)
65-
* [`ISBN()`](#ISBN)
66-
* [`ISIN()`](#ISIN)
67-
* [`ISO31661Alpha2()`](#ISO31661Alpha2)
68-
* [`ISO31661Alpha3()`](#ISO31661Alpha3)
69-
* [`ISO8601()`](#ISO8601)
70-
* [`ISRC()`](#ISRC)
71-
* [`ISSN()`](#ISSN)
72-
* [`JSON()`](#JSON)
73-
* [`JWT()`](#JWT)
74-
* [`latLong()`](#latLong)
75-
* [`lessThan()`](#lessThan)
76-
* [`lessThanOrEqualTo()`](#lessThanOrEqualTo)
77-
* [`locale()`](#locale)
78-
* [`lowercase()`](#lowercase)
79-
* [`MACAddress()`](#MACAddress)
80-
* [`magnetURI()`](#magnetURI)
81-
* [`maximum()`](#maximum)
82-
* [`MD5()`](#MD5)
83-
* [`mimeType()`](#mimeType)
84-
* [`minimum()`](#minimum)
85-
* [`mobilePhone()`](#mobilePhone)
86-
* [`mongoId()`](#mongoId)
87-
* [`multibyte()`](#multibyte)
88-
* [`nan()`](#nan)
89-
* [`null()`](#null)
90-
* [`number()`](#number)
91-
* [`object()`](#object)
92-
* [`objectLiteral()`](#objectLiteral)
93-
* [`octal()`](#octal)
94-
* [`odd()`](#odd)
95-
* [`passportNumber()`](#passportNumber)
96-
* [`pathToDir()`](#pathToDir)
97-
* [`pathToFile()`](#pathToFile)
98-
* [`portNumber()`](#portNumber)
99-
* [`postalCode()`](#postalCode)
100-
* [`primitive()`](#primitive)
101-
* [`regexp()`](#regexp)
102-
* [`RFC3339()`](#RFC3339)
103-
* [`rgbColor()`](#rgbColor)
104-
* [`semVer()`](#semVer)
105-
* [`slug()`](#slug)
106-
* [`string()`](#string)
107-
* [`stringBool()`](#stringBool)
108-
* [`stringContains()`](#stringContains)
109-
* [`stringDecimal()`](#stringDecimal)
110-
* [`stringEmpty()`](#stringEmpty)
111-
* [`stringEquals()`](#stringEquals)
112-
* [`stringIn()`](#stringIn)
113-
* [`stringInteger()`](#stringInteger)
114-
* [`stringLength()`](#stringLength)
115-
* [`stringMatches()`](#stringMatches)
116-
* [`stringNumeric()`](#stringNumeric)
117-
* [`surrogatePair()`](#surrogatePair)
118-
* [`svg()`](#svg)
119-
* [`symbol()`](#symbol)
120-
* [`taxID()`](#taxID)
121-
* [`true()`](#true)
122-
* [`type()`](#type)
123-
* [`undefined()`](#undefined)
124-
* [`uppercase()`](#uppercase)
125-
* [`URL()`](#URL)
126-
* [`UUID()`](#UUID)
127-
* [`variableWidth()`](#variableWidth)
128-
* [`whitelisted()`](#whitelisted)
129-
* [`within()`](#within)
130-
* [Exceptions](getting-started/basic-usage/exceptions.md)
3+
- [Introduction](getting-started/introduction.md)
4+
- [Prerequisites](getting-started/prerequisites.md)
5+
- [Installation](getting-started/installation.md)
6+
- [Basic Usage](getting-started/basic-usage/basic-usage.md)
7+
- [Validators](getting-started/basic-usage/validators.md)
8+
- [`actualNaN()`](#actualNaN)
9+
- [`alpha()`](#alpha)
10+
- [`alphanumeric()`](#alphanumeric)
11+
- [`args()`](#args)
12+
- [`argsEmpty()`](#argsEmpty)
13+
- [`array()`](#array)
14+
- [`arrayEmpty()`](#arrayEmpty)
15+
- [`arrayLike()`](#arrayLike)
16+
- [`ascii()`](#ascii)
17+
- [`base32()`](#base32)
18+
- [`base64()`](#base64)
19+
- [`BIC()`](#BIC)
20+
- [`bigint()`](#bigint)
21+
- [`bool()`](#bool)
22+
- [`btcAddress()`](#btcAddress)
23+
- [`buffer()`](#buffer)
24+
- [`byteLength()`](#byteLength)
25+
- [`creditCard()`](#currency)
26+
- [`currency()`](#currency)
27+
- [`dataURI()`](#dataURI)
28+
- [`date()`](#date)
29+
- [`dateAfter()`](#dateAfter)
30+
- [`dateBefore()`](#dateBefore)
31+
- [`dateValid()`](#dateValid)
32+
- [`decimal()`](#decimal)
33+
- [`defined()`](#defined)
34+
- [`divisibleBy()`](#divisibleBy)
35+
- [`EAN()`](#EAN)
36+
- [`element()`](#element)
37+
- [`email()`](#email)
38+
- [`empty()`](#empty)
39+
- [`equal()`](#equal)
40+
- [`error()`](#error)
41+
- [`ethereumAddress()`](#ethereumAddress)
42+
- [`even()`](#false)
43+
- [`false()`](#false)
44+
- [`float()`](#float)
45+
- [`fn()`](#fn)
46+
- [`FQDN()`](#FQDN)
47+
- [`fullWidth()`](#fullWidth)
48+
- [`greaterThan()`](#greaterThan)
49+
- [`greaterThanOrEqualTo()`](#greaterThanOrEqualTo)
50+
- [`halfWidth()`](#halfWidth)
51+
- [`hash()`](#hash)
52+
- [`hex()`](#hex)
53+
- [`hexadecimal()`](#hexadecimal)
54+
- [`hexColor()`](#hexColor)
55+
- [`hosted()`](#hosted)
56+
- [`HSL()`](#HSL)
57+
- [`IBAN()`](#IBAN)
58+
- [`identityCard()`](#identityCard)
59+
- [`IMEI()`](#IMEI)
60+
- [`infinite()`](#infinite)
61+
- [`instance()`](#instance)
62+
- [`integer()`](#integer)
63+
- [`IP()`](#IP)
64+
- [`IPRange()`](#IPRange)
65+
- [`ISBN()`](#ISBN)
66+
- [`ISIN()`](#ISIN)
67+
- [`ISO31661Alpha2()`](#ISO31661Alpha2)
68+
- [`ISO31661Alpha3()`](#ISO31661Alpha3)
69+
- [`ISO8601()`](#ISO8601)
70+
- [`ISRC()`](#ISRC)
71+
- [`ISSN()`](#ISSN)
72+
- [`JSON()`](#JSON)
73+
- [`JWT()`](#JWT)
74+
- [`latLong()`](#latLong)
75+
- [`lessThan()`](#lessThan)
76+
- [`lessThanOrEqualTo()`](#lessThanOrEqualTo)
77+
- [`locale()`](#locale)
78+
- [`lowercase()`](#lowercase)
79+
- [`MACAddress()`](#MACAddress)
80+
- [`magnetURI()`](#magnetURI)
81+
- [`maximum()`](#maximum)
82+
- [`MD5()`](#MD5)
83+
- [`mimeType()`](#mimeType)
84+
- [`minimum()`](#minimum)
85+
- [`mobilePhone()`](#mobilePhone)
86+
- [`mongoId()`](#mongoId)
87+
- [`multibyte()`](#multibyte)
88+
- [`nan()`](#nan)
89+
- [`null()`](#null)
90+
- [`number()`](#number)
91+
- [`object()`](#object)
92+
- [`objectLiteral()`](#objectLiteral)
93+
- [`octal()`](#octal)
94+
- [`odd()`](#odd)
95+
- [`passportNumber()`](#passportNumber)
96+
- [`pathToDir()`](#pathToDir)
97+
- [`pathToFile()`](#pathToFile)
98+
- [`portNumber()`](#portNumber)
99+
- [`postalCode()`](#postalCode)
100+
- [`primitive()`](#primitive)
101+
- [`regexp()`](#regexp)
102+
- [`RFC3339()`](#RFC3339)
103+
- [`rgbColor()`](#rgbColor)
104+
- [`semVer()`](#semVer)
105+
- [`slug()`](#slug)
106+
- [`string()`](#string)
107+
- [`stringBool()`](#stringBool)
108+
- [`stringContains()`](#stringContains)
109+
- [`stringDecimal()`](#stringDecimal)
110+
- [`stringEmpty()`](#stringEmpty)
111+
- [`stringEquals()`](#stringEquals)
112+
- [`stringIn()`](#stringIn)
113+
- [`stringInteger()`](#stringInteger)
114+
- [`stringLength()`](#stringLength)
115+
- [`stringMatches()`](#stringMatches)
116+
- [`stringNumeric()`](#stringNumeric)
117+
- [`surrogatePair()`](#surrogatePair)
118+
- [`svg()`](#svg)
119+
- [`symbol()`](#symbol)
120+
- [`taxID()`](#taxID)
121+
- [`true()`](#true)
122+
- [`type()`](#type)
123+
- [`undefined()`](#undefined)
124+
- [`uppercase()`](#uppercase)
125+
- [`URL()`](#URL)
126+
- [`UUID()`](#UUID)
127+
- [`variableWidth()`](#variableWidth)
128+
- [`whitelisted()`](#whitelisted)
129+
- [`within()`](#within)
131130

132-
* Miscellaneous
131+
- Miscellaneous
133132

134-
* [Changelog](miscellaneous/changelog.md)
135-
* [Testing](miscellaneous/testing.md)
136-
* [License](miscellaneous/license.md)
133+
- [Changelog](miscellaneous/changelog.md)
134+
- [Testing](miscellaneous/testing.md)
135+
- [License](miscellaneous/license.md)

‎docs/getting-started/basic-usage/basic-usage.md‎

Lines changed: 0 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
---
44

5-
65
### **Validator** - If you are using | [`oslllo-validator`](https://www.npmjs.com/package/oslllo-validator)
76

87
![](../../images/cover-small.png)
@@ -47,58 +46,3 @@ https://cdn.jsdelivr.net/npm/oslllo-validator@latest/dist/oslllo-validator.js
4746
```
4847

4948
---
50-
51-
### **Validator Exception** - If you are using | [`oslllo-validator-exception`](https://www.npmjs.com/package/oslllo-validator-exception)
52-
53-
![](../../images/cover-exception-small.png)
54-
55-
## Node / Bundler
56-
57-
```js
58-
const assert = require("oslllo-validator-exception");
59-
```
60-
61-
## Browser / Client-side
62-
63-
Both `minified` and `unminified` versions are available.
64-
65-
> You can fetch the already built files via the `jsdelivr` CDN or by building them `locally`
66-
67-
---
68-
69-
### CDN
70-
71-
- [**jsdelivr**](https://www.jsdelivr.com/package/npm/oslllo-validator-exception?path=dist)
72-
73-
Minified
74-
75-
```txt
76-
https://cdn.jsdelivr.net/npm/oslllo-validator-exception@latest/dist/oslllo-validator-exception.min.js
77-
```
78-
79-
Un-minified
80-
81-
```txt
82-
https://cdn.jsdelivr.net/npm/oslllo-validator-exception@latest/dist/oslllo-validator-exception.js
83-
```
84-
85-
### Usage
86-
87-
```js
88-
<script type="text/javascript" src="path/to/oslllo-validator-exception.min.js"></script>
89-
<script type="text/javascript">
90-
assert.string("test"); // => True
91-
</script>
92-
```
93-
94-
---
95-
96-
### Build Locally
97-
98-
1. Clone the [repository](https://github.com/oslllo/validator-exception) to your local machine.
99-
2. Run `npm install --dev`.
100-
3. Run `npm run build`.
101-
102-
The built client-side files will be located in the `dist` folder.
103-
104-
----

‎docs/getting-started/basic-usage/exceptions.md‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎docs/getting-started/introduction.md‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
![Cover Image](../images/cover.png)
32

43
[![build](https://img.shields.io/travis/oslllo/validator)](https://travis-ci.com/github/oslllo/validator)
@@ -32,15 +31,6 @@ const is = require("oslllo-validator");
3231

3332
is.UUID("A987FBC9-4BED-3078-CF07-9141BA07C9F3", 3); // => True
3433
is.UUID("xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3", 3); // => False
35-
3634
```
3735

3836
---
39-
40-
## Throw `exception` on false
41-
42-
If you want to throw an `exception` on `false` then check out `oslllo-validator-exception` [HERE](https://github.com/oslllo/validator-exception)
43-
44-
![](../images/cover-exception-small.png)
45-
46-
---

‎docs/images/cover-exception-small.png‎

-65.7 KB
Binary file not shown.

‎docs/images/cover-exception.png‎

-82.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)