Skip to content

Commit 8e3713d

Browse files
committed
Updated prettier and documentation
1 parent 7fe5905 commit 8e3713d

File tree

6 files changed

+5261
-4871
lines changed

6 files changed

+5261
-4871
lines changed

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
README.md

README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# IsBetween.js
1+
# IsBetween.js
2+
23
[![Build Status](https://travis-ci.com/raymonschouwenaar/is-between-js.svg?branch=master)](https://travis-ci.com/raymonschouwenaar/is-between-js)
34
[![npm version](https://badge.fury.io/js/is-between-js.svg)](https://badge.fury.io/js/is-between-js)
45

56
## Install
7+
68
```
79
npm i is-between-js
810
```
@@ -14,8 +16,19 @@ You can import the isBetween function in your JavaScript/TypeScript file and use
1416
The TypeScript types are included in the library.
1517

1618
```javascript
17-
import isBetween from 'is-between-js'
19+
import { isBetween } from 'is-between-js'
1820

19-
isBetween(10, 0, 100) // returns true
20-
isBetween(120, 0, 100) // returns false
21+
isBetween(1).min(0).max(10).calc() // returns true
22+
isBetween(10).min(0).max(9).calc() // returns false
2123
```
24+
25+
or
26+
27+
```javascript
28+
import { Between } from 'is-between-js'
29+
30+
const between = new Between()
31+
32+
between.value(1).min(0).max(10).calc() // returns true
33+
between.value(10).min(0).max(9).calc() // returns false
34+
```

0 commit comments

Comments
 (0)