Awesome

is-word-character

Check if a character is a word character.

What is this?
When should I use this?
Install
Use
API
- isWordCharacter(value)
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 14.14+, 16.0+), install with npm:

npm install is-word-character

In Deno with esm.sh:

import {isWordCharacter} from 'https://esm.sh/is-word-character@2'

In browsers with esm.sh:

<script type="module">
  import {isWordCharacter} from 'https://esm.sh/is-word-character@2?bundle'
</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 identifier isWordCharacter. There is no default export.

`isWordCharacter(value)`

Check if the given code point (number), or the code point at the first index (string), is a word character.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

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

Security

This package is safe.

Contribute

Yes please! See How to Contribute to Open Source.

License