Skip to content

Commit

Permalink
Updated bash links of API
Browse files Browse the repository at this point in the history
  • Loading branch information
Norman Carcamo committed Feb 5, 2020
1 parent 0e8bfcf commit 3ee9f8e
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ const is = require('@ncardez/is');
npm run test
```

### is.object
## is.object
- ``is.object`` (value``: object``) ``:boolean``

```js
Expand All @@ -64,7 +64,7 @@ npm run test
expect(is.object({})).toBe(true);
```

### is.null
## is.null
- ``is.null`` (value``: null``) ``:boolean``

```js
Expand All @@ -73,7 +73,7 @@ npm run test
expect(is.null(null)).toBe(true);
```

### is.undefined
## is.undefined
- ``is.undefined`` (value``: undefined``)``: boolean``

```js
Expand All @@ -84,7 +84,7 @@ npm run test
expect(is.undefined(undefined)).toBe(true);
```

### is.number
## is.number
- ``is.number`` (value``: number|string``, parse``: boolean``)``: boolean``

```js
Expand All @@ -97,7 +97,7 @@ npm run test
expect(is.number('13', true)).toBe(true);
```

### is.array
## is.array
- ``is.array`` (value``: array``)``: boolean``

```js
Expand All @@ -106,7 +106,7 @@ npm run test
expect(is.array([])).toBe(true);
```

### is.string
## is.string
- ``is.string`` (value``: string``)``: boolean``

```js
Expand All @@ -115,7 +115,7 @@ npm run test
expect(is.string('')).toBe(true);
```

### is.boolean
## is.boolean
- ``is.boolean`` (value``: boolean|string``, parse``: boolean``)``: boolean``

```js
Expand All @@ -130,7 +130,7 @@ npm run test
expect(is.boolean('false', true)).toBe(true);
```

### is.uuid
## is.uuid
- ``is.uuid`` (value`: string`, version`: string`)``: boolean``

value: must be a valid UUID.
Expand All @@ -143,7 +143,7 @@ npm run test
expect(is.uuid('1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed', 'v4')).toBe(true);
```

### is.integer
## is.integer
- ``is.integer`` (value``: number|string``)``: boolean``

```js
Expand All @@ -154,7 +154,7 @@ expect(is.integer(23)).toBe(true);
expect(is.integer('43')).toBe(true);
```

### is.float
## is.float
- ``is.float`` (value``: number|string``)``: boolean``

```js
Expand All @@ -164,7 +164,7 @@ expect(is.float(.23)).toBe(true);
expect(is.float('2.43')).toBe(true);
```

### is.positive
## is.positive
- ``is.positive`` (value``: number|string``, parse``: boolean``)``: boolean``

```js
Expand All @@ -175,7 +175,7 @@ expect(is.positive(23)).toBe(true);
expect(is.positive('2.43')).toBe(true);
```

### is.negative
## is.negative
- ``is.negative`` (value``: number|string``, parse``: boolean``)``: boolean``

```js
Expand All @@ -186,7 +186,7 @@ expect(is.negative(-23)).toBe(true);
expect(is.negative('-2.43')).toBe(true);
```

### is.zero
## is.zero
- ``is.zero`` (value``: number|string``, parse``: boolean``)``: boolean``

```js
Expand All @@ -197,7 +197,7 @@ expect(is.zero(0)).toBe(true);
expect(is.zero('0')).toBe(true);
```

### is.between
## is.between
- ``is.between`` (min``: number|string|date``, max``: number|string|date``, value``: number|string|date``, parse``: boolean``)``: boolean``

```js
Expand All @@ -209,7 +209,7 @@ expect(is.between('2010-02-01', '2010-02-20', '2010-02-10')).toBe(true);
expect(is.between(new Date('2010-02-01'), new Date('2010-02-20'), new Date('2010-02-10'))).toBe(true);
```

### is.alpha
## is.alpha
- ``is.alpha`` (value``: string``)``: boolean``

```js
Expand All @@ -220,7 +220,7 @@ expect(is.zero('aknd23')).toBe(true);
expect(is.zero('0ksjdn =13')).toBe(false);
```

### is.digit
## is.digit
- ``is.digit`` (value``: number|string``)``: boolean``

