https://github.com/k4m4/sha-regex
Regular expression for matching SHA hashes in strings.
https://github.com/k4m4/sha-regex
hash matcher regex regex-match regular-expression sha
Last synced: 4 months ago
JSON representation
Regular expression for matching SHA hashes in strings.
- Host: GitHub
- URL: https://github.com/k4m4/sha-regex
- Owner: k4m4
- License: mit
- Created: 2018-03-25T17:28:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:33:38.000Z (almost 3 years ago)
- Last Synced: 2025-04-22T21:50:42.201Z (6 months ago)
- Topics: hash, matcher, regex, regex-match, regular-expression, sha
- Language: JavaScript
- Homepage:
- Size: 575 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# sha-regex [](https://travis-ci.org/k4m4/sha-regex) [](https://github.com/xojs/xo)
> Regular expression for matching SHA hashes in strings.
## Install
```
~ ❯❯❯ npm install sha-regex
```
## Usage
```js
const sha = require('sha-regex')
sha().test('nodejsrocks 84de6753b298abd027fcd1d790eade2413eafb5a')
//=> true
sha({exact: true}).test('nodejsrocks 84de6753b298abd027fcd1d790eade2413eafb5a foo')
//=> false
sha({exact: true}).test('84de6753b298abd027fcd1d790eade2413eafb5a')
//=> true
sha.version(256, {exact: true}).test('c6cb50e7eea0df1fd3eaf52ada2358f5423afd7c0b5ee2395231a9b3208ffcaf')
//=> true
sha.version(512, {exact: true}).test('84de6753b298abd027fcd1d790eade2413eafb5a')
//=> false
'nodejsrocks 84de6753b298abd027fcd1d790eade2413eafb5a rainbow c6cb50e7eea0df1fd3eaf52ada2358f5423afd7c0b5ee2395231a9b3208ffcaf'.match(sha())
//=> ['84de6753b298abd027fcd1d790eade2413eafb5a','c6cb50e7eea0df1fd3eaf52ada2358f5423afd7c0b5ee2395231a9b3208ffca']
```
## API
### sha([options])
Returns a regex for matching SHA hashes.
#### options
Type: `Object`
##### exact
Type: `boolean`
Default: `false` *(Matches any SHA hash in a string)*
Only match an exact string. Useful with `RegExp#test()` to check if a string is a SHA hash.
### sha.version(version, [options])
Returns a regex for matching specific SHA version hashes.
#### version
Type: `integer`
Supported Versions: `1`, `224`, `256`, `384`, `512`
Match a specific version of SHA.
#### options
Type: `Object`
##### exact
Type: `boolean`
Default: `false` *(Matches any SHA hash in a string)*
Only match an exact string. Useful with `RegExp#test()` to check if a string is a SHA hash.
## License
MIT © [Nikolaos Kamarinakis](https://nikolaskama.me)