.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / is-whitespace-character / readme.md
1 # is-whitespace-character
2
3 [![Build][build-badge]][build]
4 [![Coverage][coverage-badge]][coverage]
5 [![Downloads][downloads-badge]][downloads]
6 [![Size][size-badge]][size]
7
8 Check if a character is a whitespace character: `\s`, which equals all Unicode
9 Space Separators (including `[ \t\v\f]`), the BOM (`\uFEFF`), and line
10 terminator (`[\n\r\u2028\u2029]`).
11
12 ## Install
13
14 [npm][]:
15
16 ```sh
17 npm install is-whitespace-character
18 ```
19
20 ## Use
21
22 ```js
23 var whitespace = require('is-whitespace-character')
24
25 whitespace(' ') // => true
26 whitespace('\n') // => true
27 whitespace('\uFEFF') // => true
28 whitespace('_') // => false
29 whitespace('a') // => false
30 whitespace('💩') // => false
31 ```
32
33 ## API
34
35 ### `whitespaceCharacter(character|code)`
36
37 Check whether the given character code (`number`), or the character code at the
38 first position (`string`), is a whitespace character.
39
40 ## Related
41
42 *   [`is-alphabetical`](https://github.com/wooorm/is-alphabetical)
43 *   [`is-alphanumerical`](https://github.com/wooorm/is-alphanumerical)
44 *   [`is-decimal`](https://github.com/wooorm/is-decimal)
45 *   [`is-hexadecimal`](https://github.com/wooorm/is-hexadecimal)
46 *   [`is-word-character`](https://github.com/wooorm/is-word-character)
47
48 ## License
49
50 [MIT][license] Â© [Titus Wormer][author]
51
52 <!-- Definitions -->
53
54 [build-badge]: https://img.shields.io/travis/wooorm/is-whitespace-character.svg
55
56 [build]: https://travis-ci.org/wooorm/is-whitespace-character
57
58 [coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/is-whitespace-character.svg
59
60 [coverage]: https://codecov.io/github/wooorm/is-whitespace-character
61
62 [downloads-badge]: https://img.shields.io/npm/dm/is-whitespace-character.svg
63
64 [downloads]: https://www.npmjs.com/package/is-whitespace-character
65
66 [size-badge]: https://img.shields.io/bundlephobia/minzip/is-whitespace-character.svg
67
68 [size]: https://bundlephobia.com/result?p=is-whitespace-character
69
70 [npm]: https://docs.npmjs.com/cli/install
71
72 [license]: license
73
74 [author]: https://wooorm.com