is-whitespace-character

Check if a character is a white space character.

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

npm install is-whitespace-character

In Deno with Skypack:

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

In browsers with Skypack:

<script type="module">
  import {isWhitespaceCharacter} from 'https://cdn.skypack.dev/is-whitespace-character@2?min'
</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 following identifiers: isWhitespaceCharacter. There is no default export.