Awesome
is-whitespace-character
Check if a character is whitespace.
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 a white space character:
\s
, which equals all Unicode Space Separators (including [ \t\v\f]
), the BOM
(\uFEFF
), and line terminators ([\n\r\u2028\u2029]
).
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-whitespace-character
In Deno with esm.sh
:
import {isWhitespaceCharacter} from 'https://esm.sh/is-whitespace-character@2'
In browsers with esm.sh
:
<script type="module">
import {isWhitespaceCharacter} from 'https://esm.sh/is-whitespace-character@2?bundle'
</script>
Use
import {isWhitespaceCharacter} from 'is-whitespace-character'
isWhitespaceCharacter(' ') // => true
isWhitespaceCharacter('\n') // => true
isWhitespaceCharacter('\uFEFF') // => true
isWhitespaceCharacter('_') // => false
isWhitespaceCharacter('a') // => false
isWhitespaceCharacter('💩') // => false
API
This package exports the identifier isWhitespaceCharacter
.
There is no default export.
isWhitespaceCharacter(character|code)
Check if the given code point (number
), or the code point at the first index
(string
), is a whitespace 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
wooorm/is-alphanumerical
wooorm/is-decimal
wooorm/is-hexadecimal
wooorm/is-word-character
Contribute
Yes please! See How to Contribute to Open Source.