UNPKG

count-between

Version:

Counts up and down between two numbers

github.com/electerious/count-between

electerious/count-between

46 lines (29 loc) • 803 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# count-between ![Build](https://github.com/electerious/count-between/workflows/Build/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/electerious/count-between/badge.svg?branch=master)](https://coveralls.io/github/electerious/count-between?branch=master) Count up and down between two numbers. ## Install ``` npm install count-between ``` ## Usage ```js const c = require('count-between')(2, 5, 5) c(1) // 2 c(1) // 3 c(3) // 2 c(-2) // 4 c(0) // 4 c() // 4 ``` ## API ### Parameters - `min` `{Number}` Minimum number. - `max` `{Number}` Maximum number. - `initial` `{Number}` Initial number. ### Returns - `{Function}({?Number})` [Count-between instance](#instance-api). ## Instance API ### Parameters - `modifier ` `{?Number}` ### Returns - `{Number}` Current number.