https://github.com/compactjs/remap
Map a value from one range to another
https://github.com/compactjs/remap
javascript map range remap
Last synced: 3 months ago
JSON representation
Map a value from one range to another
- Host: GitHub
- URL: https://github.com/compactjs/remap
- Owner: CompactJS
- License: mit
- Created: 2020-04-18T08:25:13.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-04T12:59:56.000Z (about 2 years ago)
- Last Synced: 2025-03-02T09:36:01.110Z (3 months ago)
- Topics: javascript, map, range, remap
- Language: JavaScript
- Size: 2.1 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/remap
Map a value from one range to another
·
Homepage
·
Report Bug / Request Feature
·
## Table of Contents
- [Installation](#Install)
- [Usage](#usage)
- [Test](#run-tests)
- [Contact](#contact)
- [Contributing](#Contributing)
- [License](#license)
## Install
### NPM:
```sh
npm install @compactjs/remap
```
### CDN:
```html
```
## Usage
```typescript
/**
* Maps a value from one range to another
*/
function remap(
value: number,
min: number,
max: number,
targetMin: number,
targetMax: number
): number;
```
### As module:
```javascript
import { remap } from '@compactjs/remap';
```
### Example:
```javascript
remap(0.5, 0, 1, 180, 360); // => 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/remap/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/remap/blob/main/LICENSE) License.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_