summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/is-alphanumerical/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/eslint/node_modules/is-alphanumerical/readme.md')
-rw-r--r--tools/eslint/node_modules/is-alphanumerical/readme.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/tools/eslint/node_modules/is-alphanumerical/readme.md b/tools/eslint/node_modules/is-alphanumerical/readme.md
index 26e6289d38..9b1ffddddc 100644
--- a/tools/eslint/node_modules/is-alphanumerical/readme.md
+++ b/tools/eslint/node_modules/is-alphanumerical/readme.md
@@ -1,12 +1,10 @@
# is-alphanumerical [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
-<!--lint disable heading-increment list-item-spacing-->
-
Check if a character is alphanumerical (`[a-zA-Z0-9]`).
## Installation
-[npm][npm-install]:
+[npm][]:
```bash
npm install is-alphanumerical
@@ -17,11 +15,11 @@ npm install is-alphanumerical
```javascript
var alphanumerical = require('is-alphanumerical');
-alphanumerical('a'); // true
-alphanumerical('Z'); // true
-alphanumerical('0'); // true
-alphanumerical(' '); // false
-alphanumerical('💩'); // false
+alphanumerical('a'); //=> true
+alphanumerical('Z'); //=> true
+alphanumerical('0'); //=> true
+alphanumerical(' '); //=> false
+alphanumerical('💩'); //=> false
```
## API
@@ -53,7 +51,7 @@ code at the first position (`string`), is alphanumerical.
[codecov]: https://codecov.io/github/wooorm/is-alphanumerical
-[npm-install]: https://docs.npmjs.com/cli/install
+[npm]: https://docs.npmjs.com/cli/install
[license]: LICENSE