```js
Expand All @@ -230,7 +230,7 @@ expect(is.zero('2')).toBe(true);
expect(is.zero(3)).toBe(true);
```

### is.function
## is.function
- ``is.function`` (value``: function``)``: boolean``

```js
Expand All @@ -241,7 +241,7 @@ expect(is.function(() => {})).toBe(true);
expect(is.function(function() {})).toBe(true);
```

### is.async_function
## is.async_function
- ``is.async_function`` (value``: Async Function``)``: boolean``

```js
Expand All @@ -252,7 +252,7 @@ expect(is.function(async () => {})).toBe(true);
expect(is.function(async function() {})).toBe(true);
```

### is.promise
## is.promise
- ``is.promise`` (value``: Promise``)``: boolean``

```js
Expand All @@ -261,7 +261,7 @@ expect(is.function(async function() {})).toBe(true);
expect(is.promise(Promise.resolve(2))).toBe(true);
```

### is.empty
## is.empty
- ``is.empty`` (value``: string|array|object|function``)``: boolean``

```js
Expand All @@ -278,7 +278,7 @@ expect(is.promise(() => {})).toBe(true);
expect(is.promise(function () {})).toBe(true);
```

### is.regexp
## is.regexp
- ``is.regexp`` (value``: RegExp``)``: boolean``

```js
Expand All @@ -287,7 +287,7 @@ expect(is.promise(function () {})).toBe(true);
expect(is.regexp(/\d/)).toBe(true);
```

### is.ip
## is.ip
- ``is.ip`` (value``: string``)``: boolean``

```js
Expand All @@ -296,7 +296,7 @@ expect(is.regexp(/\d/)).toBe(true);
expect(is.ip('192.168.0.1')).toBe(true);
```

### is.port
## is.port
- ``is.port`` (value``: number``)``: boolean``

```js
Expand All @@ -305,7 +305,7 @@ expect(is.ip('192.168.0.1')).toBe(true);
expect(is.port(8080)).toBe(true);
```

### is.date
## is.date
- ``is.date`` (value``: Date``)``: boolean`` - alias: ``is.date.valid(value: Date): boolean``

```js
Expand All @@ -318,7 +318,7 @@ expect(is.date(Date(2020, 10, 12))).toBe(true);
expect(is.date(Date('2010-02-03'))).toBe(true);
```

### is.date.only
## is.date.only
- ``is.date.only`` (value``: string``)``: boolean``

```js
Expand All @@ -327,7 +327,7 @@ expect(is.date(Date('2010-02-03'))).toBe(true);
expect(is.date.only('2010-02-03')).toBe(true);
```

### is.date.time
## is.date.time
- ``is.date.time`` (value``: string``)``: boolean``

```js
Expand All @@ -336,7 +336,7 @@ expect(is.date.only('2010-02-03')).toBe(true);
expect(is.date.time('2010-02-03 03:20:14')).toBe(true);
```

### is.date.time.only
## is.date.time.only
- ``is.date.time.only`` (value``: string``)``: boolean``

```js
Expand All @@ -345,7 +345,7 @@ expect(is.date.time('2010-02-03 03:20:14')).toBe(true);
expect(is.date.time.only('03:20:14')).toBe(true);
```

### is.date.iso
## is.date.iso
- ``is.date.iso`` (value``: string``)``: boolean``

```js
Expand All @@ -356,7 +356,7 @@ expect(is.date.iso('2010-02-03 03:20:14.290Z')).toBe(true);
expect(is.date.iso('2018-02-11T02:10:14.210Z')).toBe(true);
```

### is.date.instance
## is.date.instance
- ``is.date.instance`` (value``: Date``)``: boolean``

```js
Expand All @@ -367,7 +367,7 @@ expect(is.date.instance(new Date())).toBe(true);
expect(is.date.instance(new Date('2018-02-11T02:10:14.210Z'))).toBe(true);
```

### is.type
## is.type
- ``is.type`` (value``: function|number|boolean|object|array|null|undefined|regexp|date|string|function``, parse``: boolean``)``: string``

```js
Expand Down

0 comments on commit 3ee9f8e

Please sign in to comment.