is-word-character

is-word-character

Check if a character is a word character.

Contents

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

What is this?

This is a function that checks if a given character is a word character: whether it matches \w (which is short for [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-word-character

In Deno with Skypack:

import {isWordCharacter} from 'https://cdn.skypack.dev/is-word-character@2?dts'

In browsers with Skypack:

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

Use

import {isWordCharacter} from 'is-word-character'

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

API

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

isWordCharacter(character|code)

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

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-alphanumerical
• wooorm/is-decimal
• wooorm/is-hexadecimal
• wooorm/is-whitespace-character

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer