Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wooorm/is-word-character
Check if a character is a word character
https://github.com/wooorm/is-word-character
alphabetical character number numerical word
Last synced: about 1 month ago
JSON representation
Check if a character is a word character
- Host: GitHub
- URL: https://github.com/wooorm/is-word-character
- Owner: wooorm
- License: mit
- Created: 2016-07-12T09:22:02.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2022-11-23T12:01:38.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T01:04:42.376Z (about 1 month ago)
- Topics: alphabetical, character, number, numerical, word
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: funding.yml
- License: license
Awesome Lists containing this project
README
# is-word-character
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]Check if a character is a word character.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`isWordCharacter(value)`](#iswordcharactervalue)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#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][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:```sh
npm install is-word-character
```In Deno with [`esm.sh`][esmsh]:
```js
import {isWordCharacter} from 'https://esm.sh/is-word-character@2'
```In browsers with [`esm.sh`][esmsh]:
```html
import {isWordCharacter} from 'https://esm.sh/is-word-character@2?bundle'
```
## Use
```js
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.
## Related
* [`wooorm/is-alphabetical`](https://github.com/wooorm/is-alphabetical)
* [`wooorm/is-alphanumerical`](https://github.com/wooorm/is-alphanumerical)
* [`wooorm/is-decimal`](https://github.com/wooorm/is-decimal)
* [`wooorm/is-hexadecimal`](https://github.com/wooorm/is-hexadecimal)
* [`wooorm/is-whitespace-character`](https://github.com/wooorm/is-whitespace-character)## Contribute
Yes please!
See [How to Contribute to Open Source][contribute].## License
[MIT][license] Β© [Titus Wormer][author]
[build-badge]: https://github.com/wooorm/is-word-character/workflows/main/badge.svg
[build]: https://github.com/wooorm/is-word-character/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/is-word-character.svg
[coverage]: https://codecov.io/github/wooorm/is-word-character
[downloads-badge]: https://img.shields.io/npm/dm/is-word-character.svg
[downloads]: https://www.npmjs.com/package/is-word-character
[size-badge]: https://img.shields.io/bundlephobia/minzip/is-word-character.svg
[size]: https://bundlephobia.com/result?p=is-word-character
[npm]: https://docs.npmjs.com/cli/install
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/