https://github.com/electerious/count-between

Counts up and down between two numbers.
https://github.com/electerious/count-between

count num number

Last synced: about 1 year ago
JSON representation

Counts up and down between two numbers.

• Host: GitHub
• URL: https://github.com/electerious/count-between
• Owner: electerious
• License: mit
• Created: 2016-07-20T08:40:38.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-10-01T13:59:17.000Z (over 3 years ago)
• Last Synced: 2025-04-19T06:41:46.793Z (about 1 year ago)
• Topics: count, num, number
• Language: JavaScript
• Homepage:
• Size: 34.2 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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.