summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/is-alphabetical/readme.md
blob: ea08662dad3bc2aa076d4e72e7ef9dd2db69f33a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# is-alphabetical [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]

<!--lint disable heading-increment list-item-spacing-->

Check if a character is alphabetical.

## Installation

[npm][npm-install]:

```bash
npm install is-alphabetical
```

## Usage

Dependencies:

```javascript
var alphabetical = require('is-alphabetical');

alphabetical('a'); // true
alphabetical('B'); // true
alphabetical('0'); // false
alphabetical('💩'); // false
```

## API

### `alphabetical(character)`

Check whether the given character code (`number`), or the character
code at the first position (`string`), is alphabetical.

## Related

*   [`is-decimal`](https://github.com/wooorm/is-decimal)
*   [`is-hexadecimal`](https://github.com/wooorm/is-hexadecimal)

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[travis-badge]: https://img.shields.io/travis/wooorm/is-alphabetical.svg

[travis]: https://travis-ci.org/wooorm/is-alphabetical

[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/is-alphabetical.svg

[codecov]: https://codecov.io/github/wooorm/is-alphabetical

[npm-install]: https://docs.npmjs.com/cli/install

[license]: LICENSE

[author]: http://wooorm.com