@compactjs/limit

Limits a value to a defined range

Usage no npm install needed!

<script type="module">
  import compactjsLimit from 'https://cdn.skypack.dev/@compactjs/limit';
</script>

README

@compactjs/limit

Limits a value to a defined range

Version License: MIT

· Homepage · Report Bug / Request Feature ·

Table of Contents

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:

npm install @compactjs/limit

CDN:

<script src="https://unpkg.com/@compactjs/limit/dist/index.umd.js"></script>

Usage

As module:

import { limit } from '@compactjs/limit';

Example:

// hours
limit(25, 24); // returns: 1

// degrees
limit(90 - 180, 360); // returns: 270

Run tests

npm run test

Contact

👤 Timo Bechtel timo@bechtel.solutions

🤝 Contributing

Contributions, issues and feature requests are welcome!

  1. Check issues
  2. Fork the Project
  3. Create your Feature Branch (git checkout -b feat/AmazingFeature)
  4. Test your changes npm run test
  5. Commit your Changes (git commit -m 'feat: add amazingFeature')
  6. Push to the Branch (git push origin feat/AmazingFeature)
  7. Open a Pull Request

Commit messages

This project uses semantic-release for automated release versions. So commits in this project follow the Conventional Commits guidelines. I recommend using commitizen for automated commit messages.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Distributed under the MIT License.

This README was generated with ❤️ by readme-md-generator