alphanumeric-validator
v1.0.1
Published
Validates if a string is alphanumeric
Downloads
153
Readme
alphanumeric-validator
A simple and lightweight utility to check if a given string is alphanumeric. This package returns true
if the string contains only letters and digits, and false
otherwise.
Why Use alphanumeric-validator?
- Zero dependencies: Small footprint and quick to install.
- Straightforward API: Just one function—no overhead.
- Tested and Reliable: Every published version passes CI tests.
Installation
Install the package via npm:
npm install alphanumeric-validator
Usage
Import the function and call it with the string you want to validate:
const isAlphaNumeric = require('alphanumeric-validator');
console.log(isAlphaNumeric('abc123')); // true
console.log(isAlphaNumeric('hello world!')); // false
It’s that simple. If the string contains only letters ([a-zA-Z]
) and digits ([0-9]
), you’ll get true
; otherwise, false
.
Running Tests
If you’ve cloned this repository locally and want to run tests:
npm install
npm test
We use Jest to ensure code quality. The CI/CD pipeline also runs these tests before publishing to npm, guaranteeing that every release is verified.
Contributing
Contributions are welcome! To get started:
- Fork the repository and create a new branch for your feature or bug fix.
- Write tests for any new logic to ensure it’s fully covered.
- Open a pull request, and describe what changes you’ve made and why.
Please follow the established coding style and make sure tests pass before submitting your PR.
License
This project is licensed under the ISC License.