Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

is-whitespace-character

Build Coverage Downloads Size

Check if a character is a white space character.

Contents

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 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 following identifiers: isWhitespaceCharacter. There is no default export.

isWhitespaceCharacter(character|code)

Check whether the given character code (number) or the character code at the first position (string) is a whitespace 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

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer

About

Check if a character is a white space character

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project