| 1 | # is-alphabetical
|
|---|
| 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 alphabetical.
|
|---|
| 9 |
|
|---|
| 10 | ## Install
|
|---|
| 11 |
|
|---|
| 12 | [npm][]:
|
|---|
| 13 |
|
|---|
| 14 | ```sh
|
|---|
| 15 | npm install is-alphabetical
|
|---|
| 16 | ```
|
|---|
| 17 |
|
|---|
| 18 | ## Use
|
|---|
| 19 |
|
|---|
| 20 | ```js
|
|---|
| 21 | var alphabetical = require('is-alphabetical')
|
|---|
| 22 |
|
|---|
| 23 | alphabetical('a') // => true
|
|---|
| 24 | alphabetical('B') // => true
|
|---|
| 25 | alphabetical('0') // => false
|
|---|
| 26 | alphabetical('💩') // => false
|
|---|
| 27 | ```
|
|---|
| 28 |
|
|---|
| 29 | ## API
|
|---|
| 30 |
|
|---|
| 31 | ### `alphabetical(character|code)`
|
|---|
| 32 |
|
|---|
| 33 | Check whether the given character code (`number`), or the character code at the
|
|---|
| 34 | first position (`string`), is alphabetical.
|
|---|
| 35 |
|
|---|
| 36 | ## Related
|
|---|
| 37 |
|
|---|
| 38 | * [`is-decimal`](https://github.com/wooorm/is-decimal)
|
|---|
| 39 | * [`is-hexadecimal`](https://github.com/wooorm/is-hexadecimal)
|
|---|
| 40 | * [`is-alphanumerical`](https://github.com/wooorm/is-alphanumerical)
|
|---|
| 41 | * [`is-whitespace-character`](https://github.com/wooorm/is-whitespace-character)
|
|---|
| 42 | * [`is-word-character`](https://github.com/wooorm/is-word-character)
|
|---|
| 43 |
|
|---|
| 44 | ## License
|
|---|
| 45 |
|
|---|
| 46 | [MIT][license] © [Titus Wormer][author]
|
|---|
| 47 |
|
|---|
| 48 | <!-- Definitions -->
|
|---|
| 49 |
|
|---|
| 50 | [build-badge]: https://img.shields.io/travis/wooorm/is-alphabetical.svg
|
|---|
| 51 |
|
|---|
| 52 | [build]: https://travis-ci.org/wooorm/is-alphabetical
|
|---|
| 53 |
|
|---|
| 54 | [coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/is-alphabetical.svg
|
|---|
| 55 |
|
|---|
| 56 | [coverage]: https://codecov.io/github/wooorm/is-alphabetical
|
|---|
| 57 |
|
|---|
| 58 | [downloads-badge]: https://img.shields.io/npm/dm/is-alphabetical.svg
|
|---|
| 59 |
|
|---|
| 60 | [downloads]: https://www.npmjs.com/package/is-alphabetical
|
|---|
| 61 |
|
|---|
| 62 | [size-badge]: https://img.shields.io/bundlephobia/minzip/is-alphabetical.svg
|
|---|
| 63 |
|
|---|
| 64 | [size]: https://bundlephobia.com/result?p=is-alphabetical
|
|---|
| 65 |
|
|---|
| 66 | [npm]: https://docs.npmjs.com/cli/install
|
|---|
| 67 |
|
|---|
| 68 | [license]: license
|
|---|
| 69 |
|
|---|
| 70 | [author]: https://wooorm.com
|
|---|
