summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/is-hexadecimal/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/eslint/node_modules/is-hexadecimal/readme.md')
-rw-r--r--tools/eslint/node_modules/is-hexadecimal/readme.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/tools/eslint/node_modules/is-hexadecimal/readme.md b/tools/eslint/node_modules/is-hexadecimal/readme.md
new file mode 100644
index 0000000000..19640e3668
--- /dev/null
+++ b/tools/eslint/node_modules/is-hexadecimal/readme.md
@@ -0,0 +1,58 @@
+# is-hexadecimal [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
+
+<!--lint disable heading-increment list-item-spacing-->
+
+Check if a character is hexadecimal.
+
+## Installation
+
+[npm][npm-install]:
+
+```bash
+npm install is-hexadecimal
+```
+
+## Usage
+
+Dependencies:
+
+```javascript
+var hexadecimal = require('is-hexadecimal');
+
+hexadecimal('a'); // true
+hexadecimal('0'); // true
+hexadecimal('G'); // false
+hexadecimal('💩'); // false
+```
+
+## API
+
+### `hexadecimal(character)`
+
+Check whether the given character code (`number`), or the character
+code at the first position (`string`), is hexadecimal.
+
+## Related
+
+* [`is-alphabetical`](https://github.com/wooorm/is-alphabetical)
+* [`is-decimal`](https://github.com/wooorm/is-decimal)
+
+## License
+
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[travis-badge]: https://img.shields.io/travis/wooorm/is-hexadecimal.svg
+
+[travis]: https://travis-ci.org/wooorm/is-hexadecimal
+
+[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/is-hexadecimal.svg
+
+[codecov]: https://codecov.io/github/wooorm/is-hexadecimal
+
+[npm-install]: https://docs.npmjs.com/cli/install
+
+[license]: LICENSE
+
+[author]: http://wooorm.com