3.5 KiB
is-alphabetical
Check if a character is alphabetical.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
What is this?
This is a function that checks if a given character is ASCII alphabetical:
matching [a-z], case insensitive.
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-alphabetical
In Deno with Skypack:
import {isAlphabetical} from 'https://cdn.skypack.dev/is-alphabetical@2?dts'
In browsers with Skypack:
<script type="module">
import {isAlphabetical} from 'https://cdn.skypack.dev/is-alphabetical@2?min'
</script>
Use
import {isAlphabetical} from 'is-alphabetical'
isAlphabetical('a') // => true
isAlphabetical('B') // => true
isAlphabetical('0') // => false
isAlphabetical('💩') // => false
API
This package exports the following identifier: isAlphabetical.
There is no default export.
isAlphabetical(character|code)
Check whether the given character code (number), or the character code at the
first position (string), is alphabetical.
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-decimalwooorm/is-hexadecimalwooorm/is-alphanumericalwooorm/is-whitespace-characterwooorm/is-word-character
Contribute
Yes please! See How to Contribute to Open Source.