https://github.com/compactjs/limit
Limits a value to a defined range
https://github.com/compactjs/limit
degrees hours javascript limit minutes range
Last synced: 3 months ago
JSON representation
Limits a value to a defined range
- Host: GitHub
- URL: https://github.com/compactjs/limit
- Owner: CompactJS
- License: mit
- Created: 2020-04-10T22:09:10.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-04T11:30:10.000Z (about 2 years ago)
- Last Synced: 2025-02-16T19:48:33.714Z (3 months ago)
- Topics: degrees, hours, javascript, limit, minutes, range
- Language: JavaScript
- Size: 2.41 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
@compactjs/limit
Limits a value to a defined range
·
Homepage
·
Report Bug / Request Feature
·
## Table of Contents
- [About](#What-it-does)
- [Installation](#Install)
- [Usage](#usage)
- [Test](#run-tests)
- [Contact](#contact)
- [Contributing](#Contributing)
- [License](#license)
## What it does
@compactjs/limit limits any number to a given range. If it exceeds the range, it start back at 0 and equally starts from maximum value if it falls below 0.
Use it to easily calculate hours, minutes or degrees.
## Install
### NPM:
```sh
npm install @compactjs/limit
```
### CDN:
```html
```
## Usage
### As module:
```javascript
import { limit } from '@compactjs/limit';
```
### Example:
```javascript
// hours
limit(25, 24); // returns: 1
// degrees
limit(90 - 180, 360); // returns: 270
```
## Run tests
```sh
npm run test
```
## Contact
👤 **Timo Bechtel **
- Website: https://timobechtel.com
- Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel)
- GitHub: [@TimoBechtel](https://github.com/TimoBechtel)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
1. Check [issues](https://github.com/CompactJS/limit/issues)
1. Fork the Project
1. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)
1. Test your changes `npm run test`
1. Commit your Changes (`git commit -m 'feat: add amazingFeature'`)
1. Push to the Branch (`git push origin feat/AmazingFeature`)
1. Open a Pull Request
### Commit messages
This project uses semantic-release for automated release versions. So commits in this project follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) guidelines. I recommend using [commitizen](https://github.com/commitizen/cz-cli) for automated commit messages.
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Distributed under the [MIT](https://github.com/CompactJS/limit/blob/main/LICENSE) License.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_