is-alphanumerical

What is is-alphanumerical?

The is-alphanumerical npm package is designed to check if a given input (string or character) is alphanumeric, meaning it consists of letters and numbers only. This can be particularly useful for validating user input, parsing content, or filtering data in applications where alphanumeric strings are required or expected.

What are is-alphanumerical's main functionalities?

Check if a string is alphanumeric

This feature allows you to verify if an entire string is alphanumeric. It returns true if the string contains only letters and numbers, and false otherwise.

"use strict"; var isAlphanumerical = require('is-alphanumerical'); console.log(isAlphanumerical('abc123')); // true console.log(isAlphanumerical('abc!123')); // false

Check if a single character is alphanumeric

This feature enables checking whether a single character is alphanumeric. It's useful for parsing or iterating through strings character by character to validate or process each one.

"use strict"; var isAlphanumerical = require('is-alphanumerical'); console.log(isAlphanumerical('a')); // true console.log(isAlphanumerical('!')); // false

Other packages similar to is-alphanumerical

validator

Validator is a more comprehensive library for string validation and sanitization. It includes a function to check if a string is alphanumeric among many other validation functions. Compared to is-alphanumerical, validator is more versatile but also larger in size, making is-alphanumerical a lightweight alternative for specific alphanumeric checks.

is-alphanumeric

Is-alphanumeric is another package with a similar purpose, offering functionality to check if strings or characters are alphanumeric. The main difference lies in the implementation details and possibly in performance benchmarks, but both serve the same primary purpose.

README

is-alphanumerical

Check if a character is alphanumerical.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • isAlphanumerical(character)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This is a function that checks if a given character is ASCII alphanumerical: it matches [a-zA-Z0-9].

When should I use this?

Not often, as it’s relatively simple to do yourself. This package exists because it’s needed in several related packages, at which point it becomes useful to defer to one shared function.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install is-alphanumerical

In Deno with Skypack:

import {isAlphanumerical} from 'https://cdn.skypack.dev/is-alphanumerical@2?dts'

In browsers with Skypack:

<script type="module">
  import {isAlphanumerical} from 'https://cdn.skypack.dev/is-alphanumerical@2?min'
</script>

Use

import {isAlphanumerical} from 'is-alphanumerical'

isAlphanumerical('a') // => true
isAlphanumerical('Z') // => true
isAlphanumerical('0') // => true
isAlphanumerical(' ') // => false
isAlphanumerical('💩') // => false

API

This package exports the following identifier: isAlphanumerical. There is no default export.

isAlphanumerical(character)

Check whether the given character code (number), or the character code at the first position (string), is alphanumerical.

Types

This package is fully typed with TypeScript.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

• wooorm/is-alphabetical
• wooorm/is-decimal
• wooorm/is-hexadecimal
• wooorm/is-whitespace-character
• wooorm/is-word-character

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer