Narcissistic Preening Monarch

    is-whitespace-character
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    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 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.

    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

    Install

    npm i is-whitespace-character

    DownloadsWeekly Downloads

    3,956,527

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    7.66 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm