🧢 @compactjs/cap

Caps a value when out of a defined range

· Homepage · Report Bug / Request Feature ·

Table of Contents

• About
• Installation
• Usage
• Test
• Contact
• Contributing
• License

What it does

@compactjs/cap limits any number to a given range. Similar to @compactjs/limit but caps it when out of range.

Install

NPM:

npm install @compactjs/cap

Or download manually: https://unpkg.com/@compactjs/cap/dist/index.umd.js

Usage

As module:

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

Else:

const{ cap }=cap;

Example:

constmin=1;constmax=5;cap(7,min,max);// returns: 5cap(3,0,6);// returns: 3cap(-5,1,-4);// returns: -4

Function declaration

/** * Limits value to range from min to max. * If max is omitted min will be used as max, without a min range limit. * @value value to limit * @min minimum value * @max maximum value (optional) */functioncap(value: number,min: number,max?: number): number;

Run tests

npm run test

Contact

👤 Timo Bechtel

• Website: https://timobechtel.com
• Twitter: @TimoBechtel
• GitHub: @TimoBechtel

🤝 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