geez-numerals-converter
v1.0.0
Published
A JavaScript library for converting numbers between English/Arabic numerals and Ge'ez numerals.
Downloads
5
Maintainers
Readme
Geez Numerals Converter
Geez Numerals Converter is a powerful JavaScript library designed to seamlessly convert numbers between English/Arabic numerals and Ge'ez numerals. Perfect for developers working on projects involving Ethiopian scripts, historical numerical systems, or multilingual support, this package ensures accurate and efficient conversions.
Features
- Bidirectional Conversion: Convert numbers from English/Arabic to Ge'ez numerals and vice versa.
- High Accuracy: Maintains numerical integrity during conversions.
- Lightweight and Fast: Optimized for performance in both client-side and server-side applications.
- Easy Integration: Simple API for quick implementation in JavaScript or TypeScript projects.
- Open Source: Encourages community contributions and collaboration.
Installation
Install the package using npm:
npm install geez-numerals-converter
Or with yarn:
yarn add geez-numerals-converter
Usage
Import the Library
const { intToGeez, geezToInt } = require('geez-numerals-converter');
Convert Integer to Ge'ez Numerals
const geezNumber = intToGeez(4321);
console.log(geezNumber); // Output: ፬፼፫፻፲፩
Convert Ge'ez Numerals to Integer
const integer = geezToInt('፬፼፫፻፲፩');
console.log(integer); // Output: 4321
API
intToGeez(num)
Converts an integer to its Ge'ez numeral representation.
- Parameters:
num
(Number) - The integer to convert. - Returns: (String) - The Ge'ez numeral representation of the number.
geezToInt(geezNum)
Converts a Ge'ez numeral string to its integer representation.
- Parameters:
geezNum
(String) - The Ge'ez numeral string to convert. - Returns: (Number) - The integer representation of the Ge'ez numerals.
Contributing
We welcome contributions from the community. If you find a bug or have a feature request, please open an issue or submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
- Fork the repository
- Create your feature branch (
git checkout -b feature/my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin feature/my-new-feature
) - Create a new Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgements
Special thanks to all contributors and the open-source community for their invaluable support and contributions.